diff --git a/.gitignore b/.gitignore index 2291049..069cb1e 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,2 @@ +**/node_modules/** desktop.ini diff --git a/init.ps1 b/init.ps1 index 46e8bed..e0c1270 100644 --- a/init.ps1 +++ b/init.ps1 @@ -10,4 +10,4 @@ node -v # should print `v22.11.0` npm -v # should print `10.9.0` npm i -g '@google/clasp' -npm i -D '@types/google-apps-script' \ No newline at end of file +npm install \ No newline at end of file diff --git a/node_modules/.package-lock.json b/node_modules/.package-lock.json deleted file mode 100644 index 6aeb5f4..0000000 --- a/node_modules/.package-lock.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "name": "product_inventory", - "lockfileVersion": 3, - "requires": true, - "packages": { - "node_modules/@types/google-apps-script": { - "version": "1.0.84", - "resolved": "https://registry.npmjs.org/@types/google-apps-script/-/google-apps-script-1.0.84.tgz", - "integrity": "sha512-qZBeCyk3vJBGEiWtBSRrV89KVovdo9qruw1rQH8OZAQUgXS8RNbMKnnPI5dW+PuJwM8rMiYZpvl6LeaW9IS+WA==", - "dev": true, - "license": "MIT" - } - } -} diff --git a/node_modules/@types/google-apps-script/LICENSE b/node_modules/@types/google-apps-script/LICENSE deleted file mode 100644 index 9e841e7..0000000 --- a/node_modules/@types/google-apps-script/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ - MIT License - - Copyright (c) Microsoft Corporation. - - Permission is hereby granted, free of charge, to any person obtaining a copy - of this software and associated documentation files (the "Software"), to deal - in the Software without restriction, including without limitation the rights - to use, copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the Software is - furnished to do so, subject to the following conditions: - - The above copyright notice and this permission notice shall be included in all - copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR - IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, - FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE - AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER - LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, - OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE - SOFTWARE diff --git a/node_modules/@types/google-apps-script/README.md b/node_modules/@types/google-apps-script/README.md deleted file mode 100644 index 1a3dfd6..0000000 --- a/node_modules/@types/google-apps-script/README.md +++ /dev/null @@ -1,15 +0,0 @@ -# Installation -> `npm install --save @types/google-apps-script` - -# Summary -This package contains type definitions for google-apps-script (https://developers.google.com/apps-script/). - -# Details -Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-apps-script. - -### Additional Details - * Last updated: Sun, 13 Oct 2024 11:07:15 GMT - * Dependencies: none - -# Credits -These definitions were written by [PopGoesTheWza](https://github.com/PopGoesTheWza), [motemen](https://github.com/motemen), [pierluigi-montagna](https://github.com/pierluigi-montagna), and [mtgto](https://github.com/mtgto). diff --git a/node_modules/@types/google-apps-script/addons/google-apps-script.addon-event-objects.d.ts b/node_modules/@types/google-apps-script/addons/google-apps-script.addon-event-objects.d.ts deleted file mode 100644 index f4dd6de..0000000 --- a/node_modules/@types/google-apps-script/addons/google-apps-script.addon-event-objects.d.ts +++ /dev/null @@ -1,232 +0,0 @@ -declare namespace GoogleAppsScript { - /** - * @summary Apps Script Addon Event Objects - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects - */ - namespace Addons { - /** - * @summary Addon Event Object - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#event_object_structure - */ - interface EventObject { - commonEventObject: CommonEventObject; - calendar?: CalendarEventObject | undefined; - docs?: DocsEventObject | undefined; - drive?: DriveEventObject | undefined; - gmail?: GmailEventObject | undefined; - sheets?: SheetsEventObject | undefined; - slides?: SlidesEventObject | undefined; - } - - type InvitationResponseStatus = "accepted" | "declined" | "needsAction" | "tentative"; - - /** - * @summary Object with information on individual attendees to Calendar events - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#attendee - */ - interface AttendeeObject { - additionalGuests: number; - comment: string; - displayName: string; - email: string; - optional: boolean; - organizer: boolean; - resource: boolean; - responseStatus: InvitationResponseStatus; - self: boolean; - } - - type EntryPointFeature = "toll" | "toll_free"; - type EntryPointType = "more" | "phone" | "sip" | "video"; - - /** - * @summary Object with information on means of accessing a conference - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#entry_point - */ - interface EntryPointObject { - accessCode: string; - entryPointFeatures: EntryPointFeature[]; - entryPointType: EntryPointType; - label: string; - meetingCode: string; - passcode: string; - password: string; - pin: string; - regionCode: string; - uri: string; - } - - /** - * @summary Object with information on conferences attached to Calendar events - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#conference_data - */ - interface ConferenceDataObject { - conferenceId: string; - conferenceSolution: { - iconUri: string; - key: { - type: "eventHangout" | "eventNamedHangout" | "hangoutsMeet"; - }; - name: string; - }; - entryPoints: EntryPointObject[]; - notes: string; - parameters: { - addOnParameters: { [key: string]: string }; - }; - } - - /** - * @summary Event object with information on user's calendar and events - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#calendar_event_object - */ - interface CalendarEventObject { - attendees: AttendeeObject[]; - calendarId: string; - id: string; - capabilities: { - canAddAttendees: boolean; - canSeeAttendees: boolean; - canSeeConferenceData: boolean; - canSetConferenceData: boolean; - conferenceData: ConferenceDataObject; - }; - organizer: { - email: string; - }; - recurringEventId: string; - } - - /** - * @summary Event object with information on user's document and its contents - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#docs_event_object - */ - interface DocsEventObject { - id?: string | undefined; - title?: string | undefined; - addonHasFileScopePermission: boolean; - } - - /** - * @summary Object with information on Drive items - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#drive_item - */ - interface DriveItemObject { - addonHasFileScopePermission: boolean; - id: string; - iconUrl: string; - mimeType: string; - title: string; - } - - /** - * @summary Event object with information on user's Drive and its contents - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#drive_event_object - */ - interface DriveEventObject { - activeCursorItem: DriveItemObject; - selectedItems: DriveItemObject[]; - } - - /** - * @summary Event object with information on user's Gmail messages - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#gmail_event_object - */ - interface GmailEventObject { - accessToken: string; - bccRecipients?: string[] | undefined; - ccRecipients?: string[] | undefined; - messageId: string; - threadId: string; - toRecipients?: string[] | undefined; - } - - /** - * @summary Event object with information on user's spreadsheet and its contents - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#sheets_event_object - */ - interface SheetsEventObject { - id?: string | undefined; - title?: string | undefined; - addonHasFileScopePermission: boolean; - } - - /** - * @summary Event object with information on user's presentation and its contents - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#slides_event_object - */ - interface SlidesEventObject { - id?: string | undefined; - title?: string | undefined; - addonHasFileScopePermission: boolean; - } - - type Platform = "WEB" | "IOS" | "ANDROID"; - type HostApplication = "GMAIL" | "CALENDAR" | "DRIVE" | "DOCS" | "SHEETS" | "SLIDES"; - - /** - * @summary Event object with host-independent information - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#common_event_object - */ - interface CommonEventObject { - userLocale?: string | undefined; - timeZone?: { - id: string; - offset: string; - } | undefined; - platform: Platform; - parameters: { [key: string]: string }; - hostApp: HostApplication; - formInputs: { - [ID: string]: { - // For Rhino, always one key only <""> - "": { - stringInputs?: StringInputObject | undefined; - dateInput?: DateInputObject | undefined; - timeInput?: TimeInputObject | undefined; - dateTimeInput?: DateTimeInputObject | undefined; - }; - // For V8 (recommended) - stringInputs?: StringInputObject | undefined; - dateInput?: DateInputObject | undefined; - timeInput?: TimeInputObject | undefined; - dateTimeInput?: DateTimeInputObject | undefined; - }; - }; - } - - /** - * @summary Signle and multi-value text widgets object - */ - interface StringInputObject { - value: string[]; - } - - /** - * @summary DatePicker formInputs object - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#date-input - */ - interface DateInputObject { - msSinceEpoch: string; - } - - /** - * @summary TimePicker formInputs object - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#time-input - */ - interface TimeInputObject { - hours: number; - minutes: number; - } - - /** - * @summary DateTimePicker formInputs object - * @see https://developers.google.com/workspace/add-ons/concepts/event-objects#date-time-input - */ - interface DateTimeInputObject { - hasDate: boolean; - hasTime: boolean; - msSinceEpoch: string; - } - } -} diff --git a/node_modules/@types/google-apps-script/apis/adsense_v1_4.d.ts b/node_modules/@types/google-apps-script/apis/adsense_v1_4.d.ts deleted file mode 100644 index 4d0e129..0000000 --- a/node_modules/@types/google-apps-script/apis/adsense_v1_4.d.ts +++ /dev/null @@ -1,461 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Adsense { - namespace Collection { - namespace Accounts { - namespace Adunits { - interface CustomchannelsCollection { - // List all custom channels which the specified ad unit belongs to. - list(accountId: string, adClientId: string, adUnitId: string): Adsense.Schema.CustomChannels; - // List all custom channels which the specified ad unit belongs to. - list( - accountId: string, - adClientId: string, - adUnitId: string, - optionalArgs: object, - ): Adsense.Schema.CustomChannels; - } - } - namespace Customchannels { - interface AdunitsCollection { - // List all ad units in the specified custom channel. - list(accountId: string, adClientId: string, customChannelId: string): Adsense.Schema.AdUnits; - // List all ad units in the specified custom channel. - list( - accountId: string, - adClientId: string, - customChannelId: string, - optionalArgs: object, - ): Adsense.Schema.AdUnits; - } - } - namespace Reports { - interface SavedCollection { - // Generate an AdSense report based on the saved report ID sent in the query parameters. - generate( - accountId: string, - savedReportId: string, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - // Generate an AdSense report based on the saved report ID sent in the query parameters. - generate( - accountId: string, - savedReportId: string, - optionalArgs: object, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - // List all saved reports in the specified AdSense account. - list(accountId: string): Adsense.Schema.SavedReports; - // List all saved reports in the specified AdSense account. - list(accountId: string, optionalArgs: object): Adsense.Schema.SavedReports; - } - } - interface AdclientsCollection { - // Get Auto ad code for a given ad client. - getAdCode(accountId: string, adClientId: string): Adsense.Schema.AdCode; - // List all ad clients in the specified account. - list(accountId: string): Adsense.Schema.AdClients; - // List all ad clients in the specified account. - list(accountId: string, optionalArgs: object): Adsense.Schema.AdClients; - } - interface AdunitsCollection { - Customchannels?: Adsense.Collection.Accounts.Adunits.CustomchannelsCollection | undefined; - // Gets the specified ad unit in the specified ad client for the specified account. - get(accountId: string, adClientId: string, adUnitId: string): Adsense.Schema.AdUnit; - // Get ad code for the specified ad unit. - getAdCode(accountId: string, adClientId: string, adUnitId: string): Adsense.Schema.AdCode; - // List all ad units in the specified ad client for the specified account. - list(accountId: string, adClientId: string): Adsense.Schema.AdUnits; - // List all ad units in the specified ad client for the specified account. - list(accountId: string, adClientId: string, optionalArgs: object): Adsense.Schema.AdUnits; - } - interface AlertsCollection { - // List the alerts for the specified AdSense account. - list(accountId: string): Adsense.Schema.Alerts; - // List the alerts for the specified AdSense account. - list(accountId: string, optionalArgs: object): Adsense.Schema.Alerts; - // Dismiss (delete) the specified alert from the specified publisher AdSense account. - remove(accountId: string, alertId: string): void; - } - interface CustomchannelsCollection { - Adunits?: Adsense.Collection.Accounts.Customchannels.AdunitsCollection | undefined; - // Get the specified custom channel from the specified ad client for the specified account. - get(accountId: string, adClientId: string, customChannelId: string): Adsense.Schema.CustomChannel; - // List all custom channels in the specified ad client for the specified account. - list(accountId: string, adClientId: string): Adsense.Schema.CustomChannels; - // List all custom channels in the specified ad client for the specified account. - list(accountId: string, adClientId: string, optionalArgs: object): Adsense.Schema.CustomChannels; - } - interface PaymentsCollection { - // List the payments for the specified AdSense account. - list(accountId: string): Adsense.Schema.Payments; - } - interface ReportsCollection { - Saved?: Adsense.Collection.Accounts.Reports.SavedCollection | undefined; - // Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - generate( - accountId: string, - startDate: string, - endDate: string, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - // Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - generate( - accountId: string, - startDate: string, - endDate: string, - optionalArgs: object, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - } - interface SavedadstylesCollection { - // List a specific saved ad style for the specified account. - get(accountId: string, savedAdStyleId: string): Adsense.Schema.SavedAdStyle; - // List all saved ad styles in the specified account. - list(accountId: string): Adsense.Schema.SavedAdStyles; - // List all saved ad styles in the specified account. - list(accountId: string, optionalArgs: object): Adsense.Schema.SavedAdStyles; - } - interface UrlchannelsCollection { - // List all URL channels in the specified ad client for the specified account. - list(accountId: string, adClientId: string): Adsense.Schema.UrlChannels; - // List all URL channels in the specified ad client for the specified account. - list(accountId: string, adClientId: string, optionalArgs: object): Adsense.Schema.UrlChannels; - } - } - namespace Adunits { - interface CustomchannelsCollection { - // List all custom channels which the specified ad unit belongs to. - list(adClientId: string, adUnitId: string): Adsense.Schema.CustomChannels; - // List all custom channels which the specified ad unit belongs to. - list(adClientId: string, adUnitId: string, optionalArgs: object): Adsense.Schema.CustomChannels; - } - } - namespace Customchannels { - interface AdunitsCollection { - // List all ad units in the specified custom channel. - list(adClientId: string, customChannelId: string): Adsense.Schema.AdUnits; - // List all ad units in the specified custom channel. - list(adClientId: string, customChannelId: string, optionalArgs: object): Adsense.Schema.AdUnits; - } - } - namespace Metadata { - interface DimensionsCollection { - // List the metadata for the dimensions available to this AdSense account. - list(): Adsense.Schema.Metadata; - } - interface MetricsCollection { - // List the metadata for the metrics available to this AdSense account. - list(): Adsense.Schema.Metadata; - } - } - namespace Reports { - interface SavedCollection { - // Generate an AdSense report based on the saved report ID sent in the query parameters. - generate(savedReportId: string): Adsense.Schema.AdsenseReportsGenerateResponse; - // Generate an AdSense report based on the saved report ID sent in the query parameters. - generate( - savedReportId: string, - optionalArgs: object, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - // List all saved reports in this AdSense account. - list(): Adsense.Schema.SavedReports; - // List all saved reports in this AdSense account. - list(optionalArgs: object): Adsense.Schema.SavedReports; - } - } - interface AccountsCollection { - Adclients?: Adsense.Collection.Accounts.AdclientsCollection | undefined; - Adunits?: Adsense.Collection.Accounts.AdunitsCollection | undefined; - Alerts?: Adsense.Collection.Accounts.AlertsCollection | undefined; - Customchannels?: Adsense.Collection.Accounts.CustomchannelsCollection | undefined; - Payments?: Adsense.Collection.Accounts.PaymentsCollection | undefined; - Reports?: Adsense.Collection.Accounts.ReportsCollection | undefined; - Savedadstyles?: Adsense.Collection.Accounts.SavedadstylesCollection | undefined; - Urlchannels?: Adsense.Collection.Accounts.UrlchannelsCollection | undefined; - // Get information about the selected AdSense account. - get(accountId: string): Adsense.Schema.Account; - // Get information about the selected AdSense account. - get(accountId: string, optionalArgs: object): Adsense.Schema.Account; - // List all accounts available to this AdSense account. - list(): Adsense.Schema.Accounts; - // List all accounts available to this AdSense account. - list(optionalArgs: object): Adsense.Schema.Accounts; - } - interface AdclientsCollection { - // List all ad clients in this AdSense account. - list(): Adsense.Schema.AdClients; - // List all ad clients in this AdSense account. - list(optionalArgs: object): Adsense.Schema.AdClients; - } - interface AdunitsCollection { - Customchannels?: Adsense.Collection.Adunits.CustomchannelsCollection | undefined; - // Gets the specified ad unit in the specified ad client. - get(adClientId: string, adUnitId: string): Adsense.Schema.AdUnit; - // Get ad code for the specified ad unit. - getAdCode(adClientId: string, adUnitId: string): Adsense.Schema.AdCode; - // List all ad units in the specified ad client for this AdSense account. - list(adClientId: string): Adsense.Schema.AdUnits; - // List all ad units in the specified ad client for this AdSense account. - list(adClientId: string, optionalArgs: object): Adsense.Schema.AdUnits; - } - interface AlertsCollection { - // List the alerts for this AdSense account. - list(): Adsense.Schema.Alerts; - // List the alerts for this AdSense account. - list(optionalArgs: object): Adsense.Schema.Alerts; - // Dismiss (delete) the specified alert from the publisher's AdSense account. - remove(alertId: string): void; - } - interface CustomchannelsCollection { - Adunits?: Adsense.Collection.Customchannels.AdunitsCollection | undefined; - // Get the specified custom channel from the specified ad client. - get(adClientId: string, customChannelId: string): Adsense.Schema.CustomChannel; - // List all custom channels in the specified ad client for this AdSense account. - list(adClientId: string): Adsense.Schema.CustomChannels; - // List all custom channels in the specified ad client for this AdSense account. - list(adClientId: string, optionalArgs: object): Adsense.Schema.CustomChannels; - } - interface MetadataCollection { - Dimensions?: Adsense.Collection.Metadata.DimensionsCollection | undefined; - Metrics?: Adsense.Collection.Metadata.MetricsCollection | undefined; - } - interface PaymentsCollection { - // List the payments for this AdSense account. - list(): Adsense.Schema.Payments; - } - interface ReportsCollection { - Saved?: Adsense.Collection.Reports.SavedCollection | undefined; - // Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - generate(startDate: string, endDate: string): Adsense.Schema.AdsenseReportsGenerateResponse; - // Generate an AdSense report based on the report request sent in the query parameters. Returns the result as JSON; to retrieve output in CSV format specify "alt=csv" as a query parameter. - generate( - startDate: string, - endDate: string, - optionalArgs: object, - ): Adsense.Schema.AdsenseReportsGenerateResponse; - } - interface SavedadstylesCollection { - // Get a specific saved ad style from the user's account. - get(savedAdStyleId: string): Adsense.Schema.SavedAdStyle; - // List all saved ad styles in the user's account. - list(): Adsense.Schema.SavedAdStyles; - // List all saved ad styles in the user's account. - list(optionalArgs: object): Adsense.Schema.SavedAdStyles; - } - interface UrlchannelsCollection { - // List all URL channels in the specified ad client for this AdSense account. - list(adClientId: string): Adsense.Schema.UrlChannels; - // List all URL channels in the specified ad client for this AdSense account. - list(adClientId: string, optionalArgs: object): Adsense.Schema.UrlChannels; - } - } - namespace Schema { - interface Account { - creation_time?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - premium?: boolean | undefined; - subAccounts?: Adsense.Schema.Account[] | undefined; - timezone?: string | undefined; - } - interface Accounts { - etag?: string | undefined; - items?: Adsense.Schema.Account[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AdClient { - arcOptIn?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - productCode?: string | undefined; - supportsReporting?: boolean | undefined; - } - interface AdClients { - etag?: string | undefined; - items?: Adsense.Schema.AdClient[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AdCode { - adCode?: string | undefined; - ampBody?: string | undefined; - ampHead?: string | undefined; - kind?: string | undefined; - } - interface AdStyle { - colors?: Adsense.Schema.AdStyleColors | undefined; - corners?: string | undefined; - font?: Adsense.Schema.AdStyleFont | undefined; - kind?: string | undefined; - } - interface AdStyleColors { - background?: string | undefined; - border?: string | undefined; - text?: string | undefined; - title?: string | undefined; - url?: string | undefined; - } - interface AdStyleFont { - family?: string | undefined; - size?: string | undefined; - } - interface AdUnit { - code?: string | undefined; - contentAdsSettings?: Adsense.Schema.AdUnitContentAdsSettings | undefined; - customStyle?: Adsense.Schema.AdStyle | undefined; - feedAdsSettings?: Adsense.Schema.AdUnitFeedAdsSettings | undefined; - id?: string | undefined; - kind?: string | undefined; - mobileContentAdsSettings?: Adsense.Schema.AdUnitMobileContentAdsSettings | undefined; - name?: string | undefined; - savedStyleId?: string | undefined; - status?: string | undefined; - } - interface AdUnitContentAdsSettings { - backupOption?: Adsense.Schema.AdUnitContentAdsSettingsBackupOption | undefined; - size?: string | undefined; - type?: string | undefined; - } - interface AdUnitContentAdsSettingsBackupOption { - color?: string | undefined; - type?: string | undefined; - url?: string | undefined; - } - interface AdUnitFeedAdsSettings { - adPosition?: string | undefined; - frequency?: number | undefined; - minimumWordCount?: number | undefined; - type?: string | undefined; - } - interface AdUnitMobileContentAdsSettings { - markupLanguage?: string | undefined; - scriptingLanguage?: string | undefined; - size?: string | undefined; - type?: string | undefined; - } - interface AdUnits { - etag?: string | undefined; - items?: Adsense.Schema.AdUnit[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AdsenseReportsGenerateResponse { - averages?: string[] | undefined; - endDate?: string | undefined; - headers?: Adsense.Schema.AdsenseReportsGenerateResponseHeaders[] | undefined; - kind?: string | undefined; - rows?: string[][] | undefined; - startDate?: string | undefined; - totalMatchedRows?: string | undefined; - totals?: string[] | undefined; - warnings?: string[] | undefined; - } - interface AdsenseReportsGenerateResponseHeaders { - currency?: string | undefined; - name?: string | undefined; - type?: string | undefined; - } - interface Alert { - id?: string | undefined; - isDismissible?: boolean | undefined; - kind?: string | undefined; - message?: string | undefined; - severity?: string | undefined; - type?: string | undefined; - } - interface Alerts { - items?: Adsense.Schema.Alert[] | undefined; - kind?: string | undefined; - } - interface CustomChannel { - code?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - targetingInfo?: Adsense.Schema.CustomChannelTargetingInfo | undefined; - } - interface CustomChannelTargetingInfo { - adsAppearOn?: string | undefined; - description?: string | undefined; - location?: string | undefined; - siteLanguage?: string | undefined; - } - interface CustomChannels { - etag?: string | undefined; - items?: Adsense.Schema.CustomChannel[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Metadata { - items?: Adsense.Schema.ReportingMetadataEntry[] | undefined; - kind?: string | undefined; - } - interface Payment { - id?: string | undefined; - kind?: string | undefined; - paymentAmount?: string | undefined; - paymentAmountCurrencyCode?: string | undefined; - paymentDate?: string | undefined; - } - interface Payments { - items?: Adsense.Schema.Payment[] | undefined; - kind?: string | undefined; - } - interface ReportingMetadataEntry { - compatibleDimensions?: string[] | undefined; - compatibleMetrics?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - requiredDimensions?: string[] | undefined; - requiredMetrics?: string[] | undefined; - supportedProducts?: string[] | undefined; - } - interface SavedAdStyle { - adStyle?: Adsense.Schema.AdStyle | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface SavedAdStyles { - etag?: string | undefined; - items?: Adsense.Schema.SavedAdStyle[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface SavedReport { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface SavedReports { - etag?: string | undefined; - items?: Adsense.Schema.SavedReport[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface UrlChannel { - id?: string | undefined; - kind?: string | undefined; - urlPattern?: string | undefined; - } - interface UrlChannels { - etag?: string | undefined; - items?: Adsense.Schema.UrlChannel[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - } - } - interface Adsense { - Accounts?: Adsense.Collection.AccountsCollection | undefined; - Adclients?: Adsense.Collection.AdclientsCollection | undefined; - Adunits?: Adsense.Collection.AdunitsCollection | undefined; - Alerts?: Adsense.Collection.AlertsCollection | undefined; - Customchannels?: Adsense.Collection.CustomchannelsCollection | undefined; - Metadata?: Adsense.Collection.MetadataCollection | undefined; - Payments?: Adsense.Collection.PaymentsCollection | undefined; - Reports?: Adsense.Collection.ReportsCollection | undefined; - Savedadstyles?: Adsense.Collection.SavedadstylesCollection | undefined; - Urlchannels?: Adsense.Collection.UrlchannelsCollection | undefined; - } -} - -declare var Adsense: GoogleAppsScript.Adsense; diff --git a/node_modules/@types/google-apps-script/apis/analytics_v3.d.ts b/node_modules/@types/google-apps-script/apis/analytics_v3.d.ts deleted file mode 100644 index a75fc02..0000000 --- a/node_modules/@types/google-apps-script/apis/analytics_v3.d.ts +++ /dev/null @@ -1,1655 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Analytics { - namespace Collection { - namespace Data { - interface GaCollection { - // Returns Analytics data for a view (profile). - get( - ids: string, - start_date: string, - end_date: string, - metrics: string, - optionalArgs?: Analytics.Schema.GaDataQuery, - ): Analytics.Schema.GaData; - } - interface McfCollection { - // Returns Analytics Multi-Channel Funnels data for a view (profile). - get( - ids: string, - start_date: string, - end_date: string, - metrics: string, - optionalArgs?: Analytics.Schema.GaDataQuery, - ): Analytics.Schema.McfData; - } - interface RealtimeCollection { - // Returns real time data for a view (profile). - get(ids: string, metrics: string, optionalArgs?: any): Analytics.Schema.RealtimeData; - } - } - namespace Management { - interface AccountSummariesCollection { - // Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. - list(): Analytics.Schema.AccountSummaries; - // Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. - list(optionalArgs: any): Analytics.Schema.AccountSummaries; - } - interface AccountUserLinksCollection { - // Adds a new user to the given account. - insert(resource: Schema.EntityUserLink, accountId: string): Analytics.Schema.EntityUserLink; - // Lists account-user links for a given account. - list(accountId: string): Analytics.Schema.EntityUserLinks; - // Lists account-user links for a given account. - list(accountId: string, optionalArgs: any): Analytics.Schema.EntityUserLinks; - // Removes a user from the given account. - remove(accountId: string, linkId: string): void; - // Updates permissions for an existing user on the given account. - update( - resource: Schema.EntityUserLink, - accountId: string, - linkId: string, - ): Analytics.Schema.EntityUserLink; - } - interface AccountsCollection { - // Lists all accounts to which the user has access. - list(): Analytics.Schema.Accounts; - // Lists all accounts to which the user has access. - list(optionalArgs: any): Analytics.Schema.Accounts; - } - interface ClientIdCollection { - // Hashes the given Client ID. - hashClientId(resource: Analytics.Schema.HashClientIdRequest): Analytics.Schema.HashClientIdResponse; - } - interface CustomDataSourcesCollection { - // List custom data sources to which the user has access. - list(accountId: string, webPropertyId: string): Analytics.Schema.CustomDataSources; - // List custom data sources to which the user has access. - list( - accountId: string, - webPropertyId: string, - optionalArgs: any, - ): Analytics.Schema.CustomDataSources; - } - interface CustomDimensionsCollection { - // Get a custom dimension to which the user has access. - get( - accountId: string, - webPropertyId: string, - customDimensionId: string, - ): Analytics.Schema.CustomDimension; - // Create a new custom dimension. - insert( - resource: Schema.CustomDimension, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.CustomDimension; - // Lists custom dimensions to which the user has access. - list(accountId: string, webPropertyId: string): Analytics.Schema.CustomDimensions; - // Lists custom dimensions to which the user has access. - list( - accountId: string, - webPropertyId: string, - optionalArgs: any, - ): Analytics.Schema.CustomDimensions; - // Updates an existing custom dimension. This method supports patch semantics. - patch( - resource: Schema.CustomDimension, - accountId: string, - webPropertyId: string, - customDimensionId: string, - ): Analytics.Schema.CustomDimension; - // Updates an existing custom dimension. This method supports patch semantics. - patch( - resource: Schema.CustomDimension, - accountId: string, - webPropertyId: string, - customDimensionId: string, - optionalArgs: any, - ): Analytics.Schema.CustomDimension; - // Updates an existing custom dimension. - update( - resource: Schema.CustomDimension, - accountId: string, - webPropertyId: string, - customDimensionId: string, - ): Analytics.Schema.CustomDimension; - // Updates an existing custom dimension. - update( - resource: Schema.CustomDimension, - accountId: string, - webPropertyId: string, - customDimensionId: string, - optionalArgs: any, - ): Analytics.Schema.CustomDimension; - } - interface CustomMetricsCollection { - // Get a custom metric to which the user has access. - get( - accountId: string, - webPropertyId: string, - customMetricId: string, - ): Analytics.Schema.CustomMetric; - // Create a new custom metric. - insert( - resource: Schema.CustomMetric, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.CustomMetric; - // Lists custom metrics to which the user has access. - list(accountId: string, webPropertyId: string): Analytics.Schema.CustomMetrics; - // Lists custom metrics to which the user has access. - list(accountId: string, webPropertyId: string, optionalArgs: any): Analytics.Schema.CustomMetrics; - // Updates an existing custom metric. This method supports patch semantics. - patch( - resource: Schema.CustomMetric, - accountId: string, - webPropertyId: string, - customMetricId: string, - ): Analytics.Schema.CustomMetric; - // Updates an existing custom metric. This method supports patch semantics. - patch( - resource: Schema.CustomMetric, - accountId: string, - webPropertyId: string, - customMetricId: string, - optionalArgs: any, - ): Analytics.Schema.CustomMetric; - // Updates an existing custom metric. - update( - resource: Schema.CustomMetric, - accountId: string, - webPropertyId: string, - customMetricId: string, - ): Analytics.Schema.CustomMetric; - // Updates an existing custom metric. - update( - resource: Schema.CustomMetric, - accountId: string, - webPropertyId: string, - customMetricId: string, - optionalArgs: any, - ): Analytics.Schema.CustomMetric; - } - interface ExperimentsCollection { - // Returns an experiment to which the user has access. - get( - accountId: string, - webPropertyId: string, - profileId: string, - experimentId: string, - ): Analytics.Schema.Experiment; - // Create a new experiment. - insert( - resource: Schema.Experiment, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.Experiment; - // Lists experiments to which the user has access. - list(accountId: string, webPropertyId: string, profileId: string): Analytics.Schema.Experiments; - // Lists experiments to which the user has access. - list( - accountId: string, - webPropertyId: string, - profileId: string, - optionalArgs: any, - ): Analytics.Schema.Experiments; - // Update an existing experiment. This method supports patch semantics. - patch( - resource: Schema.Experiment, - accountId: string, - webPropertyId: string, - profileId: string, - experimentId: string, - ): Analytics.Schema.Experiment; - // Delete an experiment. - remove(accountId: string, webPropertyId: string, profileId: string, experimentId: string): void; - // Update an existing experiment. - update( - resource: Schema.Experiment, - accountId: string, - webPropertyId: string, - profileId: string, - experimentId: string, - ): Analytics.Schema.Experiment; - } - interface FiltersCollection { - // Returns a filters to which the user has access. - get(accountId: string, filterId: string): Analytics.Schema.Filter; - // Create a new filter. - insert(resource: Schema.Filter, accountId: string): Analytics.Schema.Filter; - // Lists all filters for an account - list(accountId: string): Analytics.Schema.Filters; - // Lists all filters for an account - list(accountId: string, optionalArgs: any): Analytics.Schema.Filters; - // Updates an existing filter. This method supports patch semantics. - patch(resource: Schema.Filter, accountId: string, filterId: string): Analytics.Schema.Filter; - // Delete a filter. - remove(accountId: string, filterId: string): Analytics.Schema.Filter; - // Updates an existing filter. - update(resource: Schema.Filter, accountId: string, filterId: string): Analytics.Schema.Filter; - } - interface GoalsCollection { - // Gets a goal to which the user has access. - get( - accountId: string, - webPropertyId: string, - profileId: string, - goalId: string, - ): Analytics.Schema.Goal; - // Create a new goal. - insert( - resource: Analytics.Schema.Goal, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.Goal; - // Lists goals to which the user has access. - list(accountId: string, webPropertyId: string, profileId: string): Analytics.Schema.Goals; - // Lists goals to which the user has access. - list( - accountId: string, - webPropertyId: string, - profileId: string, - optionalArgs: any, - ): Analytics.Schema.Goals; - // Updates an existing goal. This method supports patch semantics. - patch( - resource: Schema.Goal, - accountId: string, - webPropertyId: string, - profileId: string, - goalId: string, - ): Analytics.Schema.Goal; - // Updates an existing goal. - update( - resource: Schema.Goal, - accountId: string, - webPropertyId: string, - profileId: string, - goalId: string, - ): Analytics.Schema.Goal; - } - interface ProfileFilterLinksCollection { - // Returns a single profile filter link. - get( - accountId: string, - webPropertyId: string, - profileId: string, - linkId: string, - ): Analytics.Schema.ProfileFilterLink; - // Create a new profile filter link. - insert( - resource: Schema.ProfileFilterLink, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.ProfileFilterLink; - // Lists all profile filter links for a profile. - list( - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.ProfileFilterLinks; - // Lists all profile filter links for a profile. - list( - accountId: string, - webPropertyId: string, - profileId: string, - optionalArgs: any, - ): Analytics.Schema.ProfileFilterLinks; - // Update an existing profile filter link. This method supports patch semantics. - patch( - resource: Schema.ProfileFilterLink, - accountId: string, - webPropertyId: string, - profileId: string, - linkId: string, - ): Analytics.Schema.ProfileFilterLink; - // Delete a profile filter link. - remove(accountId: string, webPropertyId: string, profileId: string, linkId: string): void; - // Update an existing profile filter link. - update( - resource: Schema.ProfileFilterLink, - accountId: string, - webPropertyId: string, - profileId: string, - linkId: string, - ): Analytics.Schema.ProfileFilterLink; - } - interface ProfileUserLinksCollection { - // Adds a new user to the given view (profile). - insert( - resource: Schema.EntityUserLink, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.EntityUserLink; - // Lists profile-user links for a given view (profile). - list(accountId: string, webPropertyId: string, profileId: string): Analytics.Schema.EntityUserLinks; - // Lists profile-user links for a given view (profile). - list( - accountId: string, - webPropertyId: string, - profileId: string, - optionalArgs: any, - ): Analytics.Schema.EntityUserLinks; - // Removes a user from the given view (profile). - remove(accountId: string, webPropertyId: string, profileId: string, linkId: string): void; - // Updates permissions for an existing user on the given view (profile). - update( - resource: Schema.EntityUserLink, - accountId: string, - webPropertyId: string, - profileId: string, - linkId: string, - ): Analytics.Schema.EntityUserLink; - } - interface ProfilesCollection { - // Gets a view (profile) to which the user has access. - get(accountId: string, webPropertyId: string, profileId: string): Analytics.Schema.Profile; - // Create a new view (profile). - insert( - resource: Schema.Profile, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.Profile; - // Lists views (profiles) to which the user has access. - list(accountId: string, webPropertyId: string): Analytics.Schema.Profiles; - // Lists views (profiles) to which the user has access. - list(accountId: string, webPropertyId: string, optionalArgs: any): Analytics.Schema.Profiles; - // Updates an existing view (profile). This method supports patch semantics. - patch( - resource: Schema.Profile, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.Profile; - // Deletes a view (profile). - remove(accountId: string, webPropertyId: string, profileId: string): void; - // Updates an existing view (profile). - update( - resource: Schema.Profile, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.Profile; - } - interface RemarketingAudienceCollection { - // Gets a remarketing audience to which the user has access. - get( - accountId: string, - webPropertyId: string, - remarketingAudienceId: string, - ): Analytics.Schema.RemarketingAudience; - // Creates a new remarketing audience. - insert( - resource: Schema.RemarketingAudience, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.RemarketingAudience; - // Lists remarketing audiences to which the user has access. - list(accountId: string, webPropertyId: string): Analytics.Schema.RemarketingAudiences; - // Lists remarketing audiences to which the user has access. - list( - accountId: string, - webPropertyId: string, - optionalArgs: any, - ): Analytics.Schema.RemarketingAudiences; - // Updates an existing remarketing audience. This method supports patch semantics. - patch( - resource: Schema.RemarketingAudience, - accountId: string, - webPropertyId: string, - remarketingAudienceId: string, - ): Analytics.Schema.RemarketingAudience; - // Delete a remarketing audience. - remove(accountId: string, webPropertyId: string, remarketingAudienceId: string): void; - // Updates an existing remarketing audience. - update( - resource: Schema.RemarketingAudience, - accountId: string, - webPropertyId: string, - remarketingAudienceId: string, - ): Analytics.Schema.RemarketingAudience; - } - interface SegmentsCollection { - // Lists segments to which the user has access. - list(): Analytics.Schema.Segments; - // Lists segments to which the user has access. - list(optionalArgs: any): Analytics.Schema.Segments; - } - interface UnsampledReportsCollection { - // Returns a single unsampled report. - get( - accountId: string, - webPropertyId: string, - profileId: string, - unsampledReportId: string, - ): Analytics.Schema.UnsampledReport; - // Create a new unsampled report. - insert( - resource: Schema.UnsampledReport, - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.UnsampledReport; - // Lists unsampled reports to which the user has access. - list( - accountId: string, - webPropertyId: string, - profileId: string, - ): Analytics.Schema.UnsampledReports; - // Lists unsampled reports to which the user has access. - list( - accountId: string, - webPropertyId: string, - profileId: string, - optionalArgs: any, - ): Analytics.Schema.UnsampledReports; - // Deletes an unsampled report. - remove( - accountId: string, - webPropertyId: string, - profileId: string, - unsampledReportId: string, - ): void; - } - interface UploadsCollection { - // Delete data associated with a previous upload. - deleteUploadData( - resource: Schema.AnalyticsDataimportDeleteUploadDataRequest, - accountId: string, - webPropertyId: string, - customDataSourceId: string, - ): void; - // List uploads to which the user has access. - get( - accountId: string, - webPropertyId: string, - customDataSourceId: string, - uploadId: string, - ): Analytics.Schema.Upload; - // List uploads to which the user has access. - list( - accountId: string, - webPropertyId: string, - customDataSourceId: string, - ): Analytics.Schema.Uploads; - // List uploads to which the user has access. - list( - accountId: string, - webPropertyId: string, - customDataSourceId: string, - optionalArgs: any, - ): Analytics.Schema.Uploads; - // Upload data for a custom data source. - uploadData( - accountId: string, - webPropertyId: string, - customDataSourceId: string, - ): Analytics.Schema.Upload; - // Upload data for a custom data source. - uploadData( - accountId: string, - webPropertyId: string, - customDataSourceId: string, - mediaData: any, - ): Analytics.Schema.Upload; - } - interface WebPropertyAdWordsLinksCollection { - // Returns a web property-Google Ads link to which the user has access. - get( - accountId: string, - webPropertyId: string, - webPropertyAdWordsLinkId: string, - ): Analytics.Schema.EntityAdWordsLink; - // Creates a webProperty-Google Ads link. - insert( - resource: Schema.EntityAdWordsLink, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.EntityAdWordsLink; - // Lists webProperty-Google Ads links for a given web property. - list(accountId: string, webPropertyId: string): Analytics.Schema.EntityAdWordsLinks; - // Lists webProperty-Google Ads links for a given web property. - list( - accountId: string, - webPropertyId: string, - optionalArgs: any, - ): Analytics.Schema.EntityAdWordsLinks; - // Updates an existing webProperty-Google Ads link. This method supports patch semantics. - patch( - resource: Schema.EntityAdWordsLink, - accountId: string, - webPropertyId: string, - webPropertyAdWordsLinkId: string, - ): Analytics.Schema.EntityAdWordsLink; - // Deletes a web property-Google Ads link. - remove(accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): void; - // Updates an existing webProperty-Google Ads link. - update( - resource: Schema.EntityAdWordsLink, - accountId: string, - webPropertyId: string, - webPropertyAdWordsLinkId: string, - ): Analytics.Schema.EntityAdWordsLink; - } - interface WebpropertiesCollection { - // Gets a web property to which the user has access. - get(accountId: string, webPropertyId: string): Analytics.Schema.Webproperty; - // Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile. - insert(resource: Schema.Webproperty, accountId: string): Analytics.Schema.Webproperty; - // Lists web properties to which the user has access. - list(accountId: string): Analytics.Schema.Webproperties; - // Lists web properties to which the user has access. - list(accountId: string, optionalArgs: any): Analytics.Schema.Webproperties; - // Updates an existing web property. This method supports patch semantics. - patch( - resource: Schema.Webproperty, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.Webproperty; - // Updates an existing web property. - update( - resource: Schema.Webproperty, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.Webproperty; - } - interface WebpropertyUserLinksCollection { - // Adds a new user to the given web property. - insert( - resource: Schema.EntityUserLink, - accountId: string, - webPropertyId: string, - ): Analytics.Schema.EntityUserLink; - // Lists webProperty-user links for a given web property. - list(accountId: string, webPropertyId: string): Analytics.Schema.EntityUserLinks; - // Lists webProperty-user links for a given web property. - list(accountId: string, webPropertyId: string, optionalArgs: any): Analytics.Schema.EntityUserLinks; - // Removes a user from the given web property. - remove(accountId: string, webPropertyId: string, linkId: string): void; - // Updates permissions for an existing user on the given web property. - update( - resource: Schema.EntityUserLink, - accountId: string, - webPropertyId: string, - linkId: string, - ): Analytics.Schema.EntityUserLink; - } - } - namespace Metadata { - interface ColumnsCollection { - // Lists all columns for a report type - list(reportType: string): Analytics.Schema.Columns; - } - } - namespace UserDeletion { - interface UserDeletionRequestCollection { - // Insert or update a user deletion requests. - upsert(resource: Schema.UserDeletionRequest): Analytics.Schema.UserDeletionRequest; - } - } - interface DataCollection { - Ga?: Analytics.Collection.Data.GaCollection | undefined; - Mcf?: Analytics.Collection.Data.McfCollection | undefined; - Realtime?: Analytics.Collection.Data.RealtimeCollection | undefined; - } - interface ManagementCollection { - AccountSummaries?: Analytics.Collection.Management.AccountSummariesCollection | undefined; - AccountUserLinks?: Analytics.Collection.Management.AccountUserLinksCollection | undefined; - Accounts?: Analytics.Collection.Management.AccountsCollection | undefined; - ClientId?: Analytics.Collection.Management.ClientIdCollection | undefined; - CustomDataSources?: Analytics.Collection.Management.CustomDataSourcesCollection | undefined; - CustomDimensions?: Analytics.Collection.Management.CustomDimensionsCollection | undefined; - CustomMetrics?: Analytics.Collection.Management.CustomMetricsCollection | undefined; - Experiments?: Analytics.Collection.Management.ExperimentsCollection | undefined; - Filters?: Analytics.Collection.Management.FiltersCollection | undefined; - Goals?: Analytics.Collection.Management.GoalsCollection | undefined; - ProfileFilterLinks?: Analytics.Collection.Management.ProfileFilterLinksCollection | undefined; - ProfileUserLinks?: Analytics.Collection.Management.ProfileUserLinksCollection | undefined; - Profiles?: Analytics.Collection.Management.ProfilesCollection | undefined; - RemarketingAudience?: Analytics.Collection.Management.RemarketingAudienceCollection | undefined; - Segments?: Analytics.Collection.Management.SegmentsCollection | undefined; - UnsampledReports?: Analytics.Collection.Management.UnsampledReportsCollection | undefined; - Uploads?: Analytics.Collection.Management.UploadsCollection | undefined; - WebPropertyAdWordsLinks?: Analytics.Collection.Management.WebPropertyAdWordsLinksCollection | undefined; - Webproperties?: Analytics.Collection.Management.WebpropertiesCollection | undefined; - WebpropertyUserLinks?: Analytics.Collection.Management.WebpropertyUserLinksCollection | undefined; - } - interface MetadataCollection { - Columns?: Analytics.Collection.Metadata.ColumnsCollection | undefined; - } - interface ProvisioningCollection { - // Creates an account ticket. - createAccountTicket(resource: Schema.AccountTicket): Analytics.Schema.AccountTicket; - // Provision account. - createAccountTree(resource: Schema.AccountTreeRequest): Analytics.Schema.AccountTreeResponse; - } - interface UserDeletionCollection { - UserDeletionRequest?: Analytics.Collection.UserDeletion.UserDeletionRequestCollection | undefined; - } - } - namespace Schema { - interface Account { - childLink?: Analytics.Schema.AccountChildLink | undefined; - created?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - permissions?: Analytics.Schema.AccountPermissions | undefined; - selfLink?: string | undefined; - starred?: boolean | undefined; - updated?: string | undefined; - } - interface AccountChildLink { - href?: string | undefined; - type?: string | undefined; - } - interface AccountPermissions { - effective?: string[] | undefined; - } - interface AccountRef { - href?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface AccountSummaries { - items?: Analytics.Schema.AccountSummary[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface AccountSummary { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - starred?: boolean | undefined; - webProperties?: Analytics.Schema.WebPropertySummary[] | undefined; - } - interface AccountTicket { - account?: Analytics.Schema.Account | undefined; - id?: string | undefined; - kind?: string | undefined; - profile?: Analytics.Schema.Profile | undefined; - redirectUri?: string | undefined; - webproperty?: Analytics.Schema.Webproperty | undefined; - } - interface AccountTreeRequest { - accountName?: string | undefined; - kind?: string | undefined; - profileName?: string | undefined; - timezone?: string | undefined; - webpropertyName?: string | undefined; - websiteUrl?: string | undefined; - } - interface AccountTreeResponse { - account?: Analytics.Schema.Account | undefined; - kind?: string | undefined; - profile?: Analytics.Schema.Profile | undefined; - webproperty?: Analytics.Schema.Webproperty | undefined; - } - interface Accounts { - items?: Analytics.Schema.Account[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface AdWordsAccount { - autoTaggingEnabled?: boolean | undefined; - customerId?: string | undefined; - kind?: string | undefined; - } - interface AnalyticsDataimportDeleteUploadDataRequest { - customDataImportUids?: string[] | undefined; - } - interface Column { - attributes?: any; - id?: string | undefined; - kind?: string | undefined; - } - interface Columns { - attributeNames?: string[] | undefined; - etag?: string | undefined; - items?: Analytics.Schema.Column[] | undefined; - kind?: string | undefined; - totalResults?: number | undefined; - } - interface CustomDataSource { - accountId?: string | undefined; - childLink?: Analytics.Schema.CustomDataSourceChildLink | undefined; - created?: string | undefined; - description?: string | undefined; - id?: string | undefined; - importBehavior?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - parentLink?: Analytics.Schema.CustomDataSourceParentLink | undefined; - profilesLinked?: string[] | undefined; - schema?: string[] | undefined; - selfLink?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - uploadType?: string | undefined; - webPropertyId?: string | undefined; - } - interface CustomDataSourceChildLink { - href?: string | undefined; - type?: string | undefined; - } - interface CustomDataSourceParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface CustomDataSources { - items?: Analytics.Schema.CustomDataSource[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface CustomDimension { - accountId?: string | undefined; - active?: boolean | undefined; - created?: string | undefined; - id?: string | undefined; - index?: number | undefined; - kind?: string | undefined; - name?: string | undefined; - parentLink?: Analytics.Schema.CustomDimensionParentLink | undefined; - scope?: string | undefined; - selfLink?: string | undefined; - updated?: string | undefined; - webPropertyId?: string | undefined; - } - interface CustomDimensionParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface CustomDimensions { - items?: Analytics.Schema.CustomDimension[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface CustomMetric { - accountId?: string | undefined; - active?: boolean | undefined; - created?: string | undefined; - id?: string | undefined; - index?: number | undefined; - kind?: string | undefined; - max_value?: string | undefined; - min_value?: string | undefined; - name?: string | undefined; - parentLink?: Analytics.Schema.CustomMetricParentLink | undefined; - scope?: string | undefined; - selfLink?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - webPropertyId?: string | undefined; - } - interface CustomMetricParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface CustomMetrics { - items?: Analytics.Schema.CustomMetric[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface EntityAdWordsLink { - adWordsAccounts?: Analytics.Schema.AdWordsAccount[] | undefined; - entity?: Analytics.Schema.EntityAdWordsLinkEntity | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - profileIds?: string[] | undefined; - selfLink?: string | undefined; - } - interface EntityAdWordsLinkEntity { - webPropertyRef?: Analytics.Schema.WebPropertyRef | undefined; - } - interface EntityAdWordsLinks { - items?: Analytics.Schema.EntityAdWordsLink[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - } - interface EntityUserLink { - entity?: Analytics.Schema.EntityUserLinkEntity | undefined; - id?: string | undefined; - kind?: string | undefined; - permissions?: Analytics.Schema.EntityUserLinkPermissions | undefined; - selfLink?: string | undefined; - userRef?: Analytics.Schema.UserRef | undefined; - } - interface EntityUserLinkEntity { - accountRef?: Analytics.Schema.AccountRef | undefined; - profileRef?: Analytics.Schema.ProfileRef | undefined; - webPropertyRef?: Analytics.Schema.WebPropertyRef | undefined; - } - interface EntityUserLinkPermissions { - effective?: string[] | undefined; - local?: string[] | undefined; - } - interface EntityUserLinks { - items?: Analytics.Schema.EntityUserLink[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - } - interface Experiment { - accountId?: string | undefined; - created?: string | undefined; - description?: string | undefined; - editableInGaUi?: boolean | undefined; - endTime?: string | undefined; - equalWeighting?: boolean | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - minimumExperimentLengthInDays?: number | undefined; - name?: string | undefined; - objectiveMetric?: string | undefined; - optimizationType?: string | undefined; - parentLink?: Analytics.Schema.ExperimentParentLink | undefined; - profileId?: string | undefined; - reasonExperimentEnded?: string | undefined; - rewriteVariationUrlsAsOriginal?: boolean | undefined; - selfLink?: string | undefined; - servingFramework?: string | undefined; - snippet?: string | undefined; - startTime?: string | undefined; - status?: string | undefined; - trafficCoverage?: number | undefined; - updated?: string | undefined; - variations?: Analytics.Schema.ExperimentVariations[] | undefined; - webPropertyId?: string | undefined; - winnerConfidenceLevel?: number | undefined; - winnerFound?: boolean | undefined; - } - interface ExperimentParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface ExperimentVariations { - name?: string | undefined; - status?: string | undefined; - url?: string | undefined; - weight?: number | undefined; - won?: boolean | undefined; - } - interface Experiments { - items?: Analytics.Schema.Experiment[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface Filter { - accountId?: string | undefined; - advancedDetails?: Analytics.Schema.FilterAdvancedDetails | undefined; - created?: string | undefined; - excludeDetails?: Analytics.Schema.FilterExpression | undefined; - id?: string | undefined; - includeDetails?: Analytics.Schema.FilterExpression | undefined; - kind?: string | undefined; - lowercaseDetails?: Analytics.Schema.FilterLowercaseDetails | undefined; - name?: string | undefined; - parentLink?: Analytics.Schema.FilterParentLink | undefined; - searchAndReplaceDetails?: Analytics.Schema.FilterSearchAndReplaceDetails | undefined; - selfLink?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - uppercaseDetails?: Analytics.Schema.FilterUppercaseDetails | undefined; - } - interface FilterAdvancedDetails { - caseSensitive?: boolean | undefined; - extractA?: string | undefined; - extractB?: string | undefined; - fieldA?: string | undefined; - fieldAIndex?: number | undefined; - fieldARequired?: boolean | undefined; - fieldB?: string | undefined; - fieldBIndex?: number | undefined; - fieldBRequired?: boolean | undefined; - outputConstructor?: string | undefined; - outputToField?: string | undefined; - outputToFieldIndex?: number | undefined; - overrideOutputField?: boolean | undefined; - } - interface FilterExpression { - caseSensitive?: boolean | undefined; - expressionValue?: string | undefined; - field?: string | undefined; - fieldIndex?: number | undefined; - kind?: string | undefined; - matchType?: string | undefined; - } - interface FilterLowercaseDetails { - field?: string | undefined; - fieldIndex?: number | undefined; - } - interface FilterParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface FilterRef { - accountId?: string | undefined; - href?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface FilterSearchAndReplaceDetails { - caseSensitive?: boolean | undefined; - field?: string | undefined; - fieldIndex?: number | undefined; - replaceString?: string | undefined; - searchString?: string | undefined; - } - interface FilterUppercaseDetails { - field?: string | undefined; - fieldIndex?: number | undefined; - } - interface Filters { - items?: Analytics.Schema.Filter[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface GaData { - columnHeaders?: Analytics.Schema.GaDataColumnHeaders[] | undefined; - containsSampledData?: boolean | undefined; - dataLastRefreshed?: string | undefined; - dataTable?: Analytics.Schema.GaDataDataTable | undefined; - id?: string | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - profileInfo?: Analytics.Schema.GaDataProfileInfo | undefined; - query?: Analytics.Schema.GaDataQuery | undefined; - rows?: string[][] | undefined; - sampleSize?: string | undefined; - sampleSpace?: string | undefined; - selfLink?: string | undefined; - totalResults?: number | undefined; - totalsForAllResults?: Record | undefined; - } - interface GaDataColumnHeaders { - columnType?: string | undefined; - dataType?: string | undefined; - name?: string | undefined; - } - interface GaDataDataTable { - cols?: Analytics.Schema.GaDataDataTableCols[] | undefined; - rows?: Analytics.Schema.GaDataDataTableRows[] | undefined; - } - interface GaDataDataTableCols { - id?: string | undefined; - label?: string | undefined; - type?: string | undefined; - } - interface GaDataDataTableRows { - c?: Analytics.Schema.GaDataDataTableRowsC[] | undefined; - } - interface GaDataDataTableRowsC { - v?: string | undefined; - } - interface GaDataProfileInfo { - accountId?: string | undefined; - internalWebPropertyId?: string | undefined; - profileId?: string | undefined; - profileName?: string | undefined; - tableId?: string | undefined; - webPropertyId?: string | undefined; - } - interface GaDataQuery { - /** The unique table ID of the form ga:XXXX, where XXXX is the Analytics view (profile) ID for which the query will retrieve the data. */ - ids?: string; - /** Start date for fetching Analytics data. Requests can specify a start date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or NdaysAgo where N is a positive integer). */ - "start-date"?: string; - /** End date for fetching Analytics data. Request can specify an end date formatted as YYYY-MM-DD, or as a relative date (e.g., today, yesterday, or NdaysAgo where N is a positive integer). */ - "end-date"?: string; - /** A list of comma-separated metrics, such as ga:sessions,ga:bounces. */ - metrics?: string; - /** A list of comma-separated dimensions for your Analytics data, such as ga:browser,ga:city. */ - dimensions?: string; - /** A list of comma-separated dimensions and metrics indicating the sorting order and sorting direction for the returned data. */ - sort?: string; - /** Dimension or metric filters that restrict the data returned for your request. */ - filters?: string; - /** Segments the data returned for your request. */ - segment?: string; - /** - * The desired sampling level. Allowed Values: - * DEFAULT — Returns response with a sample size that balances speed and accuracy. - * FASTER — Returns a fast response with a smaller sample size. - * HIGHER_PRECISION — Returns a more accurate response using a large sample size, but this may result in the response being slower. - */ - samplingLevel?: "DEFAULT" | "FASTER" | "HIGHER_PRECISION"; - /** The first row of data to retrieve, starting at 1. Use this parameter as a pagination mechanism along with the max-results parameter. */ - "start-index"?: number; - /** The maximum number of rows to include in the response. */ - "max-results"?: number; - } - interface Goal { - accountId?: string | undefined; - active?: boolean | undefined; - created?: string | undefined; - eventDetails?: Analytics.Schema.GoalEventDetails | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - parentLink?: Analytics.Schema.GoalParentLink | undefined; - profileId?: string | undefined; - selfLink?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - urlDestinationDetails?: Analytics.Schema.GoalUrlDestinationDetails | undefined; - value?: number | undefined; - visitNumPagesDetails?: Analytics.Schema.GoalVisitNumPagesDetails | undefined; - visitTimeOnSiteDetails?: Analytics.Schema.GoalVisitTimeOnSiteDetails | undefined; - webPropertyId?: string | undefined; - } - interface GoalEventDetails { - eventConditions?: GoalEventDetailsEventConditions[] | undefined; - useEventValue?: boolean | undefined; - } - interface GoalEventDetailsEventConditions { - comparisonType?: string | undefined; - comparisonValue?: string | undefined; - expression?: string | undefined; - matchType?: string | undefined; - type?: string | undefined; - } - interface GoalParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface GoalUrlDestinationDetails { - caseSensitive?: boolean | undefined; - firstStepRequired?: boolean | undefined; - matchType?: string | undefined; - steps?: GoalUrlDestinationDetailsSteps[] | undefined; - url?: string | undefined; - } - interface GoalUrlDestinationDetailsSteps { - name?: string | undefined; - number?: number | undefined; - url?: string | undefined; - } - interface GoalVisitNumPagesDetails { - comparisonType?: string | undefined; - comparisonValue?: string | undefined; - } - interface GoalVisitTimeOnSiteDetails { - comparisonType?: string | undefined; - comparisonValue?: string | undefined; - } - interface Goals { - items?: Goal[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface HashClientIdRequest { - clientId?: string | undefined; - kind?: string | undefined; - webPropertyId?: string | undefined; - } - interface HashClientIdResponse { - clientId?: string | undefined; - hashedClientId?: string | undefined; - kind?: string | undefined; - webPropertyId?: string | undefined; - } - interface IncludeConditions { - daysToLookBack?: number | undefined; - isSmartList?: boolean | undefined; - kind?: string | undefined; - membershipDurationDays?: number | undefined; - segment?: string | undefined; - } - interface LinkedForeignAccount { - accountId?: string | undefined; - eligibleForSearch?: boolean | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - linkedAccountId?: string | undefined; - remarketingAudienceId?: string | undefined; - status?: string | undefined; - type?: string | undefined; - webPropertyId?: string | undefined; - } - interface McfData { - columnHeaders?: McfDataColumnHeaders[] | undefined; - containsSampledData?: boolean | undefined; - id?: string | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - profileInfo?: McfDataProfileInfo | undefined; - query?: McfDataQuery | undefined; - rows?: McfDataRows[][] | undefined; - sampleSize?: string | undefined; - sampleSpace?: string | undefined; - selfLink?: string | undefined; - totalResults?: number | undefined; - totalsForAllResults?: Record | undefined; - } - interface McfDataColumnHeaders { - columnType?: string | undefined; - dataType?: string | undefined; - name?: string | undefined; - } - interface McfDataProfileInfo { - accountId?: string | undefined; - internalWebPropertyId?: string | undefined; - profileId?: string | undefined; - profileName?: string | undefined; - tableId?: string | undefined; - webPropertyId?: string | undefined; - } - interface McfDataQuery { - dimensions?: string | undefined; - end_date?: string | undefined; - filters?: string | undefined; - ids?: string | undefined; - max_results?: number | undefined; - metrics?: string[] | undefined; - samplingLevel?: string | undefined; - segment?: string | undefined; - sort?: string[] | undefined; - start_date?: string | undefined; - start_index?: number | undefined; - } - interface McfDataRows { - conversionPathValue?: McfDataRowsConversionPathValue[] | undefined; - primitiveValue?: string | undefined; - } - interface McfDataRowsConversionPathValue { - interactionType?: string | undefined; - nodeValue?: string | undefined; - } - interface Profile { - accountId?: string | undefined; - botFilteringEnabled?: boolean | undefined; - childLink?: ProfileChildLink | undefined; - created?: string | undefined; - currency?: string | undefined; - defaultPage?: string | undefined; - eCommerceTracking?: boolean | undefined; - enhancedECommerceTracking?: boolean | undefined; - excludeQueryParameters?: string | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - parentLink?: ProfileParentLink | undefined; - permissions?: ProfilePermissions | undefined; - selfLink?: string | undefined; - siteSearchCategoryParameters?: string | undefined; - siteSearchQueryParameters?: string | undefined; - starred?: boolean | undefined; - stripSiteSearchCategoryParameters?: boolean | undefined; - stripSiteSearchQueryParameters?: boolean | undefined; - timezone?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - webPropertyId?: string | undefined; - websiteUrl?: string | undefined; - } - interface ProfileChildLink { - href?: string | undefined; - type?: string | undefined; - } - interface ProfileFilterLink { - filterRef?: Analytics.Schema.FilterRef | undefined; - id?: string | undefined; - kind?: string | undefined; - profileRef?: ProfileRef | undefined; - rank?: number | undefined; - selfLink?: string | undefined; - } - interface ProfileFilterLinks { - items?: ProfileFilterLink[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface ProfileParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface ProfilePermissions { - effective?: string[] | undefined; - } - interface ProfileRef { - accountId?: string | undefined; - href?: string | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - webPropertyId?: string | undefined; - } - interface ProfileSummary { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - starred?: boolean | undefined; - type?: string | undefined; - } - interface Profiles { - items?: Profile[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface RealtimeData { - columnHeaders?: RealtimeDataColumnHeaders[] | undefined; - id?: string | undefined; - kind?: string | undefined; - profileInfo?: RealtimeDataProfileInfo | undefined; - query?: RealtimeDataQuery | undefined; - rows?: string[][] | undefined; - selfLink?: string | undefined; - totalResults?: number | undefined; - totalsForAllResults?: Record | undefined; - } - interface RealtimeDataColumnHeaders { - columnType?: string | undefined; - dataType?: string | undefined; - name?: string | undefined; - } - interface RealtimeDataProfileInfo { - accountId?: string | undefined; - internalWebPropertyId?: string | undefined; - profileId?: string | undefined; - profileName?: string | undefined; - tableId?: string | undefined; - webPropertyId?: string | undefined; - } - interface RealtimeDataQuery { - dimensions?: string | undefined; - filters?: string | undefined; - ids?: string | undefined; - max_results?: number | undefined; - metrics?: string[] | undefined; - sort?: string[] | undefined; - } - interface RemarketingAudience { - accountId?: string | undefined; - audienceDefinition?: RemarketingAudienceAudienceDefinition | undefined; - audienceType?: string | undefined; - created?: string | undefined; - description?: string | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - linkedAdAccounts?: LinkedForeignAccount[] | undefined; - linkedViews?: string[] | undefined; - name?: string | undefined; - stateBasedAudienceDefinition?: RemarketingAudienceStateBasedAudienceDefinition | undefined; - updated?: string | undefined; - webPropertyId?: string | undefined; - } - interface RemarketingAudienceAudienceDefinition { - includeConditions?: IncludeConditions | undefined; - } - interface RemarketingAudienceStateBasedAudienceDefinition { - excludeConditions?: RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions | undefined; - includeConditions?: IncludeConditions | undefined; - } - interface RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions { - exclusionDuration?: string | undefined; - segment?: string | undefined; - } - interface RemarketingAudiences { - items?: RemarketingAudience[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface Segment { - created?: string | undefined; - definition?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - segmentId?: string | undefined; - selfLink?: string | undefined; - type?: string | undefined; - updated?: string | undefined; - } - interface Segments { - items?: Segment[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface UnsampledReport { - accountId?: string | undefined; - cloudStorageDownloadDetails?: UnsampledReportCloudStorageDownloadDetails | undefined; - created?: string | undefined; - dimensions?: string | undefined; - downloadType?: string | undefined; - driveDownloadDetails?: UnsampledReportDriveDownloadDetails | undefined; - end_date?: string | undefined; - filters?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - metrics?: string | undefined; - profileId?: string | undefined; - segment?: string | undefined; - selfLink?: string | undefined; - start_date?: string | undefined; - status?: string | undefined; - title?: string | undefined; - updated?: string | undefined; - webPropertyId?: string | undefined; - } - interface UnsampledReportCloudStorageDownloadDetails { - bucketId?: string | undefined; - objectId?: string | undefined; - } - interface UnsampledReportDriveDownloadDetails { - documentId?: string | undefined; - } - interface UnsampledReports { - items?: UnsampledReport[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface Upload { - accountId?: string | undefined; - customDataSourceId?: string | undefined; - errors?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - status?: string | undefined; - uploadTime?: string | undefined; - } - interface Uploads { - items?: Upload[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - } - interface UserDeletionRequest { - deletionRequestTime?: string | undefined; - firebaseProjectId?: string | undefined; - id?: UserDeletionRequestId | undefined; - kind?: string | undefined; - webPropertyId?: string | undefined; - } - interface UserDeletionRequestId { - type?: string | undefined; - userId?: string | undefined; - } - interface UserRef { - email?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - } - interface WebPropertyRef { - accountId?: string | undefined; - href?: string | undefined; - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface WebPropertySummary { - id?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - level?: string | undefined; - name?: string | undefined; - profiles?: ProfileSummary[] | undefined; - starred?: boolean | undefined; - websiteUrl?: string | undefined; - } - interface Webproperties { - items?: Webproperty[] | undefined; - itemsPerPage?: number | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - previousLink?: string | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - username?: string | undefined; - } - interface Webproperty { - accountId?: string | undefined; - childLink?: WebpropertyChildLink | undefined; - created?: string | undefined; - dataRetentionResetOnNewActivity?: boolean | undefined; - dataRetentionTtl?: string | undefined; - defaultProfileId?: string | undefined; - id?: string | undefined; - industryVertical?: string | undefined; - internalWebPropertyId?: string | undefined; - kind?: string | undefined; - level?: string | undefined; - name?: string | undefined; - parentLink?: WebpropertyParentLink | undefined; - permissions?: WebpropertyPermissions | undefined; - profileCount?: number | undefined; - selfLink?: string | undefined; - starred?: boolean | undefined; - updated?: string | undefined; - websiteUrl?: string | undefined; - } - interface WebpropertyChildLink { - href?: string | undefined; - type?: string | undefined; - } - interface WebpropertyParentLink { - href?: string | undefined; - type?: string | undefined; - } - interface WebpropertyPermissions { - effective?: string[] | undefined; - } - } - } - interface Analytics { - Data?: Analytics.Collection.DataCollection | undefined; - Management?: Analytics.Collection.ManagementCollection | undefined; - Metadata?: Analytics.Collection.MetadataCollection | undefined; - Provisioning?: Analytics.Collection.ProvisioningCollection | undefined; - UserDeletion?: Analytics.Collection.UserDeletionCollection | undefined; - // Create a new instance of Account - newAccount(): Analytics.Schema.Account; - // Create a new instance of AccountChildLink - newAccountChildLink(): Analytics.Schema.AccountChildLink; - // Create a new instance of AccountPermissions - newAccountPermissions(): Analytics.Schema.AccountPermissions; - // Create a new instance of AccountRef - newAccountRef(): Analytics.Schema.AccountRef; - // Create a new instance of AccountTicket - newAccountTicket(): Analytics.Schema.AccountTicket; - // Create a new instance of AccountTreeRequest - newAccountTreeRequest(): Analytics.Schema.AccountTreeRequest; - // Create a new instance of AdWordsAccount - newAdWordsAccount(): Analytics.Schema.AdWordsAccount; - // Create a new instance of AnalyticsDataimportDeleteUploadDataRequest - newAnalyticsDataimportDeleteUploadDataRequest(): Analytics.Schema.AnalyticsDataimportDeleteUploadDataRequest; - // Create a new instance of CustomDimension - newCustomDimension(): Analytics.Schema.CustomDimension; - // Create a new instance of CustomDimensionParentLink - newCustomDimensionParentLink(): Analytics.Schema.CustomDimensionParentLink; - // Create a new instance of CustomMetric - newCustomMetric(): Analytics.Schema.CustomMetric; - // Create a new instance of CustomMetricParentLink - newCustomMetricParentLink(): Analytics.Schema.CustomMetricParentLink; - // Create a new instance of EntityAdWordsLink - newEntityAdWordsLink(): Analytics.Schema.EntityAdWordsLink; - // Create a new instance of EntityAdWordsLinkEntity - newEntityAdWordsLinkEntity(): Analytics.Schema.EntityAdWordsLinkEntity; - // Create a new instance of EntityUserLink - newEntityUserLink(): Analytics.Schema.EntityUserLink; - // Create a new instance of EntityUserLinkEntity - newEntityUserLinkEntity(): Analytics.Schema.EntityUserLinkEntity; - // Create a new instance of EntityUserLinkPermissions - newEntityUserLinkPermissions(): Analytics.Schema.EntityUserLinkPermissions; - // Create a new instance of Experiment - newExperiment(): Analytics.Schema.Experiment; - // Create a new instance of ExperimentParentLink - newExperimentParentLink(): Analytics.Schema.ExperimentParentLink; - // Create a new instance of ExperimentVariations - newExperimentVariations(): Analytics.Schema.ExperimentVariations; - // Create a new instance of Filter - newFilter(): Analytics.Schema.Filter; - // Create a new instance of FilterAdvancedDetails - newFilterAdvancedDetails(): Analytics.Schema.FilterAdvancedDetails; - // Create a new instance of FilterExpression - newFilterExpression(): Analytics.Schema.FilterExpression; - // Create a new instance of FilterLowercaseDetails - newFilterLowercaseDetails(): Analytics.Schema.FilterLowercaseDetails; - // Create a new instance of FilterParentLink - newFilterParentLink(): Analytics.Schema.FilterParentLink; - // Create a new instance of FilterRef - newFilterRef(): Analytics.Schema.FilterRef; - // Create a new instance of FilterSearchAndReplaceDetails - newFilterSearchAndReplaceDetails(): Analytics.Schema.FilterSearchAndReplaceDetails; - // Create a new instance of FilterUppercaseDetails - newFilterUppercaseDetails(): Analytics.Schema.FilterUppercaseDetails; - // Create a new instance of Goal - newGoal(): Analytics.Schema.Goal; - // Create a new instance of GoalEventDetails - newGoalEventDetails(): Analytics.Schema.GoalEventDetails; - // Create a new instance of GoalEventDetailsEventConditions - newGoalEventDetailsEventConditions(): Analytics.Schema.GoalEventDetailsEventConditions; - // Create a new instance of GoalParentLink - newGoalParentLink(): Analytics.Schema.GoalParentLink; - // Create a new instance of GoalUrlDestinationDetails - newGoalUrlDestinationDetails(): Analytics.Schema.GoalUrlDestinationDetails; - // Create a new instance of GoalUrlDestinationDetailsSteps - newGoalUrlDestinationDetailsSteps(): Analytics.Schema.GoalUrlDestinationDetailsSteps; - // Create a new instance of GoalVisitNumPagesDetails - newGoalVisitNumPagesDetails(): Analytics.Schema.GoalVisitNumPagesDetails; - // Create a new instance of GoalVisitTimeOnSiteDetails - newGoalVisitTimeOnSiteDetails(): Analytics.Schema.GoalVisitTimeOnSiteDetails; - // Create a new instance of HashClientIdRequest - newHashClientIdRequest(): Analytics.Schema.HashClientIdRequest; - // Create a new instance of IncludeConditions - newIncludeConditions(): Analytics.Schema.IncludeConditions; - // Create a new instance of LinkedForeignAccount - newLinkedForeignAccount(): Analytics.Schema.LinkedForeignAccount; - // Create a new instance of Profile - newProfile(): Analytics.Schema.Profile; - // Create a new instance of ProfileChildLink - newProfileChildLink(): Analytics.Schema.ProfileChildLink; - // Create a new instance of ProfileFilterLink - newProfileFilterLink(): Analytics.Schema.ProfileFilterLink; - // Create a new instance of ProfileParentLink - newProfileParentLink(): Analytics.Schema.ProfileParentLink; - // Create a new instance of ProfilePermissions - newProfilePermissions(): Analytics.Schema.ProfilePermissions; - // Create a new instance of ProfileRef - newProfileRef(): Analytics.Schema.ProfileRef; - // Create a new instance of RemarketingAudience - newRemarketingAudience(): Analytics.Schema.RemarketingAudience; - // Create a new instance of RemarketingAudienceAudienceDefinition - newRemarketingAudienceAudienceDefinition(): Analytics.Schema.RemarketingAudienceAudienceDefinition; - // Create a new instance of RemarketingAudienceStateBasedAudienceDefinition - newRemarketingAudienceStateBasedAudienceDefinition(): Analytics.Schema.RemarketingAudienceStateBasedAudienceDefinition; - // Create a new instance of RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions - newRemarketingAudienceStateBasedAudienceDefinitionExcludeConditions(): Analytics.Schema.RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions; - // Create a new instance of UnsampledReport - newUnsampledReport(): Analytics.Schema.UnsampledReport; - // Create a new instance of UnsampledReportCloudStorageDownloadDetails - newUnsampledReportCloudStorageDownloadDetails(): Analytics.Schema.UnsampledReportCloudStorageDownloadDetails; - // Create a new instance of UnsampledReportDriveDownloadDetails - newUnsampledReportDriveDownloadDetails(): Analytics.Schema.UnsampledReportDriveDownloadDetails; - // Create a new instance of UserDeletionRequest - newUserDeletionRequest(): Analytics.Schema.UserDeletionRequest; - // Create a new instance of UserDeletionRequestId - newUserDeletionRequestId(): Analytics.Schema.UserDeletionRequestId; - // Create a new instance of UserRef - newUserRef(): Analytics.Schema.UserRef; - // Create a new instance of WebPropertyRef - newWebPropertyRef(): Analytics.Schema.WebPropertyRef; - // Create a new instance of Webproperty - newWebproperty(): Analytics.Schema.Webproperty; - // Create a new instance of WebpropertyChildLink - newWebpropertyChildLink(): Analytics.Schema.WebpropertyChildLink; - // Create a new instance of WebpropertyParentLink - newWebpropertyParentLink(): Analytics.Schema.WebpropertyParentLink; - // Create a new instance of WebpropertyPermissions - newWebpropertyPermissions(): Analytics.Schema.WebpropertyPermissions; - } -} - -declare var Analytics: GoogleAppsScript.Analytics; diff --git a/node_modules/@types/google-apps-script/apis/analyticsreporting_v4.d.ts b/node_modules/@types/google-apps-script/apis/analyticsreporting_v4.d.ts deleted file mode 100644 index 4edd806..0000000 --- a/node_modules/@types/google-apps-script/apis/analyticsreporting_v4.d.ts +++ /dev/null @@ -1,357 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AnalyticsReporting { - namespace Collection { - interface ReportsCollection { - // Returns the Analytics data. - batchGet(resource: Schema.GetReportsRequest): AnalyticsReporting.Schema.GetReportsResponse; - } - interface UserActivityCollection { - // Returns User Activity data. - search( - resource: Schema.SearchUserActivityRequest, - ): AnalyticsReporting.Schema.SearchUserActivityResponse; - } - } - namespace Schema { - interface Activity { - activityTime?: string | undefined; - activityType?: string | undefined; - appview?: AnalyticsReporting.Schema.ScreenviewData | undefined; - campaign?: string | undefined; - channelGrouping?: string | undefined; - customDimension?: AnalyticsReporting.Schema.CustomDimension[] | undefined; - ecommerce?: AnalyticsReporting.Schema.EcommerceData | undefined; - event?: AnalyticsReporting.Schema.EventData | undefined; - goals?: AnalyticsReporting.Schema.GoalSetData | undefined; - hostname?: string | undefined; - keyword?: string | undefined; - landingPagePath?: string | undefined; - medium?: string | undefined; - pageview?: AnalyticsReporting.Schema.PageviewData | undefined; - source?: string | undefined; - } - interface Cohort { - dateRange?: AnalyticsReporting.Schema.DateRange | undefined; - name?: string | undefined; - type?: string | undefined; - } - interface CohortGroup { - cohorts?: AnalyticsReporting.Schema.Cohort[] | undefined; - lifetimeValue?: boolean | undefined; - } - interface ColumnHeader { - dimensions?: string[] | undefined; - metricHeader?: AnalyticsReporting.Schema.MetricHeader | undefined; - } - interface CustomDimension { - index?: number | undefined; - value?: string | undefined; - } - interface DateRange { - endDate?: string | undefined; - startDate?: string | undefined; - } - interface DateRangeValues { - pivotValueRegions?: AnalyticsReporting.Schema.PivotValueRegion[] | undefined; - values?: string[] | undefined; - } - interface Dimension { - histogramBuckets?: string[] | undefined; - name?: string | undefined; - } - interface DimensionFilter { - caseSensitive?: boolean | undefined; - dimensionName?: string | undefined; - expressions?: string[] | undefined; - not?: boolean | undefined; - operator?: string | undefined; - } - interface DimensionFilterClause { - filters?: AnalyticsReporting.Schema.DimensionFilter[] | undefined; - operator?: string | undefined; - } - interface DynamicSegment { - name?: string | undefined; - sessionSegment?: AnalyticsReporting.Schema.SegmentDefinition | undefined; - userSegment?: AnalyticsReporting.Schema.SegmentDefinition | undefined; - } - interface EcommerceData { - actionType?: string | undefined; - ecommerceType?: string | undefined; - products?: AnalyticsReporting.Schema.ProductData[] | undefined; - transaction?: AnalyticsReporting.Schema.TransactionData | undefined; - } - interface EventData { - eventAction?: string | undefined; - eventCategory?: string | undefined; - eventCount?: string | undefined; - eventLabel?: string | undefined; - eventValue?: string | undefined; - } - interface GetReportsRequest { - reportRequests?: AnalyticsReporting.Schema.ReportRequest[] | undefined; - useResourceQuotas?: boolean | undefined; - } - interface GetReportsResponse { - queryCost?: number | undefined; - reports?: AnalyticsReporting.Schema.Report[] | undefined; - resourceQuotasRemaining?: AnalyticsReporting.Schema.ResourceQuotasRemaining | undefined; - } - interface GoalData { - goalCompletionLocation?: string | undefined; - goalCompletions?: string | undefined; - goalIndex?: number | undefined; - goalName?: string | undefined; - goalPreviousStep1?: string | undefined; - goalPreviousStep2?: string | undefined; - goalPreviousStep3?: string | undefined; - goalValue?: number | undefined; - } - interface GoalSetData { - goals?: AnalyticsReporting.Schema.GoalData[] | undefined; - } - interface Metric { - alias?: string | undefined; - expression?: string | undefined; - formattingType?: string | undefined; - } - interface MetricFilter { - comparisonValue?: string | undefined; - metricName?: string | undefined; - not?: boolean | undefined; - operator?: string | undefined; - } - interface MetricFilterClause { - filters?: AnalyticsReporting.Schema.MetricFilter[] | undefined; - operator?: string | undefined; - } - interface MetricHeader { - metricHeaderEntries?: AnalyticsReporting.Schema.MetricHeaderEntry[] | undefined; - pivotHeaders?: AnalyticsReporting.Schema.PivotHeader[] | undefined; - } - interface MetricHeaderEntry { - name?: string | undefined; - type?: string | undefined; - } - interface OrFiltersForSegment { - segmentFilterClauses?: AnalyticsReporting.Schema.SegmentFilterClause[] | undefined; - } - interface OrderBy { - fieldName?: string | undefined; - orderType?: string | undefined; - sortOrder?: string | undefined; - } - interface PageviewData { - pagePath?: string | undefined; - pageTitle?: string | undefined; - } - interface Pivot { - dimensionFilterClauses?: AnalyticsReporting.Schema.DimensionFilterClause[] | undefined; - dimensions?: AnalyticsReporting.Schema.Dimension[] | undefined; - maxGroupCount?: number | undefined; - metrics?: AnalyticsReporting.Schema.Metric[] | undefined; - startGroup?: number | undefined; - } - interface PivotHeader { - pivotHeaderEntries?: AnalyticsReporting.Schema.PivotHeaderEntry[] | undefined; - totalPivotGroupsCount?: number | undefined; - } - interface PivotHeaderEntry { - dimensionNames?: string[] | undefined; - dimensionValues?: string[] | undefined; - metric?: AnalyticsReporting.Schema.MetricHeaderEntry | undefined; - } - interface PivotValueRegion { - values?: string[] | undefined; - } - interface ProductData { - itemRevenue?: number | undefined; - productName?: string | undefined; - productQuantity?: string | undefined; - productSku?: string | undefined; - } - interface Report { - columnHeader?: AnalyticsReporting.Schema.ColumnHeader | undefined; - data?: AnalyticsReporting.Schema.ReportData | undefined; - nextPageToken?: string | undefined; - } - interface ReportData { - dataLastRefreshed?: string | undefined; - isDataGolden?: boolean | undefined; - maximums?: AnalyticsReporting.Schema.DateRangeValues[] | undefined; - minimums?: AnalyticsReporting.Schema.DateRangeValues[] | undefined; - rowCount?: number | undefined; - rows?: AnalyticsReporting.Schema.ReportRow[] | undefined; - samplesReadCounts?: string[] | undefined; - samplingSpaceSizes?: string[] | undefined; - totals?: AnalyticsReporting.Schema.DateRangeValues[] | undefined; - } - interface ReportRequest { - cohortGroup?: AnalyticsReporting.Schema.CohortGroup | undefined; - dateRanges?: AnalyticsReporting.Schema.DateRange[] | undefined; - dimensionFilterClauses?: AnalyticsReporting.Schema.DimensionFilterClause[] | undefined; - dimensions?: AnalyticsReporting.Schema.Dimension[] | undefined; - filtersExpression?: string | undefined; - hideTotals?: boolean | undefined; - hideValueRanges?: boolean | undefined; - includeEmptyRows?: boolean | undefined; - metricFilterClauses?: AnalyticsReporting.Schema.MetricFilterClause[] | undefined; - metrics?: AnalyticsReporting.Schema.Metric[] | undefined; - orderBys?: AnalyticsReporting.Schema.OrderBy[] | undefined; - pageSize?: number | undefined; - pageToken?: string | undefined; - pivots?: AnalyticsReporting.Schema.Pivot[] | undefined; - samplingLevel?: string | undefined; - segments?: AnalyticsReporting.Schema.Segment[] | undefined; - viewId?: string | undefined; - } - interface ReportRow { - dimensions?: string[] | undefined; - metrics?: AnalyticsReporting.Schema.DateRangeValues[] | undefined; - } - interface ResourceQuotasRemaining { - dailyQuotaTokensRemaining?: number | undefined; - hourlyQuotaTokensRemaining?: number | undefined; - } - interface ScreenviewData { - appName?: string | undefined; - mobileDeviceBranding?: string | undefined; - mobileDeviceModel?: string | undefined; - screenName?: string | undefined; - } - interface SearchUserActivityRequest { - activityTypes?: string[] | undefined; - dateRange?: AnalyticsReporting.Schema.DateRange | undefined; - pageSize?: number | undefined; - pageToken?: string | undefined; - user?: AnalyticsReporting.Schema.User | undefined; - viewId?: string | undefined; - } - interface SearchUserActivityResponse { - nextPageToken?: string | undefined; - sampleRate?: number | undefined; - sessions?: AnalyticsReporting.Schema.UserActivitySession[] | undefined; - totalRows?: number | undefined; - } - interface Segment { - dynamicSegment?: AnalyticsReporting.Schema.DynamicSegment | undefined; - segmentId?: string | undefined; - } - interface SegmentDefinition { - segmentFilters?: AnalyticsReporting.Schema.SegmentFilter[] | undefined; - } - interface SegmentDimensionFilter { - caseSensitive?: boolean | undefined; - dimensionName?: string | undefined; - expressions?: string[] | undefined; - maxComparisonValue?: string | undefined; - minComparisonValue?: string | undefined; - operator?: string | undefined; - } - interface SegmentFilter { - not?: boolean | undefined; - sequenceSegment?: AnalyticsReporting.Schema.SequenceSegment | undefined; - simpleSegment?: AnalyticsReporting.Schema.SimpleSegment | undefined; - } - interface SegmentFilterClause { - dimensionFilter?: AnalyticsReporting.Schema.SegmentDimensionFilter | undefined; - metricFilter?: AnalyticsReporting.Schema.SegmentMetricFilter | undefined; - not?: boolean | undefined; - } - interface SegmentMetricFilter { - comparisonValue?: string | undefined; - maxComparisonValue?: string | undefined; - metricName?: string | undefined; - operator?: string | undefined; - scope?: string | undefined; - } - interface SegmentSequenceStep { - matchType?: string | undefined; - orFiltersForSegment?: AnalyticsReporting.Schema.OrFiltersForSegment[] | undefined; - } - interface SequenceSegment { - firstStepShouldMatchFirstHit?: boolean | undefined; - segmentSequenceSteps?: AnalyticsReporting.Schema.SegmentSequenceStep[] | undefined; - } - interface SimpleSegment { - orFiltersForSegment?: AnalyticsReporting.Schema.OrFiltersForSegment[] | undefined; - } - interface TransactionData { - transactionId?: string | undefined; - transactionRevenue?: number | undefined; - transactionShipping?: number | undefined; - transactionTax?: number | undefined; - } - interface User { - type?: string | undefined; - userId?: string | undefined; - } - interface UserActivitySession { - activities?: AnalyticsReporting.Schema.Activity[] | undefined; - dataSource?: string | undefined; - deviceCategory?: string | undefined; - platform?: string | undefined; - sessionDate?: string | undefined; - sessionId?: string | undefined; - } - } - } - interface AnalyticsReporting { - Reports?: AnalyticsReporting.Collection.ReportsCollection | undefined; - UserActivity?: AnalyticsReporting.Collection.UserActivityCollection | undefined; - // Create a new instance of Cohort - newCohort(): AnalyticsReporting.Schema.Cohort; - // Create a new instance of CohortGroup - newCohortGroup(): AnalyticsReporting.Schema.CohortGroup; - // Create a new instance of DateRange - newDateRange(): AnalyticsReporting.Schema.DateRange; - // Create a new instance of Dimension - newDimension(): AnalyticsReporting.Schema.Dimension; - // Create a new instance of DimensionFilter - newDimensionFilter(): AnalyticsReporting.Schema.DimensionFilter; - // Create a new instance of DimensionFilterClause - newDimensionFilterClause(): AnalyticsReporting.Schema.DimensionFilterClause; - // Create a new instance of DynamicSegment - newDynamicSegment(): AnalyticsReporting.Schema.DynamicSegment; - // Create a new instance of GetReportsRequest - newGetReportsRequest(): AnalyticsReporting.Schema.GetReportsRequest; - // Create a new instance of Metric - newMetric(): AnalyticsReporting.Schema.Metric; - // Create a new instance of MetricFilter - newMetricFilter(): AnalyticsReporting.Schema.MetricFilter; - // Create a new instance of MetricFilterClause - newMetricFilterClause(): AnalyticsReporting.Schema.MetricFilterClause; - // Create a new instance of OrFiltersForSegment - newOrFiltersForSegment(): AnalyticsReporting.Schema.OrFiltersForSegment; - // Create a new instance of OrderBy - newOrderBy(): AnalyticsReporting.Schema.OrderBy; - // Create a new instance of Pivot - newPivot(): AnalyticsReporting.Schema.Pivot; - // Create a new instance of ReportRequest - newReportRequest(): AnalyticsReporting.Schema.ReportRequest; - // Create a new instance of SearchUserActivityRequest - newSearchUserActivityRequest(): AnalyticsReporting.Schema.SearchUserActivityRequest; - // Create a new instance of Segment - newSegment(): AnalyticsReporting.Schema.Segment; - // Create a new instance of SegmentDefinition - newSegmentDefinition(): AnalyticsReporting.Schema.SegmentDefinition; - // Create a new instance of SegmentDimensionFilter - newSegmentDimensionFilter(): AnalyticsReporting.Schema.SegmentDimensionFilter; - // Create a new instance of SegmentFilter - newSegmentFilter(): AnalyticsReporting.Schema.SegmentFilter; - // Create a new instance of SegmentFilterClause - newSegmentFilterClause(): AnalyticsReporting.Schema.SegmentFilterClause; - // Create a new instance of SegmentMetricFilter - newSegmentMetricFilter(): AnalyticsReporting.Schema.SegmentMetricFilter; - // Create a new instance of SegmentSequenceStep - newSegmentSequenceStep(): AnalyticsReporting.Schema.SegmentSequenceStep; - // Create a new instance of SequenceSegment - newSequenceSegment(): AnalyticsReporting.Schema.SequenceSegment; - // Create a new instance of SimpleSegment - newSimpleSegment(): AnalyticsReporting.Schema.SimpleSegment; - // Create a new instance of User - newUser(): AnalyticsReporting.Schema.User; - } -} - -declare var AnalyticsReporting: GoogleAppsScript.AnalyticsReporting; diff --git a/node_modules/@types/google-apps-script/apis/appsactivity_v1.d.ts b/node_modules/@types/google-apps-script/apis/appsactivity_v1.d.ts deleted file mode 100644 index cedcd41..0000000 --- a/node_modules/@types/google-apps-script/apis/appsactivity_v1.d.ts +++ /dev/null @@ -1,78 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Appsactivity { - namespace Collection { - interface ActivitiesCollection { - // Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter. - list(): Appsactivity.Schema.ListActivitiesResponse; - // Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter. - list(optionalArgs: object): Appsactivity.Schema.ListActivitiesResponse; - } - } - namespace Schema { - interface Activity { - combinedEvent?: Appsactivity.Schema.Event | undefined; - singleEvents?: Appsactivity.Schema.Event[] | undefined; - } - interface Event { - additionalEventTypes?: string[] | undefined; - eventTimeMillis?: string | undefined; - fromUserDeletion?: boolean | undefined; - move?: Appsactivity.Schema.Move | undefined; - permissionChanges?: Appsactivity.Schema.PermissionChange[] | undefined; - primaryEventType?: string | undefined; - rename?: Appsactivity.Schema.Rename | undefined; - target?: Appsactivity.Schema.Target | undefined; - user?: Appsactivity.Schema.User | undefined; - } - interface ListActivitiesResponse { - activities?: Appsactivity.Schema.Activity[] | undefined; - nextPageToken?: string | undefined; - } - interface Move { - addedParents?: Appsactivity.Schema.Parent[] | undefined; - removedParents?: Appsactivity.Schema.Parent[] | undefined; - } - interface Parent { - id?: string | undefined; - isRoot?: boolean | undefined; - title?: string | undefined; - } - interface Permission { - name?: string | undefined; - permissionId?: string | undefined; - role?: string | undefined; - type?: string | undefined; - user?: Appsactivity.Schema.User | undefined; - withLink?: boolean | undefined; - } - interface PermissionChange { - addedPermissions?: Appsactivity.Schema.Permission[] | undefined; - removedPermissions?: Appsactivity.Schema.Permission[] | undefined; - } - interface Photo { - url?: string | undefined; - } - interface Rename { - newTitle?: string | undefined; - oldTitle?: string | undefined; - } - interface Target { - id?: string | undefined; - mimeType?: string | undefined; - name?: string | undefined; - } - interface User { - isDeleted?: boolean | undefined; - isMe?: boolean | undefined; - name?: string | undefined; - permissionId?: string | undefined; - photo?: Appsactivity.Schema.Photo | undefined; - } - } - } - interface Appsactivity { - Activities?: Appsactivity.Collection.ActivitiesCollection | undefined; - } -} - -declare var Appsactivity: GoogleAppsScript.Appsactivity; diff --git a/node_modules/@types/google-apps-script/apis/bigquery_v2.d.ts b/node_modules/@types/google-apps-script/apis/bigquery_v2.d.ts deleted file mode 100644 index 66b49f8..0000000 --- a/node_modules/@types/google-apps-script/apis/bigquery_v2.d.ts +++ /dev/null @@ -1,821 +0,0 @@ -declare namespace GoogleAppsScript { - namespace BigQuery { - namespace Collection { - interface DatasetsCollection { - // Returns the dataset specified by datasetID. - get(projectId: string, datasetId: string): BigQuery.Schema.Dataset; - // Creates a new empty dataset. - insert(resource: BigQuery.Schema.Dataset, projectId: string): BigQuery.Schema.Dataset; - // Lists all datasets in the specified project to which you have been granted the READER dataset role. - list(projectId: string): BigQuery.Schema.DatasetList; - // Lists all datasets in the specified project to which you have been granted the READER dataset role. - list(projectId: string, optionalArgs: object): BigQuery.Schema.DatasetList; - // Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. - patch(resource: BigQuery.Schema.Dataset, projectId: string, datasetId: string): BigQuery.Schema.Dataset; - // Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. - remove(projectId: string, datasetId: string): void; - // Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. - remove(projectId: string, datasetId: string, optionalArgs: object): void; - // Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. - update( - resource: BigQuery.Schema.Dataset, - projectId: string, - datasetId: string, - ): BigQuery.Schema.Dataset; - } - interface JobsCollection { - // Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. - cancel(projectId: string, jobId: string): BigQuery.Schema.JobCancelResponse; - // Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. - cancel(projectId: string, jobId: string, optionalArgs: object): BigQuery.Schema.JobCancelResponse; - // Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. - get(projectId: string, jobId: string): BigQuery.Schema.Job; - // Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. - get(projectId: string, jobId: string, optionalArgs: object): BigQuery.Schema.Job; - // Retrieves the results of a query job. - getQueryResults(projectId: string, jobId: string): BigQuery.Schema.GetQueryResultsResponse; - // Retrieves the results of a query job. - getQueryResults( - projectId: string, - jobId: string, - optionalArgs: object, - ): BigQuery.Schema.GetQueryResultsResponse; - // Starts a new asynchronous job. Requires the Can View project role. - insert(resource: BigQuery.Schema.Job, projectId: string): BigQuery.Schema.Job; - // Starts a new asynchronous job. Requires the Can View project role. - insert(resource: BigQuery.Schema.Job, projectId: string, mediaData: any): BigQuery.Schema.Job; - // Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. - list(projectId: string): BigQuery.Schema.JobList; - // Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. - list(projectId: string, optionalArgs: object): BigQuery.Schema.JobList; - // Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. - query(resource: BigQuery.Schema.QueryRequest, projectId: string): BigQuery.Schema.QueryResponse; - } - interface ProjectsCollection { - // Returns the email address of the service account for your project used for interactions with Google Cloud KMS. - getServiceAccount(projectId: string): BigQuery.Schema.GetServiceAccountResponse; - // Lists all projects to which you have been granted any project role. - list(): BigQuery.Schema.ProjectList; - // Lists all projects to which you have been granted any project role. - list(optionalArgs: object): BigQuery.Schema.ProjectList; - } - interface TabledataCollection { - // Streams data into BigQuery one record at a time without needing to run a load job. Requires the WRITER dataset role. - insertAll( - resource: BigQuery.Schema.TableDataInsertAllRequest, - projectId: string, - datasetId: string, - tableId: string, - ): BigQuery.Schema.TableDataInsertAllResponse; - // Retrieves table data from a specified set of rows. Requires the READER dataset role. - list(projectId: string, datasetId: string, tableId: string): BigQuery.Schema.TableDataList; - // Retrieves table data from a specified set of rows. Requires the READER dataset role. - list( - projectId: string, - datasetId: string, - tableId: string, - optionalArgs: object, - ): BigQuery.Schema.TableDataList; - } - interface TablesCollection { - // Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. - get(projectId: string, datasetId: string, tableId: string): BigQuery.Schema.Table; - // Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. - get(projectId: string, datasetId: string, tableId: string, optionalArgs: object): BigQuery.Schema.Table; - // Creates a new, empty table in the dataset. - insert(resource: BigQuery.Schema.Table, projectId: string, datasetId: string): BigQuery.Schema.Table; - // Lists all tables in the specified dataset. Requires the READER dataset role. - list(projectId: string, datasetId: string): BigQuery.Schema.TableList; - // Lists all tables in the specified dataset. Requires the READER dataset role. - list(projectId: string, datasetId: string, optionalArgs: object): BigQuery.Schema.TableList; - // Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. - patch( - resource: BigQuery.Schema.Table, - projectId: string, - datasetId: string, - tableId: string, - ): BigQuery.Schema.Table; - // Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. - remove(projectId: string, datasetId: string, tableId: string): void; - // Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. - update( - resource: BigQuery.Schema.Table, - projectId: string, - datasetId: string, - tableId: string, - ): BigQuery.Schema.Table; - } - } - namespace Schema { - interface BigQueryModelTraining { - currentIteration?: number | undefined; - expectedTotalIterations?: string | undefined; - } - interface BigtableColumn { - encoding?: string | undefined; - fieldName?: string | undefined; - onlyReadLatest?: boolean | undefined; - qualifierEncoded?: string | undefined; - qualifierString?: string | undefined; - type?: string | undefined; - } - interface BigtableColumnFamily { - columns?: BigQuery.Schema.BigtableColumn[] | undefined; - encoding?: string | undefined; - familyId?: string | undefined; - onlyReadLatest?: boolean | undefined; - type?: string | undefined; - } - interface BigtableOptions { - columnFamilies?: BigQuery.Schema.BigtableColumnFamily[] | undefined; - ignoreUnspecifiedColumnFamilies?: boolean | undefined; - readRowkeyAsString?: boolean | undefined; - } - interface BqmlIterationResult { - durationMs?: string | undefined; - evalLoss?: number | undefined; - index?: number | undefined; - learnRate?: number | undefined; - trainingLoss?: number | undefined; - } - interface BqmlTrainingRun { - iterationResults?: BigQuery.Schema.BqmlIterationResult[] | undefined; - startTime?: string | undefined; - state?: string | undefined; - trainingOptions?: BigQuery.Schema.BqmlTrainingRunTrainingOptions | undefined; - } - interface BqmlTrainingRunTrainingOptions { - earlyStop?: boolean | undefined; - l1Reg?: number | undefined; - l2Reg?: number | undefined; - learnRate?: number | undefined; - learnRateStrategy?: string | undefined; - lineSearchInitLearnRate?: number | undefined; - maxIteration?: string | undefined; - minRelProgress?: number | undefined; - warmStart?: boolean | undefined; - } - interface Clustering { - fields?: string[] | undefined; - } - interface CsvOptions { - allowJaggedRows?: boolean | undefined; - allowQuotedNewlines?: boolean | undefined; - encoding?: string | undefined; - fieldDelimiter?: string | undefined; - quote?: string | undefined; - skipLeadingRows?: string | undefined; - } - interface Dataset { - access?: BigQuery.Schema.DatasetAccess[] | undefined; - creationTime?: string | undefined; - datasetReference?: BigQuery.Schema.DatasetReference | undefined; - defaultPartitionExpirationMs?: string | undefined; - defaultTableExpirationMs?: string | undefined; - description?: string | undefined; - etag?: string | undefined; - friendlyName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - labels?: object | undefined; - lastModifiedTime?: string | undefined; - location?: string | undefined; - selfLink?: string | undefined; - } - interface DatasetAccess { - domain?: string | undefined; - groupByEmail?: string | undefined; - iamMember?: string | undefined; - role?: string | undefined; - specialGroup?: string | undefined; - userByEmail?: string | undefined; - view?: BigQuery.Schema.TableReference | undefined; - } - interface DatasetList { - datasets?: BigQuery.Schema.DatasetListDatasets[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface DatasetListDatasets { - datasetReference?: BigQuery.Schema.DatasetReference | undefined; - friendlyName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - labels?: object | undefined; - location?: string | undefined; - } - interface DatasetReference { - datasetId?: string | undefined; - projectId?: string | undefined; - } - interface DestinationTableProperties { - description?: string | undefined; - friendlyName?: string | undefined; - labels?: object | undefined; - } - interface EncryptionConfiguration { - kmsKeyName?: string | undefined; - } - interface ErrorProto { - debugInfo?: string | undefined; - location?: string | undefined; - message?: string | undefined; - reason?: string | undefined; - } - interface ExplainQueryStage { - completedParallelInputs?: string | undefined; - computeMsAvg?: string | undefined; - computeMsMax?: string | undefined; - computeRatioAvg?: number | undefined; - computeRatioMax?: number | undefined; - endMs?: string | undefined; - id?: string | undefined; - inputStages?: string[] | undefined; - name?: string | undefined; - parallelInputs?: string | undefined; - readMsAvg?: string | undefined; - readMsMax?: string | undefined; - readRatioAvg?: number | undefined; - readRatioMax?: number | undefined; - recordsRead?: string | undefined; - recordsWritten?: string | undefined; - shuffleOutputBytes?: string | undefined; - shuffleOutputBytesSpilled?: string | undefined; - startMs?: string | undefined; - status?: string | undefined; - steps?: BigQuery.Schema.ExplainQueryStep[] | undefined; - waitMsAvg?: string | undefined; - waitMsMax?: string | undefined; - waitRatioAvg?: number | undefined; - waitRatioMax?: number | undefined; - writeMsAvg?: string | undefined; - writeMsMax?: string | undefined; - writeRatioAvg?: number | undefined; - writeRatioMax?: number | undefined; - } - interface ExplainQueryStep { - kind?: string | undefined; - substeps?: string[] | undefined; - } - interface ExternalDataConfiguration { - autodetect?: boolean | undefined; - bigtableOptions?: BigQuery.Schema.BigtableOptions | undefined; - compression?: string | undefined; - csvOptions?: BigQuery.Schema.CsvOptions | undefined; - googleSheetsOptions?: BigQuery.Schema.GoogleSheetsOptions | undefined; - hivePartitioningMode?: string | undefined; - ignoreUnknownValues?: boolean | undefined; - maxBadRecords?: number | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - sourceFormat?: string | undefined; - sourceUris?: string[] | undefined; - } - interface GetQueryResultsResponse { - cacheHit?: boolean | undefined; - errors?: BigQuery.Schema.ErrorProto[] | undefined; - etag?: string | undefined; - jobComplete?: boolean | undefined; - jobReference?: BigQuery.Schema.JobReference | undefined; - kind?: string | undefined; - numDmlAffectedRows?: string | undefined; - pageToken?: string | undefined; - rows?: BigQuery.Schema.TableRow[] | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - totalBytesProcessed?: string | undefined; - totalRows?: string | undefined; - } - interface GetServiceAccountResponse { - email?: string | undefined; - kind?: string | undefined; - } - interface GoogleSheetsOptions { - range?: string | undefined; - skipLeadingRows?: string | undefined; - } - interface Job { - configuration?: BigQuery.Schema.JobConfiguration | undefined; - etag?: string | undefined; - id?: string | undefined; - jobReference?: BigQuery.Schema.JobReference | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - statistics?: BigQuery.Schema.JobStatistics | undefined; - status?: BigQuery.Schema.JobStatus | undefined; - user_email?: string | undefined; - } - interface JobCancelResponse { - job?: BigQuery.Schema.Job | undefined; - kind?: string | undefined; - } - interface JobConfiguration { - copy?: BigQuery.Schema.JobConfigurationTableCopy | undefined; - dryRun?: boolean | undefined; - extract?: BigQuery.Schema.JobConfigurationExtract | undefined; - jobTimeoutMs?: string | undefined; - jobType?: string | undefined; - labels?: object | undefined; - load?: BigQuery.Schema.JobConfigurationLoad | undefined; - query?: BigQuery.Schema.JobConfigurationQuery | undefined; - } - interface JobConfigurationExtract { - compression?: string | undefined; - destinationFormat?: string | undefined; - destinationUri?: string | undefined; - destinationUris?: string[] | undefined; - fieldDelimiter?: string | undefined; - printHeader?: boolean | undefined; - sourceTable?: BigQuery.Schema.TableReference | undefined; - } - interface JobConfigurationLoad { - allowJaggedRows?: boolean | undefined; - allowQuotedNewlines?: boolean | undefined; - autodetect?: boolean | undefined; - clustering?: BigQuery.Schema.Clustering | undefined; - createDisposition?: string | undefined; - destinationEncryptionConfiguration?: BigQuery.Schema.EncryptionConfiguration | undefined; - destinationTable?: BigQuery.Schema.TableReference | undefined; - destinationTableProperties?: BigQuery.Schema.DestinationTableProperties | undefined; - encoding?: string | undefined; - fieldDelimiter?: string | undefined; - hivePartitioningMode?: string | undefined; - ignoreUnknownValues?: boolean | undefined; - maxBadRecords?: number | undefined; - nullMarker?: string | undefined; - projectionFields?: string[] | undefined; - quote?: string | undefined; - rangePartitioning?: BigQuery.Schema.RangePartitioning | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - schemaInline?: string | undefined; - schemaInlineFormat?: string | undefined; - schemaUpdateOptions?: string[] | undefined; - skipLeadingRows?: number | undefined; - sourceFormat?: string | undefined; - sourceUris?: string[] | undefined; - timePartitioning?: BigQuery.Schema.TimePartitioning | undefined; - useAvroLogicalTypes?: boolean | undefined; - writeDisposition?: string | undefined; - } - interface JobConfigurationQuery { - allowLargeResults?: boolean | undefined; - clustering?: BigQuery.Schema.Clustering | undefined; - createDisposition?: string | undefined; - defaultDataset?: BigQuery.Schema.DatasetReference | undefined; - destinationEncryptionConfiguration?: BigQuery.Schema.EncryptionConfiguration | undefined; - destinationTable?: BigQuery.Schema.TableReference | undefined; - flattenResults?: boolean | undefined; - maximumBillingTier?: number | undefined; - maximumBytesBilled?: string | undefined; - parameterMode?: string | undefined; - preserveNulls?: boolean | undefined; - priority?: string | undefined; - query?: string | undefined; - queryParameters?: BigQuery.Schema.QueryParameter[] | undefined; - rangePartitioning?: BigQuery.Schema.RangePartitioning | undefined; - schemaUpdateOptions?: string[] | undefined; - tableDefinitions?: object | undefined; - timePartitioning?: BigQuery.Schema.TimePartitioning | undefined; - useLegacySql?: boolean | undefined; - useQueryCache?: boolean | undefined; - userDefinedFunctionResources?: BigQuery.Schema.UserDefinedFunctionResource[] | undefined; - writeDisposition?: string | undefined; - } - interface JobConfigurationTableCopy { - createDisposition?: string | undefined; - destinationEncryptionConfiguration?: BigQuery.Schema.EncryptionConfiguration | undefined; - destinationTable?: BigQuery.Schema.TableReference | undefined; - sourceTable?: BigQuery.Schema.TableReference | undefined; - sourceTables?: BigQuery.Schema.TableReference[] | undefined; - writeDisposition?: string | undefined; - } - interface JobList { - etag?: string | undefined; - jobs?: BigQuery.Schema.JobListJobs[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface JobListJobs { - configuration?: BigQuery.Schema.JobConfiguration | undefined; - errorResult?: BigQuery.Schema.ErrorProto | undefined; - id?: string | undefined; - jobReference?: BigQuery.Schema.JobReference | undefined; - kind?: string | undefined; - state?: string | undefined; - statistics?: BigQuery.Schema.JobStatistics | undefined; - status?: BigQuery.Schema.JobStatus | undefined; - user_email?: string | undefined; - } - interface JobReference { - jobId?: string | undefined; - location?: string | undefined; - projectId?: string | undefined; - } - interface JobStatistics { - completionRatio?: number | undefined; - creationTime?: string | undefined; - endTime?: string | undefined; - extract?: BigQuery.Schema.JobStatistics4 | undefined; - load?: BigQuery.Schema.JobStatistics3 | undefined; - numChildJobs?: string | undefined; - parentJobId?: string | undefined; - query?: BigQuery.Schema.JobStatistics2 | undefined; - quotaDeferments?: string[] | undefined; - reservationUsage?: BigQuery.Schema.JobStatisticsReservationUsage[] | undefined; - startTime?: string | undefined; - totalBytesProcessed?: string | undefined; - totalSlotMs?: string | undefined; - } - interface JobStatistics2 { - billingTier?: number | undefined; - cacheHit?: boolean | undefined; - ddlOperationPerformed?: string | undefined; - ddlTargetRoutine?: BigQuery.Schema.RoutineReference | undefined; - ddlTargetTable?: BigQuery.Schema.TableReference | undefined; - estimatedBytesProcessed?: string | undefined; - modelTraining?: BigQuery.Schema.BigQueryModelTraining | undefined; - modelTrainingCurrentIteration?: number | undefined; - modelTrainingExpectedTotalIteration?: string | undefined; - numDmlAffectedRows?: string | undefined; - queryPlan?: BigQuery.Schema.ExplainQueryStage[] | undefined; - referencedTables?: BigQuery.Schema.TableReference[] | undefined; - reservationUsage?: BigQuery.Schema.JobStatistics2ReservationUsage[] | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - statementType?: string | undefined; - timeline?: BigQuery.Schema.QueryTimelineSample[] | undefined; - totalBytesBilled?: string | undefined; - totalBytesProcessed?: string | undefined; - totalBytesProcessedAccuracy?: string | undefined; - totalPartitionsProcessed?: string | undefined; - totalSlotMs?: string | undefined; - undeclaredQueryParameters?: BigQuery.Schema.QueryParameter[] | undefined; - } - interface JobStatistics2ReservationUsage { - name?: string | undefined; - slotMs?: string | undefined; - } - interface JobStatistics3 { - badRecords?: string | undefined; - inputFileBytes?: string | undefined; - inputFiles?: string | undefined; - outputBytes?: string | undefined; - outputRows?: string | undefined; - } - interface JobStatistics4 { - destinationUriFileCounts?: string[] | undefined; - inputBytes?: string | undefined; - } - interface JobStatisticsReservationUsage { - name?: string | undefined; - slotMs?: string | undefined; - } - interface JobStatus { - errorResult?: BigQuery.Schema.ErrorProto | undefined; - errors?: BigQuery.Schema.ErrorProto[] | undefined; - state?: string | undefined; - } - interface MaterializedViewDefinition { - lastRefreshTime?: string | undefined; - query?: string | undefined; - } - interface ModelDefinition { - modelOptions?: BigQuery.Schema.ModelDefinitionModelOptions | undefined; - trainingRuns?: BigQuery.Schema.BqmlTrainingRun[] | undefined; - } - interface ModelDefinitionModelOptions { - labels?: string[] | undefined; - lossType?: string | undefined; - modelType?: string | undefined; - } - interface ProjectList { - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - projects?: BigQuery.Schema.ProjectListProjects[] | undefined; - totalItems?: number | undefined; - } - interface ProjectListProjects { - friendlyName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - numericId?: string | undefined; - projectReference?: BigQuery.Schema.ProjectReference | undefined; - } - interface ProjectReference { - projectId?: string | undefined; - } - interface QueryParameter { - name?: string | undefined; - parameterType?: BigQuery.Schema.QueryParameterType | undefined; - parameterValue?: BigQuery.Schema.QueryParameterValue | undefined; - } - interface QueryParameterType { - arrayType?: BigQuery.Schema.QueryParameterType | undefined; - structTypes?: BigQuery.Schema.QueryParameterTypeStructTypes[] | undefined; - type?: string | undefined; - } - interface QueryParameterTypeStructTypes { - description?: string | undefined; - name?: string | undefined; - type?: BigQuery.Schema.QueryParameterType | undefined; - } - interface QueryParameterValue { - arrayValues?: BigQuery.Schema.QueryParameterValue[] | undefined; - structValues?: object | undefined; - value?: string | undefined; - } - interface QueryRequest { - defaultDataset?: BigQuery.Schema.DatasetReference | undefined; - dryRun?: boolean | undefined; - kind?: string | undefined; - location?: string | undefined; - maxResults?: number | undefined; - parameterMode?: string | undefined; - preserveNulls?: boolean | undefined; - query?: string | undefined; - queryParameters?: BigQuery.Schema.QueryParameter[] | undefined; - timeoutMs?: number | undefined; - useLegacySql?: boolean | undefined; - useQueryCache?: boolean | undefined; - } - interface QueryResponse { - cacheHit?: boolean | undefined; - errors?: BigQuery.Schema.ErrorProto[] | undefined; - jobComplete?: boolean | undefined; - jobReference?: BigQuery.Schema.JobReference | undefined; - kind?: string | undefined; - numDmlAffectedRows?: string | undefined; - pageToken?: string | undefined; - rows?: BigQuery.Schema.TableRow[] | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - totalBytesProcessed?: string | undefined; - totalRows?: string | undefined; - } - interface QueryTimelineSample { - activeUnits?: string | undefined; - completedUnits?: string | undefined; - elapsedMs?: string | undefined; - pendingUnits?: string | undefined; - totalSlotMs?: string | undefined; - } - interface RangePartitioning { - field?: string | undefined; - range?: BigQuery.Schema.RangePartitioningRange | undefined; - } - interface RangePartitioningRange { - end?: string | undefined; - interval?: string | undefined; - start?: string | undefined; - } - interface RoutineReference { - datasetId?: string | undefined; - projectId?: string | undefined; - routineId?: string | undefined; - } - interface Streamingbuffer { - estimatedBytes?: string | undefined; - estimatedRows?: string | undefined; - oldestEntryTime?: string | undefined; - } - interface Table { - clustering?: BigQuery.Schema.Clustering | undefined; - creationTime?: string | undefined; - description?: string | undefined; - encryptionConfiguration?: BigQuery.Schema.EncryptionConfiguration | undefined; - etag?: string | undefined; - expirationTime?: string | undefined; - externalDataConfiguration?: BigQuery.Schema.ExternalDataConfiguration | undefined; - friendlyName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - labels?: object | undefined; - lastModifiedTime?: string | undefined; - location?: string | undefined; - materializedView?: BigQuery.Schema.MaterializedViewDefinition | undefined; - model?: BigQuery.Schema.ModelDefinition | undefined; - numBytes?: string | undefined; - numLongTermBytes?: string | undefined; - numPhysicalBytes?: string | undefined; - numRows?: string | undefined; - rangePartitioning?: BigQuery.Schema.RangePartitioning | undefined; - requirePartitionFilter?: boolean | undefined; - schema?: BigQuery.Schema.TableSchema | undefined; - selfLink?: string | undefined; - streamingBuffer?: BigQuery.Schema.Streamingbuffer | undefined; - tableReference?: BigQuery.Schema.TableReference | undefined; - timePartitioning?: BigQuery.Schema.TimePartitioning | undefined; - type?: string | undefined; - view?: BigQuery.Schema.ViewDefinition | undefined; - } - interface TableCell { - v?: object | undefined; - } - interface TableDataInsertAllRequest { - ignoreUnknownValues?: boolean | undefined; - kind?: string | undefined; - rows?: BigQuery.Schema.TableDataInsertAllRequestRows[] | undefined; - skipInvalidRows?: boolean | undefined; - templateSuffix?: string | undefined; - } - interface TableDataInsertAllRequestRows { - insertId?: string | undefined; - json?: object | undefined; - } - interface TableDataInsertAllResponse { - insertErrors?: BigQuery.Schema.TableDataInsertAllResponseInsertErrors[] | undefined; - kind?: string | undefined; - } - interface TableDataInsertAllResponseInsertErrors { - errors?: BigQuery.Schema.ErrorProto[] | undefined; - index?: number | undefined; - } - interface TableDataList { - etag?: string | undefined; - kind?: string | undefined; - pageToken?: string | undefined; - rows?: BigQuery.Schema.TableRow[] | undefined; - totalRows?: string | undefined; - } - interface TableFieldSchema { - categories?: BigQuery.Schema.TableFieldSchemaCategories | undefined; - description?: string | undefined; - fields?: BigQuery.Schema.TableFieldSchema[] | undefined; - mode?: string | undefined; - name?: string | undefined; - type?: string | undefined; - } - interface TableFieldSchemaCategories { - names?: string[] | undefined; - } - interface TableList { - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - tables?: BigQuery.Schema.TableListTables[] | undefined; - totalItems?: number | undefined; - } - interface TableListTables { - clustering?: BigQuery.Schema.Clustering | undefined; - creationTime?: string | undefined; - expirationTime?: string | undefined; - friendlyName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - labels?: object | undefined; - tableReference?: BigQuery.Schema.TableReference | undefined; - timePartitioning?: BigQuery.Schema.TimePartitioning | undefined; - type?: string | undefined; - view?: BigQuery.Schema.TableListTablesView | undefined; - } - interface TableListTablesView { - useLegacySql?: boolean | undefined; - } - interface TableReference { - datasetId?: string | undefined; - projectId?: string | undefined; - tableId?: string | undefined; - } - interface TableRow { - f?: BigQuery.Schema.TableCell[] | undefined; - } - interface TableSchema { - fields?: BigQuery.Schema.TableFieldSchema[] | undefined; - } - interface TimePartitioning { - expirationMs?: string | undefined; - field?: string | undefined; - requirePartitionFilter?: boolean | undefined; - type?: string | undefined; - } - interface UserDefinedFunctionResource { - inlineCode?: string | undefined; - resourceUri?: string | undefined; - } - interface ViewDefinition { - query?: string | undefined; - useLegacySql?: boolean | undefined; - userDefinedFunctionResources?: BigQuery.Schema.UserDefinedFunctionResource[] | undefined; - } - } - } - interface BigQuery { - Datasets?: BigQuery.Collection.DatasetsCollection | undefined; - Jobs?: BigQuery.Collection.JobsCollection | undefined; - Projects?: BigQuery.Collection.ProjectsCollection | undefined; - Tabledata?: BigQuery.Collection.TabledataCollection | undefined; - Tables?: BigQuery.Collection.TablesCollection | undefined; - // Create a new instance of BigQueryModelTraining - newBigQueryModelTraining(): BigQuery.Schema.BigQueryModelTraining; - // Create a new instance of BigtableColumn - newBigtableColumn(): BigQuery.Schema.BigtableColumn; - // Create a new instance of BigtableColumnFamily - newBigtableColumnFamily(): BigQuery.Schema.BigtableColumnFamily; - // Create a new instance of BigtableOptions - newBigtableOptions(): BigQuery.Schema.BigtableOptions; - // Create a new instance of BqmlIterationResult - newBqmlIterationResult(): BigQuery.Schema.BqmlIterationResult; - // Create a new instance of BqmlTrainingRun - newBqmlTrainingRun(): BigQuery.Schema.BqmlTrainingRun; - // Create a new instance of BqmlTrainingRunTrainingOptions - newBqmlTrainingRunTrainingOptions(): BigQuery.Schema.BqmlTrainingRunTrainingOptions; - // Create a new instance of Clustering - newClustering(): BigQuery.Schema.Clustering; - // Create a new instance of CsvOptions - newCsvOptions(): BigQuery.Schema.CsvOptions; - // Create a new instance of Dataset - newDataset(): BigQuery.Schema.Dataset; - // Create a new instance of DatasetAccess - newDatasetAccess(): BigQuery.Schema.DatasetAccess; - // Create a new instance of DatasetReference - newDatasetReference(): BigQuery.Schema.DatasetReference; - // Create a new instance of DestinationTableProperties - newDestinationTableProperties(): BigQuery.Schema.DestinationTableProperties; - // Create a new instance of EncryptionConfiguration - newEncryptionConfiguration(): BigQuery.Schema.EncryptionConfiguration; - // Create a new instance of ErrorProto - newErrorProto(): BigQuery.Schema.ErrorProto; - // Create a new instance of ExplainQueryStage - newExplainQueryStage(): BigQuery.Schema.ExplainQueryStage; - // Create a new instance of ExplainQueryStep - newExplainQueryStep(): BigQuery.Schema.ExplainQueryStep; - // Create a new instance of ExternalDataConfiguration - newExternalDataConfiguration(): BigQuery.Schema.ExternalDataConfiguration; - // Create a new instance of GoogleSheetsOptions - newGoogleSheetsOptions(): BigQuery.Schema.GoogleSheetsOptions; - // Create a new instance of Job - newJob(): BigQuery.Schema.Job; - // Create a new instance of JobConfiguration - newJobConfiguration(): BigQuery.Schema.JobConfiguration; - // Create a new instance of JobConfigurationExtract - newJobConfigurationExtract(): BigQuery.Schema.JobConfigurationExtract; - // Create a new instance of JobConfigurationLoad - newJobConfigurationLoad(): BigQuery.Schema.JobConfigurationLoad; - // Create a new instance of JobConfigurationQuery - newJobConfigurationQuery(): BigQuery.Schema.JobConfigurationQuery; - // Create a new instance of JobConfigurationTableCopy - newJobConfigurationTableCopy(): BigQuery.Schema.JobConfigurationTableCopy; - // Create a new instance of JobReference - newJobReference(): BigQuery.Schema.JobReference; - // Create a new instance of JobStatistics - newJobStatistics(): BigQuery.Schema.JobStatistics; - // Create a new instance of JobStatistics2 - newJobStatistics2(): BigQuery.Schema.JobStatistics2; - // Create a new instance of JobStatistics2ReservationUsage - newJobStatistics2ReservationUsage(): BigQuery.Schema.JobStatistics2ReservationUsage; - // Create a new instance of JobStatistics3 - newJobStatistics3(): BigQuery.Schema.JobStatistics3; - // Create a new instance of JobStatistics4 - newJobStatistics4(): BigQuery.Schema.JobStatistics4; - // Create a new instance of JobStatisticsReservationUsage - newJobStatisticsReservationUsage(): BigQuery.Schema.JobStatisticsReservationUsage; - // Create a new instance of JobStatus - newJobStatus(): BigQuery.Schema.JobStatus; - // Create a new instance of MaterializedViewDefinition - newMaterializedViewDefinition(): BigQuery.Schema.MaterializedViewDefinition; - // Create a new instance of ModelDefinition - newModelDefinition(): BigQuery.Schema.ModelDefinition; - // Create a new instance of ModelDefinitionModelOptions - newModelDefinitionModelOptions(): BigQuery.Schema.ModelDefinitionModelOptions; - // Create a new instance of QueryParameter - newQueryParameter(): BigQuery.Schema.QueryParameter; - // Create a new instance of QueryParameterType - newQueryParameterType(): BigQuery.Schema.QueryParameterType; - // Create a new instance of QueryParameterTypeStructTypes - newQueryParameterTypeStructTypes(): BigQuery.Schema.QueryParameterTypeStructTypes; - // Create a new instance of QueryParameterValue - newQueryParameterValue(): BigQuery.Schema.QueryParameterValue; - // Create a new instance of QueryRequest - newQueryRequest(): BigQuery.Schema.QueryRequest; - // Create a new instance of QueryTimelineSample - newQueryTimelineSample(): BigQuery.Schema.QueryTimelineSample; - // Create a new instance of RangePartitioning - newRangePartitioning(): BigQuery.Schema.RangePartitioning; - // Create a new instance of RangePartitioningRange - newRangePartitioningRange(): BigQuery.Schema.RangePartitioningRange; - // Create a new instance of RoutineReference - newRoutineReference(): BigQuery.Schema.RoutineReference; - // Create a new instance of Streamingbuffer - newStreamingbuffer(): BigQuery.Schema.Streamingbuffer; - // Create a new instance of Table - newTable(): BigQuery.Schema.Table; - // Create a new instance of TableDataInsertAllRequest - newTableDataInsertAllRequest(): BigQuery.Schema.TableDataInsertAllRequest; - // Create a new instance of TableDataInsertAllRequestRows - newTableDataInsertAllRequestRows(): BigQuery.Schema.TableDataInsertAllRequestRows; - // Create a new instance of TableFieldSchema - newTableFieldSchema(): BigQuery.Schema.TableFieldSchema; - // Create a new instance of TableFieldSchemaCategories - newTableFieldSchemaCategories(): BigQuery.Schema.TableFieldSchemaCategories; - // Create a new instance of TableReference - newTableReference(): BigQuery.Schema.TableReference; - // Create a new instance of TableSchema - newTableSchema(): BigQuery.Schema.TableSchema; - // Create a new instance of TimePartitioning - newTimePartitioning(): BigQuery.Schema.TimePartitioning; - // Create a new instance of UserDefinedFunctionResource - newUserDefinedFunctionResource(): BigQuery.Schema.UserDefinedFunctionResource; - // Create a new instance of ViewDefinition - newViewDefinition(): BigQuery.Schema.ViewDefinition; - } -} - -declare var BigQuery: GoogleAppsScript.BigQuery; diff --git a/node_modules/@types/google-apps-script/apis/calendar_v3.d.ts b/node_modules/@types/google-apps-script/apis/calendar_v3.d.ts deleted file mode 100644 index 141b833..0000000 --- a/node_modules/@types/google-apps-script/apis/calendar_v3.d.ts +++ /dev/null @@ -1,731 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Calendar { - namespace Collection { - interface AclCollection { - // Returns an access control rule. - get(calendarId: string, ruleId: string): Calendar.Schema.AclRule; - // Returns an access control rule. - get(calendarId: string, ruleId: string, optionalArgs: object, headers: object): Calendar.Schema.AclRule; - // Creates an access control rule. - insert(resource: Schema.AclRule, calendarId: string): Calendar.Schema.AclRule; - // Creates an access control rule. - insert(resource: Schema.AclRule, calendarId: string, optionalArgs: object): Calendar.Schema.AclRule; - // Creates an access control rule. - insert( - resource: Schema.AclRule, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.AclRule; - // Returns the rules in the access control list for the calendar. - list(calendarId: string): Calendar.Schema.Acl; - // Returns the rules in the access control list for the calendar. - list(calendarId: string, optionalArgs: object): Calendar.Schema.Acl; - // Returns the rules in the access control list for the calendar. - list(calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Acl; - // Updates an access control rule. This method supports patch semantics. - patch(resource: Schema.AclRule, calendarId: string, ruleId: string): Calendar.Schema.AclRule; - // Updates an access control rule. This method supports patch semantics. - patch( - resource: Schema.AclRule, - calendarId: string, - ruleId: string, - optionalArgs: object, - ): Calendar.Schema.AclRule; - // Updates an access control rule. This method supports patch semantics. - patch( - resource: Schema.AclRule, - calendarId: string, - ruleId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.AclRule; - // Deletes an access control rule. - remove(calendarId: string, ruleId: string): void; - // Deletes an access control rule. - remove(calendarId: string, ruleId: string, optionalArgs: object, headers: object): void; - // Updates an access control rule. - update(resource: Schema.AclRule, calendarId: string, ruleId: string): Calendar.Schema.AclRule; - // Updates an access control rule. - update( - resource: Schema.AclRule, - calendarId: string, - ruleId: string, - optionalArgs: object, - ): Calendar.Schema.AclRule; - // Updates an access control rule. - update( - resource: Schema.AclRule, - calendarId: string, - ruleId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.AclRule; - // Watch for changes to ACL resources. - watch(resource: Schema.Channel, calendarId: string): Calendar.Schema.Channel; - // Watch for changes to ACL resources. - watch(resource: Schema.Channel, calendarId: string, optionalArgs: object): Calendar.Schema.Channel; - // Watch for changes to ACL resources. - watch( - resource: Schema.Channel, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Channel; - } - interface CalendarListCollection { - // Returns a calendar from the user's calendar list. - get(calendarId: string): Calendar.Schema.CalendarListEntry; - // Returns a calendar from the user's calendar list. - get(calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.CalendarListEntry; - // Inserts an existing calendar into the user's calendar list. - insert(resource: Schema.CalendarListEntry): Calendar.Schema.CalendarListEntry; - // Inserts an existing calendar into the user's calendar list. - insert(resource: Schema.CalendarListEntry, optionalArgs: object): Calendar.Schema.CalendarListEntry; - // Inserts an existing calendar into the user's calendar list. - insert( - resource: Schema.CalendarListEntry, - optionalArgs: object, - headers: object, - ): Calendar.Schema.CalendarListEntry; - // Returns the calendars on the user's calendar list. - list(): Calendar.Schema.CalendarList; - // Returns the calendars on the user's calendar list. - list(optionalArgs: object): Calendar.Schema.CalendarList; - // Returns the calendars on the user's calendar list. - list(optionalArgs: object, headers: object): Calendar.Schema.CalendarList; - // Updates an existing calendar on the user's calendar list. This method supports patch semantics. - patch(resource: Schema.CalendarListEntry, calendarId: string): Calendar.Schema.CalendarListEntry; - // Updates an existing calendar on the user's calendar list. This method supports patch semantics. - patch( - resource: Schema.CalendarListEntry, - calendarId: string, - optionalArgs: object, - ): Calendar.Schema.CalendarListEntry; - // Updates an existing calendar on the user's calendar list. This method supports patch semantics. - patch( - resource: Schema.CalendarListEntry, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.CalendarListEntry; - // Removes a calendar from the user's calendar list. - remove(calendarId: string): void; - // Removes a calendar from the user's calendar list. - remove(calendarId: string, optionalArgs: object, headers: object): void; - // Updates an existing calendar on the user's calendar list. - update(resource: Schema.CalendarListEntry, calendarId: string): Calendar.Schema.CalendarListEntry; - // Updates an existing calendar on the user's calendar list. - update( - resource: Schema.CalendarListEntry, - calendarId: string, - optionalArgs: object, - ): Calendar.Schema.CalendarListEntry; - // Updates an existing calendar on the user's calendar list. - update( - resource: Schema.CalendarListEntry, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.CalendarListEntry; - // Watch for changes to CalendarList resources. - watch(resource: Schema.Channel): Calendar.Schema.Channel; - // Watch for changes to CalendarList resources. - watch(resource: Schema.Channel, optionalArgs: object): Calendar.Schema.Channel; - // Watch for changes to CalendarList resources. - watch(resource: Schema.Channel, optionalArgs: object, headers: object): Calendar.Schema.Channel; - } - interface CalendarsCollection { - // Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. - clear(calendarId: string): void; - // Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. - clear(calendarId: string, optionalArgs: object, headers: object): void; - // Returns metadata for a calendar. - get(calendarId: string): Calendar.Schema.Calendar; - // Returns metadata for a calendar. - get(calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Calendar; - // Creates a secondary calendar. - insert(resource: Schema.Calendar): Calendar.Schema.Calendar; - // Creates a secondary calendar. - insert(resource: Schema.Calendar, optionalArgs: object, headers: object): Calendar.Schema.Calendar; - // Updates metadata for a calendar. This method supports patch semantics. - patch(resource: Schema.Calendar, calendarId: string): Calendar.Schema.Calendar; - // Updates metadata for a calendar. This method supports patch semantics. - patch( - resource: Schema.Calendar, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Calendar; - // Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. - remove(calendarId: string): void; - // Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. - remove(calendarId: string, optionalArgs: object, headers: object): void; - // Updates metadata for a calendar. - update(resource: Schema.Calendar, calendarId: string): Calendar.Schema.Calendar; - // Updates metadata for a calendar. - update( - resource: Schema.Calendar, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Calendar; - } - interface ChannelsCollection { - // Stop watching resources through this channel - stop(resource: Schema.Channel): void; - // Stop watching resources through this channel - stop(resource: Schema.Channel, optionalArgs: object, headers: object): void; - } - interface ColorsCollection { - // Returns the color definitions for calendars and events. - get(): Calendar.Schema.Colors; - // Returns the color definitions for calendars and events. - get(optionalArgs: object, headers: object): Calendar.Schema.Colors; - } - interface EventsCollection { - // Returns an event. - get(calendarId: string, eventId: string): Calendar.Schema.Event; - // Returns an event. - get(calendarId: string, eventId: string, optionalArgs: object): Calendar.Schema.Event; - // Returns an event. - get(calendarId: string, eventId: string, optionalArgs: object, headers: object): Calendar.Schema.Event; - // Imports an event. This operation is used to add a private copy of an existing event to a calendar. - import(resource: Schema.Event, calendarId: string): Calendar.Schema.Event; - // Imports an event. This operation is used to add a private copy of an existing event to a calendar. - import(resource: Schema.Event, calendarId: string, optionalArgs: object): Calendar.Schema.Event; - // Imports an event. This operation is used to add a private copy of an existing event to a calendar. - import( - resource: Schema.Event, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Creates an event. - insert(resource: Schema.Event, calendarId: string): Calendar.Schema.Event; - // Creates an event. - insert(resource: Schema.Event, calendarId: string, optionalArgs: object): Calendar.Schema.Event; - // Creates an event. - insert( - resource: Schema.Event, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Returns instances of the specified recurring event. - instances(calendarId: string, eventId: string): Calendar.Schema.Events; - // Returns instances of the specified recurring event. - instances(calendarId: string, eventId: string, optionalArgs: object): Calendar.Schema.Events; - // Returns instances of the specified recurring event. - instances( - calendarId: string, - eventId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Events; - // Returns events on the specified calendar. - list(calendarId: string): Calendar.Schema.Events; - // Returns events on the specified calendar. - list(calendarId: string, optionalArgs: object): Calendar.Schema.Events; - // Returns events on the specified calendar. - list(calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Events; - // Moves an event to another calendar, i.e. changes an event's organizer. - move(calendarId: string, eventId: string, destination: string): Calendar.Schema.Event; - // Moves an event to another calendar, i.e. changes an event's organizer. - move( - calendarId: string, - eventId: string, - destination: string, - optionalArgs: object, - ): Calendar.Schema.Event; - // Moves an event to another calendar, i.e. changes an event's organizer. - move( - calendarId: string, - eventId: string, - destination: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Updates an event. This method supports patch semantics. - patch(resource: Schema.Event, calendarId: string, eventId: string): Calendar.Schema.Event; - // Updates an event. This method supports patch semantics. - patch( - resource: Schema.Event, - calendarId: string, - eventId: string, - optionalArgs: object, - ): Calendar.Schema.Event; - // Updates an event. This method supports patch semantics. - patch( - resource: Schema.Event, - calendarId: string, - eventId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Creates an event based on a simple text string. - quickAdd(calendarId: string, text: string): Calendar.Schema.Event; - // Creates an event based on a simple text string. - quickAdd(calendarId: string, text: string, optionalArgs: object): Calendar.Schema.Event; - // Creates an event based on a simple text string. - quickAdd( - calendarId: string, - text: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Deletes an event. - remove(calendarId: string, eventId: string): void; - // Deletes an event. - remove(calendarId: string, eventId: string, optionalArgs: object): void; - // Deletes an event. - remove(calendarId: string, eventId: string, optionalArgs: object, headers: object): void; - // Updates an event. - update(resource: Schema.Event, calendarId: string, eventId: string): Calendar.Schema.Event; - // Updates an event. - update( - resource: Schema.Event, - calendarId: string, - eventId: string, - optionalArgs: object, - ): Calendar.Schema.Event; - // Updates an event. - update( - resource: Schema.Event, - calendarId: string, - eventId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Event; - // Watch for changes to Events resources. - watch(resource: Schema.Channel, calendarId: string): Calendar.Schema.Channel; - // Watch for changes to Events resources. - watch(resource: Schema.Channel, calendarId: string, optionalArgs: object): Calendar.Schema.Channel; - // Watch for changes to Events resources. - watch( - resource: Schema.Channel, - calendarId: string, - optionalArgs: object, - headers: object, - ): Calendar.Schema.Channel; - } - interface FreebusyCollection { - // Returns free/busy information for a set of calendars. - query(resource: Schema.FreeBusyRequest): Calendar.Schema.FreeBusyResponse; - // Returns free/busy information for a set of calendars. - query( - resource: Schema.FreeBusyRequest, - optionalArgs: object, - headers: object, - ): Calendar.Schema.FreeBusyResponse; - } - interface SettingsCollection { - // Returns a single user setting. - get(setting: string): Calendar.Schema.Setting; - // Returns a single user setting. - get(setting: string, optionalArgs: object, headers: object): Calendar.Schema.Setting; - // Returns all user settings for the authenticated user. - list(): Calendar.Schema.Settings; - // Returns all user settings for the authenticated user. - list(optionalArgs: object): Calendar.Schema.Settings; - // Returns all user settings for the authenticated user. - list(optionalArgs: object, headers: object): Calendar.Schema.Settings; - // Watch for changes to Settings resources. - watch(resource: Schema.Channel): Calendar.Schema.Channel; - // Watch for changes to Settings resources. - watch(resource: Schema.Channel, optionalArgs: object): Calendar.Schema.Channel; - // Watch for changes to Settings resources. - watch(resource: Schema.Channel, optionalArgs: object, headers: object): Calendar.Schema.Channel; - } - } - namespace Schema { - interface Acl { - etag?: string | undefined; - items?: Calendar.Schema.AclRule[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - } - interface AclRule { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - role?: string | undefined; - scope?: Calendar.Schema.AclRuleScope | undefined; - } - interface AclRuleScope { - type?: string | undefined; - value?: string | undefined; - } - interface Calendar { - conferenceProperties?: Calendar.Schema.ConferenceProperties | undefined; - description?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - location?: string | undefined; - summary?: string | undefined; - timeZone?: string | undefined; - } - interface CalendarList { - etag?: string | undefined; - items?: Calendar.Schema.CalendarListEntry[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - } - interface CalendarListEntry { - accessRole?: string | undefined; - backgroundColor?: string | undefined; - colorId?: string | undefined; - conferenceProperties?: Calendar.Schema.ConferenceProperties | undefined; - defaultReminders?: Calendar.Schema.EventReminder[] | undefined; - deleted?: boolean | undefined; - description?: string | undefined; - etag?: string | undefined; - foregroundColor?: string | undefined; - hidden?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - location?: string | undefined; - notificationSettings?: Calendar.Schema.CalendarListEntryNotificationSettings | undefined; - primary?: boolean | undefined; - selected?: boolean | undefined; - summary?: string | undefined; - summaryOverride?: string | undefined; - timeZone?: string | undefined; - } - interface CalendarListEntryNotificationSettings { - notifications?: Calendar.Schema.CalendarNotification[] | undefined; - } - interface CalendarNotification { - method?: string | undefined; - type?: string | undefined; - } - interface Channel { - address?: string | undefined; - expiration?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - params?: object | undefined; - payload?: boolean | undefined; - resourceId?: string | undefined; - resourceUri?: string | undefined; - token?: string | undefined; - type?: string | undefined; - } - interface ColorDefinition { - background?: string | undefined; - foreground?: string | undefined; - } - interface Colors { - calendar?: object | undefined; - event?: object | undefined; - kind?: string | undefined; - updated?: string | undefined; - } - interface ConferenceData { - conferenceId?: string | undefined; - conferenceSolution?: Calendar.Schema.ConferenceSolution | undefined; - createRequest?: Calendar.Schema.CreateConferenceRequest | undefined; - entryPoints?: Calendar.Schema.EntryPoint[] | undefined; - notes?: string | undefined; - parameters?: Calendar.Schema.ConferenceParameters | undefined; - signature?: string | undefined; - } - interface ConferenceParameters { - addOnParameters?: Calendar.Schema.ConferenceParametersAddOnParameters | undefined; - } - interface ConferenceParametersAddOnParameters { - parameters?: Record | undefined; - } - interface ConferenceProperties { - allowedConferenceSolutionTypes?: string[] | undefined; - } - interface ConferenceRequestStatus { - statusCode?: string | undefined; - } - interface ConferenceSolution { - iconUri?: string | undefined; - key?: Calendar.Schema.ConferenceSolutionKey | undefined; - name?: string | undefined; - } - interface ConferenceSolutionKey { - type?: string | undefined; - } - interface CreateConferenceRequest { - conferenceSolutionKey?: Calendar.Schema.ConferenceSolutionKey | undefined; - requestId?: string | undefined; - status?: Calendar.Schema.ConferenceRequestStatus | undefined; - } - interface EntryPoint { - accessCode?: string | undefined; - entryPointFeatures?: string[] | undefined; - entryPointType?: string | undefined; - label?: string | undefined; - meetingCode?: string | undefined; - passcode?: string | undefined; - password?: string | undefined; - pin?: string | undefined; - regionCode?: string | undefined; - uri?: string | undefined; - } - interface Error { - domain?: string | undefined; - reason?: string | undefined; - } - interface Event { - anyoneCanAddSelf?: boolean | undefined; - attachments?: Calendar.Schema.EventAttachment[] | undefined; - attendees?: Calendar.Schema.EventAttendee[] | undefined; - attendeesOmitted?: boolean | undefined; - colorId?: string | undefined; - conferenceData?: Calendar.Schema.ConferenceData | undefined; - created?: string | undefined; - creator?: Calendar.Schema.EventCreator | undefined; - description?: string | undefined; - end?: Calendar.Schema.EventDateTime | undefined; - endTimeUnspecified?: boolean | undefined; - etag?: string | undefined; - eventType?: "default" | "outOfOffice" | "focusTime" | "workingLocation"; - extendedProperties?: Calendar.Schema.EventExtendedProperties | undefined; - gadget?: Calendar.Schema.EventGadget | undefined; - guestsCanInviteOthers?: boolean | undefined; - guestsCanModify?: boolean | undefined; - guestsCanSeeOtherGuests?: boolean | undefined; - hangoutLink?: string | undefined; - htmlLink?: string | undefined; - iCalUID?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - location?: string | undefined; - locked?: boolean | undefined; - organizer?: Calendar.Schema.EventOrganizer | undefined; - originalStartTime?: Calendar.Schema.EventDateTime | undefined; - privateCopy?: boolean | undefined; - recurrence?: string[] | undefined; - recurringEventId?: string | undefined; - reminders?: Calendar.Schema.EventReminders | undefined; - sequence?: number | undefined; - source?: Calendar.Schema.EventSource | undefined; - start?: Calendar.Schema.EventDateTime | undefined; - status?: string | undefined; - summary?: string | undefined; - transparency?: string | undefined; - updated?: string | undefined; - visibility?: string | undefined; - workingLocationProperties?: Calendar.Schema.EventWorkingLocationProperties | undefined; - } - interface EventAttachment { - fileId?: string | undefined; - fileUrl?: string | undefined; - iconLink?: string | undefined; - mimeType?: string | undefined; - title?: string | undefined; - } - interface EventAttendee { - additionalGuests?: number | undefined; - comment?: string | undefined; - displayName?: string | undefined; - email?: string | undefined; - id?: string | undefined; - optional?: boolean | undefined; - organizer?: boolean | undefined; - resource?: boolean | undefined; - responseStatus?: string | undefined; - self?: boolean | undefined; - } - interface EventCreator { - displayName?: string | undefined; - email?: string | undefined; - id?: string | undefined; - self?: boolean | undefined; - } - interface EventDateTime { - date?: string | undefined; - dateTime?: string | undefined; - timeZone?: string | undefined; - } - interface EventExtendedProperties { - private?: Record | undefined; - shared?: Record | undefined; - } - interface EventGadget { - display?: string | undefined; - height?: number | undefined; - iconLink?: string | undefined; - link?: string | undefined; - preferences?: object | undefined; - title?: string | undefined; - type?: string | undefined; - width?: number | undefined; - } - interface EventOrganizer { - displayName?: string | undefined; - email?: string | undefined; - id?: string | undefined; - self?: boolean | undefined; - } - interface EventReminder { - method?: string | undefined; - minutes?: number | undefined; - } - interface EventReminders { - overrides?: Calendar.Schema.EventReminder[] | undefined; - useDefault?: boolean | undefined; - } - interface EventSource { - title?: string | undefined; - url?: string | undefined; - } - interface Events { - accessRole?: string | undefined; - defaultReminders?: Calendar.Schema.EventReminder[] | undefined; - description?: string | undefined; - etag?: string | undefined; - items?: Calendar.Schema.Event[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - summary?: string | undefined; - timeZone?: string | undefined; - updated?: string | undefined; - } - interface FreeBusyCalendar { - busy?: Calendar.Schema.TimePeriod[] | undefined; - errors?: Calendar.Schema.Error[] | undefined; - } - interface FreeBusyGroup { - calendars?: string[] | undefined; - errors?: Calendar.Schema.Error[] | undefined; - } - interface FreeBusyRequest { - calendarExpansionMax?: number | undefined; - groupExpansionMax?: number | undefined; - items?: Calendar.Schema.FreeBusyRequestItem[] | undefined; - timeMax?: string | undefined; - timeMin?: string | undefined; - timeZone?: string | undefined; - } - interface FreeBusyRequestItem { - id?: string | undefined; - } - interface FreeBusyResponse { - calendars?: object | undefined; - groups?: object | undefined; - kind?: string | undefined; - timeMax?: string | undefined; - timeMin?: string | undefined; - } - interface Setting { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - value?: string | undefined; - } - interface Settings { - etag?: string | undefined; - items?: Calendar.Schema.Setting[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - } - interface TimePeriod { - end?: string | undefined; - start?: string | undefined; - } - interface EventWorkingLocationPropertiesOfficeLocation { - buildingId?: string | undefined; - floorId?: string | undefined; - floorSectionId?: string | undefined; - deskId?: string | undefined; - label?: string | undefined; - } - interface EventWorkingLocationPropertiesCustomLocation { - label: string; - } - interface EventWorkingLocationProperties { - type?: string | undefined; - homeOffice?: object | undefined; - customLocation?: EventWorkingLocationPropertiesCustomLocation | undefined; - officeLocation?: EventWorkingLocationPropertiesOfficeLocation | undefined; - } - } - } - interface Calendar { - Acl?: Calendar.Collection.AclCollection | undefined; - CalendarList?: Calendar.Collection.CalendarListCollection | undefined; - Calendars?: Calendar.Collection.CalendarsCollection | undefined; - Channels?: Calendar.Collection.ChannelsCollection | undefined; - Colors?: Calendar.Collection.ColorsCollection | undefined; - Events?: Calendar.Collection.EventsCollection | undefined; - Freebusy?: Calendar.Collection.FreebusyCollection | undefined; - Settings?: Calendar.Collection.SettingsCollection | undefined; - // Create a new instance of AclRule - newAclRule(): Calendar.Schema.AclRule; - // Create a new instance of AclRuleScope - newAclRuleScope(): Calendar.Schema.AclRuleScope; - // Create a new instance of Calendar - newCalendar(): Calendar.Schema.Calendar; - // Create a new instance of CalendarListEntry - newCalendarListEntry(): Calendar.Schema.CalendarListEntry; - // Create a new instance of CalendarListEntryNotificationSettings - newCalendarListEntryNotificationSettings(): Calendar.Schema.CalendarListEntryNotificationSettings; - // Create a new instance of CalendarNotification - newCalendarNotification(): Calendar.Schema.CalendarNotification; - // Create a new instance of Channel - newChannel(): Calendar.Schema.Channel; - // Create a new instance of ConferenceData - newConferenceData(): Calendar.Schema.ConferenceData; - // Create a new instance of ConferenceParameters - newConferenceParameters(): Calendar.Schema.ConferenceParameters; - // Create a new instance of ConferenceParametersAddOnParameters - newConferenceParametersAddOnParameters(): Calendar.Schema.ConferenceParametersAddOnParameters; - // Create a new instance of ConferenceProperties - newConferenceProperties(): Calendar.Schema.ConferenceProperties; - // Create a new instance of ConferenceRequestStatus - newConferenceRequestStatus(): Calendar.Schema.ConferenceRequestStatus; - // Create a new instance of ConferenceSolution - newConferenceSolution(): Calendar.Schema.ConferenceSolution; - // Create a new instance of ConferenceSolutionKey - newConferenceSolutionKey(): Calendar.Schema.ConferenceSolutionKey; - // Create a new instance of CreateConferenceRequest - newCreateConferenceRequest(): Calendar.Schema.CreateConferenceRequest; - // Create a new instance of EntryPoint - newEntryPoint(): Calendar.Schema.EntryPoint; - // Create a new instance of Event - newEvent(): Calendar.Schema.Event; - // Create a new instance of EventAttachment - newEventAttachment(): Calendar.Schema.EventAttachment; - // Create a new instance of EventAttendee - newEventAttendee(): Calendar.Schema.EventAttendee; - // Create a new instance of EventCreator - newEventCreator(): Calendar.Schema.EventCreator; - // Create a new instance of EventDateTime - newEventDateTime(): Calendar.Schema.EventDateTime; - // Create a new instance of EventExtendedProperties - newEventExtendedProperties(): Calendar.Schema.EventExtendedProperties; - // Create a new instance of EventGadget - newEventGadget(): Calendar.Schema.EventGadget; - // Create a new instance of EventOrganizer - newEventOrganizer(): Calendar.Schema.EventOrganizer; - // Create a new instance of EventReminder - newEventReminder(): Calendar.Schema.EventReminder; - // Create a new instance of EventReminders - newEventReminders(): Calendar.Schema.EventReminders; - // Create a new instance of EventSource - newEventSource(): Calendar.Schema.EventSource; - // Create a new instance of FreeBusyRequest - newFreeBusyRequest(): Calendar.Schema.FreeBusyRequest; - // Create a new instance of FreeBusyRequestItem - newFreeBusyRequestItem(): Calendar.Schema.FreeBusyRequestItem; - // Create a new instance of EventWorkingLocationProperties - newEventWorkingLocationProperties(): Calendar.Schema.EventWorkingLocationProperties; - // Create a new instance of EventWorkingLocationPropertiesCustomLocation - newEventWorkingLocationPropertiesCustomLocation(): Calendar.Schema.EventWorkingLocationPropertiesCustomLocation; - // Create a new instance of EventWorkingLocationPropertiesOfficeLocation - newEventWorkingLocationPropertiesOfficeLocation(): Calendar.Schema.EventWorkingLocationPropertiesOfficeLocation; - } -} - -declare var Calendar: GoogleAppsScript.Calendar; diff --git a/node_modules/@types/google-apps-script/apis/classroom_v1.d.ts b/node_modules/@types/google-apps-script/apis/classroom_v1.d.ts deleted file mode 100644 index 78cbdde..0000000 --- a/node_modules/@types/google-apps-script/apis/classroom_v1.d.ts +++ /dev/null @@ -1,946 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Classroom { - namespace Collection { - namespace Courses { - namespace CourseWork { - interface StudentSubmissionsCollection { - // Returns a student submission. - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, course work, or student submission or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - get(courseId: string, courseWorkId: string, id: string): Classroom.Schema.StudentSubmission; - // Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string, courseWorkId: string): Classroom.Schema.ListStudentSubmissionsResponse; - // Returns a list of student submissions that the requester is permitted to view, factoring in the OAuth scopes of the request. `-` may be specified as the `course_work_id` to include student submissions for multiple course work items. Course students may only view their own work. Course teachers and domain administrators may view all student submissions. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list( - courseId: string, - courseWorkId: string, - optionalArgs: object, - ): Classroom.Schema.ListStudentSubmissionsResponse; - // Modifies attachments of student submission. Attachments may only be added to student submissions belonging to course work objects with a `workType` of `ASSIGNMENT`. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, if the user is not permitted to modify attachments on the requested student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - modifyAttachments( - resource: Schema.ModifyAttachmentsRequest, - courseId: string, - courseWorkId: string, - id: string, - ): Classroom.Schema.StudentSubmission; - // Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - patch( - resource: Schema.StudentSubmission, - courseId: string, - courseWorkId: string, - id: string, - ): Classroom.Schema.StudentSubmission; - // Updates one or more fields of a student submission. See google.classroom.v1.StudentSubmission for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - patch( - resource: Schema.StudentSubmission, - courseId: string, - courseWorkId: string, - id: string, - optionalArgs: object, - ): Classroom.Schema.StudentSubmission; - // Reclaims a student submission on behalf of the student that owns it. Reclaiming a student submission transfers ownership of attached Drive files to the student and updates the submission state. Only the student that owns the requested student submission may call this method, and only for a student submission that has been turned in. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, unsubmit the requested student submission, or for access errors. - // *`FAILED_PRECONDITION` if the student submission has not been turned in. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - reclaim(courseId: string, courseWorkId: string, id: string): void; - // Returns a student submission. Returning a student submission transfers ownership of attached Drive files to the student and may also update the submission state. Unlike the Classroom application, returning a student submission does not set assignedGrade to the draftGrade value. Only a teacher of the course that contains the requested student submission may call this method. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, return the requested student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - return(rcourseId: string, courseWorkId: string, id: string): void; - // Turns in a student submission. Turning in a student submission transfers ownership of attached Drive files to the teacher and may also update the submission state. This may only be called by the student that owns the specified student submission. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, turn in the requested student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - turnIn(courseId: string, courseWorkId: string, id: string): void; - } - } - interface AliasesCollection { - // Creates an alias for a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create the alias or for access errors. - // *`NOT_FOUND` if the course does not exist. - // *`ALREADY_EXISTS` if the alias already exists. - // *`FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to access a domain-scoped alias). - create(resource: Schema.CourseAlias, courseId: string): Classroom.Schema.CourseAlias; - // Returns a list of aliases for a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. - // *`NOT_FOUND` if the course does not exist. - list(courseId: string): Classroom.Schema.ListCourseAliasesResponse; - // Returns a list of aliases for a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the course or for access errors. - // *`NOT_FOUND` if the course does not exist. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseAliasesResponse; - // Deletes an alias of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to remove the alias or for access errors. - // *`NOT_FOUND` if the alias does not exist. - // *`FAILED_PRECONDITION` if the alias requested does not make sense for the requesting user or course (for example, if a user not in a domain attempts to delete a domain-scoped alias). - remove(courseId: string, alias: string): void; - } - interface AnnouncementsCollection { - // Creates an announcement. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create announcements in the requested course, share a Drive attachment, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - // *`FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible - create(resource: Schema.Announcement, courseId: string): Classroom.Schema.Announcement; - // Returns an announcement. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or announcement, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or announcement does not exist. - get(courseId: string, id: string): Classroom.Schema.Announcement; - // Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string): Classroom.Schema.ListAnnouncementsResponse; - // Returns a list of announcements that the requester is permitted to view. Course students may only view `PUBLISHED` announcements. Course teachers and domain administrators may view all announcements. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListAnnouncementsResponse; - // Modifies assignee mode and options of an announcement. Only a teacher of the course that contains the announcement may call this method. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or course work does not exist. - modifyAssignees( - resource: Schema.ModifyAnnouncementAssigneesRequest, - courseId: string, - id: string, - ): Classroom.Schema.Announcement; - // Updates one or more fields of an announcement. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested announcement has already been deleted. - // *`NOT_FOUND` if the requested course or announcement does not exist - patch(resource: Schema.Announcement, courseId: string, id: string): Classroom.Schema.Announcement; - // Updates one or more fields of an announcement. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested announcement has already been deleted. - // *`NOT_FOUND` if the requested course or announcement does not exist - patch( - resource: Schema.Announcement, - courseId: string, - id: string, - optionalArgs: object, - ): Classroom.Schema.Announcement; - // Deletes an announcement. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding announcement item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding announcement, if the requesting user is not permitted to delete the requested course or for access errors. - // *`FAILED_PRECONDITION` if the requested announcement has already been deleted. - // *`NOT_FOUND` if no course exists with the requested ID. - remove(courseId: string, id: string): void; - } - interface CourseWorkCollection { - StudentSubmissions?: - | Classroom.Collection.Courses.CourseWork.StudentSubmissionsCollection - | undefined; - // Creates course work. The resulting course work (and corresponding student submissions) are associated with the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to make the request. Classroom API requests to modify course work and student submissions must be made with an OAuth client ID from the associated Developer Console project. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work in the requested course, share a Drive attachment, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - // *`FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible - create(resource: Schema.CourseWork, courseId: string): Classroom.Schema.CourseWork; - // Returns course work. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or course work does not exist. - get(courseId: string, id: string): Classroom.Schema.CourseWork; - // Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string): Classroom.Schema.ListCourseWorkResponse; - // Returns a list of course work that the requester is permitted to view. Course students may only view `PUBLISHED` course work. Course teachers and domain administrators may view all course work. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseWorkResponse; - // Modifies assignee mode and options of a coursework. Only a teacher of the course that contains the coursework may call this method. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or course work does not exist. - modifyAssignees( - resource: Schema.ModifyCourseWorkAssigneesRequest, - courseId: string, - id: string, - ): Classroom.Schema.CourseWork; - // Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested course work has already been deleted. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - patch(resource: Schema.CourseWork, courseId: string, id: string): Classroom.Schema.CourseWork; - // Updates one or more fields of a course work. See google.classroom.v1.CourseWork for details of which fields may be updated and who may change them. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the user is not permitted to make the requested modification to the student submission, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested course work has already been deleted. - // *`NOT_FOUND` if the requested course, course work, or student submission does not exist. - patch( - resource: Schema.CourseWork, - courseId: string, - id: string, - optionalArgs: object, - ): Classroom.Schema.CourseWork; - // Deletes a course work. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work, if the requesting user is not permitted to delete the requested course or for access errors. - // *`FAILED_PRECONDITION` if the requested course work has already been deleted. - // *`NOT_FOUND` if no course exists with the requested ID. - remove(courseId: string, id: string): void; - } - interface CourseWorkMaterialsCollection { - // Creates a course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create course work material in the requested course, share a Drive attachment, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed or if more than 20 * materials are provided. - // *`NOT_FOUND` if the requested course does not exist. - // *`FAILED_PRECONDITION` for the following request error: * AttachmentNotVisible - create(resource: Schema.CourseWorkMaterial, courseId: string): Classroom.Schema.CourseWorkMaterial; - // Returns a course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or course work material, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or course work material does not exist. - get(courseId: string, id: string): Classroom.Schema.CourseWorkMaterial; - // Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string): Classroom.Schema.ListCourseWorkMaterialResponse; - // Returns a list of course work material that the requester is permitted to view. Course students may only view `PUBLISHED` course work material. Course teachers and domain administrators may view all course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListCourseWorkMaterialResponse; - // Updates one or more fields of a course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested course work material has already been deleted. - // *`NOT_FOUND` if the requested course or course work material does not exist - patch( - resource: Schema.CourseWorkMaterial, - courseId: string, - id: string, - ): Classroom.Schema.CourseWorkMaterial; - // Updates one or more fields of a course work material. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`FAILED_PRECONDITION` if the requested course work material has already been deleted. - // *`NOT_FOUND` if the requested course or course work material does not exist - patch( - resource: Schema.CourseWorkMaterial, - courseId: string, - id: string, - optionalArgs: object, - ): Classroom.Schema.CourseWorkMaterial; - // Deletes a course work material. This request must be made by the Developer Console project of the [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to create the corresponding course work material item. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding course work material, if the requesting user is not permitted to delete the requested course or for access errors. - // *`FAILED_PRECONDITION` if the requested course work material has already been deleted. - // *`NOT_FOUND` if no course exists with the requested ID. - remove(courseId: string, id: string): void; - } - interface StudentsCollection { - // Adds a user as a student of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. - // *`NOT_FOUND` if the requested course ID does not exist. - // *`FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached - // *`ALREADY_EXISTS` if the user is already a student or teacher in the course. - create(resource: Schema.Student, courseId: string): Classroom.Schema.Student; - // Adds a user as a student of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create students in this course or for access errors. - // *`NOT_FOUND` if the requested course ID does not exist. - // *`FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * UserGroupsMembershipLimitReached - // *`ALREADY_EXISTS` if the user is already a student or teacher in the course. - create(resource: Schema.Student, courseId: string, optionalArgs: object): Classroom.Schema.Student; - // Returns a student of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to view students of this course or for access errors. - // *`NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. - get(courseId: string, userId: string): Classroom.Schema.Student; - // Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: - // *`NOT_FOUND` if the course does not exist. - // *`PERMISSION_DENIED` for access errors. - list(courseId: string): Classroom.Schema.ListStudentsResponse; - // Returns a list of students of this course that the requester is permitted to view. This method returns the following error codes: - // *`NOT_FOUND` if the course does not exist. - // *`PERMISSION_DENIED` for access errors. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListStudentsResponse; - // Deletes a student of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to delete students of this course or for access errors. - // *`NOT_FOUND` if no student of this course has the requested ID or if the course does not exist. - remove(courseId: string, userId: string): void; - } - interface TeachersCollection { - // Creates a teacher of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create teachers in this course or for access errors. - // *`NOT_FOUND` if the requested course ID does not exist. - // *`FAILED_PRECONDITION` if the requested user's account is disabled, for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached - // *`ALREADY_EXISTS` if the user is already a teacher or student in the course. - create(resource: Schema.Teacher, courseId: string): Classroom.Schema.Teacher; - // Returns a teacher of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to view teachers of this course or for access errors. - // *`NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. - get(courseId: string, userId: string): Classroom.Schema.Teacher; - // Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: - // *`NOT_FOUND` if the course does not exist. - // *`PERMISSION_DENIED` for access errors. - list(courseId: string): Classroom.Schema.ListTeachersResponse; - // Returns a list of teachers of this course that the requester is permitted to view. This method returns the following error codes: - // *`NOT_FOUND` if the course does not exist. - // *`PERMISSION_DENIED` for access errors. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListTeachersResponse; - // Deletes a teacher of a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to delete teachers of this course or for access errors. - // *`NOT_FOUND` if no teacher of this course has the requested ID or if the course does not exist. - // *`FAILED_PRECONDITION` if the requested ID belongs to the primary teacher of this course. - remove(courseId: string, userId: string): void; - } - interface TopicsCollection { - // Creates a topic. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course, create a topic in the requested course, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - create(resource: Schema.Topic, courseId: string): Classroom.Schema.Topic; - // Returns a topic. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or topic, or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or topic does not exist. - get(courseId: string, id: string): Classroom.Schema.Topic; - // Returns the list of topics that the requester is permitted to view. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string): Classroom.Schema.ListTopicResponse; - // Returns the list of topics that the requester is permitted to view. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course does not exist. - list(courseId: string, optionalArgs: object): Classroom.Schema.ListTopicResponse; - // Updates one or more fields of a topic. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or topic does not exist - patch(resource: Schema.Topic, courseId: string, id: string): Classroom.Schema.Topic; - // Updates one or more fields of a topic. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting developer project did not create the corresponding topic or for access errors. - // *`INVALID_ARGUMENT` if the request is malformed. - // *`NOT_FOUND` if the requested course or topic does not exist - patch( - resource: Schema.Topic, - courseId: string, - id: string, - optionalArgs: object, - ): Classroom.Schema.Topic; - // Deletes a topic. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not allowed to delete the requested topic or for access errors. - // *`FAILED_PRECONDITION` if the requested topic has already been deleted. - // *`NOT_FOUND` if no course or topic exists with the requested ID. - remove(courseId: string, id: string): void; - } - } - namespace UserProfiles { - interface GuardianInvitationsCollection { - // Creates a guardian invitation, and sends an email to the guardian asking them to confirm that they are the student's guardian. Once the guardian accepts the invitation, their `state` will change to `COMPLETED` and they will start receiving guardian notifications. A `Guardian` resource will also be created to represent the active guardian. The request object must have the `student_id` and `invited_email_address` fields set. Failing to set these fields, or setting any other fields in the request, will result in an error. This method returns the following error codes: - // *`PERMISSION_DENIED` if the current user does not have permission to manage guardians, if the guardian in question has already rejected too many requests for that student, if guardians are not enabled for the domain in question, or for other access errors. - // *`RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian link limit. - // *`INVALID_ARGUMENT` if the guardian email address is not valid (for example, if it is too long), or if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API). This error will also be returned if read-only fields are set, or if the `state` field is set to to a value other than `PENDING`. - // *`NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student. - // *`ALREADY_EXISTS` if there is already a pending guardian invitation for the student and `invited_email_address` provided, or if the provided `invited_email_address` matches the Google account of an existing `Guardian` for this user. - create(resource: Schema.GuardianInvitation, studentId: string): Classroom.Schema.GuardianInvitation; - // Returns a specific guardian invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to view guardian invitations for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). - // *`NOT_FOUND` if Classroom cannot find any record of the given student or `invitation_id`. May also be returned if the student exists, but the requesting user does not have access to see that student. - get(studentId: string, invitationId: string): Classroom.Schema.GuardianInvitation; - // Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: - // *`PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. - // *`NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. - list(studentId: string): Classroom.Schema.ListGuardianInvitationsResponse; - // Returns a list of guardian invitations that the requesting user is permitted to view, filtered by the parameters provided. This method returns the following error codes: - // *`PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian invitations for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` or `state` is provided. - // *`NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. - list(studentId: string, optionalArgs: object): Classroom.Schema.ListGuardianInvitationsResponse; - // Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. - // *`FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. - // *`INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. - // *`NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. - patch( - resource: Schema.GuardianInvitation, - studentId: string, - invitationId: string, - ): Classroom.Schema.GuardianInvitation; - // Modifies a guardian invitation. Currently, the only valid modification is to change the `state` from `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the current user does not have permission to manage guardians, if guardians are not enabled for the domain in question or for other access errors. - // *`FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. - // *`INVALID_ARGUMENT` if the format of the student ID provided cannot be recognized (it is not an email address, nor a `user_id` from this API), or if the passed `GuardianInvitation` has a `state` other than `COMPLETE`, or if it modifies fields other than `state`. - // *`NOT_FOUND` if the student ID provided is a valid student ID, but Classroom has no record of that student, or if the `id` field does not refer to a guardian invitation known to Classroom. - patch( - resource: Schema.GuardianInvitation, - studentId: string, - invitationId: string, - optionalArgs: object, - ): Classroom.Schema.GuardianInvitation; - } - interface GuardiansCollection { - // Returns a specific guardian. This method returns the following error codes: - // *`PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to view guardian information for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). - // *`NOT_FOUND` if the requesting user is permitted to view guardians for the requested `student_id`, but no `Guardian` record exists for that student that matches the provided `guardian_id`. - get(studentId: string, guardianId: string): Classroom.Schema.Guardian; - // Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: - // *`PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. - // *`NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. - list(studentId: string): Classroom.Schema.ListGuardiansResponse; - // Returns a list of guardians that the requesting user is permitted to view, restricted to those that match the request. To list guardians for any student that the requesting user may view guardians for, use the literal character `-` for the student ID. This method returns the following error codes: - // *`PERMISSION_DENIED` if a `student_id` is specified, and the requesting user is not permitted to view guardian information for that student, if `"-"` is specified as the `student_id` and the user is not a domain administrator, if guardians are not enabled for the domain in question, if the `invited_email_address` filter is set by a user who is not a domain administrator, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API, nor the literal string `me`). May also be returned if an invalid `page_token` is provided. - // *`NOT_FOUND` if a `student_id` is specified, and its format can be recognized, but Classroom has no record of that student. - list(studentId: string, optionalArgs: object): Classroom.Schema.ListGuardiansResponse; - // Deletes a guardian. The guardian will no longer receive guardian notifications and the guardian will no longer be accessible via the API. This method returns the following error codes: - // *`PERMISSION_DENIED` if no user that matches the provided `student_id` is visible to the requesting user, if the requesting user is not permitted to manage guardians for the student identified by the `student_id`, if guardians are not enabled for the domain in question, or for other access errors. - // *`INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot be recognized (it is not an email address, nor a `student_id` from the API). - // *`NOT_FOUND` if the requesting user is permitted to modify guardians for the requested `student_id`, but no `Guardian` record exists for that student with the provided `guardian_id`. - remove(studentId: string, guardianId: string): void; - } - } - interface CoursesCollection { - Aliases?: Classroom.Collection.Courses.AliasesCollection | undefined; - Announcements?: Classroom.Collection.Courses.AnnouncementsCollection | undefined; - CourseWork?: Classroom.Collection.Courses.CourseWorkCollection | undefined; - CourseWorkMaterials?: Classroom.Collection.Courses.CourseWorkMaterialsCollection | undefined; - Students?: Classroom.Collection.Courses.StudentsCollection | undefined; - Teachers?: Classroom.Collection.Courses.TeachersCollection | undefined; - Topics?: Classroom.Collection.Courses.TopicsCollection | undefined; - // Creates a course. The user specified in `ownerId` is the owner of the created course and added as a teacher. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create courses or for access errors. - // *`NOT_FOUND` if the primary teacher is not a valid user. - // *`FAILED_PRECONDITION` if the course owner's account is disabled or for the following request errors: * UserGroupsMembershipLimitReached - // *`ALREADY_EXISTS` if an alias was specified in the `id` and already exists. - create(resource: Schema.Course): Classroom.Schema.Course; - // Returns a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access the requested course or for access errors. - // *`NOT_FOUND` if no course exists with the requested ID. - get(id: string): Classroom.Schema.Course; - // Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: - // *`PERMISSION_DENIED` for access errors. - // *`INVALID_ARGUMENT` if the query argument is malformed. - // *`NOT_FOUND` if any users specified in the query arguments do not exist. - list(): Classroom.Schema.ListCoursesResponse; - // Returns a list of courses that the requesting user is permitted to view, restricted to those that match the request. Returned courses are ordered by creation time, with the most recently created coming first. This method returns the following error codes: - // *`PERMISSION_DENIED` for access errors. - // *`INVALID_ARGUMENT` if the query argument is malformed. - // *`NOT_FOUND` if any users specified in the query arguments do not exist. - list(optionalArgs: object): Classroom.Schema.ListCoursesResponse; - // Updates one or more fields in a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. - // *`NOT_FOUND` if no course exists with the requested ID. - // *`INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. - // *`FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable - patch(resource: Schema.Course, id: string): Classroom.Schema.Course; - // Updates one or more fields in a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. - // *`NOT_FOUND` if no course exists with the requested ID. - // *`INVALID_ARGUMENT` if invalid fields are specified in the update mask or if no update mask is supplied. - // *`FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable - patch(resource: Schema.Course, id: string, optionalArgs: object): Classroom.Schema.Course; - // Deletes a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to delete the requested course or for access errors. - // *`NOT_FOUND` if no course exists with the requested ID. - remove(id: string): void; - // Updates a course. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to modify the requested course or for access errors. - // *`NOT_FOUND` if no course exists with the requested ID. - // *`FAILED_PRECONDITION` for the following request errors: * CourseNotModifiable - update(resource: Schema.Course, id: string): Classroom.Schema.Course; - } - interface InvitationsCollection { - // Accepts an invitation, removing it and adding the invited user to the teachers or students (as appropriate) of the specified course. Only the invited user may accept an invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to accept the requested invitation or for access errors. - // *`FAILED_PRECONDITION` for the following request errors: * CourseMemberLimitReached * CourseNotModifiable * CourseTeacherLimitReached * UserGroupsMembershipLimitReached - // *`NOT_FOUND` if no invitation exists with the requested ID. - accept(id: string): void; - // Creates an invitation. Only one invitation for a user and course may exist at a time. Delete and re-create an invitation to make changes. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to create invitations for this course or for access errors. - // *`NOT_FOUND` if the course or the user does not exist. - // *`FAILED_PRECONDITION` if the requested user's account is disabled or if the user already has this role or a role with greater permissions. - // *`ALREADY_EXISTS` if an invitation for the specified user and course already exists. - create(resource: Schema.Invitation): Classroom.Schema.Invitation; - // Returns an invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to view the requested invitation or for access errors. - // *`NOT_FOUND` if no invitation exists with the requested ID. - get(id: string): Classroom.Schema.Invitation; - // Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: - // *`PERMISSION_DENIED` for access errors. - list(): Classroom.Schema.ListInvitationsResponse; - // Returns a list of invitations that the requesting user is permitted to view, restricted to those that match the list request. *Note:* At least one of `user_id` or `course_id` must be supplied. Both fields can be supplied. This method returns the following error codes: - // *`PERMISSION_DENIED` for access errors. - list(optionalArgs: object): Classroom.Schema.ListInvitationsResponse; - // Deletes an invitation. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to delete the requested invitation or for access errors. - // *`NOT_FOUND` if no invitation exists with the requested ID. - remove(id: string): void; - } - interface RegistrationsCollection { - // Creates a `Registration`, causing Classroom to start sending notifications from the provided `feed` to the destination provided in `cloudPubSubTopic`. Returns the created `Registration`. Currently, this will be the same as the argument, but with server-assigned fields such as `expiry_time` and `id` filled in. Note that any value specified for the `expiry_time` or `id` fields will be ignored. While Classroom may validate the `cloudPubSubTopic` and return errors on a best effort basis, it is the caller's responsibility to ensure that it exists and that Classroom has permission to publish to it. This method may return the following error codes: - // *`PERMISSION_DENIED` if: * the authenticated user does not have permission to receive notifications from the requested field; or * the current user has not granted access to the current Cloud project with the appropriate scope for the requested feed. Note that domain-wide delegation of authority is not currently supported for this purpose. If the request has the appropriate scope, but no grant exists, a Request Errors is returned. * another access error is encountered. - // *`INVALID_ARGUMENT` if: * no `cloudPubsubTopic` is specified, or the specified `cloudPubsubTopic` is not valid; or * no `feed` is specified, or the specified `feed` is not valid. - // *`NOT_FOUND` if: * the specified `feed` cannot be located, or the requesting user does not have permission to determine whether or not it exists; or * the specified `cloudPubsubTopic` cannot be located, or Classroom has not been granted permission to publish to it. - create(resource: Schema.Registration): Classroom.Schema.Registration; - // Deletes a `Registration`, causing Classroom to stop sending notifications for that `Registration`. - remove(registrationId: string): void; - } - interface UserProfilesCollection { - GuardianInvitations?: Classroom.Collection.UserProfiles.GuardianInvitationsCollection | undefined; - Guardians?: Classroom.Collection.UserProfiles.GuardiansCollection | undefined; - // Returns a user profile. This method returns the following error codes: - // *`PERMISSION_DENIED` if the requesting user is not permitted to access this user profile, if no profile exists with the requested ID, or for access errors. - get(userId: string): Classroom.Schema.UserProfile; - } - } - namespace Schema { - interface Announcement { - alternateLink?: string | undefined; - assigneeMode?: string | undefined; - courseId?: string | undefined; - creationTime?: string | undefined; - creatorUserId?: string | undefined; - id?: string | undefined; - individualStudentsOptions?: Classroom.Schema.IndividualStudentsOptions | undefined; - materials?: Classroom.Schema.Material[] | undefined; - scheduledTime?: string | undefined; - state?: string | undefined; - text?: string | undefined; - updateTime?: string | undefined; - } - interface Assignment { - studentWorkFolder?: Classroom.Schema.DriveFolder | undefined; - } - interface AssignmentSubmission { - attachments?: Classroom.Schema.Attachment[] | undefined; - } - interface Attachment { - driveFile?: Classroom.Schema.DriveFile | undefined; - form?: Classroom.Schema.Form | undefined; - link?: Classroom.Schema.Link | undefined; - youTubeVideo?: Classroom.Schema.YouTubeVideo | undefined; - } - interface CloudPubsubTopic { - topicName?: string | undefined; - } - interface Course { - alternateLink?: string | undefined; - calendarId?: string | undefined; - courseGroupEmail?: string | undefined; - courseMaterialSets?: Classroom.Schema.CourseMaterialSet[] | undefined; - courseState?: string | undefined; - creationTime?: string | undefined; - description?: string | undefined; - descriptionHeading?: string | undefined; - enrollmentCode?: string | undefined; - guardiansEnabled?: boolean | undefined; - id?: string | undefined; - name?: string | undefined; - ownerId?: string | undefined; - room?: string | undefined; - section?: string | undefined; - teacherFolder?: Classroom.Schema.DriveFolder | undefined; - teacherGroupEmail?: string | undefined; - updateTime?: string | undefined; - } - interface CourseAlias { - alias?: string | undefined; - } - interface CourseMaterial { - driveFile?: Classroom.Schema.DriveFile | undefined; - form?: Classroom.Schema.Form | undefined; - link?: Classroom.Schema.Link | undefined; - youTubeVideo?: Classroom.Schema.YouTubeVideo | undefined; - } - interface CourseMaterialSet { - materials?: Classroom.Schema.CourseMaterial[] | undefined; - title?: string | undefined; - } - interface CourseRosterChangesInfo { - courseId?: string | undefined; - } - interface CourseWork { - alternateLink?: string | undefined; - assigneeMode?: string | undefined; - assignment?: Classroom.Schema.Assignment | undefined; - associatedWithDeveloper?: boolean | undefined; - courseId?: string | undefined; - creationTime?: string | undefined; - creatorUserId?: string | undefined; - description?: string | undefined; - dueDate?: Classroom.Schema.Date | undefined; - dueTime?: Classroom.Schema.TimeOfDay | undefined; - id?: string | undefined; - individualStudentsOptions?: Classroom.Schema.IndividualStudentsOptions | undefined; - materials?: Classroom.Schema.Material[] | undefined; - maxPoints?: number | undefined; - multipleChoiceQuestion?: Classroom.Schema.MultipleChoiceQuestion | undefined; - scheduledTime?: string | undefined; - state?: string | undefined; - submissionModificationMode?: string | undefined; - title?: string | undefined; - topicId?: string | undefined; - updateTime?: string | undefined; - workType?: string | undefined; - } - interface CourseWorkChangesInfo { - courseId?: string | undefined; - } - interface CourseWorkMaterial { - alternateLink?: string | undefined; - assigneeMode?: string | undefined; - courseId?: string | undefined; - creationTime?: string | undefined; - creatorUserId?: string | undefined; - description?: string | undefined; - id?: string | undefined; - individualStudentsOptions?: Classroom.Schema.IndividualStudentsOptions | undefined; - materials?: Classroom.Schema.Material[] | undefined; - scheduledTime?: string | undefined; - state?: string | undefined; - title?: string | undefined; - topicId?: string | undefined; - updateTime?: string | undefined; - } - interface Date { - day?: number | undefined; - month?: number | undefined; - year?: number | undefined; - } - interface DriveFile { - alternateLink?: string | undefined; - id?: string | undefined; - thumbnailUrl?: string | undefined; - title?: string | undefined; - } - interface DriveFolder { - alternateLink?: string | undefined; - id?: string | undefined; - title?: string | undefined; - } - interface Feed { - courseRosterChangesInfo?: Classroom.Schema.CourseRosterChangesInfo | undefined; - courseWorkChangesInfo?: Classroom.Schema.CourseWorkChangesInfo | undefined; - feedType?: string | undefined; - } - interface Form { - formUrl?: string | undefined; - responseUrl?: string | undefined; - thumbnailUrl?: string | undefined; - title?: string | undefined; - } - interface GlobalPermission { - permission?: string | undefined; - } - interface GradeHistory { - actorUserId?: string | undefined; - gradeChangeType?: string | undefined; - gradeTimestamp?: string | undefined; - maxPoints?: number | undefined; - pointsEarned?: number | undefined; - } - interface Guardian { - guardianId?: string | undefined; - guardianProfile?: Classroom.Schema.UserProfile | undefined; - invitedEmailAddress?: string | undefined; - studentId?: string | undefined; - } - interface GuardianInvitation { - creationTime?: string | undefined; - invitationId?: string | undefined; - invitedEmailAddress?: string | undefined; - state?: string | undefined; - studentId?: string | undefined; - } - interface IndividualStudentsOptions { - studentIds?: string[] | undefined; - } - interface Invitation { - courseId?: string | undefined; - id?: string | undefined; - role?: string | undefined; - userId?: string | undefined; - } - interface Link { - thumbnailUrl?: string | undefined; - title?: string | undefined; - url?: string | undefined; - } - interface ListAnnouncementsResponse { - announcements?: Classroom.Schema.Announcement[] | undefined; - nextPageToken?: string | undefined; - } - interface ListCourseAliasesResponse { - aliases?: Classroom.Schema.CourseAlias[] | undefined; - nextPageToken?: string | undefined; - } - interface ListCourseWorkMaterialResponse { - courseWorkMaterial?: Classroom.Schema.CourseWorkMaterial[] | undefined; - nextPageToken?: string | undefined; - } - interface ListCourseWorkResponse { - courseWork?: Classroom.Schema.CourseWork[] | undefined; - nextPageToken?: string | undefined; - } - interface ListCoursesResponse { - courses?: Classroom.Schema.Course[] | undefined; - nextPageToken?: string | undefined; - } - interface ListGuardianInvitationsResponse { - guardianInvitations?: Classroom.Schema.GuardianInvitation[] | undefined; - nextPageToken?: string | undefined; - } - interface ListGuardiansResponse { - guardians?: Classroom.Schema.Guardian[] | undefined; - nextPageToken?: string | undefined; - } - interface ListInvitationsResponse { - invitations?: Classroom.Schema.Invitation[] | undefined; - nextPageToken?: string | undefined; - } - interface ListStudentSubmissionsResponse { - nextPageToken?: string | undefined; - studentSubmissions?: Classroom.Schema.StudentSubmission[] | undefined; - } - interface ListStudentsResponse { - nextPageToken?: string | undefined; - students?: Classroom.Schema.Student[] | undefined; - } - interface ListTeachersResponse { - nextPageToken?: string | undefined; - teachers?: Classroom.Schema.Teacher[] | undefined; - } - interface ListTopicResponse { - nextPageToken?: string | undefined; - topic?: Classroom.Schema.Topic[] | undefined; - } - interface Material { - driveFile?: Classroom.Schema.SharedDriveFile | undefined; - form?: Classroom.Schema.Form | undefined; - link?: Classroom.Schema.Link | undefined; - youtubeVideo?: Classroom.Schema.YouTubeVideo | undefined; - } - interface ModifyAnnouncementAssigneesRequest { - assigneeMode?: string | undefined; - modifyIndividualStudentsOptions?: Classroom.Schema.ModifyIndividualStudentsOptions | undefined; - } - interface ModifyAttachmentsRequest { - addAttachments?: Classroom.Schema.Attachment[] | undefined; - } - interface ModifyCourseWorkAssigneesRequest { - assigneeMode?: string | undefined; - modifyIndividualStudentsOptions?: Classroom.Schema.ModifyIndividualStudentsOptions | undefined; - } - interface ModifyIndividualStudentsOptions { - addStudentIds?: string[] | undefined; - removeStudentIds?: string[] | undefined; - } - interface MultipleChoiceQuestion { - choices?: string[] | undefined; - } - interface MultipleChoiceSubmission { - answer?: string | undefined; - } - interface Name { - familyName?: string | undefined; - fullName?: string | undefined; - givenName?: string | undefined; - } - interface Registration { - cloudPubsubTopic?: Classroom.Schema.CloudPubsubTopic | undefined; - expiryTime?: string | undefined; - feed?: Classroom.Schema.Feed | undefined; - registrationId?: string | undefined; - } - interface SharedDriveFile { - driveFile?: Classroom.Schema.DriveFile | undefined; - shareMode?: string | undefined; - } - interface ShortAnswerSubmission { - answer?: string | undefined; - } - interface StateHistory { - actorUserId?: string | undefined; - state?: string | undefined; - stateTimestamp?: string | undefined; - } - interface Student { - courseId?: string | undefined; - profile?: Classroom.Schema.UserProfile | undefined; - studentWorkFolder?: Classroom.Schema.DriveFolder | undefined; - userId?: string | undefined; - } - interface StudentSubmission { - alternateLink?: string | undefined; - assignedGrade?: number | undefined; - assignmentSubmission?: Classroom.Schema.AssignmentSubmission | undefined; - associatedWithDeveloper?: boolean | undefined; - courseId?: string | undefined; - courseWorkId?: string | undefined; - courseWorkType?: string | undefined; - creationTime?: string | undefined; - draftGrade?: number | undefined; - id?: string | undefined; - late?: boolean | undefined; - multipleChoiceSubmission?: Classroom.Schema.MultipleChoiceSubmission | undefined; - shortAnswerSubmission?: Classroom.Schema.ShortAnswerSubmission | undefined; - state?: string | undefined; - submissionHistory?: Classroom.Schema.SubmissionHistory[] | undefined; - updateTime?: string | undefined; - userId?: string | undefined; - } - interface SubmissionHistory { - gradeHistory?: Classroom.Schema.GradeHistory | undefined; - stateHistory?: Classroom.Schema.StateHistory | undefined; - } - interface Teacher { - courseId?: string | undefined; - profile?: Classroom.Schema.UserProfile | undefined; - userId?: string | undefined; - } - interface TimeOfDay { - hours?: number | undefined; - minutes?: number | undefined; - nanos?: number | undefined; - seconds?: number | undefined; - } - interface Topic { - courseId?: string | undefined; - name?: string | undefined; - topicId?: string | undefined; - updateTime?: string | undefined; - } - interface UserProfile { - emailAddress?: string | undefined; - id?: string | undefined; - name?: Classroom.Schema.Name | undefined; - permissions?: Classroom.Schema.GlobalPermission[] | undefined; - photoUrl?: string | undefined; - verifiedTeacher?: boolean | undefined; - } - interface YouTubeVideo { - alternateLink?: string | undefined; - id?: string | undefined; - thumbnailUrl?: string | undefined; - title?: string | undefined; - } - } - } - interface Classroom { - Courses?: Classroom.Collection.CoursesCollection | undefined; - Invitations?: Classroom.Collection.InvitationsCollection | undefined; - Registrations?: Classroom.Collection.RegistrationsCollection | undefined; - UserProfiles?: Classroom.Collection.UserProfilesCollection | undefined; - // Create a new instance of Announcement - newAnnouncement(): Classroom.Schema.Announcement; - // Create a new instance of Assignment - newAssignment(): Classroom.Schema.Assignment; - // Create a new instance of AssignmentSubmission - newAssignmentSubmission(): Classroom.Schema.AssignmentSubmission; - // Create a new instance of Attachment - newAttachment(): Classroom.Schema.Attachment; - // Create a new instance of CloudPubsubTopic - newCloudPubsubTopic(): Classroom.Schema.CloudPubsubTopic; - // Create a new instance of Course - newCourse(): Classroom.Schema.Course; - // Create a new instance of CourseAlias - newCourseAlias(): Classroom.Schema.CourseAlias; - // Create a new instance of CourseMaterial - newCourseMaterial(): Classroom.Schema.CourseMaterial; - // Create a new instance of CourseMaterialSet - newCourseMaterialSet(): Classroom.Schema.CourseMaterialSet; - // Create a new instance of CourseRosterChangesInfo - newCourseRosterChangesInfo(): Classroom.Schema.CourseRosterChangesInfo; - // Create a new instance of CourseWork - newCourseWork(): Classroom.Schema.CourseWork; - // Create a new instance of CourseWorkChangesInfo - newCourseWorkChangesInfo(): Classroom.Schema.CourseWorkChangesInfo; - // Create a new instance of CourseWorkMaterial - newCourseWorkMaterial(): Classroom.Schema.CourseWorkMaterial; - // Create a new instance of Date - newDate(): Classroom.Schema.Date; - // Create a new instance of DriveFile - newDriveFile(): Classroom.Schema.DriveFile; - // Create a new instance of DriveFolder - newDriveFolder(): Classroom.Schema.DriveFolder; - // Create a new instance of Feed - newFeed(): Classroom.Schema.Feed; - // Create a new instance of Form - newForm(): Classroom.Schema.Form; - // Create a new instance of GlobalPermission - newGlobalPermission(): Classroom.Schema.GlobalPermission; - // Create a new instance of GradeHistory - newGradeHistory(): Classroom.Schema.GradeHistory; - // Create a new instance of GuardianInvitation - newGuardianInvitation(): Classroom.Schema.GuardianInvitation; - // Create a new instance of IndividualStudentsOptions - newIndividualStudentsOptions(): Classroom.Schema.IndividualStudentsOptions; - // Create a new instance of Invitation - newInvitation(): Classroom.Schema.Invitation; - // Create a new instance of Link - newLink(): Classroom.Schema.Link; - // Create a new instance of Material - newMaterial(): Classroom.Schema.Material; - // Create a new instance of ModifyAnnouncementAssigneesRequest - newModifyAnnouncementAssigneesRequest(): Classroom.Schema.ModifyAnnouncementAssigneesRequest; - // Create a new instance of ModifyAttachmentsRequest - newModifyAttachmentsRequest(): Classroom.Schema.ModifyAttachmentsRequest; - // Create a new instance of ModifyCourseWorkAssigneesRequest - newModifyCourseWorkAssigneesRequest(): Classroom.Schema.ModifyCourseWorkAssigneesRequest; - // Create a new instance of ModifyIndividualStudentsOptions - newModifyIndividualStudentsOptions(): Classroom.Schema.ModifyIndividualStudentsOptions; - // Create a new instance of MultipleChoiceQuestion - newMultipleChoiceQuestion(): Classroom.Schema.MultipleChoiceQuestion; - // Create a new instance of MultipleChoiceSubmission - newMultipleChoiceSubmission(): Classroom.Schema.MultipleChoiceSubmission; - // Create a new instance of Name - newName(): Classroom.Schema.Name; - // Create a new instance of Registration - newRegistration(): Classroom.Schema.Registration; - // Create a new instance of SharedDriveFile - newSharedDriveFile(): Classroom.Schema.SharedDriveFile; - // Create a new instance of ShortAnswerSubmission - newShortAnswerSubmission(): Classroom.Schema.ShortAnswerSubmission; - // Create a new instance of StateHistory - newStateHistory(): Classroom.Schema.StateHistory; - // Create a new instance of Student - newStudent(): Classroom.Schema.Student; - // Create a new instance of StudentSubmission - newStudentSubmission(): Classroom.Schema.StudentSubmission; - // Create a new instance of SubmissionHistory - newSubmissionHistory(): Classroom.Schema.SubmissionHistory; - // Create a new instance of Teacher - newTeacher(): Classroom.Schema.Teacher; - // Create a new instance of TimeOfDay - newTimeOfDay(): Classroom.Schema.TimeOfDay; - // Create a new instance of Topic - newTopic(): Classroom.Schema.Topic; - // Create a new instance of UserProfile - newUserProfile(): Classroom.Schema.UserProfile; - // Create a new instance of YouTubeVideo - newYouTubeVideo(): Classroom.Schema.YouTubeVideo; - } -} - -declare var Classroom: GoogleAppsScript.Classroom; diff --git a/node_modules/@types/google-apps-script/apis/content_v2.d.ts b/node_modules/@types/google-apps-script/apis/content_v2.d.ts deleted file mode 100644 index 3afceab..0000000 --- a/node_modules/@types/google-apps-script/apis/content_v2.d.ts +++ /dev/null @@ -1,2653 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Content { - namespace Collection { - interface AccountsCollection { - // Returns information about the authenticated user. - authinfo(): Content.Schema.AccountsAuthInfoResponse; - // Claims the website of a Merchant Center sub-account. - claimwebsite(merchantId: string, accountId: string): Content.Schema.AccountsClaimWebsiteResponse; - // Claims the website of a Merchant Center sub-account. - claimwebsite( - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.AccountsClaimWebsiteResponse; - // Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. - custombatch(resource: Schema.AccountsCustomBatchRequest): Content.Schema.AccountsCustomBatchResponse; - // Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. - custombatch( - resource: Schema.AccountsCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.AccountsCustomBatchResponse; - // Retrieves a Merchant Center account. - get(merchantId: string, accountId: string): Content.Schema.Account; - // Creates a Merchant Center sub-account. - insert(resource: Schema.Account, merchantId: string): Content.Schema.Account; - // Creates a Merchant Center sub-account. - insert(resource: Schema.Account, merchantId: string, optionalArgs: object): Content.Schema.Account; - // Performs an action on a link between a Merchant Center account and another account. - link( - resource: Schema.AccountsLinkRequest, - merchantId: string, - accountId: string, - ): Content.Schema.AccountsLinkResponse; - // Lists the sub-accounts in your Merchant Center account. - list(merchantId: string): Content.Schema.AccountsListResponse; - // Lists the sub-accounts in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.AccountsListResponse; - // Updates a Merchant Center account. This method supports patch semantics. - patch(resource: Schema.Account, merchantId: string, accountId: string): Content.Schema.Account; - // Updates a Merchant Center account. This method supports patch semantics. - patch( - resource: Schema.Account, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.Account; - // Deletes a Merchant Center sub-account. - remove(merchantId: string, accountId: string): void; - // Deletes a Merchant Center sub-account. - remove(merchantId: string, accountId: string, optionalArgs: object): void; - // Updates a Merchant Center account. - update(resource: Schema.Account, merchantId: string, accountId: string): Content.Schema.Account; - // Updates a Merchant Center account. - update( - resource: Schema.Account, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.Account; - } - interface AccountstatusesCollection { - // Retrieves multiple Merchant Center account statuses in a single request. - custombatch( - resource: Schema.AccountstatusesCustomBatchRequest, - ): Content.Schema.AccountstatusesCustomBatchResponse; - // Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. - get(merchantId: string, accountId: string): Content.Schema.AccountStatus; - // Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. - get(merchantId: string, accountId: string, optionalArgs: object): Content.Schema.AccountStatus; - // Lists the statuses of the sub-accounts in your Merchant Center account. - list(merchantId: string): Content.Schema.AccountstatusesListResponse; - // Lists the statuses of the sub-accounts in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.AccountstatusesListResponse; - } - interface AccounttaxCollection { - // Retrieves and updates tax settings of multiple accounts in a single request. - custombatch( - resource: Schema.AccounttaxCustomBatchRequest, - ): Content.Schema.AccounttaxCustomBatchResponse; - // Retrieves and updates tax settings of multiple accounts in a single request. - custombatch( - resource: Schema.AccounttaxCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.AccounttaxCustomBatchResponse; - // Retrieves the tax settings of the account. - get(merchantId: string, accountId: string): Content.Schema.AccountTax; - // Lists the tax settings of the sub-accounts in your Merchant Center account. - list(merchantId: string): Content.Schema.AccounttaxListResponse; - // Lists the tax settings of the sub-accounts in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.AccounttaxListResponse; - // Updates the tax settings of the account. This method supports patch semantics. - patch(resource: Schema.AccountTax, merchantId: string, accountId: string): Content.Schema.AccountTax; - // Updates the tax settings of the account. This method supports patch semantics. - patch( - resource: Schema.AccountTax, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.AccountTax; - // Updates the tax settings of the account. - update(resource: Schema.AccountTax, merchantId: string, accountId: string): Content.Schema.AccountTax; - // Updates the tax settings of the account. - update( - resource: Schema.AccountTax, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.AccountTax; - } - interface DatafeedsCollection { - // Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. - custombatch(resource: Schema.DatafeedsCustomBatchRequest): Content.Schema.DatafeedsCustomBatchResponse; - // Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. - custombatch( - resource: Schema.DatafeedsCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.DatafeedsCustomBatchResponse; - // Invokes a fetch for the datafeed in your Merchant Center account. - fetchnow(merchantId: string, datafeedId: string): Content.Schema.DatafeedsFetchNowResponse; - // Invokes a fetch for the datafeed in your Merchant Center account. - fetchnow( - merchantId: string, - datafeedId: string, - optionalArgs: object, - ): Content.Schema.DatafeedsFetchNowResponse; - // Retrieves a datafeed configuration from your Merchant Center account. - get(merchantId: string, datafeedId: string): Content.Schema.Datafeed; - // Registers a datafeed configuration with your Merchant Center account. - insert(resource: Schema.Datafeed, merchantId: string): Content.Schema.Datafeed; - // Registers a datafeed configuration with your Merchant Center account. - insert(resource: Schema.Datafeed, merchantId: string, optionalArgs: object): Content.Schema.Datafeed; - // Lists the configurations for datafeeds in your Merchant Center account. - list(merchantId: string): Content.Schema.DatafeedsListResponse; - // Lists the configurations for datafeeds in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.DatafeedsListResponse; - // Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. - patch(resource: Schema.Datafeed, merchantId: string, datafeedId: string): Content.Schema.Datafeed; - // Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. - patch( - resource: Schema.Datafeed, - merchantId: string, - datafeedId: string, - optionalArgs: object, - ): Content.Schema.Datafeed; - // Deletes a datafeed configuration from your Merchant Center account. - remove(merchantId: string, datafeedId: string): void; - // Deletes a datafeed configuration from your Merchant Center account. - remove(merchantId: string, datafeedId: string, optionalArgs: object): void; - // Updates a datafeed configuration of your Merchant Center account. - update(resource: Schema.Datafeed, merchantId: string, datafeedId: string): Content.Schema.Datafeed; - // Updates a datafeed configuration of your Merchant Center account. - update( - resource: Schema.Datafeed, - merchantId: string, - datafeedId: string, - optionalArgs: object, - ): Content.Schema.Datafeed; - } - interface DatafeedstatusesCollection { - // Gets multiple Merchant Center datafeed statuses in a single request. - custombatch( - resource: Schema.DatafeedstatusesCustomBatchRequest, - ): Content.Schema.DatafeedstatusesCustomBatchResponse; - // Retrieves the status of a datafeed from your Merchant Center account. - get(merchantId: string, datafeedId: string): Content.Schema.DatafeedStatus; - // Retrieves the status of a datafeed from your Merchant Center account. - get(merchantId: string, datafeedId: string, optionalArgs: object): Content.Schema.DatafeedStatus; - // Lists the statuses of the datafeeds in your Merchant Center account. - list(merchantId: string): Content.Schema.DatafeedstatusesListResponse; - // Lists the statuses of the datafeeds in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.DatafeedstatusesListResponse; - } - interface InventoryCollection { - // Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. - custombatch(resource: Schema.InventoryCustomBatchRequest): Content.Schema.InventoryCustomBatchResponse; - // Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. - custombatch( - resource: Schema.InventoryCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.InventoryCustomBatchResponse; - // Updates price and availability of a product in your Merchant Center account. - set( - resource: Schema.InventorySetRequest, - merchantId: string, - storeCode: string, - productId: string, - ): Content.Schema.InventorySetResponse; - // Updates price and availability of a product in your Merchant Center account. - set( - resource: Schema.InventorySetRequest, - merchantId: string, - storeCode: string, - productId: string, - optionalArgs: object, - ): Content.Schema.InventorySetResponse; - } - interface LiasettingsCollection { - // Retrieves and/or updates the LIA settings of multiple accounts in a single request. - custombatch( - resource: Schema.LiasettingsCustomBatchRequest, - ): Content.Schema.LiasettingsCustomBatchResponse; - // Retrieves and/or updates the LIA settings of multiple accounts in a single request. - custombatch( - resource: Schema.LiasettingsCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.LiasettingsCustomBatchResponse; - // Retrieves the LIA settings of the account. - get(merchantId: string, accountId: string): Content.Schema.LiaSettings; - // Retrieves the list of accessible Google My Business accounts. - getaccessiblegmbaccounts( - merchantId: string, - accountId: string, - ): Content.Schema.LiasettingsGetAccessibleGmbAccountsResponse; - // Lists the LIA settings of the sub-accounts in your Merchant Center account. - list(merchantId: string): Content.Schema.LiasettingsListResponse; - // Lists the LIA settings of the sub-accounts in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.LiasettingsListResponse; - // Retrieves the list of POS data providers that have active settings for the all eiligible countries. - listposdataproviders(): Content.Schema.LiasettingsListPosDataProvidersResponse; - // Updates the LIA settings of the account. This method supports patch semantics. - patch(resource: Schema.LiaSettings, merchantId: string, accountId: string): Content.Schema.LiaSettings; - // Updates the LIA settings of the account. This method supports patch semantics. - patch( - resource: Schema.LiaSettings, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.LiaSettings; - // Requests access to a specified Google My Business account. - requestgmbaccess( - merchantId: string, - accountId: string, - gmbEmail: string, - ): Content.Schema.LiasettingsRequestGmbAccessResponse; - // Requests inventory validation for the specified country. - requestinventoryverification( - merchantId: string, - accountId: string, - country: string, - ): Content.Schema.LiasettingsRequestInventoryVerificationResponse; - // Sets the inventory verification contract for the specified country. - setinventoryverificationcontact( - merchantId: string, - accountId: string, - contactEmail: string, - contactName: string, - country: string, - language: string, - ): Content.Schema.LiasettingsSetInventoryVerificationContactResponse; - // Sets the POS data provider for the specified country. - setposdataprovider( - merchantId: string, - accountId: string, - country: string, - ): Content.Schema.LiasettingsSetPosDataProviderResponse; - // Sets the POS data provider for the specified country. - setposdataprovider( - merchantId: string, - accountId: string, - country: string, - optionalArgs: object, - ): Content.Schema.LiasettingsSetPosDataProviderResponse; - // Updates the LIA settings of the account. - update(resource: Schema.LiaSettings, merchantId: string, accountId: string): Content.Schema.LiaSettings; - // Updates the LIA settings of the account. - update( - resource: Schema.LiaSettings, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.LiaSettings; - } - interface OrderinvoicesCollection { - // Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders. - createchargeinvoice( - resource: Schema.OrderinvoicesCreateChargeInvoiceRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderinvoicesCreateChargeInvoiceResponse; - // Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. - createrefundinvoice( - resource: Schema.OrderinvoicesCreateRefundInvoiceRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderinvoicesCreateRefundInvoiceResponse; - } - interface OrderpaymentsCollection { - // Notify about successfully authorizing user's payment method for a given amount. - notifyauthapproved( - resource: Schema.OrderpaymentsNotifyAuthApprovedRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderpaymentsNotifyAuthApprovedResponse; - // Notify about failure to authorize user's payment method. - notifyauthdeclined( - resource: Schema.OrderpaymentsNotifyAuthDeclinedRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderpaymentsNotifyAuthDeclinedResponse; - // Notify about charge on user's selected payments method. - notifycharge( - resource: Schema.OrderpaymentsNotifyChargeRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderpaymentsNotifyChargeResponse; - // Notify about refund on user's selected payments method. - notifyrefund( - resource: Schema.OrderpaymentsNotifyRefundRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrderpaymentsNotifyRefundResponse; - } - interface OrderreportsCollection { - // Retrieves a report for disbursements from your Merchant Center account. - listdisbursements( - merchantId: string, - disbursementStartDate: string, - ): Content.Schema.OrderreportsListDisbursementsResponse; - // Retrieves a report for disbursements from your Merchant Center account. - listdisbursements( - merchantId: string, - disbursementStartDate: string, - optionalArgs: object, - ): Content.Schema.OrderreportsListDisbursementsResponse; - // Retrieves a list of transactions for a disbursement from your Merchant Center account. - listtransactions( - merchantId: string, - disbursementId: string, - transactionStartDate: string, - ): Content.Schema.OrderreportsListTransactionsResponse; - // Retrieves a list of transactions for a disbursement from your Merchant Center account. - listtransactions( - merchantId: string, - disbursementId: string, - transactionStartDate: string, - optionalArgs: object, - ): Content.Schema.OrderreportsListTransactionsResponse; - } - interface OrderreturnsCollection { - // Retrieves an order return from your Merchant Center account. - get(merchantId: string, returnId: string): Content.Schema.MerchantOrderReturn; - // Lists order returns in your Merchant Center account. - list(merchantId: string): Content.Schema.OrderreturnsListResponse; - // Lists order returns in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.OrderreturnsListResponse; - } - interface OrdersCollection { - // Marks an order as acknowledged. - acknowledge( - resource: Schema.OrdersAcknowledgeRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersAcknowledgeResponse; - // Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". - advancetestorder(merchantId: string, orderId: string): Content.Schema.OrdersAdvanceTestOrderResponse; - // Cancels all line items in an order, making a full refund. - cancel( - resource: Schema.OrdersCancelRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersCancelResponse; - // Cancels a line item, making a full refund. - cancellineitem( - resource: Schema.OrdersCancelLineItemRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersCancelLineItemResponse; - // Sandbox only. Cancels a test order for customer-initiated cancellation. - canceltestorderbycustomer( - resource: Schema.OrdersCancelTestOrderByCustomerRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersCancelTestOrderByCustomerResponse; - // Sandbox only. Creates a test order. - createtestorder( - resource: Schema.OrdersCreateTestOrderRequest, - merchantId: string, - ): Content.Schema.OrdersCreateTestOrderResponse; - // Sandbox only. Creates a test return. - createtestreturn( - resource: Schema.OrdersCreateTestReturnRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersCreateTestReturnResponse; - // Retrieves or modifies multiple orders in a single request. - custombatch(resource: Schema.OrdersCustomBatchRequest): Content.Schema.OrdersCustomBatchResponse; - // Retrieves an order from your Merchant Center account. - get(merchantId: string, orderId: string): Content.Schema.Order; - // Retrieves an order using merchant order ID. - getbymerchantorderid( - merchantId: string, - merchantOrderId: string, - ): Content.Schema.OrdersGetByMerchantOrderIdResponse; - // Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. - gettestordertemplate( - merchantId: string, - templateName: string, - ): Content.Schema.OrdersGetTestOrderTemplateResponse; - // Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. - gettestordertemplate( - merchantId: string, - templateName: string, - optionalArgs: object, - ): Content.Schema.OrdersGetTestOrderTemplateResponse; - // Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). - // Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. - instorerefundlineitem( - resource: Schema.OrdersInStoreRefundLineItemRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersInStoreRefundLineItemResponse; - // Lists the orders in your Merchant Center account. - list(merchantId: string): Content.Schema.OrdersListResponse; - // Lists the orders in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.OrdersListResponse; - // Deprecated, please use returnRefundLineItem instead. - refund( - resource: Schema.OrdersRefundRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersRefundResponse; - // Rejects return on an line item. - rejectreturnlineitem( - resource: Schema.OrdersRejectReturnLineItemRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersRejectReturnLineItemResponse; - // Returns a line item. - returnlineitem( - resource: Schema.OrdersReturnLineItemRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersReturnLineItemResponse; - // Returns and refunds a line item. Note that this method can only be called on fully shipped orders. - returnrefundlineitem( - resource: Schema.OrdersReturnRefundLineItemRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersReturnRefundLineItemResponse; - // Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. - setlineitemmetadata( - resource: Schema.OrdersSetLineItemMetadataRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersSetLineItemMetadataResponse; - // Marks line item(s) as shipped. - shiplineitems( - resource: Schema.OrdersShipLineItemsRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersShipLineItemsResponse; - // Updates ship by and delivery by dates for a line item. - updatelineitemshippingdetails( - resource: Schema.OrdersUpdateLineItemShippingDetailsRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersUpdateLineItemShippingDetailsResponse; - // Updates the merchant order ID for a given order. - updatemerchantorderid( - resource: Schema.OrdersUpdateMerchantOrderIdRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersUpdateMerchantOrderIdResponse; - // Updates a shipment's status, carrier, and/or tracking ID. - updateshipment( - resource: Schema.OrdersUpdateShipmentRequest, - merchantId: string, - orderId: string, - ): Content.Schema.OrdersUpdateShipmentResponse; - } - interface PosCollection { - // Batches multiple POS-related calls in a single request. - custombatch(resource: Schema.PosCustomBatchRequest): Content.Schema.PosCustomBatchResponse; - // Batches multiple POS-related calls in a single request. - custombatch( - resource: Schema.PosCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.PosCustomBatchResponse; - // Retrieves information about the given store. - get(merchantId: string, targetMerchantId: string, storeCode: string): Content.Schema.PosStore; - // Creates a store for the given merchant. - insert( - resource: Schema.PosStore, - merchantId: string, - targetMerchantId: string, - ): Content.Schema.PosStore; - // Creates a store for the given merchant. - insert( - resource: Schema.PosStore, - merchantId: string, - targetMerchantId: string, - optionalArgs: object, - ): Content.Schema.PosStore; - // Submit inventory for the given merchant. - inventory( - resource: Schema.PosInventoryRequest, - merchantId: string, - targetMerchantId: string, - ): Content.Schema.PosInventoryResponse; - // Submit inventory for the given merchant. - inventory( - resource: Schema.PosInventoryRequest, - merchantId: string, - targetMerchantId: string, - optionalArgs: object, - ): Content.Schema.PosInventoryResponse; - // Lists the stores of the target merchant. - list(merchantId: string, targetMerchantId: string): Content.Schema.PosListResponse; - // Deletes a store for the given merchant. - remove(merchantId: string, targetMerchantId: string, storeCode: string): void; - // Deletes a store for the given merchant. - remove(merchantId: string, targetMerchantId: string, storeCode: string, optionalArgs: object): void; - // Submit a sale event for the given merchant. - sale( - resource: Schema.PosSaleRequest, - merchantId: string, - targetMerchantId: string, - ): Content.Schema.PosSaleResponse; - // Submit a sale event for the given merchant. - sale( - resource: Schema.PosSaleRequest, - merchantId: string, - targetMerchantId: string, - optionalArgs: object, - ): Content.Schema.PosSaleResponse; - } - interface ProductsCollection { - // Retrieves, inserts, and deletes multiple products in a single request. - custombatch(resource: Schema.ProductsCustomBatchRequest): Content.Schema.ProductsCustomBatchResponse; - // Retrieves, inserts, and deletes multiple products in a single request. - custombatch( - resource: Schema.ProductsCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.ProductsCustomBatchResponse; - // Retrieves a product from your Merchant Center account. - get(merchantId: string, productId: string): Content.Schema.Product; - // Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. - insert(resource: Schema.Product, merchantId: string): Content.Schema.Product; - // Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. - insert(resource: Schema.Product, merchantId: string, optionalArgs: object): Content.Schema.Product; - // Lists the products in your Merchant Center account. - list(merchantId: string): Content.Schema.ProductsListResponse; - // Lists the products in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.ProductsListResponse; - // Deletes a product from your Merchant Center account. - remove(merchantId: string, productId: string): void; - // Deletes a product from your Merchant Center account. - remove(merchantId: string, productId: string, optionalArgs: object): void; - } - interface ProductstatusesCollection { - // Gets the statuses of multiple products in a single request. - custombatch( - resource: Schema.ProductstatusesCustomBatchRequest, - ): Content.Schema.ProductstatusesCustomBatchResponse; - // Gets the statuses of multiple products in a single request. - custombatch( - resource: Schema.ProductstatusesCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.ProductstatusesCustomBatchResponse; - // Gets the status of a product from your Merchant Center account. - get(merchantId: string, productId: string): Content.Schema.ProductStatus; - // Gets the status of a product from your Merchant Center account. - get(merchantId: string, productId: string, optionalArgs: object): Content.Schema.ProductStatus; - // Lists the statuses of the products in your Merchant Center account. - list(merchantId: string): Content.Schema.ProductstatusesListResponse; - // Lists the statuses of the products in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.ProductstatusesListResponse; - } - interface ShippingsettingsCollection { - // Retrieves and updates the shipping settings of multiple accounts in a single request. - custombatch( - resource: Schema.ShippingsettingsCustomBatchRequest, - ): Content.Schema.ShippingsettingsCustomBatchResponse; - // Retrieves and updates the shipping settings of multiple accounts in a single request. - custombatch( - resource: Schema.ShippingsettingsCustomBatchRequest, - optionalArgs: object, - ): Content.Schema.ShippingsettingsCustomBatchResponse; - // Retrieves the shipping settings of the account. - get(merchantId: string, accountId: string): Content.Schema.ShippingSettings; - // Retrieves supported carriers and carrier services for an account. - getsupportedcarriers(merchantId: string): Content.Schema.ShippingsettingsGetSupportedCarriersResponse; - // Retrieves supported holidays for an account. - getsupportedholidays(merchantId: string): Content.Schema.ShippingsettingsGetSupportedHolidaysResponse; - // Lists the shipping settings of the sub-accounts in your Merchant Center account. - list(merchantId: string): Content.Schema.ShippingsettingsListResponse; - // Lists the shipping settings of the sub-accounts in your Merchant Center account. - list(merchantId: string, optionalArgs: object): Content.Schema.ShippingsettingsListResponse; - // Updates the shipping settings of the account. This method supports patch semantics. - patch( - resource: Schema.ShippingSettings, - merchantId: string, - accountId: string, - ): Content.Schema.ShippingSettings; - // Updates the shipping settings of the account. This method supports patch semantics. - patch( - resource: Schema.ShippingSettings, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.ShippingSettings; - // Updates the shipping settings of the account. - update( - resource: Schema.ShippingSettings, - merchantId: string, - accountId: string, - ): Content.Schema.ShippingSettings; - // Updates the shipping settings of the account. - update( - resource: Schema.ShippingSettings, - merchantId: string, - accountId: string, - optionalArgs: object, - ): Content.Schema.ShippingSettings; - } - } - namespace Schema { - interface Account { - adultContent?: boolean | undefined; - adwordsLinks?: Content.Schema.AccountAdwordsLink[] | undefined; - businessInformation?: Content.Schema.AccountBusinessInformation | undefined; - googleMyBusinessLink?: Content.Schema.AccountGoogleMyBusinessLink | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - reviewsUrl?: string | undefined; - sellerId?: string | undefined; - users?: Content.Schema.AccountUser[] | undefined; - websiteUrl?: string | undefined; - youtubeChannelLinks?: Content.Schema.AccountYouTubeChannelLink[] | undefined; - } - interface AccountAddress { - country?: string | undefined; - locality?: string | undefined; - postalCode?: string | undefined; - region?: string | undefined; - streetAddress?: string | undefined; - } - interface AccountAdwordsLink { - adwordsId?: string | undefined; - status?: string | undefined; - } - interface AccountBusinessInformation { - address?: Content.Schema.AccountAddress | undefined; - customerService?: Content.Schema.AccountCustomerService | undefined; - phoneNumber?: string | undefined; - } - interface AccountCustomerService { - email?: string | undefined; - phoneNumber?: string | undefined; - url?: string | undefined; - } - interface AccountGoogleMyBusinessLink { - gmbEmail?: string | undefined; - status?: string | undefined; - } - interface AccountIdentifier { - aggregatorId?: string | undefined; - merchantId?: string | undefined; - } - interface AccountStatus { - accountId?: string | undefined; - accountLevelIssues?: Content.Schema.AccountStatusAccountLevelIssue[] | undefined; - dataQualityIssues?: Content.Schema.AccountStatusDataQualityIssue[] | undefined; - kind?: string | undefined; - products?: Content.Schema.AccountStatusProducts[] | undefined; - websiteClaimed?: boolean | undefined; - } - interface AccountStatusAccountLevelIssue { - country?: string | undefined; - destination?: string | undefined; - detail?: string | undefined; - documentation?: string | undefined; - id?: string | undefined; - severity?: string | undefined; - title?: string | undefined; - } - interface AccountStatusDataQualityIssue { - country?: string | undefined; - destination?: string | undefined; - detail?: string | undefined; - displayedValue?: string | undefined; - exampleItems?: Content.Schema.AccountStatusExampleItem[] | undefined; - id?: string | undefined; - lastChecked?: string | undefined; - location?: string | undefined; - numItems?: number | undefined; - severity?: string | undefined; - submittedValue?: string | undefined; - } - interface AccountStatusExampleItem { - itemId?: string | undefined; - link?: string | undefined; - submittedValue?: string | undefined; - title?: string | undefined; - valueOnLandingPage?: string | undefined; - } - interface AccountStatusItemLevelIssue { - attributeName?: string | undefined; - code?: string | undefined; - description?: string | undefined; - detail?: string | undefined; - documentation?: string | undefined; - numItems?: string | undefined; - resolution?: string | undefined; - servability?: string | undefined; - } - interface AccountStatusProducts { - channel?: string | undefined; - country?: string | undefined; - destination?: string | undefined; - itemLevelIssues?: Content.Schema.AccountStatusItemLevelIssue[] | undefined; - statistics?: Content.Schema.AccountStatusStatistics | undefined; - } - interface AccountStatusStatistics { - active?: string | undefined; - disapproved?: string | undefined; - expiring?: string | undefined; - pending?: string | undefined; - } - interface AccountTax { - accountId?: string | undefined; - kind?: string | undefined; - rules?: Content.Schema.AccountTaxTaxRule[] | undefined; - } - interface AccountTaxTaxRule { - country?: string | undefined; - locationId?: string | undefined; - ratePercent?: string | undefined; - shippingTaxed?: boolean | undefined; - useGlobalRate?: boolean | undefined; - } - interface AccountUser { - admin?: boolean | undefined; - emailAddress?: string | undefined; - orderManager?: boolean | undefined; - paymentsAnalyst?: boolean | undefined; - paymentsManager?: boolean | undefined; - } - interface AccountYouTubeChannelLink { - channelId?: string | undefined; - status?: string | undefined; - } - interface AccountsAuthInfoResponse { - accountIdentifiers?: Content.Schema.AccountIdentifier[] | undefined; - kind?: string | undefined; - } - interface AccountsClaimWebsiteResponse { - kind?: string | undefined; - } - interface AccountsCustomBatchRequest { - entries?: Content.Schema.AccountsCustomBatchRequestEntry[] | undefined; - } - interface AccountsCustomBatchRequestEntry { - account?: Content.Schema.Account | undefined; - accountId?: string | undefined; - batchId?: number | undefined; - force?: boolean | undefined; - linkRequest?: Content.Schema.AccountsCustomBatchRequestEntryLinkRequest | undefined; - merchantId?: string | undefined; - method?: string | undefined; - overwrite?: boolean | undefined; - } - interface AccountsCustomBatchRequestEntryLinkRequest { - action?: string | undefined; - linkType?: string | undefined; - linkedAccountId?: string | undefined; - } - interface AccountsCustomBatchResponse { - entries?: Content.Schema.AccountsCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface AccountsCustomBatchResponseEntry { - account?: Content.Schema.Account | undefined; - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - linkStatus?: string | undefined; - } - interface AccountsLinkRequest { - action?: string | undefined; - linkType?: string | undefined; - linkedAccountId?: string | undefined; - } - interface AccountsLinkResponse { - kind?: string | undefined; - } - interface AccountsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.Account[] | undefined; - } - interface AccountstatusesCustomBatchRequest { - entries?: Content.Schema.AccountstatusesCustomBatchRequestEntry[] | undefined; - } - interface AccountstatusesCustomBatchRequestEntry { - accountId?: string | undefined; - batchId?: number | undefined; - destinations?: string[] | undefined; - merchantId?: string | undefined; - method?: string | undefined; - } - interface AccountstatusesCustomBatchResponse { - entries?: Content.Schema.AccountstatusesCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface AccountstatusesCustomBatchResponseEntry { - accountStatus?: Content.Schema.AccountStatus | undefined; - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - } - interface AccountstatusesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.AccountStatus[] | undefined; - } - interface AccounttaxCustomBatchRequest { - entries?: Content.Schema.AccounttaxCustomBatchRequestEntry[] | undefined; - } - interface AccounttaxCustomBatchRequestEntry { - accountId?: string | undefined; - accountTax?: Content.Schema.AccountTax | undefined; - batchId?: number | undefined; - merchantId?: string | undefined; - method?: string | undefined; - } - interface AccounttaxCustomBatchResponse { - entries?: Content.Schema.AccounttaxCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface AccounttaxCustomBatchResponseEntry { - accountTax?: Content.Schema.AccountTax | undefined; - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - } - interface AccounttaxListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.AccountTax[] | undefined; - } - interface Amount { - pretax?: Content.Schema.Price | undefined; - tax?: Content.Schema.Price | undefined; - } - interface CarrierRate { - carrierName?: string | undefined; - carrierService?: string | undefined; - flatAdjustment?: Content.Schema.Price | undefined; - name?: string | undefined; - originPostalCode?: string | undefined; - percentageAdjustment?: string | undefined; - } - interface CarriersCarrier { - country?: string | undefined; - name?: string | undefined; - services?: string[] | undefined; - } - interface CustomAttribute { - name?: string | undefined; - type?: string | undefined; - unit?: string | undefined; - value?: string | undefined; - } - interface CustomGroup { - attributes?: Content.Schema.CustomAttribute[] | undefined; - name?: string | undefined; - } - interface CustomerReturnReason { - description?: string | undefined; - reasonCode?: string | undefined; - } - interface CutoffTime { - hour?: number | undefined; - minute?: number | undefined; - timezone?: string | undefined; - } - interface Datafeed { - attributeLanguage?: string | undefined; - contentLanguage?: string | undefined; - contentType?: string | undefined; - fetchSchedule?: Content.Schema.DatafeedFetchSchedule | undefined; - fileName?: string | undefined; - format?: Content.Schema.DatafeedFormat | undefined; - id?: string | undefined; - intendedDestinations?: string[] | undefined; - kind?: string | undefined; - name?: string | undefined; - targetCountry?: string | undefined; - targets?: Content.Schema.DatafeedTarget[] | undefined; - } - interface DatafeedFetchSchedule { - dayOfMonth?: number | undefined; - fetchUrl?: string | undefined; - hour?: number | undefined; - minuteOfHour?: number | undefined; - password?: string | undefined; - paused?: boolean | undefined; - timeZone?: string | undefined; - username?: string | undefined; - weekday?: string | undefined; - } - interface DatafeedFormat { - columnDelimiter?: string | undefined; - fileEncoding?: string | undefined; - quotingMode?: string | undefined; - } - interface DatafeedStatus { - country?: string | undefined; - datafeedId?: string | undefined; - errors?: Content.Schema.DatafeedStatusError[] | undefined; - itemsTotal?: string | undefined; - itemsValid?: string | undefined; - kind?: string | undefined; - language?: string | undefined; - lastUploadDate?: string | undefined; - processingStatus?: string | undefined; - warnings?: Content.Schema.DatafeedStatusError[] | undefined; - } - interface DatafeedStatusError { - code?: string | undefined; - count?: string | undefined; - examples?: Content.Schema.DatafeedStatusExample[] | undefined; - message?: string | undefined; - } - interface DatafeedStatusExample { - itemId?: string | undefined; - lineNumber?: string | undefined; - value?: string | undefined; - } - interface DatafeedTarget { - country?: string | undefined; - excludedDestinations?: string[] | undefined; - includedDestinations?: string[] | undefined; - language?: string | undefined; - } - interface DatafeedsCustomBatchRequest { - entries?: Content.Schema.DatafeedsCustomBatchRequestEntry[] | undefined; - } - interface DatafeedsCustomBatchRequestEntry { - batchId?: number | undefined; - datafeed?: Content.Schema.Datafeed | undefined; - datafeedId?: string | undefined; - merchantId?: string | undefined; - method?: string | undefined; - } - interface DatafeedsCustomBatchResponse { - entries?: Content.Schema.DatafeedsCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface DatafeedsCustomBatchResponseEntry { - batchId?: number | undefined; - datafeed?: Content.Schema.Datafeed | undefined; - errors?: Content.Schema.Errors | undefined; - } - interface DatafeedsFetchNowResponse { - kind?: string | undefined; - } - interface DatafeedsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.Datafeed[] | undefined; - } - interface DatafeedstatusesCustomBatchRequest { - entries?: Content.Schema.DatafeedstatusesCustomBatchRequestEntry[] | undefined; - } - interface DatafeedstatusesCustomBatchRequestEntry { - batchId?: number | undefined; - country?: string | undefined; - datafeedId?: string | undefined; - language?: string | undefined; - merchantId?: string | undefined; - method?: string | undefined; - } - interface DatafeedstatusesCustomBatchResponse { - entries?: Content.Schema.DatafeedstatusesCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface DatafeedstatusesCustomBatchResponseEntry { - batchId?: number | undefined; - datafeedStatus?: Content.Schema.DatafeedStatus | undefined; - errors?: Content.Schema.Errors | undefined; - } - interface DatafeedstatusesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.DatafeedStatus[] | undefined; - } - interface DeliveryTime { - cutoffTime?: Content.Schema.CutoffTime | undefined; - holidayCutoffs?: Content.Schema.HolidayCutoff[] | undefined; - maxHandlingTimeInDays?: number | undefined; - maxTransitTimeInDays?: number | undefined; - minHandlingTimeInDays?: number | undefined; - minTransitTimeInDays?: number | undefined; - transitTimeTable?: Content.Schema.TransitTable | undefined; - } - interface Error { - domain?: string | undefined; - message?: string | undefined; - reason?: string | undefined; - } - interface Errors { - code?: number | undefined; - errors?: Content.Schema.Error[] | undefined; - message?: string | undefined; - } - interface GmbAccounts { - accountId?: string | undefined; - gmbAccounts?: Content.Schema.GmbAccountsGmbAccount[] | undefined; - } - interface GmbAccountsGmbAccount { - email?: string | undefined; - listingCount?: string | undefined; - name?: string | undefined; - type?: string | undefined; - } - interface Headers { - locations?: Content.Schema.LocationIdSet[] | undefined; - numberOfItems?: string[] | undefined; - postalCodeGroupNames?: string[] | undefined; - prices?: Content.Schema.Price[] | undefined; - weights?: Content.Schema.Weight[] | undefined; - } - interface HolidayCutoff { - deadlineDate?: string | undefined; - deadlineHour?: number | undefined; - deadlineTimezone?: string | undefined; - holidayId?: string | undefined; - visibleFromDate?: string | undefined; - } - interface HolidaysHoliday { - countryCode?: string | undefined; - date?: string | undefined; - deliveryGuaranteeDate?: string | undefined; - deliveryGuaranteeHour?: string | undefined; - id?: string | undefined; - type?: string | undefined; - } - interface Installment { - amount?: Content.Schema.Price | undefined; - months?: string | undefined; - } - interface Inventory { - availability?: string | undefined; - customLabel0?: string | undefined; - customLabel1?: string | undefined; - customLabel2?: string | undefined; - customLabel3?: string | undefined; - customLabel4?: string | undefined; - installment?: Content.Schema.Installment | undefined; - instoreProductLocation?: string | undefined; - kind?: string | undefined; - loyaltyPoints?: Content.Schema.LoyaltyPoints | undefined; - pickup?: Content.Schema.InventoryPickup | undefined; - price?: Content.Schema.Price | undefined; - quantity?: number | undefined; - salePrice?: Content.Schema.Price | undefined; - salePriceEffectiveDate?: string | undefined; - sellOnGoogleQuantity?: number | undefined; - } - interface InventoryCustomBatchRequest { - entries?: Content.Schema.InventoryCustomBatchRequestEntry[] | undefined; - } - interface InventoryCustomBatchRequestEntry { - batchId?: number | undefined; - inventory?: Content.Schema.Inventory | undefined; - merchantId?: string | undefined; - productId?: string | undefined; - storeCode?: string | undefined; - } - interface InventoryCustomBatchResponse { - entries?: Content.Schema.InventoryCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface InventoryCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - } - interface InventoryPickup { - pickupMethod?: string | undefined; - pickupSla?: string | undefined; - } - interface InventorySetRequest { - availability?: string | undefined; - customLabel0?: string | undefined; - customLabel1?: string | undefined; - customLabel2?: string | undefined; - customLabel3?: string | undefined; - customLabel4?: string | undefined; - installment?: Content.Schema.Installment | undefined; - instoreProductLocation?: string | undefined; - loyaltyPoints?: Content.Schema.LoyaltyPoints | undefined; - pickup?: Content.Schema.InventoryPickup | undefined; - price?: Content.Schema.Price | undefined; - quantity?: number | undefined; - salePrice?: Content.Schema.Price | undefined; - salePriceEffectiveDate?: string | undefined; - sellOnGoogleQuantity?: number | undefined; - } - interface InventorySetResponse { - kind?: string | undefined; - } - interface InvoiceSummary { - additionalChargeSummaries?: Content.Schema.InvoiceSummaryAdditionalChargeSummary[] | undefined; - customerBalance?: Content.Schema.Amount | undefined; - googleBalance?: Content.Schema.Amount | undefined; - merchantBalance?: Content.Schema.Amount | undefined; - productTotal?: Content.Schema.Amount | undefined; - promotionSummaries?: Content.Schema.Promotion[] | undefined; - } - interface InvoiceSummaryAdditionalChargeSummary { - totalAmount?: Content.Schema.Amount | undefined; - type?: string | undefined; - } - interface LiaAboutPageSettings { - status?: string | undefined; - url?: string | undefined; - } - interface LiaCountrySettings { - about?: Content.Schema.LiaAboutPageSettings | undefined; - country?: string | undefined; - hostedLocalStorefrontActive?: boolean | undefined; - inventory?: Content.Schema.LiaInventorySettings | undefined; - onDisplayToOrder?: Content.Schema.LiaOnDisplayToOrderSettings | undefined; - posDataProvider?: Content.Schema.LiaPosDataProvider | undefined; - storePickupActive?: boolean | undefined; - } - interface LiaInventorySettings { - inventoryVerificationContactEmail?: string | undefined; - inventoryVerificationContactName?: string | undefined; - inventoryVerificationContactStatus?: string | undefined; - status?: string | undefined; - } - interface LiaOnDisplayToOrderSettings { - shippingCostPolicyUrl?: string | undefined; - status?: string | undefined; - } - interface LiaPosDataProvider { - posDataProviderId?: string | undefined; - posExternalAccountId?: string | undefined; - } - interface LiaSettings { - accountId?: string | undefined; - countrySettings?: Content.Schema.LiaCountrySettings[] | undefined; - kind?: string | undefined; - } - interface LiasettingsCustomBatchRequest { - entries?: Content.Schema.LiasettingsCustomBatchRequestEntry[] | undefined; - } - interface LiasettingsCustomBatchRequestEntry { - accountId?: string | undefined; - batchId?: number | undefined; - contactEmail?: string | undefined; - contactName?: string | undefined; - country?: string | undefined; - gmbEmail?: string | undefined; - liaSettings?: Content.Schema.LiaSettings | undefined; - merchantId?: string | undefined; - method?: string | undefined; - posDataProviderId?: string | undefined; - posExternalAccountId?: string | undefined; - } - interface LiasettingsCustomBatchResponse { - entries?: Content.Schema.LiasettingsCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface LiasettingsCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - gmbAccounts?: Content.Schema.GmbAccounts | undefined; - kind?: string | undefined; - liaSettings?: Content.Schema.LiaSettings | undefined; - posDataProviders?: Content.Schema.PosDataProviders[] | undefined; - } - interface LiasettingsGetAccessibleGmbAccountsResponse { - accountId?: string | undefined; - gmbAccounts?: Content.Schema.GmbAccountsGmbAccount[] | undefined; - kind?: string | undefined; - } - interface LiasettingsListPosDataProvidersResponse { - kind?: string | undefined; - posDataProviders?: Content.Schema.PosDataProviders[] | undefined; - } - interface LiasettingsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.LiaSettings[] | undefined; - } - interface LiasettingsRequestGmbAccessResponse { - kind?: string | undefined; - } - interface LiasettingsRequestInventoryVerificationResponse { - kind?: string | undefined; - } - interface LiasettingsSetInventoryVerificationContactResponse { - kind?: string | undefined; - } - interface LiasettingsSetPosDataProviderResponse { - kind?: string | undefined; - } - interface LocationIdSet { - locationIds?: string[] | undefined; - } - interface LoyaltyPoints { - name?: string | undefined; - pointsValue?: string | undefined; - ratio?: number | undefined; - } - interface MerchantOrderReturn { - creationDate?: string | undefined; - merchantOrderId?: string | undefined; - orderId?: string | undefined; - orderReturnId?: string | undefined; - returnItems?: Content.Schema.MerchantOrderReturnItem[] | undefined; - returnShipments?: Content.Schema.ReturnShipment[] | undefined; - } - interface MerchantOrderReturnItem { - customerReturnReason?: Content.Schema.CustomerReturnReason | undefined; - itemId?: string | undefined; - merchantReturnReason?: Content.Schema.RefundReason | undefined; - product?: Content.Schema.OrderLineItemProduct | undefined; - returnShipmentIds?: string[] | undefined; - state?: string | undefined; - } - interface Order { - acknowledged?: boolean | undefined; - channelType?: string | undefined; - customer?: Content.Schema.OrderCustomer | undefined; - deliveryDetails?: Content.Schema.OrderDeliveryDetails | undefined; - id?: string | undefined; - kind?: string | undefined; - lineItems?: Content.Schema.OrderLineItem[] | undefined; - merchantId?: string | undefined; - merchantOrderId?: string | undefined; - netAmount?: Content.Schema.Price | undefined; - paymentMethod?: Content.Schema.OrderPaymentMethod | undefined; - paymentStatus?: string | undefined; - placedDate?: string | undefined; - promotions?: Content.Schema.OrderLegacyPromotion[] | undefined; - refunds?: Content.Schema.OrderRefund[] | undefined; - shipments?: Content.Schema.OrderShipment[] | undefined; - shippingCost?: Content.Schema.Price | undefined; - shippingCostTax?: Content.Schema.Price | undefined; - shippingOption?: string | undefined; - status?: string | undefined; - taxCollector?: string | undefined; - } - interface OrderAddress { - country?: string | undefined; - fullAddress?: string[] | undefined; - isPostOfficeBox?: boolean | undefined; - locality?: string | undefined; - postalCode?: string | undefined; - recipientName?: string | undefined; - region?: string | undefined; - streetAddress?: string[] | undefined; - } - interface OrderCancellation { - actor?: string | undefined; - creationDate?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrderCustomer { - email?: string | undefined; - explicitMarketingPreference?: boolean | undefined; - fullName?: string | undefined; - marketingRightsInfo?: Content.Schema.OrderCustomerMarketingRightsInfo | undefined; - } - interface OrderCustomerMarketingRightsInfo { - explicitMarketingPreference?: string | undefined; - lastUpdatedTimestamp?: string | undefined; - marketingEmailAddress?: string | undefined; - } - interface OrderDeliveryDetails { - address?: Content.Schema.OrderAddress | undefined; - phoneNumber?: string | undefined; - } - interface OrderLegacyPromotion { - benefits?: Content.Schema.OrderLegacyPromotionBenefit[] | undefined; - effectiveDates?: string | undefined; - genericRedemptionCode?: string | undefined; - id?: string | undefined; - longTitle?: string | undefined; - productApplicability?: string | undefined; - redemptionChannel?: string | undefined; - } - interface OrderLegacyPromotionBenefit { - discount?: Content.Schema.Price | undefined; - offerIds?: string[] | undefined; - subType?: string | undefined; - taxImpact?: Content.Schema.Price | undefined; - type?: string | undefined; - } - interface OrderLineItem { - annotations?: Content.Schema.OrderMerchantProvidedAnnotation[] | undefined; - cancellations?: Content.Schema.OrderCancellation[] | undefined; - id?: string | undefined; - price?: Content.Schema.Price | undefined; - product?: Content.Schema.OrderLineItemProduct | undefined; - quantityCanceled?: number | undefined; - quantityDelivered?: number | undefined; - quantityOrdered?: number | undefined; - quantityPending?: number | undefined; - quantityReturned?: number | undefined; - quantityShipped?: number | undefined; - returnInfo?: Content.Schema.OrderLineItemReturnInfo | undefined; - returns?: Content.Schema.OrderReturn[] | undefined; - shippingDetails?: Content.Schema.OrderLineItemShippingDetails | undefined; - tax?: Content.Schema.Price | undefined; - } - interface OrderLineItemProduct { - brand?: string | undefined; - channel?: string | undefined; - condition?: string | undefined; - contentLanguage?: string | undefined; - fees?: Content.Schema.OrderLineItemProductFee[] | undefined; - gtin?: string | undefined; - id?: string | undefined; - imageLink?: string | undefined; - itemGroupId?: string | undefined; - mpn?: string | undefined; - offerId?: string | undefined; - price?: Content.Schema.Price | undefined; - shownImage?: string | undefined; - targetCountry?: string | undefined; - title?: string | undefined; - variantAttributes?: Content.Schema.OrderLineItemProductVariantAttribute[] | undefined; - } - interface OrderLineItemProductFee { - amount?: Content.Schema.Price | undefined; - name?: string | undefined; - } - interface OrderLineItemProductVariantAttribute { - dimension?: string | undefined; - value?: string | undefined; - } - interface OrderLineItemReturnInfo { - daysToReturn?: number | undefined; - isReturnable?: boolean | undefined; - policyUrl?: string | undefined; - } - interface OrderLineItemShippingDetails { - deliverByDate?: string | undefined; - method?: Content.Schema.OrderLineItemShippingDetailsMethod | undefined; - shipByDate?: string | undefined; - } - interface OrderLineItemShippingDetailsMethod { - carrier?: string | undefined; - maxDaysInTransit?: number | undefined; - methodName?: string | undefined; - minDaysInTransit?: number | undefined; - } - interface OrderMerchantProvidedAnnotation { - key?: string | undefined; - value?: string | undefined; - } - interface OrderPaymentMethod { - billingAddress?: Content.Schema.OrderAddress | undefined; - expirationMonth?: number | undefined; - expirationYear?: number | undefined; - lastFourDigits?: string | undefined; - phoneNumber?: string | undefined; - type?: string | undefined; - } - interface OrderRefund { - actor?: string | undefined; - amount?: Content.Schema.Price | undefined; - creationDate?: string | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrderReportDisbursement { - disbursementAmount?: Content.Schema.Price | undefined; - disbursementCreationDate?: string | undefined; - disbursementDate?: string | undefined; - disbursementId?: string | undefined; - merchantId?: string | undefined; - } - interface OrderReportTransaction { - disbursementAmount?: Content.Schema.Price | undefined; - disbursementCreationDate?: string | undefined; - disbursementDate?: string | undefined; - disbursementId?: string | undefined; - merchantId?: string | undefined; - merchantOrderId?: string | undefined; - orderId?: string | undefined; - productAmount?: Content.Schema.Amount | undefined; - productAmountWithRemittedTax?: Content.Schema.ProductAmount | undefined; - transactionDate?: string | undefined; - } - interface OrderReturn { - actor?: string | undefined; - creationDate?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrderShipment { - carrier?: string | undefined; - creationDate?: string | undefined; - deliveryDate?: string | undefined; - id?: string | undefined; - lineItems?: Content.Schema.OrderShipmentLineItemShipment[] | undefined; - status?: string | undefined; - trackingId?: string | undefined; - } - interface OrderShipmentLineItemShipment { - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - } - interface OrderinvoicesCreateChargeInvoiceRequest { - invoiceId?: string | undefined; - invoiceSummary?: Content.Schema.InvoiceSummary | undefined; - lineItemInvoices?: Content.Schema.ShipmentInvoiceLineItemInvoice[] | undefined; - operationId?: string | undefined; - shipmentGroupId?: string | undefined; - } - interface OrderinvoicesCreateChargeInvoiceResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderinvoicesCreateRefundInvoiceRequest { - invoiceId?: string | undefined; - operationId?: string | undefined; - refundOnlyOption?: - | Content.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption - | undefined; - returnOption?: - | Content.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption - | undefined; - shipmentInvoices?: Content.Schema.ShipmentInvoice[] | undefined; - } - interface OrderinvoicesCreateRefundInvoiceResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption { - description?: string | undefined; - reason?: string | undefined; - } - interface OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption { - description?: string | undefined; - reason?: string | undefined; - } - interface OrderpaymentsNotifyAuthApprovedRequest { - authAmountPretax?: Content.Schema.Price | undefined; - authAmountTax?: Content.Schema.Price | undefined; - } - interface OrderpaymentsNotifyAuthApprovedResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderpaymentsNotifyAuthDeclinedRequest { - declineReason?: string | undefined; - } - interface OrderpaymentsNotifyAuthDeclinedResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderpaymentsNotifyChargeRequest { - chargeState?: string | undefined; - invoiceId?: string | undefined; - invoiceIds?: string[] | undefined; - } - interface OrderpaymentsNotifyChargeResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderpaymentsNotifyRefundRequest { - invoiceId?: string | undefined; - invoiceIds?: string[] | undefined; - refundState?: string | undefined; - } - interface OrderpaymentsNotifyRefundResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrderreportsListDisbursementsResponse { - disbursements?: Content.Schema.OrderReportDisbursement[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface OrderreportsListTransactionsResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - transactions?: Content.Schema.OrderReportTransaction[] | undefined; - } - interface OrderreturnsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.MerchantOrderReturn[] | undefined; - } - interface OrdersAcknowledgeRequest { - operationId?: string | undefined; - } - interface OrdersAcknowledgeResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersAdvanceTestOrderResponse { - kind?: string | undefined; - } - interface OrdersCancelLineItemRequest { - amount?: Content.Schema.Price | undefined; - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCancelLineItemResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersCancelRequest { - operationId?: string | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCancelResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersCancelTestOrderByCustomerRequest { - reason?: string | undefined; - } - interface OrdersCancelTestOrderByCustomerResponse { - kind?: string | undefined; - } - interface OrdersCreateTestOrderRequest { - country?: string | undefined; - templateName?: string | undefined; - testOrder?: Content.Schema.TestOrder | undefined; - } - interface OrdersCreateTestOrderResponse { - kind?: string | undefined; - orderId?: string | undefined; - } - interface OrdersCreateTestReturnRequest { - items?: Content.Schema.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem[] | undefined; - } - interface OrdersCreateTestReturnResponse { - kind?: string | undefined; - returnId?: string | undefined; - } - interface OrdersCustomBatchRequest { - entries?: Content.Schema.OrdersCustomBatchRequestEntry[] | undefined; - } - interface OrdersCustomBatchRequestEntry { - batchId?: number | undefined; - cancel?: Content.Schema.OrdersCustomBatchRequestEntryCancel | undefined; - cancelLineItem?: Content.Schema.OrdersCustomBatchRequestEntryCancelLineItem | undefined; - inStoreRefundLineItem?: Content.Schema.OrdersCustomBatchRequestEntryInStoreRefundLineItem | undefined; - merchantId?: string | undefined; - merchantOrderId?: string | undefined; - method?: string | undefined; - operationId?: string | undefined; - orderId?: string | undefined; - refund?: Content.Schema.OrdersCustomBatchRequestEntryRefund | undefined; - rejectReturnLineItem?: Content.Schema.OrdersCustomBatchRequestEntryRejectReturnLineItem | undefined; - returnLineItem?: Content.Schema.OrdersCustomBatchRequestEntryReturnLineItem | undefined; - returnRefundLineItem?: Content.Schema.OrdersCustomBatchRequestEntryReturnRefundLineItem | undefined; - setLineItemMetadata?: Content.Schema.OrdersCustomBatchRequestEntrySetLineItemMetadata | undefined; - shipLineItems?: Content.Schema.OrdersCustomBatchRequestEntryShipLineItems | undefined; - updateLineItemShippingDetails?: - | Content.Schema.OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails - | undefined; - updateShipment?: Content.Schema.OrdersCustomBatchRequestEntryUpdateShipment | undefined; - } - interface OrdersCustomBatchRequestEntryCancel { - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryCancelLineItem { - amount?: Content.Schema.Price | undefined; - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryCreateTestReturnReturnItem { - lineItemId?: string | undefined; - quantity?: number | undefined; - } - interface OrdersCustomBatchRequestEntryInStoreRefundLineItem { - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryRefund { - amount?: Content.Schema.Price | undefined; - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryRejectReturnLineItem { - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryReturnLineItem { - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntryReturnRefundLineItem { - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersCustomBatchRequestEntrySetLineItemMetadata { - annotations?: Content.Schema.OrderMerchantProvidedAnnotation[] | undefined; - lineItemId?: string | undefined; - productId?: string | undefined; - } - interface OrdersCustomBatchRequestEntryShipLineItems { - carrier?: string | undefined; - lineItems?: Content.Schema.OrderShipmentLineItemShipment[] | undefined; - shipmentGroupId?: string | undefined; - shipmentId?: string | undefined; - shipmentInfos?: Content.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[] | undefined; - trackingId?: string | undefined; - } - interface OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { - carrier?: string | undefined; - shipmentId?: string | undefined; - trackingId?: string | undefined; - } - interface OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails { - deliverByDate?: string | undefined; - lineItemId?: string | undefined; - productId?: string | undefined; - shipByDate?: string | undefined; - } - interface OrdersCustomBatchRequestEntryUpdateShipment { - carrier?: string | undefined; - deliveryDate?: string | undefined; - shipmentId?: string | undefined; - status?: string | undefined; - trackingId?: string | undefined; - } - interface OrdersCustomBatchResponse { - entries?: Content.Schema.OrdersCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface OrdersCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - executionStatus?: string | undefined; - kind?: string | undefined; - order?: Content.Schema.Order | undefined; - } - interface OrdersGetByMerchantOrderIdResponse { - kind?: string | undefined; - order?: Content.Schema.Order | undefined; - } - interface OrdersGetTestOrderTemplateResponse { - kind?: string | undefined; - template?: Content.Schema.TestOrder | undefined; - } - interface OrdersInStoreRefundLineItemRequest { - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersInStoreRefundLineItemResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.Order[] | undefined; - } - interface OrdersRefundRequest { - amount?: Content.Schema.Price | undefined; - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - operationId?: string | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersRefundResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersRejectReturnLineItemRequest { - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersRejectReturnLineItemResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersReturnLineItemRequest { - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersReturnLineItemResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersReturnRefundLineItemRequest { - amountPretax?: Content.Schema.Price | undefined; - amountTax?: Content.Schema.Price | undefined; - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - quantity?: number | undefined; - reason?: string | undefined; - reasonText?: string | undefined; - } - interface OrdersReturnRefundLineItemResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersSetLineItemMetadataRequest { - annotations?: Content.Schema.OrderMerchantProvidedAnnotation[] | undefined; - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - } - interface OrdersSetLineItemMetadataResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersShipLineItemsRequest { - carrier?: string | undefined; - lineItems?: Content.Schema.OrderShipmentLineItemShipment[] | undefined; - operationId?: string | undefined; - shipmentGroupId?: string | undefined; - shipmentId?: string | undefined; - shipmentInfos?: Content.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[] | undefined; - trackingId?: string | undefined; - } - interface OrdersShipLineItemsResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersUpdateLineItemShippingDetailsRequest { - deliverByDate?: string | undefined; - lineItemId?: string | undefined; - operationId?: string | undefined; - productId?: string | undefined; - shipByDate?: string | undefined; - } - interface OrdersUpdateLineItemShippingDetailsResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersUpdateMerchantOrderIdRequest { - merchantOrderId?: string | undefined; - operationId?: string | undefined; - } - interface OrdersUpdateMerchantOrderIdResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface OrdersUpdateShipmentRequest { - carrier?: string | undefined; - deliveryDate?: string | undefined; - operationId?: string | undefined; - shipmentId?: string | undefined; - status?: string | undefined; - trackingId?: string | undefined; - } - interface OrdersUpdateShipmentResponse { - executionStatus?: string | undefined; - kind?: string | undefined; - } - interface PosCustomBatchRequest { - entries?: Content.Schema.PosCustomBatchRequestEntry[] | undefined; - } - interface PosCustomBatchRequestEntry { - batchId?: number | undefined; - inventory?: Content.Schema.PosInventory | undefined; - merchantId?: string | undefined; - method?: string | undefined; - sale?: Content.Schema.PosSale | undefined; - store?: Content.Schema.PosStore | undefined; - storeCode?: string | undefined; - targetMerchantId?: string | undefined; - } - interface PosCustomBatchResponse { - entries?: Content.Schema.PosCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface PosCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - inventory?: Content.Schema.PosInventory | undefined; - kind?: string | undefined; - sale?: Content.Schema.PosSale | undefined; - store?: Content.Schema.PosStore | undefined; - } - interface PosDataProviders { - country?: string | undefined; - posDataProviders?: Content.Schema.PosDataProvidersPosDataProvider[] | undefined; - } - interface PosDataProvidersPosDataProvider { - displayName?: string | undefined; - fullName?: string | undefined; - providerId?: string | undefined; - } - interface PosInventory { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - kind?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosInventoryRequest { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosInventoryResponse { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - kind?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosListResponse { - kind?: string | undefined; - resources?: Content.Schema.PosStore[] | undefined; - } - interface PosSale { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - kind?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - saleId?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosSaleRequest { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - saleId?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosSaleResponse { - contentLanguage?: string | undefined; - gtin?: string | undefined; - itemId?: string | undefined; - kind?: string | undefined; - price?: Content.Schema.Price | undefined; - quantity?: string | undefined; - saleId?: string | undefined; - storeCode?: string | undefined; - targetCountry?: string | undefined; - timestamp?: string | undefined; - } - interface PosStore { - kind?: string | undefined; - storeAddress?: string | undefined; - storeCode?: string | undefined; - } - interface PostalCodeGroup { - country?: string | undefined; - name?: string | undefined; - postalCodeRanges?: Content.Schema.PostalCodeRange[] | undefined; - } - interface PostalCodeRange { - postalCodeRangeBegin?: string | undefined; - postalCodeRangeEnd?: string | undefined; - } - interface Price { - currency?: string | undefined; - value?: string | undefined; - } - interface Product { - additionalImageLinks?: string[] | undefined; - additionalProductTypes?: string[] | undefined; - adult?: boolean | undefined; - adwordsGrouping?: string | undefined; - adwordsLabels?: string[] | undefined; - adwordsRedirect?: string | undefined; - ageGroup?: string | undefined; - aspects?: Content.Schema.ProductAspect[] | undefined; - availability?: string | undefined; - availabilityDate?: string | undefined; - brand?: string | undefined; - channel?: string | undefined; - color?: string | undefined; - condition?: string | undefined; - contentLanguage?: string | undefined; - costOfGoodsSold?: Content.Schema.Price | undefined; - customAttributes?: Content.Schema.CustomAttribute[] | undefined; - customGroups?: Content.Schema.CustomGroup[] | undefined; - customLabel0?: string | undefined; - customLabel1?: string | undefined; - customLabel2?: string | undefined; - customLabel3?: string | undefined; - customLabel4?: string | undefined; - description?: string | undefined; - destinations?: Content.Schema.ProductDestination[] | undefined; - displayAdsId?: string | undefined; - displayAdsLink?: string | undefined; - displayAdsSimilarIds?: string[] | undefined; - displayAdsTitle?: string | undefined; - displayAdsValue?: number | undefined; - energyEfficiencyClass?: string | undefined; - expirationDate?: string | undefined; - gender?: string | undefined; - googleProductCategory?: string | undefined; - gtin?: string | undefined; - id?: string | undefined; - identifierExists?: boolean | undefined; - imageLink?: string | undefined; - installment?: Content.Schema.Installment | undefined; - isBundle?: boolean | undefined; - itemGroupId?: string | undefined; - kind?: string | undefined; - link?: string | undefined; - loyaltyPoints?: Content.Schema.LoyaltyPoints | undefined; - material?: string | undefined; - maxEnergyEfficiencyClass?: string | undefined; - maxHandlingTime?: string | undefined; - minEnergyEfficiencyClass?: string | undefined; - minHandlingTime?: string | undefined; - mobileLink?: string | undefined; - mpn?: string | undefined; - multipack?: string | undefined; - offerId?: string | undefined; - onlineOnly?: boolean | undefined; - pattern?: string | undefined; - price?: Content.Schema.Price | undefined; - productType?: string | undefined; - promotionIds?: string[] | undefined; - salePrice?: Content.Schema.Price | undefined; - salePriceEffectiveDate?: string | undefined; - sellOnGoogleQuantity?: string | undefined; - shipping?: Content.Schema.ProductShipping[] | undefined; - shippingHeight?: Content.Schema.ProductShippingDimension | undefined; - shippingLabel?: string | undefined; - shippingLength?: Content.Schema.ProductShippingDimension | undefined; - shippingWeight?: Content.Schema.ProductShippingWeight | undefined; - shippingWidth?: Content.Schema.ProductShippingDimension | undefined; - sizeSystem?: string | undefined; - sizeType?: string | undefined; - sizes?: string[] | undefined; - source?: string | undefined; - targetCountry?: string | undefined; - taxes?: Content.Schema.ProductTax[] | undefined; - title?: string | undefined; - unitPricingBaseMeasure?: Content.Schema.ProductUnitPricingBaseMeasure | undefined; - unitPricingMeasure?: Content.Schema.ProductUnitPricingMeasure | undefined; - validatedDestinations?: string[] | undefined; - warnings?: Content.Schema.Error[] | undefined; - } - interface ProductAmount { - priceAmount?: Content.Schema.Price | undefined; - remittedTaxAmount?: Content.Schema.Price | undefined; - taxAmount?: Content.Schema.Price | undefined; - } - interface ProductAspect { - aspectName?: string | undefined; - destinationName?: string | undefined; - intention?: string | undefined; - } - interface ProductDestination { - destinationName?: string | undefined; - intention?: string | undefined; - } - interface ProductShipping { - country?: string | undefined; - locationGroupName?: string | undefined; - locationId?: string | undefined; - postalCode?: string | undefined; - price?: Content.Schema.Price | undefined; - region?: string | undefined; - service?: string | undefined; - } - interface ProductShippingDimension { - unit?: string | undefined; - value?: number | undefined; - } - interface ProductShippingWeight { - unit?: string | undefined; - value?: number | undefined; - } - interface ProductStatus { - creationDate?: string | undefined; - dataQualityIssues?: Content.Schema.ProductStatusDataQualityIssue[] | undefined; - destinationStatuses?: Content.Schema.ProductStatusDestinationStatus[] | undefined; - googleExpirationDate?: string | undefined; - itemLevelIssues?: Content.Schema.ProductStatusItemLevelIssue[] | undefined; - kind?: string | undefined; - lastUpdateDate?: string | undefined; - link?: string | undefined; - product?: Content.Schema.Product | undefined; - productId?: string | undefined; - title?: string | undefined; - } - interface ProductStatusDataQualityIssue { - destination?: string | undefined; - detail?: string | undefined; - fetchStatus?: string | undefined; - id?: string | undefined; - location?: string | undefined; - severity?: string | undefined; - timestamp?: string | undefined; - valueOnLandingPage?: string | undefined; - valueProvided?: string | undefined; - } - interface ProductStatusDestinationStatus { - approvalPending?: boolean | undefined; - approvalStatus?: string | undefined; - destination?: string | undefined; - intention?: string | undefined; - } - interface ProductStatusItemLevelIssue { - attributeName?: string | undefined; - code?: string | undefined; - description?: string | undefined; - destination?: string | undefined; - detail?: string | undefined; - documentation?: string | undefined; - resolution?: string | undefined; - servability?: string | undefined; - } - interface ProductTax { - country?: string | undefined; - locationId?: string | undefined; - postalCode?: string | undefined; - rate?: number | undefined; - region?: string | undefined; - taxShip?: boolean | undefined; - } - interface ProductUnitPricingBaseMeasure { - unit?: string | undefined; - value?: string | undefined; - } - interface ProductUnitPricingMeasure { - unit?: string | undefined; - value?: number | undefined; - } - interface ProductsCustomBatchRequest { - entries?: Content.Schema.ProductsCustomBatchRequestEntry[] | undefined; - } - interface ProductsCustomBatchRequestEntry { - batchId?: number | undefined; - merchantId?: string | undefined; - method?: string | undefined; - product?: Content.Schema.Product | undefined; - productId?: string | undefined; - } - interface ProductsCustomBatchResponse { - entries?: Content.Schema.ProductsCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface ProductsCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - product?: Content.Schema.Product | undefined; - } - interface ProductsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.Product[] | undefined; - } - interface ProductstatusesCustomBatchRequest { - entries?: Content.Schema.ProductstatusesCustomBatchRequestEntry[] | undefined; - } - interface ProductstatusesCustomBatchRequestEntry { - batchId?: number | undefined; - destinations?: string[] | undefined; - includeAttributes?: boolean | undefined; - merchantId?: string | undefined; - method?: string | undefined; - productId?: string | undefined; - } - interface ProductstatusesCustomBatchResponse { - entries?: Content.Schema.ProductstatusesCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface ProductstatusesCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - productStatus?: Content.Schema.ProductStatus | undefined; - } - interface ProductstatusesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.ProductStatus[] | undefined; - } - interface Promotion { - promotionAmount?: Content.Schema.Amount | undefined; - promotionId?: string | undefined; - } - interface RateGroup { - applicableShippingLabels?: string[] | undefined; - carrierRates?: Content.Schema.CarrierRate[] | undefined; - mainTable?: Content.Schema.Table | undefined; - name?: string | undefined; - singleValue?: Content.Schema.Value | undefined; - subtables?: Content.Schema.Table[] | undefined; - } - interface RefundReason { - description?: string | undefined; - reasonCode?: string | undefined; - } - interface ReturnShipment { - creationDate?: string | undefined; - deliveryDate?: string | undefined; - returnMethodType?: string | undefined; - shipmentId?: string | undefined; - shipmentTrackingInfos?: Content.Schema.ShipmentTrackingInfo[] | undefined; - shippingDate?: string | undefined; - state?: string | undefined; - } - interface Row { - cells?: Content.Schema.Value[] | undefined; - } - interface Service { - active?: boolean | undefined; - currency?: string | undefined; - deliveryCountry?: string | undefined; - deliveryTime?: Content.Schema.DeliveryTime | undefined; - eligibility?: string | undefined; - minimumOrderValue?: Content.Schema.Price | undefined; - name?: string | undefined; - rateGroups?: Content.Schema.RateGroup[] | undefined; - } - interface ShipmentInvoice { - invoiceSummary?: Content.Schema.InvoiceSummary | undefined; - lineItemInvoices?: Content.Schema.ShipmentInvoiceLineItemInvoice[] | undefined; - shipmentGroupId?: string | undefined; - } - interface ShipmentInvoiceLineItemInvoice { - lineItemId?: string | undefined; - productId?: string | undefined; - shipmentUnitIds?: string[] | undefined; - unitInvoice?: Content.Schema.UnitInvoice | undefined; - } - interface ShipmentTrackingInfo { - carrier?: string | undefined; - trackingNumber?: string | undefined; - } - interface ShippingSettings { - accountId?: string | undefined; - postalCodeGroups?: Content.Schema.PostalCodeGroup[] | undefined; - services?: Content.Schema.Service[] | undefined; - } - interface ShippingsettingsCustomBatchRequest { - entries?: Content.Schema.ShippingsettingsCustomBatchRequestEntry[] | undefined; - } - interface ShippingsettingsCustomBatchRequestEntry { - accountId?: string | undefined; - batchId?: number | undefined; - merchantId?: string | undefined; - method?: string | undefined; - shippingSettings?: Content.Schema.ShippingSettings | undefined; - } - interface ShippingsettingsCustomBatchResponse { - entries?: Content.Schema.ShippingsettingsCustomBatchResponseEntry[] | undefined; - kind?: string | undefined; - } - interface ShippingsettingsCustomBatchResponseEntry { - batchId?: number | undefined; - errors?: Content.Schema.Errors | undefined; - kind?: string | undefined; - shippingSettings?: Content.Schema.ShippingSettings | undefined; - } - interface ShippingsettingsGetSupportedCarriersResponse { - carriers?: Content.Schema.CarriersCarrier[] | undefined; - kind?: string | undefined; - } - interface ShippingsettingsGetSupportedHolidaysResponse { - holidays?: Content.Schema.HolidaysHoliday[] | undefined; - kind?: string | undefined; - } - interface ShippingsettingsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - resources?: Content.Schema.ShippingSettings[] | undefined; - } - interface Table { - columnHeaders?: Content.Schema.Headers | undefined; - name?: string | undefined; - rowHeaders?: Content.Schema.Headers | undefined; - rows?: Content.Schema.Row[] | undefined; - } - interface TestOrder { - customer?: Content.Schema.TestOrderCustomer | undefined; - enableOrderinvoices?: boolean | undefined; - kind?: string | undefined; - lineItems?: Content.Schema.TestOrderLineItem[] | undefined; - notificationMode?: string | undefined; - paymentMethod?: Content.Schema.TestOrderPaymentMethod | undefined; - predefinedDeliveryAddress?: string | undefined; - promotions?: Content.Schema.OrderLegacyPromotion[] | undefined; - shippingCost?: Content.Schema.Price | undefined; - shippingCostTax?: Content.Schema.Price | undefined; - shippingOption?: string | undefined; - } - interface TestOrderCustomer { - email?: string | undefined; - explicitMarketingPreference?: boolean | undefined; - fullName?: string | undefined; - marketingRightsInfo?: Content.Schema.TestOrderCustomerMarketingRightsInfo | undefined; - } - interface TestOrderCustomerMarketingRightsInfo { - explicitMarketingPreference?: string | undefined; - lastUpdatedTimestamp?: string | undefined; - } - interface TestOrderLineItem { - product?: Content.Schema.TestOrderLineItemProduct | undefined; - quantityOrdered?: number | undefined; - returnInfo?: Content.Schema.OrderLineItemReturnInfo | undefined; - shippingDetails?: Content.Schema.OrderLineItemShippingDetails | undefined; - unitTax?: Content.Schema.Price | undefined; - } - interface TestOrderLineItemProduct { - brand?: string | undefined; - channel?: string | undefined; - condition?: string | undefined; - contentLanguage?: string | undefined; - gtin?: string | undefined; - imageLink?: string | undefined; - itemGroupId?: string | undefined; - mpn?: string | undefined; - offerId?: string | undefined; - price?: Content.Schema.Price | undefined; - targetCountry?: string | undefined; - title?: string | undefined; - variantAttributes?: Content.Schema.OrderLineItemProductVariantAttribute[] | undefined; - } - interface TestOrderPaymentMethod { - expirationMonth?: number | undefined; - expirationYear?: number | undefined; - lastFourDigits?: string | undefined; - predefinedBillingAddress?: string | undefined; - type?: string | undefined; - } - interface TransitTable { - postalCodeGroupNames?: string[] | undefined; - rows?: Content.Schema.TransitTableTransitTimeRow[] | undefined; - transitTimeLabels?: string[] | undefined; - } - interface TransitTableTransitTimeRow { - values?: Content.Schema.TransitTableTransitTimeRowTransitTimeValue[] | undefined; - } - interface TransitTableTransitTimeRowTransitTimeValue { - maxTransitTimeInDays?: number | undefined; - minTransitTimeInDays?: number | undefined; - } - interface UnitInvoice { - additionalCharges?: Content.Schema.UnitInvoiceAdditionalCharge[] | undefined; - promotions?: Content.Schema.Promotion[] | undefined; - unitPricePretax?: Content.Schema.Price | undefined; - unitPriceTaxes?: Content.Schema.UnitInvoiceTaxLine[] | undefined; - } - interface UnitInvoiceAdditionalCharge { - additionalChargeAmount?: Content.Schema.Amount | undefined; - additionalChargePromotions?: Content.Schema.Promotion[] | undefined; - type?: string | undefined; - } - interface UnitInvoiceTaxLine { - taxAmount?: Content.Schema.Price | undefined; - taxName?: string | undefined; - taxType?: string | undefined; - } - interface Value { - carrierRateName?: string | undefined; - flatRate?: Content.Schema.Price | undefined; - noShipping?: boolean | undefined; - pricePercentage?: string | undefined; - subtableName?: string | undefined; - } - interface Weight { - unit?: string | undefined; - value?: string | undefined; - } - } - } - interface Content { - Accounts?: Content.Collection.AccountsCollection | undefined; - Accountstatuses?: Content.Collection.AccountstatusesCollection | undefined; - Accounttax?: Content.Collection.AccounttaxCollection | undefined; - Datafeeds?: Content.Collection.DatafeedsCollection | undefined; - Datafeedstatuses?: Content.Collection.DatafeedstatusesCollection | undefined; - Inventory?: Content.Collection.InventoryCollection | undefined; - Liasettings?: Content.Collection.LiasettingsCollection | undefined; - Orderinvoices?: Content.Collection.OrderinvoicesCollection | undefined; - Orderpayments?: Content.Collection.OrderpaymentsCollection | undefined; - Orderreports?: Content.Collection.OrderreportsCollection | undefined; - Orderreturns?: Content.Collection.OrderreturnsCollection | undefined; - Orders?: Content.Collection.OrdersCollection | undefined; - Pos?: Content.Collection.PosCollection | undefined; - Products?: Content.Collection.ProductsCollection | undefined; - Productstatuses?: Content.Collection.ProductstatusesCollection | undefined; - Shippingsettings?: Content.Collection.ShippingsettingsCollection | undefined; - // Create a new instance of Account - newAccount(): Content.Schema.Account; - // Create a new instance of AccountAddress - newAccountAddress(): Content.Schema.AccountAddress; - // Create a new instance of AccountAdwordsLink - newAccountAdwordsLink(): Content.Schema.AccountAdwordsLink; - // Create a new instance of AccountBusinessInformation - newAccountBusinessInformation(): Content.Schema.AccountBusinessInformation; - // Create a new instance of AccountCustomerService - newAccountCustomerService(): Content.Schema.AccountCustomerService; - // Create a new instance of AccountGoogleMyBusinessLink - newAccountGoogleMyBusinessLink(): Content.Schema.AccountGoogleMyBusinessLink; - // Create a new instance of AccountTax - newAccountTax(): Content.Schema.AccountTax; - // Create a new instance of AccountTaxTaxRule - newAccountTaxTaxRule(): Content.Schema.AccountTaxTaxRule; - // Create a new instance of AccountUser - newAccountUser(): Content.Schema.AccountUser; - // Create a new instance of AccountYouTubeChannelLink - newAccountYouTubeChannelLink(): Content.Schema.AccountYouTubeChannelLink; - // Create a new instance of AccountsCustomBatchRequest - newAccountsCustomBatchRequest(): Content.Schema.AccountsCustomBatchRequest; - // Create a new instance of AccountsCustomBatchRequestEntry - newAccountsCustomBatchRequestEntry(): Content.Schema.AccountsCustomBatchRequestEntry; - // Create a new instance of AccountsCustomBatchRequestEntryLinkRequest - newAccountsCustomBatchRequestEntryLinkRequest(): Content.Schema.AccountsCustomBatchRequestEntryLinkRequest; - // Create a new instance of AccountsLinkRequest - newAccountsLinkRequest(): Content.Schema.AccountsLinkRequest; - // Create a new instance of AccountstatusesCustomBatchRequest - newAccountstatusesCustomBatchRequest(): Content.Schema.AccountstatusesCustomBatchRequest; - // Create a new instance of AccountstatusesCustomBatchRequestEntry - newAccountstatusesCustomBatchRequestEntry(): Content.Schema.AccountstatusesCustomBatchRequestEntry; - // Create a new instance of AccounttaxCustomBatchRequest - newAccounttaxCustomBatchRequest(): Content.Schema.AccounttaxCustomBatchRequest; - // Create a new instance of AccounttaxCustomBatchRequestEntry - newAccounttaxCustomBatchRequestEntry(): Content.Schema.AccounttaxCustomBatchRequestEntry; - // Create a new instance of Amount - newAmount(): Content.Schema.Amount; - // Create a new instance of CarrierRate - newCarrierRate(): Content.Schema.CarrierRate; - // Create a new instance of CustomAttribute - newCustomAttribute(): Content.Schema.CustomAttribute; - // Create a new instance of CustomGroup - newCustomGroup(): Content.Schema.CustomGroup; - // Create a new instance of CutoffTime - newCutoffTime(): Content.Schema.CutoffTime; - // Create a new instance of Datafeed - newDatafeed(): Content.Schema.Datafeed; - // Create a new instance of DatafeedFetchSchedule - newDatafeedFetchSchedule(): Content.Schema.DatafeedFetchSchedule; - // Create a new instance of DatafeedFormat - newDatafeedFormat(): Content.Schema.DatafeedFormat; - // Create a new instance of DatafeedTarget - newDatafeedTarget(): Content.Schema.DatafeedTarget; - // Create a new instance of DatafeedsCustomBatchRequest - newDatafeedsCustomBatchRequest(): Content.Schema.DatafeedsCustomBatchRequest; - // Create a new instance of DatafeedsCustomBatchRequestEntry - newDatafeedsCustomBatchRequestEntry(): Content.Schema.DatafeedsCustomBatchRequestEntry; - // Create a new instance of DatafeedstatusesCustomBatchRequest - newDatafeedstatusesCustomBatchRequest(): Content.Schema.DatafeedstatusesCustomBatchRequest; - // Create a new instance of DatafeedstatusesCustomBatchRequestEntry - newDatafeedstatusesCustomBatchRequestEntry(): Content.Schema.DatafeedstatusesCustomBatchRequestEntry; - // Create a new instance of DeliveryTime - newDeliveryTime(): Content.Schema.DeliveryTime; - // Create a new instance of Error - newError(): Content.Schema.Error; - // Create a new instance of Headers - newHeaders(): Content.Schema.Headers; - // Create a new instance of HolidayCutoff - newHolidayCutoff(): Content.Schema.HolidayCutoff; - // Create a new instance of Installment - newInstallment(): Content.Schema.Installment; - // Create a new instance of Inventory - newInventory(): Content.Schema.Inventory; - // Create a new instance of InventoryCustomBatchRequest - newInventoryCustomBatchRequest(): Content.Schema.InventoryCustomBatchRequest; - // Create a new instance of InventoryCustomBatchRequestEntry - newInventoryCustomBatchRequestEntry(): Content.Schema.InventoryCustomBatchRequestEntry; - // Create a new instance of InventoryPickup - newInventoryPickup(): Content.Schema.InventoryPickup; - // Create a new instance of InventorySetRequest - newInventorySetRequest(): Content.Schema.InventorySetRequest; - // Create a new instance of InvoiceSummary - newInvoiceSummary(): Content.Schema.InvoiceSummary; - // Create a new instance of InvoiceSummaryAdditionalChargeSummary - newInvoiceSummaryAdditionalChargeSummary(): Content.Schema.InvoiceSummaryAdditionalChargeSummary; - // Create a new instance of LiaAboutPageSettings - newLiaAboutPageSettings(): Content.Schema.LiaAboutPageSettings; - // Create a new instance of LiaCountrySettings - newLiaCountrySettings(): Content.Schema.LiaCountrySettings; - // Create a new instance of LiaInventorySettings - newLiaInventorySettings(): Content.Schema.LiaInventorySettings; - // Create a new instance of LiaOnDisplayToOrderSettings - newLiaOnDisplayToOrderSettings(): Content.Schema.LiaOnDisplayToOrderSettings; - // Create a new instance of LiaPosDataProvider - newLiaPosDataProvider(): Content.Schema.LiaPosDataProvider; - // Create a new instance of LiaSettings - newLiaSettings(): Content.Schema.LiaSettings; - // Create a new instance of LiasettingsCustomBatchRequest - newLiasettingsCustomBatchRequest(): Content.Schema.LiasettingsCustomBatchRequest; - // Create a new instance of LiasettingsCustomBatchRequestEntry - newLiasettingsCustomBatchRequestEntry(): Content.Schema.LiasettingsCustomBatchRequestEntry; - // Create a new instance of LocationIdSet - newLocationIdSet(): Content.Schema.LocationIdSet; - // Create a new instance of LoyaltyPoints - newLoyaltyPoints(): Content.Schema.LoyaltyPoints; - // Create a new instance of OrderLegacyPromotion - newOrderLegacyPromotion(): Content.Schema.OrderLegacyPromotion; - // Create a new instance of OrderLegacyPromotionBenefit - newOrderLegacyPromotionBenefit(): Content.Schema.OrderLegacyPromotionBenefit; - // Create a new instance of OrderLineItemProductVariantAttribute - newOrderLineItemProductVariantAttribute(): Content.Schema.OrderLineItemProductVariantAttribute; - // Create a new instance of OrderLineItemReturnInfo - newOrderLineItemReturnInfo(): Content.Schema.OrderLineItemReturnInfo; - // Create a new instance of OrderLineItemShippingDetails - newOrderLineItemShippingDetails(): Content.Schema.OrderLineItemShippingDetails; - // Create a new instance of OrderLineItemShippingDetailsMethod - newOrderLineItemShippingDetailsMethod(): Content.Schema.OrderLineItemShippingDetailsMethod; - // Create a new instance of OrderMerchantProvidedAnnotation - newOrderMerchantProvidedAnnotation(): Content.Schema.OrderMerchantProvidedAnnotation; - // Create a new instance of OrderShipmentLineItemShipment - newOrderShipmentLineItemShipment(): Content.Schema.OrderShipmentLineItemShipment; - // Create a new instance of OrderinvoicesCreateChargeInvoiceRequest - newOrderinvoicesCreateChargeInvoiceRequest(): Content.Schema.OrderinvoicesCreateChargeInvoiceRequest; - // Create a new instance of OrderinvoicesCreateRefundInvoiceRequest - newOrderinvoicesCreateRefundInvoiceRequest(): Content.Schema.OrderinvoicesCreateRefundInvoiceRequest; - // Create a new instance of OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption - newOrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption(): Content.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; - // Create a new instance of OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption - newOrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption(): Content.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; - // Create a new instance of OrderpaymentsNotifyAuthApprovedRequest - newOrderpaymentsNotifyAuthApprovedRequest(): Content.Schema.OrderpaymentsNotifyAuthApprovedRequest; - // Create a new instance of OrderpaymentsNotifyAuthDeclinedRequest - newOrderpaymentsNotifyAuthDeclinedRequest(): Content.Schema.OrderpaymentsNotifyAuthDeclinedRequest; - // Create a new instance of OrderpaymentsNotifyChargeRequest - newOrderpaymentsNotifyChargeRequest(): Content.Schema.OrderpaymentsNotifyChargeRequest; - // Create a new instance of OrderpaymentsNotifyRefundRequest - newOrderpaymentsNotifyRefundRequest(): Content.Schema.OrderpaymentsNotifyRefundRequest; - // Create a new instance of OrdersAcknowledgeRequest - newOrdersAcknowledgeRequest(): Content.Schema.OrdersAcknowledgeRequest; - // Create a new instance of OrdersCancelLineItemRequest - newOrdersCancelLineItemRequest(): Content.Schema.OrdersCancelLineItemRequest; - // Create a new instance of OrdersCancelRequest - newOrdersCancelRequest(): Content.Schema.OrdersCancelRequest; - // Create a new instance of OrdersCancelTestOrderByCustomerRequest - newOrdersCancelTestOrderByCustomerRequest(): Content.Schema.OrdersCancelTestOrderByCustomerRequest; - // Create a new instance of OrdersCreateTestOrderRequest - newOrdersCreateTestOrderRequest(): Content.Schema.OrdersCreateTestOrderRequest; - // Create a new instance of OrdersCreateTestReturnRequest - newOrdersCreateTestReturnRequest(): Content.Schema.OrdersCreateTestReturnRequest; - // Create a new instance of OrdersCustomBatchRequest - newOrdersCustomBatchRequest(): Content.Schema.OrdersCustomBatchRequest; - // Create a new instance of OrdersCustomBatchRequestEntry - newOrdersCustomBatchRequestEntry(): Content.Schema.OrdersCustomBatchRequestEntry; - // Create a new instance of OrdersCustomBatchRequestEntryCancel - newOrdersCustomBatchRequestEntryCancel(): Content.Schema.OrdersCustomBatchRequestEntryCancel; - // Create a new instance of OrdersCustomBatchRequestEntryCancelLineItem - newOrdersCustomBatchRequestEntryCancelLineItem(): Content.Schema.OrdersCustomBatchRequestEntryCancelLineItem; - // Create a new instance of OrdersCustomBatchRequestEntryCreateTestReturnReturnItem - newOrdersCustomBatchRequestEntryCreateTestReturnReturnItem(): Content.Schema.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem; - // Create a new instance of OrdersCustomBatchRequestEntryInStoreRefundLineItem - newOrdersCustomBatchRequestEntryInStoreRefundLineItem(): Content.Schema.OrdersCustomBatchRequestEntryInStoreRefundLineItem; - // Create a new instance of OrdersCustomBatchRequestEntryRefund - newOrdersCustomBatchRequestEntryRefund(): Content.Schema.OrdersCustomBatchRequestEntryRefund; - // Create a new instance of OrdersCustomBatchRequestEntryRejectReturnLineItem - newOrdersCustomBatchRequestEntryRejectReturnLineItem(): Content.Schema.OrdersCustomBatchRequestEntryRejectReturnLineItem; - // Create a new instance of OrdersCustomBatchRequestEntryReturnLineItem - newOrdersCustomBatchRequestEntryReturnLineItem(): Content.Schema.OrdersCustomBatchRequestEntryReturnLineItem; - // Create a new instance of OrdersCustomBatchRequestEntryReturnRefundLineItem - newOrdersCustomBatchRequestEntryReturnRefundLineItem(): Content.Schema.OrdersCustomBatchRequestEntryReturnRefundLineItem; - // Create a new instance of OrdersCustomBatchRequestEntrySetLineItemMetadata - newOrdersCustomBatchRequestEntrySetLineItemMetadata(): Content.Schema.OrdersCustomBatchRequestEntrySetLineItemMetadata; - // Create a new instance of OrdersCustomBatchRequestEntryShipLineItems - newOrdersCustomBatchRequestEntryShipLineItems(): Content.Schema.OrdersCustomBatchRequestEntryShipLineItems; - // Create a new instance of OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo - newOrdersCustomBatchRequestEntryShipLineItemsShipmentInfo(): Content.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo; - // Create a new instance of OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails - newOrdersCustomBatchRequestEntryUpdateLineItemShippingDetails(): Content.Schema.OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails; - // Create a new instance of OrdersCustomBatchRequestEntryUpdateShipment - newOrdersCustomBatchRequestEntryUpdateShipment(): Content.Schema.OrdersCustomBatchRequestEntryUpdateShipment; - // Create a new instance of OrdersInStoreRefundLineItemRequest - newOrdersInStoreRefundLineItemRequest(): Content.Schema.OrdersInStoreRefundLineItemRequest; - // Create a new instance of OrdersRefundRequest - newOrdersRefundRequest(): Content.Schema.OrdersRefundRequest; - // Create a new instance of OrdersRejectReturnLineItemRequest - newOrdersRejectReturnLineItemRequest(): Content.Schema.OrdersRejectReturnLineItemRequest; - // Create a new instance of OrdersReturnLineItemRequest - newOrdersReturnLineItemRequest(): Content.Schema.OrdersReturnLineItemRequest; - // Create a new instance of OrdersReturnRefundLineItemRequest - newOrdersReturnRefundLineItemRequest(): Content.Schema.OrdersReturnRefundLineItemRequest; - // Create a new instance of OrdersSetLineItemMetadataRequest - newOrdersSetLineItemMetadataRequest(): Content.Schema.OrdersSetLineItemMetadataRequest; - // Create a new instance of OrdersShipLineItemsRequest - newOrdersShipLineItemsRequest(): Content.Schema.OrdersShipLineItemsRequest; - // Create a new instance of OrdersUpdateLineItemShippingDetailsRequest - newOrdersUpdateLineItemShippingDetailsRequest(): Content.Schema.OrdersUpdateLineItemShippingDetailsRequest; - // Create a new instance of OrdersUpdateMerchantOrderIdRequest - newOrdersUpdateMerchantOrderIdRequest(): Content.Schema.OrdersUpdateMerchantOrderIdRequest; - // Create a new instance of OrdersUpdateShipmentRequest - newOrdersUpdateShipmentRequest(): Content.Schema.OrdersUpdateShipmentRequest; - // Create a new instance of PosCustomBatchRequest - newPosCustomBatchRequest(): Content.Schema.PosCustomBatchRequest; - // Create a new instance of PosCustomBatchRequestEntry - newPosCustomBatchRequestEntry(): Content.Schema.PosCustomBatchRequestEntry; - // Create a new instance of PosInventory - newPosInventory(): Content.Schema.PosInventory; - // Create a new instance of PosInventoryRequest - newPosInventoryRequest(): Content.Schema.PosInventoryRequest; - // Create a new instance of PosSale - newPosSale(): Content.Schema.PosSale; - // Create a new instance of PosSaleRequest - newPosSaleRequest(): Content.Schema.PosSaleRequest; - // Create a new instance of PosStore - newPosStore(): Content.Schema.PosStore; - // Create a new instance of PostalCodeGroup - newPostalCodeGroup(): Content.Schema.PostalCodeGroup; - // Create a new instance of PostalCodeRange - newPostalCodeRange(): Content.Schema.PostalCodeRange; - // Create a new instance of Price - newPrice(): Content.Schema.Price; - // Create a new instance of Product - newProduct(): Content.Schema.Product; - // Create a new instance of ProductAspect - newProductAspect(): Content.Schema.ProductAspect; - // Create a new instance of ProductDestination - newProductDestination(): Content.Schema.ProductDestination; - // Create a new instance of ProductShipping - newProductShipping(): Content.Schema.ProductShipping; - // Create a new instance of ProductShippingDimension - newProductShippingDimension(): Content.Schema.ProductShippingDimension; - // Create a new instance of ProductShippingWeight - newProductShippingWeight(): Content.Schema.ProductShippingWeight; - // Create a new instance of ProductTax - newProductTax(): Content.Schema.ProductTax; - // Create a new instance of ProductUnitPricingBaseMeasure - newProductUnitPricingBaseMeasure(): Content.Schema.ProductUnitPricingBaseMeasure; - // Create a new instance of ProductUnitPricingMeasure - newProductUnitPricingMeasure(): Content.Schema.ProductUnitPricingMeasure; - // Create a new instance of ProductsCustomBatchRequest - newProductsCustomBatchRequest(): Content.Schema.ProductsCustomBatchRequest; - // Create a new instance of ProductsCustomBatchRequestEntry - newProductsCustomBatchRequestEntry(): Content.Schema.ProductsCustomBatchRequestEntry; - // Create a new instance of ProductstatusesCustomBatchRequest - newProductstatusesCustomBatchRequest(): Content.Schema.ProductstatusesCustomBatchRequest; - // Create a new instance of ProductstatusesCustomBatchRequestEntry - newProductstatusesCustomBatchRequestEntry(): Content.Schema.ProductstatusesCustomBatchRequestEntry; - // Create a new instance of Promotion - newPromotion(): Content.Schema.Promotion; - // Create a new instance of RateGroup - newRateGroup(): Content.Schema.RateGroup; - // Create a new instance of Row - newRow(): Content.Schema.Row; - // Create a new instance of Service - newService(): Content.Schema.Service; - // Create a new instance of ShipmentInvoice - newShipmentInvoice(): Content.Schema.ShipmentInvoice; - // Create a new instance of ShipmentInvoiceLineItemInvoice - newShipmentInvoiceLineItemInvoice(): Content.Schema.ShipmentInvoiceLineItemInvoice; - // Create a new instance of ShippingSettings - newShippingSettings(): Content.Schema.ShippingSettings; - // Create a new instance of ShippingsettingsCustomBatchRequest - newShippingsettingsCustomBatchRequest(): Content.Schema.ShippingsettingsCustomBatchRequest; - // Create a new instance of ShippingsettingsCustomBatchRequestEntry - newShippingsettingsCustomBatchRequestEntry(): Content.Schema.ShippingsettingsCustomBatchRequestEntry; - // Create a new instance of Table - newTable(): Content.Schema.Table; - // Create a new instance of TestOrder - newTestOrder(): Content.Schema.TestOrder; - // Create a new instance of TestOrderCustomer - newTestOrderCustomer(): Content.Schema.TestOrderCustomer; - // Create a new instance of TestOrderCustomerMarketingRightsInfo - newTestOrderCustomerMarketingRightsInfo(): Content.Schema.TestOrderCustomerMarketingRightsInfo; - // Create a new instance of TestOrderLineItem - newTestOrderLineItem(): Content.Schema.TestOrderLineItem; - // Create a new instance of TestOrderLineItemProduct - newTestOrderLineItemProduct(): Content.Schema.TestOrderLineItemProduct; - // Create a new instance of TestOrderPaymentMethod - newTestOrderPaymentMethod(): Content.Schema.TestOrderPaymentMethod; - // Create a new instance of TransitTable - newTransitTable(): Content.Schema.TransitTable; - // Create a new instance of TransitTableTransitTimeRow - newTransitTableTransitTimeRow(): Content.Schema.TransitTableTransitTimeRow; - // Create a new instance of TransitTableTransitTimeRowTransitTimeValue - newTransitTableTransitTimeRowTransitTimeValue(): Content.Schema.TransitTableTransitTimeRowTransitTimeValue; - // Create a new instance of UnitInvoice - newUnitInvoice(): Content.Schema.UnitInvoice; - // Create a new instance of UnitInvoiceAdditionalCharge - newUnitInvoiceAdditionalCharge(): Content.Schema.UnitInvoiceAdditionalCharge; - // Create a new instance of UnitInvoiceTaxLine - newUnitInvoiceTaxLine(): Content.Schema.UnitInvoiceTaxLine; - // Create a new instance of Value - newValue(): Content.Schema.Value; - // Create a new instance of Weight - newWeight(): Content.Schema.Weight; - } -} - -declare var Content: GoogleAppsScript.Content; diff --git a/node_modules/@types/google-apps-script/apis/dfareporting_v3_3.d.ts b/node_modules/@types/google-apps-script/apis/dfareporting_v3_3.d.ts deleted file mode 100644 index 045d84d..0000000 --- a/node_modules/@types/google-apps-script/apis/dfareporting_v3_3.d.ts +++ /dev/null @@ -1,2903 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Dfareporting { - namespace Collection { - namespace Reports { - interface CompatibleFieldsCollection { - // Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. - query(resource: Schema.Report, profileId: string): Dfareporting.Schema.CompatibleFields; - } - interface FilesCollection { - // Retrieves a report file. This method supports media download. - get(profileId: string, reportId: string, fileId: string): Dfareporting.Schema.File; - // Lists files for a report. - list(profileId: string, reportId: string): Dfareporting.Schema.FileList; - // Lists files for a report. - list(profileId: string, reportId: string, optionalArgs: object): Dfareporting.Schema.FileList; - } - } - interface AccountActiveAdSummariesCollection { - // Gets the account's active ad summary by account ID. - get(profileId: string, summaryAccountId: string): Dfareporting.Schema.AccountActiveAdSummary; - } - interface AccountPermissionGroupsCollection { - // Gets one account permission group by ID. - get(profileId: string, id: string): Dfareporting.Schema.AccountPermissionGroup; - // Retrieves the list of account permission groups. - list(profileId: string): Dfareporting.Schema.AccountPermissionGroupsListResponse; - } - interface AccountPermissionsCollection { - // Gets one account permission by ID. - get(profileId: string, id: string): Dfareporting.Schema.AccountPermission; - // Retrieves the list of account permissions. - list(profileId: string): Dfareporting.Schema.AccountPermissionsListResponse; - } - interface AccountUserProfilesCollection { - // Gets one account user profile by ID. - get(profileId: string, id: string): Dfareporting.Schema.AccountUserProfile; - // Inserts a new account user profile. - insert(resource: Schema.AccountUserProfile, profileId: string): Dfareporting.Schema.AccountUserProfile; - // Retrieves a list of account user profiles, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.AccountUserProfilesListResponse; - // Retrieves a list of account user profiles, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AccountUserProfilesListResponse; - // Updates an existing account user profile. This method supports patch semantics. - patch( - resource: Schema.AccountUserProfile, - profileId: string, - id: string, - ): Dfareporting.Schema.AccountUserProfile; - // Updates an existing account user profile. - update(resource: Schema.AccountUserProfile, profileId: string): Dfareporting.Schema.AccountUserProfile; - } - interface AccountsCollection { - // Gets one account by ID. - get(profileId: string, id: string): Dfareporting.Schema.Account; - // Retrieves the list of accounts, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.AccountsListResponse; - // Retrieves the list of accounts, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AccountsListResponse; - // Updates an existing account. This method supports patch semantics. - patch(resource: Schema.Account, profileId: string, id: string): Dfareporting.Schema.Account; - // Updates an existing account. - update(resource: Schema.Account, profileId: string): Dfareporting.Schema.Account; - } - interface AdsCollection { - // Gets one ad by ID. - get(profileId: string, id: string): Dfareporting.Schema.Ad; - // Inserts a new ad. - insert(resource: Schema.Ad, profileId: string): Dfareporting.Schema.Ad; - // Retrieves a list of ads, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.AdsListResponse; - // Retrieves a list of ads, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdsListResponse; - // Updates an existing ad. This method supports patch semantics. - patch(resource: Schema.Ad, profileId: string, id: string): Dfareporting.Schema.Ad; - // Updates an existing ad. - update(resource: Schema.Ad, profileId: string): Dfareporting.Schema.Ad; - } - interface AdvertiserGroupsCollection { - // Gets one advertiser group by ID. - get(profileId: string, id: string): Dfareporting.Schema.AdvertiserGroup; - // Inserts a new advertiser group. - insert(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting.Schema.AdvertiserGroup; - // Retrieves a list of advertiser groups, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.AdvertiserGroupsListResponse; - // Retrieves a list of advertiser groups, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertiserGroupsListResponse; - // Updates an existing advertiser group. This method supports patch semantics. - patch( - resource: Schema.AdvertiserGroup, - profileId: string, - id: string, - ): Dfareporting.Schema.AdvertiserGroup; - // Deletes an existing advertiser group. - remove(profileId: string, id: string): void; - // Updates an existing advertiser group. - update(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting.Schema.AdvertiserGroup; - } - interface AdvertiserLandingPagesCollection { - // Gets one landing page by ID. - get(profileId: string, id: string): Dfareporting.Schema.LandingPage; - // Inserts a new landing page. - insert(resource: Schema.LandingPage, profileId: string): Dfareporting.Schema.LandingPage; - // Retrieves a list of landing pages. - list(profileId: string): Dfareporting.Schema.AdvertiserLandingPagesListResponse; - // Retrieves a list of landing pages. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertiserLandingPagesListResponse; - // Updates an existing landing page. This method supports patch semantics. - patch(resource: Schema.LandingPage, profileId: string, id: string): Dfareporting.Schema.LandingPage; - // Updates an existing landing page. - update(resource: Schema.LandingPage, profileId: string): Dfareporting.Schema.LandingPage; - } - interface AdvertisersCollection { - // Gets one advertiser by ID. - get(profileId: string, id: string): Dfareporting.Schema.Advertiser; - // Inserts a new advertiser. - insert(resource: Schema.Advertiser, profileId: string): Dfareporting.Schema.Advertiser; - // Retrieves a list of advertisers, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.AdvertisersListResponse; - // Retrieves a list of advertisers, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.AdvertisersListResponse; - // Updates an existing advertiser. This method supports patch semantics. - patch(resource: Schema.Advertiser, profileId: string, id: string): Dfareporting.Schema.Advertiser; - // Updates an existing advertiser. - update(resource: Schema.Advertiser, profileId: string): Dfareporting.Schema.Advertiser; - } - interface BrowsersCollection { - // Retrieves a list of browsers. - list(profileId: string): Dfareporting.Schema.BrowsersListResponse; - } - interface CampaignCreativeAssociationsCollection { - // Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. - insert( - resource: Schema.CampaignCreativeAssociation, - profileId: string, - campaignId: string, - ): Dfareporting.Schema.CampaignCreativeAssociation; - // Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. - list( - profileId: string, - campaignId: string, - ): Dfareporting.Schema.CampaignCreativeAssociationsListResponse; - // Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. - list( - profileId: string, - campaignId: string, - optionalArgs: object, - ): Dfareporting.Schema.CampaignCreativeAssociationsListResponse; - } - interface CampaignsCollection { - // Gets one campaign by ID. - get(profileId: string, id: string): Dfareporting.Schema.Campaign; - // Inserts a new campaign. - insert(resource: Schema.Campaign, profileId: string): Dfareporting.Schema.Campaign; - // Retrieves a list of campaigns, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.CampaignsListResponse; - // Retrieves a list of campaigns, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.CampaignsListResponse; - // Updates an existing campaign. This method supports patch semantics. - patch(resource: Schema.Campaign, profileId: string, id: string): Dfareporting.Schema.Campaign; - // Updates an existing campaign. - update(resource: Schema.Campaign, profileId: string): Dfareporting.Schema.Campaign; - } - interface ChangeLogsCollection { - // Gets one change log by ID. - get(profileId: string, id: string): Dfareporting.Schema.ChangeLog; - // Retrieves a list of change logs. This method supports paging. - list(profileId: string): Dfareporting.Schema.ChangeLogsListResponse; - // Retrieves a list of change logs. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.ChangeLogsListResponse; - } - interface CitiesCollection { - // Retrieves a list of cities, possibly filtered. - list(profileId: string): Dfareporting.Schema.CitiesListResponse; - // Retrieves a list of cities, possibly filtered. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.CitiesListResponse; - } - interface ConnectionTypesCollection { - // Gets one connection type by ID. - get(profileId: string, id: string): Dfareporting.Schema.ConnectionType; - // Retrieves a list of connection types. - list(profileId: string): Dfareporting.Schema.ConnectionTypesListResponse; - } - interface ContentCategoriesCollection { - // Gets one content category by ID. - get(profileId: string, id: string): Dfareporting.Schema.ContentCategory; - // Inserts a new content category. - insert(resource: Schema.ContentCategory, profileId: string): Dfareporting.Schema.ContentCategory; - // Retrieves a list of content categories, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.ContentCategoriesListResponse; - // Retrieves a list of content categories, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.ContentCategoriesListResponse; - // Updates an existing content category. This method supports patch semantics. - patch( - resource: Schema.ContentCategory, - profileId: string, - id: string, - ): Dfareporting.Schema.ContentCategory; - // Deletes an existing content category. - remove(profileId: string, id: string): void; - // Updates an existing content category. - update(resource: Schema.ContentCategory, profileId: string): Dfareporting.Schema.ContentCategory; - } - interface ConversionsCollection { - // Inserts conversions. - batchinsert( - resource: Schema.ConversionsBatchInsertRequest, - profileId: string, - ): Dfareporting.Schema.ConversionsBatchInsertResponse; - // Updates existing conversions. - batchupdate( - resource: Schema.ConversionsBatchUpdateRequest, - profileId: string, - ): Dfareporting.Schema.ConversionsBatchUpdateResponse; - } - interface CountriesCollection { - // Gets one country by ID. - get(profileId: string, dartId: string): Dfareporting.Schema.Country; - // Retrieves a list of countries. - list(profileId: string): Dfareporting.Schema.CountriesListResponse; - } - interface CreativeAssetsCollection { - // Inserts a new creative asset. - insert( - resource: Schema.CreativeAssetMetadata, - profileId: string, - advertiserId: string, - ): Dfareporting.Schema.CreativeAssetMetadata; - // Inserts a new creative asset. - insert( - resource: Schema.CreativeAssetMetadata, - profileId: string, - advertiserId: string, - mediaData: any, - ): Dfareporting.Schema.CreativeAssetMetadata; - } - interface CreativeFieldValuesCollection { - // Gets one creative field value by ID. - get(profileId: string, creativeFieldId: string, id: string): Dfareporting.Schema.CreativeFieldValue; - // Inserts a new creative field value. - insert( - resource: Schema.CreativeFieldValue, - profileId: string, - creativeFieldId: string, - ): Dfareporting.Schema.CreativeFieldValue; - // Retrieves a list of creative field values, possibly filtered. This method supports paging. - list(profileId: string, creativeFieldId: string): Dfareporting.Schema.CreativeFieldValuesListResponse; - // Retrieves a list of creative field values, possibly filtered. This method supports paging. - list( - profileId: string, - creativeFieldId: string, - optionalArgs: object, - ): Dfareporting.Schema.CreativeFieldValuesListResponse; - // Updates an existing creative field value. This method supports patch semantics. - patch( - resource: Schema.CreativeFieldValue, - profileId: string, - creativeFieldId: string, - id: string, - ): Dfareporting.Schema.CreativeFieldValue; - // Deletes an existing creative field value. - remove(profileId: string, creativeFieldId: string, id: string): void; - // Updates an existing creative field value. - update( - resource: Schema.CreativeFieldValue, - profileId: string, - creativeFieldId: string, - ): Dfareporting.Schema.CreativeFieldValue; - } - interface CreativeFieldsCollection { - // Gets one creative field by ID. - get(profileId: string, id: string): Dfareporting.Schema.CreativeField; - // Inserts a new creative field. - insert(resource: Schema.CreativeField, profileId: string): Dfareporting.Schema.CreativeField; - // Retrieves a list of creative fields, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.CreativeFieldsListResponse; - // Retrieves a list of creative fields, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativeFieldsListResponse; - // Updates an existing creative field. This method supports patch semantics. - patch(resource: Schema.CreativeField, profileId: string, id: string): Dfareporting.Schema.CreativeField; - // Deletes an existing creative field. - remove(profileId: string, id: string): void; - // Updates an existing creative field. - update(resource: Schema.CreativeField, profileId: string): Dfareporting.Schema.CreativeField; - } - interface CreativeGroupsCollection { - // Gets one creative group by ID. - get(profileId: string, id: string): Dfareporting.Schema.CreativeGroup; - // Inserts a new creative group. - insert(resource: Schema.CreativeGroup, profileId: string): Dfareporting.Schema.CreativeGroup; - // Retrieves a list of creative groups, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.CreativeGroupsListResponse; - // Retrieves a list of creative groups, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativeGroupsListResponse; - // Updates an existing creative group. This method supports patch semantics. - patch(resource: Schema.CreativeGroup, profileId: string, id: string): Dfareporting.Schema.CreativeGroup; - // Updates an existing creative group. - update(resource: Schema.CreativeGroup, profileId: string): Dfareporting.Schema.CreativeGroup; - } - interface CreativesCollection { - // Gets one creative by ID. - get(profileId: string, id: string): Dfareporting.Schema.Creative; - // Inserts a new creative. - insert(resource: Schema.Creative, profileId: string): Dfareporting.Schema.Creative; - // Retrieves a list of creatives, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.CreativesListResponse; - // Retrieves a list of creatives, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.CreativesListResponse; - // Updates an existing creative. This method supports patch semantics. - patch(resource: Schema.Creative, profileId: string, id: string): Dfareporting.Schema.Creative; - // Updates an existing creative. - update(resource: Schema.Creative, profileId: string): Dfareporting.Schema.Creative; - } - interface DimensionValuesCollection { - // Retrieves list of report dimension values for a list of filters. - query( - resource: Schema.DimensionValueRequest, - profileId: string, - ): Dfareporting.Schema.DimensionValueList; - // Retrieves list of report dimension values for a list of filters. - query( - resource: Schema.DimensionValueRequest, - profileId: string, - optionalArgs: object, - ): Dfareporting.Schema.DimensionValueList; - } - interface DirectorySitesCollection { - // Gets one directory site by ID. - get(profileId: string, id: string): Dfareporting.Schema.DirectorySite; - // Inserts a new directory site. - insert(resource: Schema.DirectorySite, profileId: string): Dfareporting.Schema.DirectorySite; - // Retrieves a list of directory sites, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.DirectorySitesListResponse; - // Retrieves a list of directory sites, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.DirectorySitesListResponse; - } - interface DynamicTargetingKeysCollection { - // Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. - insert( - resource: Schema.DynamicTargetingKey, - profileId: string, - ): Dfareporting.Schema.DynamicTargetingKey; - // Retrieves a list of dynamic targeting keys. - list(profileId: string): Dfareporting.Schema.DynamicTargetingKeysListResponse; - // Retrieves a list of dynamic targeting keys. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.DynamicTargetingKeysListResponse; - // Deletes an existing dynamic targeting key. - remove(profileId: string, objectId: string, name: string, objectType: string): void; - } - interface EventTagsCollection { - // Gets one event tag by ID. - get(profileId: string, id: string): Dfareporting.Schema.EventTag; - // Inserts a new event tag. - insert(resource: Schema.EventTag, profileId: string): Dfareporting.Schema.EventTag; - // Retrieves a list of event tags, possibly filtered. - list(profileId: string): Dfareporting.Schema.EventTagsListResponse; - // Retrieves a list of event tags, possibly filtered. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.EventTagsListResponse; - // Updates an existing event tag. This method supports patch semantics. - patch(resource: Schema.EventTag, profileId: string, id: string): Dfareporting.Schema.EventTag; - // Deletes an existing event tag. - remove(profileId: string, id: string): void; - // Updates an existing event tag. - update(resource: Schema.EventTag, profileId: string): Dfareporting.Schema.EventTag; - } - interface FilesCollection { - // Retrieves a report file by its report ID and file ID. This method supports media download. - get(reportId: string, fileId: string): Dfareporting.Schema.File; - // Lists files for a user profile. - list(profileId: string): Dfareporting.Schema.FileList; - // Lists files for a user profile. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.FileList; - } - interface FloodlightActivitiesCollection { - // Generates a tag for a floodlight activity. - generatetag(profileId: string): Dfareporting.Schema.FloodlightActivitiesGenerateTagResponse; - // Generates a tag for a floodlight activity. - generatetag( - profileId: string, - optionalArgs: object, - ): Dfareporting.Schema.FloodlightActivitiesGenerateTagResponse; - // Gets one floodlight activity by ID. - get(profileId: string, id: string): Dfareporting.Schema.FloodlightActivity; - // Inserts a new floodlight activity. - insert(resource: Schema.FloodlightActivity, profileId: string): Dfareporting.Schema.FloodlightActivity; - // Retrieves a list of floodlight activities, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.FloodlightActivitiesListResponse; - // Retrieves a list of floodlight activities, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightActivitiesListResponse; - // Updates an existing floodlight activity. This method supports patch semantics. - patch( - resource: Schema.FloodlightActivity, - profileId: string, - id: string, - ): Dfareporting.Schema.FloodlightActivity; - // Deletes an existing floodlight activity. - remove(profileId: string, id: string): void; - // Updates an existing floodlight activity. - update(resource: Schema.FloodlightActivity, profileId: string): Dfareporting.Schema.FloodlightActivity; - } - interface FloodlightActivityGroupsCollection { - // Gets one floodlight activity group by ID. - get(profileId: string, id: string): Dfareporting.Schema.FloodlightActivityGroup; - // Inserts a new floodlight activity group. - insert( - resource: Schema.FloodlightActivityGroup, - profileId: string, - ): Dfareporting.Schema.FloodlightActivityGroup; - // Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.FloodlightActivityGroupsListResponse; - // Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightActivityGroupsListResponse; - // Updates an existing floodlight activity group. This method supports patch semantics. - patch( - resource: Schema.FloodlightActivityGroup, - profileId: string, - id: string, - ): Dfareporting.Schema.FloodlightActivityGroup; - // Updates an existing floodlight activity group. - update( - resource: Schema.FloodlightActivityGroup, - profileId: string, - ): Dfareporting.Schema.FloodlightActivityGroup; - } - interface FloodlightConfigurationsCollection { - // Gets one floodlight configuration by ID. - get(profileId: string, id: string): Dfareporting.Schema.FloodlightConfiguration; - // Retrieves a list of floodlight configurations, possibly filtered. - list(profileId: string): Dfareporting.Schema.FloodlightConfigurationsListResponse; - // Retrieves a list of floodlight configurations, possibly filtered. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.FloodlightConfigurationsListResponse; - // Updates an existing floodlight configuration. This method supports patch semantics. - patch( - resource: Schema.FloodlightConfiguration, - profileId: string, - id: string, - ): Dfareporting.Schema.FloodlightConfiguration; - // Updates an existing floodlight configuration. - update( - resource: Schema.FloodlightConfiguration, - profileId: string, - ): Dfareporting.Schema.FloodlightConfiguration; - } - interface InventoryItemsCollection { - // Gets one inventory item by ID. - get(profileId: string, projectId: string, id: string): Dfareporting.Schema.InventoryItem; - // Retrieves a list of inventory items, possibly filtered. This method supports paging. - list(profileId: string, projectId: string): Dfareporting.Schema.InventoryItemsListResponse; - // Retrieves a list of inventory items, possibly filtered. This method supports paging. - list( - profileId: string, - projectId: string, - optionalArgs: object, - ): Dfareporting.Schema.InventoryItemsListResponse; - } - interface LanguagesCollection { - // Retrieves a list of languages. - list(profileId: string): Dfareporting.Schema.LanguagesListResponse; - } - interface MetrosCollection { - // Retrieves a list of metros. - list(profileId: string): Dfareporting.Schema.MetrosListResponse; - } - interface MobileAppsCollection { - // Gets one mobile app by ID. - get(profileId: string, id: string): Dfareporting.Schema.MobileApp; - // Retrieves list of available mobile apps. - list(profileId: string): Dfareporting.Schema.MobileAppsListResponse; - // Retrieves list of available mobile apps. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.MobileAppsListResponse; - } - interface MobileCarriersCollection { - // Gets one mobile carrier by ID. - get(profileId: string, id: string): Dfareporting.Schema.MobileCarrier; - // Retrieves a list of mobile carriers. - list(profileId: string): Dfareporting.Schema.MobileCarriersListResponse; - } - interface OperatingSystemVersionsCollection { - // Gets one operating system version by ID. - get(profileId: string, id: string): Dfareporting.Schema.OperatingSystemVersion; - // Retrieves a list of operating system versions. - list(profileId: string): Dfareporting.Schema.OperatingSystemVersionsListResponse; - } - interface OperatingSystemsCollection { - // Gets one operating system by DART ID. - get(profileId: string, dartId: string): Dfareporting.Schema.OperatingSystem; - // Retrieves a list of operating systems. - list(profileId: string): Dfareporting.Schema.OperatingSystemsListResponse; - } - interface OrderDocumentsCollection { - // Gets one order document by ID. - get(profileId: string, projectId: string, id: string): Dfareporting.Schema.OrderDocument; - // Retrieves a list of order documents, possibly filtered. This method supports paging. - list(profileId: string, projectId: string): Dfareporting.Schema.OrderDocumentsListResponse; - // Retrieves a list of order documents, possibly filtered. This method supports paging. - list( - profileId: string, - projectId: string, - optionalArgs: object, - ): Dfareporting.Schema.OrderDocumentsListResponse; - } - interface OrdersCollection { - // Gets one order by ID. - get(profileId: string, projectId: string, id: string): Dfareporting.Schema.Order; - // Retrieves a list of orders, possibly filtered. This method supports paging. - list(profileId: string, projectId: string): Dfareporting.Schema.OrdersListResponse; - // Retrieves a list of orders, possibly filtered. This method supports paging. - list( - profileId: string, - projectId: string, - optionalArgs: object, - ): Dfareporting.Schema.OrdersListResponse; - } - interface PlacementGroupsCollection { - // Gets one placement group by ID. - get(profileId: string, id: string): Dfareporting.Schema.PlacementGroup; - // Inserts a new placement group. - insert(resource: Schema.PlacementGroup, profileId: string): Dfareporting.Schema.PlacementGroup; - // Retrieves a list of placement groups, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.PlacementGroupsListResponse; - // Retrieves a list of placement groups, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementGroupsListResponse; - // Updates an existing placement group. This method supports patch semantics. - patch( - resource: Schema.PlacementGroup, - profileId: string, - id: string, - ): Dfareporting.Schema.PlacementGroup; - // Updates an existing placement group. - update(resource: Schema.PlacementGroup, profileId: string): Dfareporting.Schema.PlacementGroup; - } - interface PlacementStrategiesCollection { - // Gets one placement strategy by ID. - get(profileId: string, id: string): Dfareporting.Schema.PlacementStrategy; - // Inserts a new placement strategy. - insert(resource: Schema.PlacementStrategy, profileId: string): Dfareporting.Schema.PlacementStrategy; - // Retrieves a list of placement strategies, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.PlacementStrategiesListResponse; - // Retrieves a list of placement strategies, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementStrategiesListResponse; - // Updates an existing placement strategy. This method supports patch semantics. - patch( - resource: Schema.PlacementStrategy, - profileId: string, - id: string, - ): Dfareporting.Schema.PlacementStrategy; - // Deletes an existing placement strategy. - remove(profileId: string, id: string): void; - // Updates an existing placement strategy. - update(resource: Schema.PlacementStrategy, profileId: string): Dfareporting.Schema.PlacementStrategy; - } - interface PlacementsCollection { - // Generates tags for a placement. - generatetags(profileId: string): Dfareporting.Schema.PlacementsGenerateTagsResponse; - // Generates tags for a placement. - generatetags( - profileId: string, - optionalArgs: object, - ): Dfareporting.Schema.PlacementsGenerateTagsResponse; - // Gets one placement by ID. - get(profileId: string, id: string): Dfareporting.Schema.Placement; - // Inserts a new placement. - insert(resource: Schema.Placement, profileId: string): Dfareporting.Schema.Placement; - // Retrieves a list of placements, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.PlacementsListResponse; - // Retrieves a list of placements, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.PlacementsListResponse; - // Updates an existing placement. This method supports patch semantics. - patch(resource: Schema.Placement, profileId: string, id: string): Dfareporting.Schema.Placement; - // Updates an existing placement. - update(resource: Schema.Placement, profileId: string): Dfareporting.Schema.Placement; - } - interface PlatformTypesCollection { - // Gets one platform type by ID. - get(profileId: string, id: string): Dfareporting.Schema.PlatformType; - // Retrieves a list of platform types. - list(profileId: string): Dfareporting.Schema.PlatformTypesListResponse; - } - interface PostalCodesCollection { - // Gets one postal code by ID. - get(profileId: string, code: string): Dfareporting.Schema.PostalCode; - // Retrieves a list of postal codes. - list(profileId: string): Dfareporting.Schema.PostalCodesListResponse; - } - interface ProjectsCollection { - // Gets one project by ID. - get(profileId: string, id: string): Dfareporting.Schema.Project; - // Retrieves a list of projects, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.ProjectsListResponse; - // Retrieves a list of projects, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.ProjectsListResponse; - } - interface RegionsCollection { - // Retrieves a list of regions. - list(profileId: string): Dfareporting.Schema.RegionsListResponse; - } - interface RemarketingListSharesCollection { - // Gets one remarketing list share by remarketing list ID. - get(profileId: string, remarketingListId: string): Dfareporting.Schema.RemarketingListShare; - // Updates an existing remarketing list share. This method supports patch semantics. - patch( - resource: Schema.RemarketingListShare, - profileId: string, - remarketingListId: string, - ): Dfareporting.Schema.RemarketingListShare; - // Updates an existing remarketing list share. - update( - resource: Schema.RemarketingListShare, - profileId: string, - ): Dfareporting.Schema.RemarketingListShare; - } - interface RemarketingListsCollection { - // Gets one remarketing list by ID. - get(profileId: string, id: string): Dfareporting.Schema.RemarketingList; - // Inserts a new remarketing list. - insert(resource: Schema.RemarketingList, profileId: string): Dfareporting.Schema.RemarketingList; - // Retrieves a list of remarketing lists, possibly filtered. This method supports paging. - list(profileId: string, advertiserId: string): Dfareporting.Schema.RemarketingListsListResponse; - // Retrieves a list of remarketing lists, possibly filtered. This method supports paging. - list( - profileId: string, - advertiserId: string, - optionalArgs: object, - ): Dfareporting.Schema.RemarketingListsListResponse; - // Updates an existing remarketing list. This method supports patch semantics. - patch( - resource: Schema.RemarketingList, - profileId: string, - id: string, - ): Dfareporting.Schema.RemarketingList; - // Updates an existing remarketing list. - update(resource: Schema.RemarketingList, profileId: string): Dfareporting.Schema.RemarketingList; - } - interface ReportsCollection { - CompatibleFields?: Dfareporting.Collection.Reports.CompatibleFieldsCollection | undefined; - Files?: Dfareporting.Collection.Reports.FilesCollection | undefined; - // Retrieves a report by its ID. - get(profileId: string, reportId: string): Dfareporting.Schema.Report; - // Creates a report. - insert(resource: Schema.Report, profileId: string): Dfareporting.Schema.Report; - // Retrieves list of reports. - list(profileId: string): Dfareporting.Schema.ReportList; - // Retrieves list of reports. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.ReportList; - // Updates a report. This method supports patch semantics. - patch(resource: Schema.Report, profileId: string, reportId: string): Dfareporting.Schema.Report; - // Deletes a report by its ID. - remove(profileId: string, reportId: string): void; - // Runs a report. - run(profileId: string, reportId: string): Dfareporting.Schema.File; - // Runs a report. - run(profileId: string, reportId: string, optionalArgs: object): Dfareporting.Schema.File; - // Updates a report. - update(resource: Schema.Report, profileId: string, reportId: string): Dfareporting.Schema.Report; - } - interface SitesCollection { - // Gets one site by ID. - get(profileId: string, id: string): Dfareporting.Schema.Site; - // Inserts a new site. - insert(resource: Schema.Site, profileId: string): Dfareporting.Schema.Site; - // Retrieves a list of sites, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.SitesListResponse; - // Retrieves a list of sites, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.SitesListResponse; - // Updates an existing site. This method supports patch semantics. - patch(resource: Schema.Site, profileId: string, id: string): Dfareporting.Schema.Site; - // Updates an existing site. - update(resource: Schema.Site, profileId: string): Dfareporting.Schema.Site; - } - interface SizesCollection { - // Gets one size by ID. - get(profileId: string, id: string): Dfareporting.Schema.Size; - // Inserts a new size. - insert(resource: Schema.Size, profileId: string): Dfareporting.Schema.Size; - // Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. - list(profileId: string): Dfareporting.Schema.SizesListResponse; - // Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.SizesListResponse; - } - interface SubaccountsCollection { - // Gets one subaccount by ID. - get(profileId: string, id: string): Dfareporting.Schema.Subaccount; - // Inserts a new subaccount. - insert(resource: Schema.Subaccount, profileId: string): Dfareporting.Schema.Subaccount; - // Gets a list of subaccounts, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.SubaccountsListResponse; - // Gets a list of subaccounts, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.SubaccountsListResponse; - // Updates an existing subaccount. This method supports patch semantics. - patch(resource: Schema.Subaccount, profileId: string, id: string): Dfareporting.Schema.Subaccount; - // Updates an existing subaccount. - update(resource: Schema.Subaccount, profileId: string): Dfareporting.Schema.Subaccount; - } - interface TargetableRemarketingListsCollection { - // Gets one remarketing list by ID. - get(profileId: string, id: string): Dfareporting.Schema.TargetableRemarketingList; - // Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. - list( - profileId: string, - advertiserId: string, - ): Dfareporting.Schema.TargetableRemarketingListsListResponse; - // Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. - list( - profileId: string, - advertiserId: string, - optionalArgs: object, - ): Dfareporting.Schema.TargetableRemarketingListsListResponse; - } - interface TargetingTemplatesCollection { - // Gets one targeting template by ID. - get(profileId: string, id: string): Dfareporting.Schema.TargetingTemplate; - // Inserts a new targeting template. - insert(resource: Schema.TargetingTemplate, profileId: string): Dfareporting.Schema.TargetingTemplate; - // Retrieves a list of targeting templates, optionally filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.TargetingTemplatesListResponse; - // Retrieves a list of targeting templates, optionally filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.TargetingTemplatesListResponse; - // Updates an existing targeting template. This method supports patch semantics. - patch( - resource: Schema.TargetingTemplate, - profileId: string, - id: string, - ): Dfareporting.Schema.TargetingTemplate; - // Updates an existing targeting template. - update(resource: Schema.TargetingTemplate, profileId: string): Dfareporting.Schema.TargetingTemplate; - } - interface UserProfilesCollection { - // Gets one user profile by ID. - get(profileId: string): Dfareporting.Schema.UserProfile; - // Retrieves list of user profiles for a user. - list(): Dfareporting.Schema.UserProfileList; - } - interface UserRolePermissionGroupsCollection { - // Gets one user role permission group by ID. - get(profileId: string, id: string): Dfareporting.Schema.UserRolePermissionGroup; - // Gets a list of all supported user role permission groups. - list(profileId: string): Dfareporting.Schema.UserRolePermissionGroupsListResponse; - } - interface UserRolePermissionsCollection { - // Gets one user role permission by ID. - get(profileId: string, id: string): Dfareporting.Schema.UserRolePermission; - // Gets a list of user role permissions, possibly filtered. - list(profileId: string): Dfareporting.Schema.UserRolePermissionsListResponse; - // Gets a list of user role permissions, possibly filtered. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.UserRolePermissionsListResponse; - } - interface UserRolesCollection { - // Gets one user role by ID. - get(profileId: string, id: string): Dfareporting.Schema.UserRole; - // Inserts a new user role. - insert(resource: Schema.UserRole, profileId: string): Dfareporting.Schema.UserRole; - // Retrieves a list of user roles, possibly filtered. This method supports paging. - list(profileId: string): Dfareporting.Schema.UserRolesListResponse; - // Retrieves a list of user roles, possibly filtered. This method supports paging. - list(profileId: string, optionalArgs: object): Dfareporting.Schema.UserRolesListResponse; - // Updates an existing user role. This method supports patch semantics. - patch(resource: Schema.UserRole, profileId: string, id: string): Dfareporting.Schema.UserRole; - // Deletes an existing user role. - remove(profileId: string, id: string): void; - // Updates an existing user role. - update(resource: Schema.UserRole, profileId: string): Dfareporting.Schema.UserRole; - } - interface VideoFormatsCollection { - // Gets one video format by ID. - get(profileId: string, id: number): Dfareporting.Schema.VideoFormat; - // Lists available video formats. - list(profileId: string): Dfareporting.Schema.VideoFormatsListResponse; - } - } - namespace Schema { - interface Account { - accountPermissionIds?: string[] | undefined; - accountProfile?: string | undefined; - active?: boolean | undefined; - activeAdsLimitTier?: string | undefined; - activeViewOptOut?: boolean | undefined; - availablePermissionIds?: string[] | undefined; - countryId?: string | undefined; - currencyId?: string | undefined; - defaultCreativeSizeId?: string | undefined; - description?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - locale?: string | undefined; - maximumImageSize?: string | undefined; - name?: string | undefined; - nielsenOcrEnabled?: boolean | undefined; - reportsConfiguration?: Dfareporting.Schema.ReportsConfiguration | undefined; - shareReportsWithTwitter?: boolean | undefined; - teaserSizeLimit?: string | undefined; - } - interface AccountActiveAdSummary { - accountId?: string | undefined; - activeAds?: string | undefined; - activeAdsLimitTier?: string | undefined; - availableAds?: string | undefined; - kind?: string | undefined; - } - interface AccountPermission { - accountProfiles?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - level?: string | undefined; - name?: string | undefined; - permissionGroupId?: string | undefined; - } - interface AccountPermissionGroup { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface AccountPermissionGroupsListResponse { - accountPermissionGroups?: Dfareporting.Schema.AccountPermissionGroup[] | undefined; - kind?: string | undefined; - } - interface AccountPermissionsListResponse { - accountPermissions?: Dfareporting.Schema.AccountPermission[] | undefined; - kind?: string | undefined; - } - interface AccountUserProfile { - accountId?: string | undefined; - active?: boolean | undefined; - advertiserFilter?: Dfareporting.Schema.ObjectFilter | undefined; - campaignFilter?: Dfareporting.Schema.ObjectFilter | undefined; - comments?: string | undefined; - email?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - locale?: string | undefined; - name?: string | undefined; - siteFilter?: Dfareporting.Schema.ObjectFilter | undefined; - subaccountId?: string | undefined; - traffickerType?: string | undefined; - userAccessType?: string | undefined; - userRoleFilter?: Dfareporting.Schema.ObjectFilter | undefined; - userRoleId?: string | undefined; - } - interface AccountUserProfilesListResponse { - accountUserProfiles?: Dfareporting.Schema.AccountUserProfile[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AccountsListResponse { - accounts?: Dfareporting.Schema.Account[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Activities { - filters?: Dfareporting.Schema.DimensionValue[] | undefined; - kind?: string | undefined; - metricNames?: string[] | undefined; - } - interface Ad { - accountId?: string | undefined; - active?: boolean | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - archived?: boolean | undefined; - audienceSegmentId?: string | undefined; - campaignId?: string | undefined; - campaignIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - clickThroughUrl?: Dfareporting.Schema.ClickThroughUrl | undefined; - clickThroughUrlSuffixProperties?: Dfareporting.Schema.ClickThroughUrlSuffixProperties | undefined; - comments?: string | undefined; - compatibility?: string | undefined; - createInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - creativeGroupAssignments?: Dfareporting.Schema.CreativeGroupAssignment[] | undefined; - creativeRotation?: Dfareporting.Schema.CreativeRotation | undefined; - dayPartTargeting?: Dfareporting.Schema.DayPartTargeting | undefined; - defaultClickThroughEventTagProperties?: - | Dfareporting.Schema.DefaultClickThroughEventTagProperties - | undefined; - deliverySchedule?: Dfareporting.Schema.DeliverySchedule | undefined; - dynamicClickTracker?: boolean | undefined; - endTime?: string | undefined; - eventTagOverrides?: Dfareporting.Schema.EventTagOverride[] | undefined; - geoTargeting?: Dfareporting.Schema.GeoTargeting | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - keyValueTargetingExpression?: Dfareporting.Schema.KeyValueTargetingExpression | undefined; - kind?: string | undefined; - languageTargeting?: Dfareporting.Schema.LanguageTargeting | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - placementAssignments?: Dfareporting.Schema.PlacementAssignment[] | undefined; - remarketingListExpression?: Dfareporting.Schema.ListTargetingExpression | undefined; - size?: Dfareporting.Schema.Size | undefined; - sslCompliant?: boolean | undefined; - sslRequired?: boolean | undefined; - startTime?: string | undefined; - subaccountId?: string | undefined; - targetingTemplateId?: string | undefined; - technologyTargeting?: Dfareporting.Schema.TechnologyTargeting | undefined; - type?: string | undefined; - } - interface AdBlockingConfiguration { - clickThroughUrl?: string | undefined; - creativeBundleId?: string | undefined; - enabled?: boolean | undefined; - overrideClickThroughUrl?: boolean | undefined; - } - interface AdSlot { - comment?: string | undefined; - compatibility?: string | undefined; - height?: string | undefined; - linkedPlacementId?: string | undefined; - name?: string | undefined; - paymentSourceType?: string | undefined; - primary?: boolean | undefined; - width?: string | undefined; - } - interface AdsListResponse { - ads?: Dfareporting.Schema.Ad[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Advertiser { - accountId?: string | undefined; - advertiserGroupId?: string | undefined; - clickThroughUrlSuffix?: string | undefined; - defaultClickThroughEventTagId?: string | undefined; - defaultEmail?: string | undefined; - floodlightConfigurationId?: string | undefined; - floodlightConfigurationIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - name?: string | undefined; - originalFloodlightConfigurationId?: string | undefined; - status?: string | undefined; - subaccountId?: string | undefined; - suspended?: boolean | undefined; - } - interface AdvertiserGroup { - accountId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface AdvertiserGroupsListResponse { - advertiserGroups?: Dfareporting.Schema.AdvertiserGroup[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AdvertiserLandingPagesListResponse { - kind?: string | undefined; - landingPages?: Dfareporting.Schema.LandingPage[] | undefined; - nextPageToken?: string | undefined; - } - interface AdvertisersListResponse { - advertisers?: Dfareporting.Schema.Advertiser[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface AudienceSegment { - allocation?: number | undefined; - id?: string | undefined; - name?: string | undefined; - } - interface AudienceSegmentGroup { - audienceSegments?: Dfareporting.Schema.AudienceSegment[] | undefined; - id?: string | undefined; - name?: string | undefined; - } - interface Browser { - browserVersionId?: string | undefined; - dartId?: string | undefined; - kind?: string | undefined; - majorVersion?: string | undefined; - minorVersion?: string | undefined; - name?: string | undefined; - } - interface BrowsersListResponse { - browsers?: Dfareporting.Schema.Browser[] | undefined; - kind?: string | undefined; - } - interface Campaign { - accountId?: string | undefined; - adBlockingConfiguration?: Dfareporting.Schema.AdBlockingConfiguration | undefined; - additionalCreativeOptimizationConfigurations?: - | Dfareporting.Schema.CreativeOptimizationConfiguration[] - | undefined; - advertiserGroupId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - archived?: boolean | undefined; - audienceSegmentGroups?: Dfareporting.Schema.AudienceSegmentGroup[] | undefined; - billingInvoiceCode?: string | undefined; - clickThroughUrlSuffixProperties?: Dfareporting.Schema.ClickThroughUrlSuffixProperties | undefined; - comment?: string | undefined; - createInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - creativeGroupIds?: string[] | undefined; - creativeOptimizationConfiguration?: Dfareporting.Schema.CreativeOptimizationConfiguration | undefined; - defaultClickThroughEventTagProperties?: - | Dfareporting.Schema.DefaultClickThroughEventTagProperties - | undefined; - defaultLandingPageId?: string | undefined; - endDate?: string | undefined; - eventTagOverrides?: Dfareporting.Schema.EventTagOverride[] | undefined; - externalId?: string | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - nielsenOcrEnabled?: boolean | undefined; - startDate?: string | undefined; - subaccountId?: string | undefined; - traffickerEmails?: string[] | undefined; - } - interface CampaignCreativeAssociation { - creativeId?: string | undefined; - kind?: string | undefined; - } - interface CampaignCreativeAssociationsListResponse { - campaignCreativeAssociations?: Dfareporting.Schema.CampaignCreativeAssociation[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CampaignsListResponse { - campaigns?: Dfareporting.Schema.Campaign[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface ChangeLog { - accountId?: string | undefined; - action?: string | undefined; - changeTime?: string | undefined; - fieldName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - newValue?: string | undefined; - objectId?: string | undefined; - objectType?: string | undefined; - oldValue?: string | undefined; - subaccountId?: string | undefined; - transactionId?: string | undefined; - userProfileId?: string | undefined; - userProfileName?: string | undefined; - } - interface ChangeLogsListResponse { - changeLogs?: Dfareporting.Schema.ChangeLog[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CitiesListResponse { - cities?: Dfareporting.Schema.City[] | undefined; - kind?: string | undefined; - } - interface City { - countryCode?: string | undefined; - countryDartId?: string | undefined; - dartId?: string | undefined; - kind?: string | undefined; - metroCode?: string | undefined; - metroDmaId?: string | undefined; - name?: string | undefined; - regionCode?: string | undefined; - regionDartId?: string | undefined; - } - interface ClickTag { - clickThroughUrl?: Dfareporting.Schema.CreativeClickThroughUrl | undefined; - eventName?: string | undefined; - name?: string | undefined; - } - interface ClickThroughUrl { - computedClickThroughUrl?: string | undefined; - customClickThroughUrl?: string | undefined; - defaultLandingPage?: boolean | undefined; - landingPageId?: string | undefined; - } - interface ClickThroughUrlSuffixProperties { - clickThroughUrlSuffix?: string | undefined; - overrideInheritedSuffix?: boolean | undefined; - } - interface CompanionClickThroughOverride { - clickThroughUrl?: Dfareporting.Schema.ClickThroughUrl | undefined; - creativeId?: string | undefined; - } - interface CompanionSetting { - companionsDisabled?: boolean | undefined; - enabledSizes?: Dfareporting.Schema.Size[] | undefined; - imageOnly?: boolean | undefined; - kind?: string | undefined; - } - interface CompatibleFields { - crossDimensionReachReportCompatibleFields?: - | Dfareporting.Schema.CrossDimensionReachReportCompatibleFields - | undefined; - floodlightReportCompatibleFields?: Dfareporting.Schema.FloodlightReportCompatibleFields | undefined; - kind?: string | undefined; - pathToConversionReportCompatibleFields?: - | Dfareporting.Schema.PathToConversionReportCompatibleFields - | undefined; - reachReportCompatibleFields?: Dfareporting.Schema.ReachReportCompatibleFields | undefined; - reportCompatibleFields?: Dfareporting.Schema.ReportCompatibleFields | undefined; - } - interface ConnectionType { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface ConnectionTypesListResponse { - connectionTypes?: Dfareporting.Schema.ConnectionType[] | undefined; - kind?: string | undefined; - } - interface ContentCategoriesListResponse { - contentCategories?: Dfareporting.Schema.ContentCategory[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface ContentCategory { - accountId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface Conversion { - childDirectedTreatment?: boolean | undefined; - customVariables?: Dfareporting.Schema.CustomFloodlightVariable[] | undefined; - encryptedUserId?: string | undefined; - encryptedUserIdCandidates?: string[] | undefined; - floodlightActivityId?: string | undefined; - floodlightConfigurationId?: string | undefined; - gclid?: string | undefined; - kind?: string | undefined; - limitAdTracking?: boolean | undefined; - mobileDeviceId?: string | undefined; - nonPersonalizedAd?: boolean | undefined; - ordinal?: string | undefined; - quantity?: string | undefined; - timestampMicros?: string | undefined; - treatmentForUnderage?: boolean | undefined; - value?: number | undefined; - } - interface ConversionError { - code?: string | undefined; - kind?: string | undefined; - message?: string | undefined; - } - interface ConversionStatus { - conversion?: Dfareporting.Schema.Conversion | undefined; - errors?: Dfareporting.Schema.ConversionError[] | undefined; - kind?: string | undefined; - } - interface ConversionsBatchInsertRequest { - conversions?: Dfareporting.Schema.Conversion[] | undefined; - encryptionInfo?: Dfareporting.Schema.EncryptionInfo | undefined; - kind?: string | undefined; - } - interface ConversionsBatchInsertResponse { - hasFailures?: boolean | undefined; - kind?: string | undefined; - status?: Dfareporting.Schema.ConversionStatus[] | undefined; - } - interface ConversionsBatchUpdateRequest { - conversions?: Dfareporting.Schema.Conversion[] | undefined; - encryptionInfo?: Dfareporting.Schema.EncryptionInfo | undefined; - kind?: string | undefined; - } - interface ConversionsBatchUpdateResponse { - hasFailures?: boolean | undefined; - kind?: string | undefined; - status?: Dfareporting.Schema.ConversionStatus[] | undefined; - } - interface CountriesListResponse { - countries?: Dfareporting.Schema.Country[] | undefined; - kind?: string | undefined; - } - interface Country { - countryCode?: string | undefined; - dartId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - sslEnabled?: boolean | undefined; - } - interface Creative { - accountId?: string | undefined; - active?: boolean | undefined; - adParameters?: string | undefined; - adTagKeys?: string[] | undefined; - additionalSizes?: Dfareporting.Schema.Size[] | undefined; - advertiserId?: string | undefined; - allowScriptAccess?: boolean | undefined; - archived?: boolean | undefined; - artworkType?: string | undefined; - authoringSource?: string | undefined; - authoringTool?: string | undefined; - autoAdvanceImages?: boolean | undefined; - backgroundColor?: string | undefined; - backupImageClickThroughUrl?: Dfareporting.Schema.CreativeClickThroughUrl | undefined; - backupImageFeatures?: string[] | undefined; - backupImageReportingLabel?: string | undefined; - backupImageTargetWindow?: Dfareporting.Schema.TargetWindow | undefined; - clickTags?: Dfareporting.Schema.ClickTag[] | undefined; - commercialId?: string | undefined; - companionCreatives?: string[] | undefined; - compatibility?: string[] | undefined; - convertFlashToHtml5?: boolean | undefined; - counterCustomEvents?: Dfareporting.Schema.CreativeCustomEvent[] | undefined; - creativeAssetSelection?: Dfareporting.Schema.CreativeAssetSelection | undefined; - creativeAssets?: Dfareporting.Schema.CreativeAsset[] | undefined; - creativeFieldAssignments?: Dfareporting.Schema.CreativeFieldAssignment[] | undefined; - customKeyValues?: string[] | undefined; - dynamicAssetSelection?: boolean | undefined; - exitCustomEvents?: Dfareporting.Schema.CreativeCustomEvent[] | undefined; - fsCommand?: Dfareporting.Schema.FsCommand | undefined; - htmlCode?: string | undefined; - htmlCodeLocked?: boolean | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - latestTraffickedCreativeId?: string | undefined; - mediaDescription?: string | undefined; - mediaDuration?: number | undefined; - name?: string | undefined; - overrideCss?: string | undefined; - progressOffset?: Dfareporting.Schema.VideoOffset | undefined; - redirectUrl?: string | undefined; - renderingId?: string | undefined; - renderingIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - requiredFlashPluginVersion?: string | undefined; - requiredFlashVersion?: number | undefined; - size?: Dfareporting.Schema.Size | undefined; - skipOffset?: Dfareporting.Schema.VideoOffset | undefined; - skippable?: boolean | undefined; - sslCompliant?: boolean | undefined; - sslOverride?: boolean | undefined; - studioAdvertiserId?: string | undefined; - studioCreativeId?: string | undefined; - studioTraffickedCreativeId?: string | undefined; - subaccountId?: string | undefined; - thirdPartyBackupImageImpressionsUrl?: string | undefined; - thirdPartyRichMediaImpressionsUrl?: string | undefined; - thirdPartyUrls?: Dfareporting.Schema.ThirdPartyTrackingUrl[] | undefined; - timerCustomEvents?: Dfareporting.Schema.CreativeCustomEvent[] | undefined; - totalFileSize?: string | undefined; - type?: string | undefined; - universalAdId?: Dfareporting.Schema.UniversalAdId | undefined; - version?: number | undefined; - } - interface CreativeAsset { - actionScript3?: boolean | undefined; - active?: boolean | undefined; - additionalSizes?: Dfareporting.Schema.Size[] | undefined; - alignment?: string | undefined; - artworkType?: string | undefined; - assetIdentifier?: Dfareporting.Schema.CreativeAssetId | undefined; - audioBitRate?: number | undefined; - audioSampleRate?: number | undefined; - backupImageExit?: Dfareporting.Schema.CreativeCustomEvent | undefined; - bitRate?: number | undefined; - childAssetType?: string | undefined; - collapsedSize?: Dfareporting.Schema.Size | undefined; - companionCreativeIds?: string[] | undefined; - customStartTimeValue?: number | undefined; - detectedFeatures?: string[] | undefined; - displayType?: string | undefined; - duration?: number | undefined; - durationType?: string | undefined; - expandedDimension?: Dfareporting.Schema.Size | undefined; - fileSize?: string | undefined; - flashVersion?: number | undefined; - frameRate?: number | undefined; - hideFlashObjects?: boolean | undefined; - hideSelectionBoxes?: boolean | undefined; - horizontallyLocked?: boolean | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - mediaDuration?: number | undefined; - mimeType?: string | undefined; - offset?: Dfareporting.Schema.OffsetPosition | undefined; - orientation?: string | undefined; - originalBackup?: boolean | undefined; - politeLoad?: boolean | undefined; - position?: Dfareporting.Schema.OffsetPosition | undefined; - positionLeftUnit?: string | undefined; - positionTopUnit?: string | undefined; - progressiveServingUrl?: string | undefined; - pushdown?: boolean | undefined; - pushdownDuration?: number | undefined; - role?: string | undefined; - size?: Dfareporting.Schema.Size | undefined; - sslCompliant?: boolean | undefined; - startTimeType?: string | undefined; - streamingServingUrl?: string | undefined; - transparency?: boolean | undefined; - verticallyLocked?: boolean | undefined; - windowMode?: string | undefined; - zIndex?: number | undefined; - zipFilename?: string | undefined; - zipFilesize?: string | undefined; - } - interface CreativeAssetId { - name?: string | undefined; - type?: string | undefined; - } - interface CreativeAssetMetadata { - assetIdentifier?: Dfareporting.Schema.CreativeAssetId | undefined; - clickTags?: Dfareporting.Schema.ClickTag[] | undefined; - detectedFeatures?: string[] | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - warnedValidationRules?: string[] | undefined; - } - interface CreativeAssetSelection { - defaultAssetId?: string | undefined; - rules?: Dfareporting.Schema.Rule[] | undefined; - } - interface CreativeAssignment { - active?: boolean | undefined; - applyEventTags?: boolean | undefined; - clickThroughUrl?: Dfareporting.Schema.ClickThroughUrl | undefined; - companionCreativeOverrides?: Dfareporting.Schema.CompanionClickThroughOverride[] | undefined; - creativeGroupAssignments?: Dfareporting.Schema.CreativeGroupAssignment[] | undefined; - creativeId?: string | undefined; - creativeIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - endTime?: string | undefined; - richMediaExitOverrides?: Dfareporting.Schema.RichMediaExitOverride[] | undefined; - sequence?: number | undefined; - sslCompliant?: boolean | undefined; - startTime?: string | undefined; - weight?: number | undefined; - } - interface CreativeClickThroughUrl { - computedClickThroughUrl?: string | undefined; - customClickThroughUrl?: string | undefined; - landingPageId?: string | undefined; - } - interface CreativeCustomEvent { - advertiserCustomEventId?: string | undefined; - advertiserCustomEventName?: string | undefined; - advertiserCustomEventType?: string | undefined; - artworkLabel?: string | undefined; - artworkType?: string | undefined; - exitClickThroughUrl?: Dfareporting.Schema.CreativeClickThroughUrl | undefined; - id?: string | undefined; - popupWindowProperties?: Dfareporting.Schema.PopupWindowProperties | undefined; - targetType?: string | undefined; - videoReportingId?: string | undefined; - } - interface CreativeField { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - } - interface CreativeFieldAssignment { - creativeFieldId?: string | undefined; - creativeFieldValueId?: string | undefined; - } - interface CreativeFieldValue { - id?: string | undefined; - kind?: string | undefined; - value?: string | undefined; - } - interface CreativeFieldValuesListResponse { - creativeFieldValues?: Dfareporting.Schema.CreativeFieldValue[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CreativeFieldsListResponse { - creativeFields?: Dfareporting.Schema.CreativeField[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CreativeGroup { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - groupNumber?: number | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - } - interface CreativeGroupAssignment { - creativeGroupId?: string | undefined; - creativeGroupNumber?: string | undefined; - } - interface CreativeGroupsListResponse { - creativeGroups?: Dfareporting.Schema.CreativeGroup[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CreativeOptimizationConfiguration { - id?: string | undefined; - name?: string | undefined; - optimizationActivitys?: Dfareporting.Schema.OptimizationActivity[] | undefined; - optimizationModel?: string | undefined; - } - interface CreativeRotation { - creativeAssignments?: Dfareporting.Schema.CreativeAssignment[] | undefined; - creativeOptimizationConfigurationId?: string | undefined; - type?: string | undefined; - weightCalculationStrategy?: string | undefined; - } - interface CreativesListResponse { - creatives?: Dfareporting.Schema.Creative[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CrossDimensionReachReportCompatibleFields { - breakdown?: Dfareporting.Schema.Dimension[] | undefined; - dimensionFilters?: Dfareporting.Schema.Dimension[] | undefined; - kind?: string | undefined; - metrics?: Dfareporting.Schema.Metric[] | undefined; - overlapMetrics?: Dfareporting.Schema.Metric[] | undefined; - } - interface CustomFloodlightVariable { - kind?: string | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface CustomRichMediaEvents { - filteredEventIds?: Dfareporting.Schema.DimensionValue[] | undefined; - kind?: string | undefined; - } - interface CustomViewabilityMetric { - configuration?: Dfareporting.Schema.CustomViewabilityMetricConfiguration | undefined; - id?: string | undefined; - name?: string | undefined; - } - interface CustomViewabilityMetricConfiguration { - audible?: boolean | undefined; - timeMillis?: number | undefined; - timePercent?: number | undefined; - viewabilityPercent?: number | undefined; - } - interface DateRange { - endDate?: string | undefined; - kind?: string | undefined; - relativeDateRange?: string | undefined; - startDate?: string | undefined; - } - interface DayPartTargeting { - daysOfWeek?: string[] | undefined; - hoursOfDay?: number[] | undefined; - userLocalTime?: boolean | undefined; - } - interface DeepLink { - appUrl?: string | undefined; - fallbackUrl?: string | undefined; - kind?: string | undefined; - mobileApp?: Dfareporting.Schema.MobileApp | undefined; - remarketingListIds?: string[] | undefined; - } - interface DefaultClickThroughEventTagProperties { - defaultClickThroughEventTagId?: string | undefined; - overrideInheritedEventTag?: boolean | undefined; - } - interface DeliverySchedule { - frequencyCap?: Dfareporting.Schema.FrequencyCap | undefined; - hardCutoff?: boolean | undefined; - impressionRatio?: string | undefined; - priority?: string | undefined; - } - interface DfpSettings { - dfpNetworkCode?: string | undefined; - dfpNetworkName?: string | undefined; - programmaticPlacementAccepted?: boolean | undefined; - pubPaidPlacementAccepted?: boolean | undefined; - publisherPortalOnly?: boolean | undefined; - } - interface Dimension { - kind?: string | undefined; - name?: string | undefined; - } - interface DimensionFilter { - dimensionName?: string | undefined; - kind?: string | undefined; - value?: string | undefined; - } - interface DimensionValue { - dimensionName?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - matchType?: string | undefined; - value?: string | undefined; - } - interface DimensionValueList { - etag?: string | undefined; - items?: Dfareporting.Schema.DimensionValue[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface DimensionValueRequest { - dimensionName?: string | undefined; - endDate?: string | undefined; - filters?: Dfareporting.Schema.DimensionFilter[] | undefined; - kind?: string | undefined; - startDate?: string | undefined; - } - interface DirectorySite { - active?: boolean | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - inpageTagFormats?: string[] | undefined; - interstitialTagFormats?: string[] | undefined; - kind?: string | undefined; - name?: string | undefined; - settings?: Dfareporting.Schema.DirectorySiteSettings | undefined; - url?: string | undefined; - } - interface DirectorySiteSettings { - activeViewOptOut?: boolean | undefined; - dfpSettings?: Dfareporting.Schema.DfpSettings | undefined; - instreamVideoPlacementAccepted?: boolean | undefined; - interstitialPlacementAccepted?: boolean | undefined; - } - interface DirectorySitesListResponse { - directorySites?: Dfareporting.Schema.DirectorySite[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface DynamicTargetingKey { - kind?: string | undefined; - name?: string | undefined; - objectId?: string | undefined; - objectType?: string | undefined; - } - interface DynamicTargetingKeysListResponse { - dynamicTargetingKeys?: Dfareporting.Schema.DynamicTargetingKey[] | undefined; - kind?: string | undefined; - } - interface EncryptionInfo { - encryptionEntityId?: string | undefined; - encryptionEntityType?: string | undefined; - encryptionSource?: string | undefined; - kind?: string | undefined; - } - interface EventTag { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - campaignId?: string | undefined; - campaignIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - enabledByDefault?: boolean | undefined; - excludeFromAdxRequests?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - siteFilterType?: string | undefined; - siteIds?: string[] | undefined; - sslCompliant?: boolean | undefined; - status?: string | undefined; - subaccountId?: string | undefined; - type?: string | undefined; - url?: string | undefined; - urlEscapeLevels?: number | undefined; - } - interface EventTagOverride { - enabled?: boolean | undefined; - id?: string | undefined; - } - interface EventTagsListResponse { - eventTags?: Dfareporting.Schema.EventTag[] | undefined; - kind?: string | undefined; - } - interface File { - dateRange?: Dfareporting.Schema.DateRange | undefined; - etag?: string | undefined; - fileName?: string | undefined; - format?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lastModifiedTime?: string | undefined; - reportId?: string | undefined; - status?: string | undefined; - urls?: Dfareporting.Schema.FileUrls | undefined; - } - interface FileList { - etag?: string | undefined; - items?: Dfareporting.Schema.File[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface FileUrls { - apiUrl?: string | undefined; - browserUrl?: string | undefined; - } - interface Flight { - endDate?: string | undefined; - rateOrCost?: string | undefined; - startDate?: string | undefined; - units?: string | undefined; - } - interface FloodlightActivitiesGenerateTagResponse { - floodlightActivityTag?: string | undefined; - globalSiteTagGlobalSnippet?: string | undefined; - kind?: string | undefined; - } - interface FloodlightActivitiesListResponse { - floodlightActivities?: Dfareporting.Schema.FloodlightActivity[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface FloodlightActivity { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - cacheBustingType?: string | undefined; - countingMethod?: string | undefined; - defaultTags?: Dfareporting.Schema.FloodlightActivityDynamicTag[] | undefined; - expectedUrl?: string | undefined; - floodlightActivityGroupId?: string | undefined; - floodlightActivityGroupName?: string | undefined; - floodlightActivityGroupTagString?: string | undefined; - floodlightActivityGroupType?: string | undefined; - floodlightConfigurationId?: string | undefined; - floodlightConfigurationIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - floodlightTagType?: string | undefined; - hidden?: boolean | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - name?: string | undefined; - notes?: string | undefined; - publisherTags?: Dfareporting.Schema.FloodlightActivityPublisherDynamicTag[] | undefined; - secure?: boolean | undefined; - sslCompliant?: boolean | undefined; - sslRequired?: boolean | undefined; - subaccountId?: string | undefined; - tagFormat?: string | undefined; - tagString?: string | undefined; - userDefinedVariableTypes?: string[] | undefined; - } - interface FloodlightActivityDynamicTag { - id?: string | undefined; - name?: string | undefined; - tag?: string | undefined; - } - interface FloodlightActivityGroup { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - floodlightConfigurationId?: string | undefined; - floodlightConfigurationIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - tagString?: string | undefined; - type?: string | undefined; - } - interface FloodlightActivityGroupsListResponse { - floodlightActivityGroups?: Dfareporting.Schema.FloodlightActivityGroup[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface FloodlightActivityPublisherDynamicTag { - clickThrough?: boolean | undefined; - directorySiteId?: string | undefined; - dynamicTag?: Dfareporting.Schema.FloodlightActivityDynamicTag | undefined; - siteId?: string | undefined; - siteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - viewThrough?: boolean | undefined; - } - interface FloodlightConfiguration { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - analyticsDataSharingEnabled?: boolean | undefined; - customViewabilityMetric?: Dfareporting.Schema.CustomViewabilityMetric | undefined; - exposureToConversionEnabled?: boolean | undefined; - firstDayOfWeek?: string | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - inAppAttributionTrackingEnabled?: boolean | undefined; - kind?: string | undefined; - lookbackConfiguration?: Dfareporting.Schema.LookbackConfiguration | undefined; - naturalSearchConversionAttributionOption?: string | undefined; - omnitureSettings?: Dfareporting.Schema.OmnitureSettings | undefined; - subaccountId?: string | undefined; - tagSettings?: Dfareporting.Schema.TagSettings | undefined; - thirdPartyAuthenticationTokens?: Dfareporting.Schema.ThirdPartyAuthenticationToken[] | undefined; - userDefinedVariableConfigurations?: Dfareporting.Schema.UserDefinedVariableConfiguration[] | undefined; - } - interface FloodlightConfigurationsListResponse { - floodlightConfigurations?: Dfareporting.Schema.FloodlightConfiguration[] | undefined; - kind?: string | undefined; - } - interface FloodlightReportCompatibleFields { - dimensionFilters?: Dfareporting.Schema.Dimension[] | undefined; - dimensions?: Dfareporting.Schema.Dimension[] | undefined; - kind?: string | undefined; - metrics?: Dfareporting.Schema.Metric[] | undefined; - } - interface FrequencyCap { - duration?: string | undefined; - impressions?: string | undefined; - } - interface FsCommand { - left?: number | undefined; - positionOption?: string | undefined; - top?: number | undefined; - windowHeight?: number | undefined; - windowWidth?: number | undefined; - } - interface GeoTargeting { - cities?: Dfareporting.Schema.City[] | undefined; - countries?: Dfareporting.Schema.Country[] | undefined; - excludeCountries?: boolean | undefined; - metros?: Dfareporting.Schema.Metro[] | undefined; - postalCodes?: Dfareporting.Schema.PostalCode[] | undefined; - regions?: Dfareporting.Schema.Region[] | undefined; - } - interface InventoryItem { - accountId?: string | undefined; - adSlots?: Dfareporting.Schema.AdSlot[] | undefined; - advertiserId?: string | undefined; - contentCategoryId?: string | undefined; - estimatedClickThroughRate?: string | undefined; - estimatedConversionRate?: string | undefined; - id?: string | undefined; - inPlan?: boolean | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - negotiationChannelId?: string | undefined; - orderId?: string | undefined; - placementStrategyId?: string | undefined; - pricing?: Dfareporting.Schema.Pricing | undefined; - projectId?: string | undefined; - rfpId?: string | undefined; - siteId?: string | undefined; - subaccountId?: string | undefined; - type?: string | undefined; - } - interface InventoryItemsListResponse { - inventoryItems?: Dfareporting.Schema.InventoryItem[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface KeyValueTargetingExpression { - expression?: string | undefined; - } - interface LandingPage { - advertiserId?: string | undefined; - archived?: boolean | undefined; - deepLinks?: Dfareporting.Schema.DeepLink[] | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - url?: string | undefined; - } - interface Language { - id?: string | undefined; - kind?: string | undefined; - languageCode?: string | undefined; - name?: string | undefined; - } - interface LanguageTargeting { - languages?: Dfareporting.Schema.Language[] | undefined; - } - interface LanguagesListResponse { - kind?: string | undefined; - languages?: Dfareporting.Schema.Language[] | undefined; - } - interface LastModifiedInfo { - time?: string | undefined; - } - interface ListPopulationClause { - terms?: Dfareporting.Schema.ListPopulationTerm[] | undefined; - } - interface ListPopulationRule { - floodlightActivityId?: string | undefined; - floodlightActivityName?: string | undefined; - listPopulationClauses?: Dfareporting.Schema.ListPopulationClause[] | undefined; - } - interface ListPopulationTerm { - contains?: boolean | undefined; - negation?: boolean | undefined; - operator?: string | undefined; - remarketingListId?: string | undefined; - type?: string | undefined; - value?: string | undefined; - variableFriendlyName?: string | undefined; - variableName?: string | undefined; - } - interface ListTargetingExpression { - expression?: string | undefined; - } - interface LookbackConfiguration { - clickDuration?: number | undefined; - postImpressionActivitiesDuration?: number | undefined; - } - interface Metric { - kind?: string | undefined; - name?: string | undefined; - } - interface Metro { - countryCode?: string | undefined; - countryDartId?: string | undefined; - dartId?: string | undefined; - dmaId?: string | undefined; - kind?: string | undefined; - metroCode?: string | undefined; - name?: string | undefined; - } - interface MetrosListResponse { - kind?: string | undefined; - metros?: Dfareporting.Schema.Metro[] | undefined; - } - interface MobileApp { - directory?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - publisherName?: string | undefined; - title?: string | undefined; - } - interface MobileAppsListResponse { - kind?: string | undefined; - mobileApps?: Dfareporting.Schema.MobileApp[] | undefined; - nextPageToken?: string | undefined; - } - interface MobileCarrier { - countryCode?: string | undefined; - countryDartId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface MobileCarriersListResponse { - kind?: string | undefined; - mobileCarriers?: Dfareporting.Schema.MobileCarrier[] | undefined; - } - interface ObjectFilter { - kind?: string | undefined; - objectIds?: string[] | undefined; - status?: string | undefined; - } - interface OffsetPosition { - left?: number | undefined; - top?: number | undefined; - } - interface OmnitureSettings { - omnitureCostDataEnabled?: boolean | undefined; - omnitureIntegrationEnabled?: boolean | undefined; - } - interface OperatingSystem { - dartId?: string | undefined; - desktop?: boolean | undefined; - kind?: string | undefined; - mobile?: boolean | undefined; - name?: string | undefined; - } - interface OperatingSystemVersion { - id?: string | undefined; - kind?: string | undefined; - majorVersion?: string | undefined; - minorVersion?: string | undefined; - name?: string | undefined; - operatingSystem?: Dfareporting.Schema.OperatingSystem | undefined; - } - interface OperatingSystemVersionsListResponse { - kind?: string | undefined; - operatingSystemVersions?: Dfareporting.Schema.OperatingSystemVersion[] | undefined; - } - interface OperatingSystemsListResponse { - kind?: string | undefined; - operatingSystems?: Dfareporting.Schema.OperatingSystem[] | undefined; - } - interface OptimizationActivity { - floodlightActivityId?: string | undefined; - floodlightActivityIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - weight?: number | undefined; - } - interface Order { - accountId?: string | undefined; - advertiserId?: string | undefined; - approverUserProfileIds?: string[] | undefined; - buyerInvoiceId?: string | undefined; - buyerOrganizationName?: string | undefined; - comments?: string | undefined; - contacts?: Dfareporting.Schema.OrderContact[] | undefined; - id?: string | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - notes?: string | undefined; - planningTermId?: string | undefined; - projectId?: string | undefined; - sellerOrderId?: string | undefined; - sellerOrganizationName?: string | undefined; - siteId?: string[] | undefined; - siteNames?: string[] | undefined; - subaccountId?: string | undefined; - termsAndConditions?: string | undefined; - } - interface OrderContact { - contactInfo?: string | undefined; - contactName?: string | undefined; - contactTitle?: string | undefined; - contactType?: string | undefined; - signatureUserProfileId?: string | undefined; - } - interface OrderDocument { - accountId?: string | undefined; - advertiserId?: string | undefined; - amendedOrderDocumentId?: string | undefined; - approvedByUserProfileIds?: string[] | undefined; - cancelled?: boolean | undefined; - createdInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - effectiveDate?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lastSentRecipients?: string[] | undefined; - lastSentTime?: string | undefined; - orderId?: string | undefined; - projectId?: string | undefined; - signed?: boolean | undefined; - subaccountId?: string | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface OrderDocumentsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - orderDocuments?: Dfareporting.Schema.OrderDocument[] | undefined; - } - interface OrdersListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - orders?: Dfareporting.Schema.Order[] | undefined; - } - interface PathToConversionReportCompatibleFields { - conversionDimensions?: Dfareporting.Schema.Dimension[] | undefined; - customFloodlightVariables?: Dfareporting.Schema.Dimension[] | undefined; - kind?: string | undefined; - metrics?: Dfareporting.Schema.Metric[] | undefined; - perInteractionDimensions?: Dfareporting.Schema.Dimension[] | undefined; - } - interface Placement { - accountId?: string | undefined; - adBlockingOptOut?: boolean | undefined; - additionalSizes?: Dfareporting.Schema.Size[] | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - archived?: boolean | undefined; - campaignId?: string | undefined; - campaignIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - comment?: string | undefined; - compatibility?: string | undefined; - contentCategoryId?: string | undefined; - createInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - directorySiteId?: string | undefined; - directorySiteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - externalId?: string | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - keyName?: string | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - lookbackConfiguration?: Dfareporting.Schema.LookbackConfiguration | undefined; - name?: string | undefined; - paymentApproved?: boolean | undefined; - paymentSource?: string | undefined; - placementGroupId?: string | undefined; - placementGroupIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - placementStrategyId?: string | undefined; - pricingSchedule?: Dfareporting.Schema.PricingSchedule | undefined; - primary?: boolean | undefined; - publisherUpdateInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - siteId?: string | undefined; - siteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - size?: Dfareporting.Schema.Size | undefined; - sslRequired?: boolean | undefined; - status?: string | undefined; - subaccountId?: string | undefined; - tagFormats?: string[] | undefined; - tagSetting?: Dfareporting.Schema.TagSetting | undefined; - videoActiveViewOptOut?: boolean | undefined; - videoSettings?: Dfareporting.Schema.VideoSettings | undefined; - vpaidAdapterChoice?: string | undefined; - } - interface PlacementAssignment { - active?: boolean | undefined; - placementId?: string | undefined; - placementIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - sslRequired?: boolean | undefined; - } - interface PlacementGroup { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - archived?: boolean | undefined; - campaignId?: string | undefined; - campaignIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - childPlacementIds?: string[] | undefined; - comment?: string | undefined; - contentCategoryId?: string | undefined; - createInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - directorySiteId?: string | undefined; - directorySiteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - externalId?: string | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - placementGroupType?: string | undefined; - placementStrategyId?: string | undefined; - pricingSchedule?: Dfareporting.Schema.PricingSchedule | undefined; - primaryPlacementId?: string | undefined; - primaryPlacementIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - siteId?: string | undefined; - siteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - subaccountId?: string | undefined; - } - interface PlacementGroupsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - placementGroups?: Dfareporting.Schema.PlacementGroup[] | undefined; - } - interface PlacementStrategiesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - placementStrategies?: Dfareporting.Schema.PlacementStrategy[] | undefined; - } - interface PlacementStrategy { - accountId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface PlacementTag { - placementId?: string | undefined; - tagDatas?: Dfareporting.Schema.TagData[] | undefined; - } - interface PlacementsGenerateTagsResponse { - kind?: string | undefined; - placementTags?: Dfareporting.Schema.PlacementTag[] | undefined; - } - interface PlacementsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - placements?: Dfareporting.Schema.Placement[] | undefined; - } - interface PlatformType { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface PlatformTypesListResponse { - kind?: string | undefined; - platformTypes?: Dfareporting.Schema.PlatformType[] | undefined; - } - interface PopupWindowProperties { - dimension?: Dfareporting.Schema.Size | undefined; - offset?: Dfareporting.Schema.OffsetPosition | undefined; - positionType?: string | undefined; - showAddressBar?: boolean | undefined; - showMenuBar?: boolean | undefined; - showScrollBar?: boolean | undefined; - showStatusBar?: boolean | undefined; - showToolBar?: boolean | undefined; - title?: string | undefined; - } - interface PostalCode { - code?: string | undefined; - countryCode?: string | undefined; - countryDartId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - } - interface PostalCodesListResponse { - kind?: string | undefined; - postalCodes?: Dfareporting.Schema.PostalCode[] | undefined; - } - interface Pricing { - capCostType?: string | undefined; - endDate?: string | undefined; - flights?: Dfareporting.Schema.Flight[] | undefined; - groupType?: string | undefined; - pricingType?: string | undefined; - startDate?: string | undefined; - } - interface PricingSchedule { - capCostOption?: string | undefined; - disregardOverdelivery?: boolean | undefined; - endDate?: string | undefined; - flighted?: boolean | undefined; - floodlightActivityId?: string | undefined; - pricingPeriods?: Dfareporting.Schema.PricingSchedulePricingPeriod[] | undefined; - pricingType?: string | undefined; - startDate?: string | undefined; - testingStartDate?: string | undefined; - } - interface PricingSchedulePricingPeriod { - endDate?: string | undefined; - pricingComment?: string | undefined; - rateOrCostNanos?: string | undefined; - startDate?: string | undefined; - units?: string | undefined; - } - interface Project { - accountId?: string | undefined; - advertiserId?: string | undefined; - audienceAgeGroup?: string | undefined; - audienceGender?: string | undefined; - budget?: string | undefined; - clientBillingCode?: string | undefined; - clientName?: string | undefined; - endDate?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lastModifiedInfo?: Dfareporting.Schema.LastModifiedInfo | undefined; - name?: string | undefined; - overview?: string | undefined; - startDate?: string | undefined; - subaccountId?: string | undefined; - targetClicks?: string | undefined; - targetConversions?: string | undefined; - targetCpaNanos?: string | undefined; - targetCpcNanos?: string | undefined; - targetCpmActiveViewNanos?: string | undefined; - targetCpmNanos?: string | undefined; - targetImpressions?: string | undefined; - } - interface ProjectsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - projects?: Dfareporting.Schema.Project[] | undefined; - } - interface ReachReportCompatibleFields { - dimensionFilters?: Dfareporting.Schema.Dimension[] | undefined; - dimensions?: Dfareporting.Schema.Dimension[] | undefined; - kind?: string | undefined; - metrics?: Dfareporting.Schema.Metric[] | undefined; - pivotedActivityMetrics?: Dfareporting.Schema.Metric[] | undefined; - reachByFrequencyMetrics?: Dfareporting.Schema.Metric[] | undefined; - } - interface Recipient { - deliveryType?: string | undefined; - email?: string | undefined; - kind?: string | undefined; - } - interface Region { - countryCode?: string | undefined; - countryDartId?: string | undefined; - dartId?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - regionCode?: string | undefined; - } - interface RegionsListResponse { - kind?: string | undefined; - regions?: Dfareporting.Schema.Region[] | undefined; - } - interface RemarketingList { - accountId?: string | undefined; - active?: boolean | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - description?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lifeSpan?: string | undefined; - listPopulationRule?: Dfareporting.Schema.ListPopulationRule | undefined; - listSize?: string | undefined; - listSource?: string | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - } - interface RemarketingListShare { - kind?: string | undefined; - remarketingListId?: string | undefined; - sharedAccountIds?: string[] | undefined; - sharedAdvertiserIds?: string[] | undefined; - } - interface RemarketingListsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - remarketingLists?: Dfareporting.Schema.RemarketingList[] | undefined; - } - interface Report { - accountId?: string | undefined; - criteria?: Dfareporting.Schema.ReportCriteria | undefined; - crossDimensionReachCriteria?: Dfareporting.Schema.ReportCrossDimensionReachCriteria | undefined; - delivery?: Dfareporting.Schema.ReportDelivery | undefined; - etag?: string | undefined; - fileName?: string | undefined; - floodlightCriteria?: Dfareporting.Schema.ReportFloodlightCriteria | undefined; - format?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lastModifiedTime?: string | undefined; - name?: string | undefined; - ownerProfileId?: string | undefined; - pathToConversionCriteria?: Dfareporting.Schema.ReportPathToConversionCriteria | undefined; - reachCriteria?: Dfareporting.Schema.ReportReachCriteria | undefined; - schedule?: Dfareporting.Schema.ReportSchedule | undefined; - subAccountId?: string | undefined; - type?: string | undefined; - } - interface ReportCompatibleFields { - dimensionFilters?: Dfareporting.Schema.Dimension[] | undefined; - dimensions?: Dfareporting.Schema.Dimension[] | undefined; - kind?: string | undefined; - metrics?: Dfareporting.Schema.Metric[] | undefined; - pivotedActivityMetrics?: Dfareporting.Schema.Metric[] | undefined; - } - interface ReportCriteria { - activities?: Dfareporting.Schema.Activities | undefined; - customRichMediaEvents?: Dfareporting.Schema.CustomRichMediaEvents | undefined; - dateRange?: Dfareporting.Schema.DateRange | undefined; - dimensionFilters?: Dfareporting.Schema.DimensionValue[] | undefined; - dimensions?: Dfareporting.Schema.SortedDimension[] | undefined; - metricNames?: string[] | undefined; - } - interface ReportCrossDimensionReachCriteria { - breakdown?: Dfareporting.Schema.SortedDimension[] | undefined; - dateRange?: Dfareporting.Schema.DateRange | undefined; - dimension?: string | undefined; - dimensionFilters?: Dfareporting.Schema.DimensionValue[] | undefined; - metricNames?: string[] | undefined; - overlapMetricNames?: string[] | undefined; - pivoted?: boolean | undefined; - } - interface ReportDelivery { - emailOwner?: boolean | undefined; - emailOwnerDeliveryType?: string | undefined; - message?: string | undefined; - recipients?: Dfareporting.Schema.Recipient[] | undefined; - } - interface ReportFloodlightCriteria { - customRichMediaEvents?: Dfareporting.Schema.DimensionValue[] | undefined; - dateRange?: Dfareporting.Schema.DateRange | undefined; - dimensionFilters?: Dfareporting.Schema.DimensionValue[] | undefined; - dimensions?: Dfareporting.Schema.SortedDimension[] | undefined; - floodlightConfigId?: Dfareporting.Schema.DimensionValue | undefined; - metricNames?: string[] | undefined; - reportProperties?: Dfareporting.Schema.ReportFloodlightCriteriaReportProperties | undefined; - } - interface ReportFloodlightCriteriaReportProperties { - includeAttributedIPConversions?: boolean | undefined; - includeUnattributedCookieConversions?: boolean | undefined; - includeUnattributedIPConversions?: boolean | undefined; - } - interface ReportList { - etag?: string | undefined; - items?: Dfareporting.Schema.Report[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface ReportPathToConversionCriteria { - activityFilters?: Dfareporting.Schema.DimensionValue[] | undefined; - conversionDimensions?: Dfareporting.Schema.SortedDimension[] | undefined; - customFloodlightVariables?: Dfareporting.Schema.SortedDimension[] | undefined; - customRichMediaEvents?: Dfareporting.Schema.DimensionValue[] | undefined; - dateRange?: Dfareporting.Schema.DateRange | undefined; - floodlightConfigId?: Dfareporting.Schema.DimensionValue | undefined; - metricNames?: string[] | undefined; - perInteractionDimensions?: Dfareporting.Schema.SortedDimension[] | undefined; - reportProperties?: Dfareporting.Schema.ReportPathToConversionCriteriaReportProperties | undefined; - } - interface ReportPathToConversionCriteriaReportProperties { - clicksLookbackWindow?: number | undefined; - impressionsLookbackWindow?: number | undefined; - includeAttributedIPConversions?: boolean | undefined; - includeUnattributedCookieConversions?: boolean | undefined; - includeUnattributedIPConversions?: boolean | undefined; - maximumClickInteractions?: number | undefined; - maximumImpressionInteractions?: number | undefined; - maximumInteractionGap?: number | undefined; - pivotOnInteractionPath?: boolean | undefined; - } - interface ReportReachCriteria { - activities?: Dfareporting.Schema.Activities | undefined; - customRichMediaEvents?: Dfareporting.Schema.CustomRichMediaEvents | undefined; - dateRange?: Dfareporting.Schema.DateRange | undefined; - dimensionFilters?: Dfareporting.Schema.DimensionValue[] | undefined; - dimensions?: Dfareporting.Schema.SortedDimension[] | undefined; - enableAllDimensionCombinations?: boolean | undefined; - metricNames?: string[] | undefined; - reachByFrequencyMetricNames?: string[] | undefined; - } - interface ReportSchedule { - active?: boolean | undefined; - every?: number | undefined; - expirationDate?: string | undefined; - repeats?: string | undefined; - repeatsOnWeekDays?: string[] | undefined; - runsOnDayOfMonth?: string | undefined; - startDate?: string | undefined; - } - interface ReportsConfiguration { - exposureToConversionEnabled?: boolean | undefined; - lookbackConfiguration?: Dfareporting.Schema.LookbackConfiguration | undefined; - reportGenerationTimeZoneId?: string | undefined; - } - interface RichMediaExitOverride { - clickThroughUrl?: Dfareporting.Schema.ClickThroughUrl | undefined; - enabled?: boolean | undefined; - exitId?: string | undefined; - } - interface Rule { - assetId?: string | undefined; - name?: string | undefined; - targetingTemplateId?: string | undefined; - } - interface Site { - accountId?: string | undefined; - approved?: boolean | undefined; - directorySiteId?: string | undefined; - directorySiteIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - id?: string | undefined; - idDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - keyName?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - siteContacts?: Dfareporting.Schema.SiteContact[] | undefined; - siteSettings?: Dfareporting.Schema.SiteSettings | undefined; - subaccountId?: string | undefined; - videoSettings?: Dfareporting.Schema.SiteVideoSettings | undefined; - } - interface SiteCompanionSetting { - companionsDisabled?: boolean | undefined; - enabledSizes?: Dfareporting.Schema.Size[] | undefined; - imageOnly?: boolean | undefined; - kind?: string | undefined; - } - interface SiteContact { - address?: string | undefined; - contactType?: string | undefined; - email?: string | undefined; - firstName?: string | undefined; - id?: string | undefined; - lastName?: string | undefined; - phone?: string | undefined; - title?: string | undefined; - } - interface SiteSettings { - activeViewOptOut?: boolean | undefined; - adBlockingOptOut?: boolean | undefined; - disableNewCookie?: boolean | undefined; - tagSetting?: Dfareporting.Schema.TagSetting | undefined; - videoActiveViewOptOutTemplate?: boolean | undefined; - vpaidAdapterChoiceTemplate?: string | undefined; - } - interface SiteSkippableSetting { - kind?: string | undefined; - progressOffset?: Dfareporting.Schema.VideoOffset | undefined; - skipOffset?: Dfareporting.Schema.VideoOffset | undefined; - skippable?: boolean | undefined; - } - interface SiteTranscodeSetting { - enabledVideoFormats?: number[] | undefined; - kind?: string | undefined; - } - interface SiteVideoSettings { - companionSettings?: Dfareporting.Schema.SiteCompanionSetting | undefined; - kind?: string | undefined; - orientation?: string | undefined; - skippableSettings?: Dfareporting.Schema.SiteSkippableSetting | undefined; - transcodeSettings?: Dfareporting.Schema.SiteTranscodeSetting | undefined; - } - interface SitesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - sites?: Dfareporting.Schema.Site[] | undefined; - } - interface Size { - height?: number | undefined; - iab?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - width?: number | undefined; - } - interface SizesListResponse { - kind?: string | undefined; - sizes?: Dfareporting.Schema.Size[] | undefined; - } - interface SkippableSetting { - kind?: string | undefined; - progressOffset?: Dfareporting.Schema.VideoOffset | undefined; - skipOffset?: Dfareporting.Schema.VideoOffset | undefined; - skippable?: boolean | undefined; - } - interface SortedDimension { - kind?: string | undefined; - name?: string | undefined; - sortOrder?: string | undefined; - } - interface Subaccount { - accountId?: string | undefined; - availablePermissionIds?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface SubaccountsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - subaccounts?: Dfareporting.Schema.Subaccount[] | undefined; - } - interface TagData { - adId?: string | undefined; - clickTag?: string | undefined; - creativeId?: string | undefined; - format?: string | undefined; - impressionTag?: string | undefined; - } - interface TagSetting { - additionalKeyValues?: string | undefined; - includeClickThroughUrls?: boolean | undefined; - includeClickTracking?: boolean | undefined; - keywordOption?: string | undefined; - } - interface TagSettings { - dynamicTagEnabled?: boolean | undefined; - imageTagEnabled?: boolean | undefined; - } - interface TargetWindow { - customHtml?: string | undefined; - targetWindowOption?: string | undefined; - } - interface TargetableRemarketingList { - accountId?: string | undefined; - active?: boolean | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - description?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lifeSpan?: string | undefined; - listSize?: string | undefined; - listSource?: string | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - } - interface TargetableRemarketingListsListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - targetableRemarketingLists?: Dfareporting.Schema.TargetableRemarketingList[] | undefined; - } - interface TargetingTemplate { - accountId?: string | undefined; - advertiserId?: string | undefined; - advertiserIdDimensionValue?: Dfareporting.Schema.DimensionValue | undefined; - dayPartTargeting?: Dfareporting.Schema.DayPartTargeting | undefined; - geoTargeting?: Dfareporting.Schema.GeoTargeting | undefined; - id?: string | undefined; - keyValueTargetingExpression?: Dfareporting.Schema.KeyValueTargetingExpression | undefined; - kind?: string | undefined; - languageTargeting?: Dfareporting.Schema.LanguageTargeting | undefined; - listTargetingExpression?: Dfareporting.Schema.ListTargetingExpression | undefined; - name?: string | undefined; - subaccountId?: string | undefined; - technologyTargeting?: Dfareporting.Schema.TechnologyTargeting | undefined; - } - interface TargetingTemplatesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - targetingTemplates?: Dfareporting.Schema.TargetingTemplate[] | undefined; - } - interface TechnologyTargeting { - browsers?: Dfareporting.Schema.Browser[] | undefined; - connectionTypes?: Dfareporting.Schema.ConnectionType[] | undefined; - mobileCarriers?: Dfareporting.Schema.MobileCarrier[] | undefined; - operatingSystemVersions?: Dfareporting.Schema.OperatingSystemVersion[] | undefined; - operatingSystems?: Dfareporting.Schema.OperatingSystem[] | undefined; - platformTypes?: Dfareporting.Schema.PlatformType[] | undefined; - } - interface ThirdPartyAuthenticationToken { - name?: string | undefined; - value?: string | undefined; - } - interface ThirdPartyTrackingUrl { - thirdPartyUrlType?: string | undefined; - url?: string | undefined; - } - interface TranscodeSetting { - enabledVideoFormats?: number[] | undefined; - kind?: string | undefined; - } - interface UniversalAdId { - registry?: string | undefined; - value?: string | undefined; - } - interface UserDefinedVariableConfiguration { - dataType?: string | undefined; - reportName?: string | undefined; - variableType?: string | undefined; - } - interface UserProfile { - accountId?: string | undefined; - accountName?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - profileId?: string | undefined; - subAccountId?: string | undefined; - subAccountName?: string | undefined; - userName?: string | undefined; - } - interface UserProfileList { - etag?: string | undefined; - items?: Dfareporting.Schema.UserProfile[] | undefined; - kind?: string | undefined; - } - interface UserRole { - accountId?: string | undefined; - defaultUserRole?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - parentUserRoleId?: string | undefined; - permissions?: Dfareporting.Schema.UserRolePermission[] | undefined; - subaccountId?: string | undefined; - } - interface UserRolePermission { - availability?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - permissionGroupId?: string | undefined; - } - interface UserRolePermissionGroup { - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface UserRolePermissionGroupsListResponse { - kind?: string | undefined; - userRolePermissionGroups?: Dfareporting.Schema.UserRolePermissionGroup[] | undefined; - } - interface UserRolePermissionsListResponse { - kind?: string | undefined; - userRolePermissions?: Dfareporting.Schema.UserRolePermission[] | undefined; - } - interface UserRolesListResponse { - kind?: string | undefined; - nextPageToken?: string | undefined; - userRoles?: Dfareporting.Schema.UserRole[] | undefined; - } - interface VideoFormat { - fileType?: string | undefined; - id?: number | undefined; - kind?: string | undefined; - resolution?: Dfareporting.Schema.Size | undefined; - targetBitRate?: number | undefined; - } - interface VideoFormatsListResponse { - kind?: string | undefined; - videoFormats?: Dfareporting.Schema.VideoFormat[] | undefined; - } - interface VideoOffset { - offsetPercentage?: number | undefined; - offsetSeconds?: number | undefined; - } - interface VideoSettings { - companionSettings?: Dfareporting.Schema.CompanionSetting | undefined; - kind?: string | undefined; - orientation?: string | undefined; - skippableSettings?: Dfareporting.Schema.SkippableSetting | undefined; - transcodeSettings?: Dfareporting.Schema.TranscodeSetting | undefined; - } - } - } - interface Dfareporting { - AccountActiveAdSummaries?: Dfareporting.Collection.AccountActiveAdSummariesCollection | undefined; - AccountPermissionGroups?: Dfareporting.Collection.AccountPermissionGroupsCollection | undefined; - AccountPermissions?: Dfareporting.Collection.AccountPermissionsCollection | undefined; - AccountUserProfiles?: Dfareporting.Collection.AccountUserProfilesCollection | undefined; - Accounts?: Dfareporting.Collection.AccountsCollection | undefined; - Ads?: Dfareporting.Collection.AdsCollection | undefined; - AdvertiserGroups?: Dfareporting.Collection.AdvertiserGroupsCollection | undefined; - AdvertiserLandingPages?: Dfareporting.Collection.AdvertiserLandingPagesCollection | undefined; - Advertisers?: Dfareporting.Collection.AdvertisersCollection | undefined; - Browsers?: Dfareporting.Collection.BrowsersCollection | undefined; - CampaignCreativeAssociations?: Dfareporting.Collection.CampaignCreativeAssociationsCollection | undefined; - Campaigns?: Dfareporting.Collection.CampaignsCollection | undefined; - ChangeLogs?: Dfareporting.Collection.ChangeLogsCollection | undefined; - Cities?: Dfareporting.Collection.CitiesCollection | undefined; - ConnectionTypes?: Dfareporting.Collection.ConnectionTypesCollection | undefined; - ContentCategories?: Dfareporting.Collection.ContentCategoriesCollection | undefined; - Conversions?: Dfareporting.Collection.ConversionsCollection | undefined; - Countries?: Dfareporting.Collection.CountriesCollection | undefined; - CreativeAssets?: Dfareporting.Collection.CreativeAssetsCollection | undefined; - CreativeFieldValues?: Dfareporting.Collection.CreativeFieldValuesCollection | undefined; - CreativeFields?: Dfareporting.Collection.CreativeFieldsCollection | undefined; - CreativeGroups?: Dfareporting.Collection.CreativeGroupsCollection | undefined; - Creatives?: Dfareporting.Collection.CreativesCollection | undefined; - DimensionValues?: Dfareporting.Collection.DimensionValuesCollection | undefined; - DirectorySites?: Dfareporting.Collection.DirectorySitesCollection | undefined; - DynamicTargetingKeys?: Dfareporting.Collection.DynamicTargetingKeysCollection | undefined; - EventTags?: Dfareporting.Collection.EventTagsCollection | undefined; - Files?: Dfareporting.Collection.FilesCollection | undefined; - FloodlightActivities?: Dfareporting.Collection.FloodlightActivitiesCollection | undefined; - FloodlightActivityGroups?: Dfareporting.Collection.FloodlightActivityGroupsCollection | undefined; - FloodlightConfigurations?: Dfareporting.Collection.FloodlightConfigurationsCollection | undefined; - InventoryItems?: Dfareporting.Collection.InventoryItemsCollection | undefined; - Languages?: Dfareporting.Collection.LanguagesCollection | undefined; - Metros?: Dfareporting.Collection.MetrosCollection | undefined; - MobileApps?: Dfareporting.Collection.MobileAppsCollection | undefined; - MobileCarriers?: Dfareporting.Collection.MobileCarriersCollection | undefined; - OperatingSystemVersions?: Dfareporting.Collection.OperatingSystemVersionsCollection | undefined; - OperatingSystems?: Dfareporting.Collection.OperatingSystemsCollection | undefined; - OrderDocuments?: Dfareporting.Collection.OrderDocumentsCollection | undefined; - Orders?: Dfareporting.Collection.OrdersCollection | undefined; - PlacementGroups?: Dfareporting.Collection.PlacementGroupsCollection | undefined; - PlacementStrategies?: Dfareporting.Collection.PlacementStrategiesCollection | undefined; - Placements?: Dfareporting.Collection.PlacementsCollection | undefined; - PlatformTypes?: Dfareporting.Collection.PlatformTypesCollection | undefined; - PostalCodes?: Dfareporting.Collection.PostalCodesCollection | undefined; - Projects?: Dfareporting.Collection.ProjectsCollection | undefined; - Regions?: Dfareporting.Collection.RegionsCollection | undefined; - RemarketingListShares?: Dfareporting.Collection.RemarketingListSharesCollection | undefined; - RemarketingLists?: Dfareporting.Collection.RemarketingListsCollection | undefined; - Reports?: Dfareporting.Collection.ReportsCollection | undefined; - Sites?: Dfareporting.Collection.SitesCollection | undefined; - Sizes?: Dfareporting.Collection.SizesCollection | undefined; - Subaccounts?: Dfareporting.Collection.SubaccountsCollection | undefined; - TargetableRemarketingLists?: Dfareporting.Collection.TargetableRemarketingListsCollection | undefined; - TargetingTemplates?: Dfareporting.Collection.TargetingTemplatesCollection | undefined; - UserProfiles?: Dfareporting.Collection.UserProfilesCollection | undefined; - UserRolePermissionGroups?: Dfareporting.Collection.UserRolePermissionGroupsCollection | undefined; - UserRolePermissions?: Dfareporting.Collection.UserRolePermissionsCollection | undefined; - UserRoles?: Dfareporting.Collection.UserRolesCollection | undefined; - VideoFormats?: Dfareporting.Collection.VideoFormatsCollection | undefined; - // Create a new instance of Account - newAccount(): Dfareporting.Schema.Account; - // Create a new instance of AccountUserProfile - newAccountUserProfile(): Dfareporting.Schema.AccountUserProfile; - // Create a new instance of Activities - newActivities(): Dfareporting.Schema.Activities; - // Create a new instance of Ad - newAd(): Dfareporting.Schema.Ad; - // Create a new instance of AdBlockingConfiguration - newAdBlockingConfiguration(): Dfareporting.Schema.AdBlockingConfiguration; - // Create a new instance of Advertiser - newAdvertiser(): Dfareporting.Schema.Advertiser; - // Create a new instance of AdvertiserGroup - newAdvertiserGroup(): Dfareporting.Schema.AdvertiserGroup; - // Create a new instance of AudienceSegment - newAudienceSegment(): Dfareporting.Schema.AudienceSegment; - // Create a new instance of AudienceSegmentGroup - newAudienceSegmentGroup(): Dfareporting.Schema.AudienceSegmentGroup; - // Create a new instance of Browser - newBrowser(): Dfareporting.Schema.Browser; - // Create a new instance of Campaign - newCampaign(): Dfareporting.Schema.Campaign; - // Create a new instance of CampaignCreativeAssociation - newCampaignCreativeAssociation(): Dfareporting.Schema.CampaignCreativeAssociation; - // Create a new instance of City - newCity(): Dfareporting.Schema.City; - // Create a new instance of ClickTag - newClickTag(): Dfareporting.Schema.ClickTag; - // Create a new instance of ClickThroughUrl - newClickThroughUrl(): Dfareporting.Schema.ClickThroughUrl; - // Create a new instance of ClickThroughUrlSuffixProperties - newClickThroughUrlSuffixProperties(): Dfareporting.Schema.ClickThroughUrlSuffixProperties; - // Create a new instance of CompanionClickThroughOverride - newCompanionClickThroughOverride(): Dfareporting.Schema.CompanionClickThroughOverride; - // Create a new instance of CompanionSetting - newCompanionSetting(): Dfareporting.Schema.CompanionSetting; - // Create a new instance of ConnectionType - newConnectionType(): Dfareporting.Schema.ConnectionType; - // Create a new instance of ContentCategory - newContentCategory(): Dfareporting.Schema.ContentCategory; - // Create a new instance of Conversion - newConversion(): Dfareporting.Schema.Conversion; - // Create a new instance of ConversionsBatchInsertRequest - newConversionsBatchInsertRequest(): Dfareporting.Schema.ConversionsBatchInsertRequest; - // Create a new instance of ConversionsBatchUpdateRequest - newConversionsBatchUpdateRequest(): Dfareporting.Schema.ConversionsBatchUpdateRequest; - // Create a new instance of Country - newCountry(): Dfareporting.Schema.Country; - // Create a new instance of Creative - newCreative(): Dfareporting.Schema.Creative; - // Create a new instance of CreativeAsset - newCreativeAsset(): Dfareporting.Schema.CreativeAsset; - // Create a new instance of CreativeAssetId - newCreativeAssetId(): Dfareporting.Schema.CreativeAssetId; - // Create a new instance of CreativeAssetMetadata - newCreativeAssetMetadata(): Dfareporting.Schema.CreativeAssetMetadata; - // Create a new instance of CreativeAssetSelection - newCreativeAssetSelection(): Dfareporting.Schema.CreativeAssetSelection; - // Create a new instance of CreativeAssignment - newCreativeAssignment(): Dfareporting.Schema.CreativeAssignment; - // Create a new instance of CreativeClickThroughUrl - newCreativeClickThroughUrl(): Dfareporting.Schema.CreativeClickThroughUrl; - // Create a new instance of CreativeCustomEvent - newCreativeCustomEvent(): Dfareporting.Schema.CreativeCustomEvent; - // Create a new instance of CreativeField - newCreativeField(): Dfareporting.Schema.CreativeField; - // Create a new instance of CreativeFieldAssignment - newCreativeFieldAssignment(): Dfareporting.Schema.CreativeFieldAssignment; - // Create a new instance of CreativeFieldValue - newCreativeFieldValue(): Dfareporting.Schema.CreativeFieldValue; - // Create a new instance of CreativeGroup - newCreativeGroup(): Dfareporting.Schema.CreativeGroup; - // Create a new instance of CreativeGroupAssignment - newCreativeGroupAssignment(): Dfareporting.Schema.CreativeGroupAssignment; - // Create a new instance of CreativeOptimizationConfiguration - newCreativeOptimizationConfiguration(): Dfareporting.Schema.CreativeOptimizationConfiguration; - // Create a new instance of CreativeRotation - newCreativeRotation(): Dfareporting.Schema.CreativeRotation; - // Create a new instance of CustomFloodlightVariable - newCustomFloodlightVariable(): Dfareporting.Schema.CustomFloodlightVariable; - // Create a new instance of CustomRichMediaEvents - newCustomRichMediaEvents(): Dfareporting.Schema.CustomRichMediaEvents; - // Create a new instance of CustomViewabilityMetric - newCustomViewabilityMetric(): Dfareporting.Schema.CustomViewabilityMetric; - // Create a new instance of CustomViewabilityMetricConfiguration - newCustomViewabilityMetricConfiguration(): Dfareporting.Schema.CustomViewabilityMetricConfiguration; - // Create a new instance of DateRange - newDateRange(): Dfareporting.Schema.DateRange; - // Create a new instance of DayPartTargeting - newDayPartTargeting(): Dfareporting.Schema.DayPartTargeting; - // Create a new instance of DeepLink - newDeepLink(): Dfareporting.Schema.DeepLink; - // Create a new instance of DefaultClickThroughEventTagProperties - newDefaultClickThroughEventTagProperties(): Dfareporting.Schema.DefaultClickThroughEventTagProperties; - // Create a new instance of DeliverySchedule - newDeliverySchedule(): Dfareporting.Schema.DeliverySchedule; - // Create a new instance of DfpSettings - newDfpSettings(): Dfareporting.Schema.DfpSettings; - // Create a new instance of DimensionFilter - newDimensionFilter(): Dfareporting.Schema.DimensionFilter; - // Create a new instance of DimensionValue - newDimensionValue(): Dfareporting.Schema.DimensionValue; - // Create a new instance of DimensionValueRequest - newDimensionValueRequest(): Dfareporting.Schema.DimensionValueRequest; - // Create a new instance of DirectorySite - newDirectorySite(): Dfareporting.Schema.DirectorySite; - // Create a new instance of DirectorySiteSettings - newDirectorySiteSettings(): Dfareporting.Schema.DirectorySiteSettings; - // Create a new instance of DynamicTargetingKey - newDynamicTargetingKey(): Dfareporting.Schema.DynamicTargetingKey; - // Create a new instance of EncryptionInfo - newEncryptionInfo(): Dfareporting.Schema.EncryptionInfo; - // Create a new instance of EventTag - newEventTag(): Dfareporting.Schema.EventTag; - // Create a new instance of EventTagOverride - newEventTagOverride(): Dfareporting.Schema.EventTagOverride; - // Create a new instance of FloodlightActivity - newFloodlightActivity(): Dfareporting.Schema.FloodlightActivity; - // Create a new instance of FloodlightActivityDynamicTag - newFloodlightActivityDynamicTag(): Dfareporting.Schema.FloodlightActivityDynamicTag; - // Create a new instance of FloodlightActivityGroup - newFloodlightActivityGroup(): Dfareporting.Schema.FloodlightActivityGroup; - // Create a new instance of FloodlightActivityPublisherDynamicTag - newFloodlightActivityPublisherDynamicTag(): Dfareporting.Schema.FloodlightActivityPublisherDynamicTag; - // Create a new instance of FloodlightConfiguration - newFloodlightConfiguration(): Dfareporting.Schema.FloodlightConfiguration; - // Create a new instance of FrequencyCap - newFrequencyCap(): Dfareporting.Schema.FrequencyCap; - // Create a new instance of FsCommand - newFsCommand(): Dfareporting.Schema.FsCommand; - // Create a new instance of GeoTargeting - newGeoTargeting(): Dfareporting.Schema.GeoTargeting; - // Create a new instance of KeyValueTargetingExpression - newKeyValueTargetingExpression(): Dfareporting.Schema.KeyValueTargetingExpression; - // Create a new instance of LandingPage - newLandingPage(): Dfareporting.Schema.LandingPage; - // Create a new instance of Language - newLanguage(): Dfareporting.Schema.Language; - // Create a new instance of LanguageTargeting - newLanguageTargeting(): Dfareporting.Schema.LanguageTargeting; - // Create a new instance of LastModifiedInfo - newLastModifiedInfo(): Dfareporting.Schema.LastModifiedInfo; - // Create a new instance of ListPopulationClause - newListPopulationClause(): Dfareporting.Schema.ListPopulationClause; - // Create a new instance of ListPopulationRule - newListPopulationRule(): Dfareporting.Schema.ListPopulationRule; - // Create a new instance of ListPopulationTerm - newListPopulationTerm(): Dfareporting.Schema.ListPopulationTerm; - // Create a new instance of ListTargetingExpression - newListTargetingExpression(): Dfareporting.Schema.ListTargetingExpression; - // Create a new instance of LookbackConfiguration - newLookbackConfiguration(): Dfareporting.Schema.LookbackConfiguration; - // Create a new instance of Metro - newMetro(): Dfareporting.Schema.Metro; - // Create a new instance of MobileApp - newMobileApp(): Dfareporting.Schema.MobileApp; - // Create a new instance of MobileCarrier - newMobileCarrier(): Dfareporting.Schema.MobileCarrier; - // Create a new instance of ObjectFilter - newObjectFilter(): Dfareporting.Schema.ObjectFilter; - // Create a new instance of OffsetPosition - newOffsetPosition(): Dfareporting.Schema.OffsetPosition; - // Create a new instance of OmnitureSettings - newOmnitureSettings(): Dfareporting.Schema.OmnitureSettings; - // Create a new instance of OperatingSystem - newOperatingSystem(): Dfareporting.Schema.OperatingSystem; - // Create a new instance of OperatingSystemVersion - newOperatingSystemVersion(): Dfareporting.Schema.OperatingSystemVersion; - // Create a new instance of OptimizationActivity - newOptimizationActivity(): Dfareporting.Schema.OptimizationActivity; - // Create a new instance of Placement - newPlacement(): Dfareporting.Schema.Placement; - // Create a new instance of PlacementAssignment - newPlacementAssignment(): Dfareporting.Schema.PlacementAssignment; - // Create a new instance of PlacementGroup - newPlacementGroup(): Dfareporting.Schema.PlacementGroup; - // Create a new instance of PlacementStrategy - newPlacementStrategy(): Dfareporting.Schema.PlacementStrategy; - // Create a new instance of PlatformType - newPlatformType(): Dfareporting.Schema.PlatformType; - // Create a new instance of PopupWindowProperties - newPopupWindowProperties(): Dfareporting.Schema.PopupWindowProperties; - // Create a new instance of PostalCode - newPostalCode(): Dfareporting.Schema.PostalCode; - // Create a new instance of PricingSchedule - newPricingSchedule(): Dfareporting.Schema.PricingSchedule; - // Create a new instance of PricingSchedulePricingPeriod - newPricingSchedulePricingPeriod(): Dfareporting.Schema.PricingSchedulePricingPeriod; - // Create a new instance of Recipient - newRecipient(): Dfareporting.Schema.Recipient; - // Create a new instance of Region - newRegion(): Dfareporting.Schema.Region; - // Create a new instance of RemarketingList - newRemarketingList(): Dfareporting.Schema.RemarketingList; - // Create a new instance of RemarketingListShare - newRemarketingListShare(): Dfareporting.Schema.RemarketingListShare; - // Create a new instance of Report - newReport(): Dfareporting.Schema.Report; - // Create a new instance of ReportCriteria - newReportCriteria(): Dfareporting.Schema.ReportCriteria; - // Create a new instance of ReportCrossDimensionReachCriteria - newReportCrossDimensionReachCriteria(): Dfareporting.Schema.ReportCrossDimensionReachCriteria; - // Create a new instance of ReportDelivery - newReportDelivery(): Dfareporting.Schema.ReportDelivery; - // Create a new instance of ReportFloodlightCriteria - newReportFloodlightCriteria(): Dfareporting.Schema.ReportFloodlightCriteria; - // Create a new instance of ReportFloodlightCriteriaReportProperties - newReportFloodlightCriteriaReportProperties(): Dfareporting.Schema.ReportFloodlightCriteriaReportProperties; - // Create a new instance of ReportPathToConversionCriteria - newReportPathToConversionCriteria(): Dfareporting.Schema.ReportPathToConversionCriteria; - // Create a new instance of ReportPathToConversionCriteriaReportProperties - newReportPathToConversionCriteriaReportProperties(): Dfareporting.Schema.ReportPathToConversionCriteriaReportProperties; - // Create a new instance of ReportReachCriteria - newReportReachCriteria(): Dfareporting.Schema.ReportReachCriteria; - // Create a new instance of ReportSchedule - newReportSchedule(): Dfareporting.Schema.ReportSchedule; - // Create a new instance of ReportsConfiguration - newReportsConfiguration(): Dfareporting.Schema.ReportsConfiguration; - // Create a new instance of RichMediaExitOverride - newRichMediaExitOverride(): Dfareporting.Schema.RichMediaExitOverride; - // Create a new instance of Rule - newRule(): Dfareporting.Schema.Rule; - // Create a new instance of Site - newSite(): Dfareporting.Schema.Site; - // Create a new instance of SiteCompanionSetting - newSiteCompanionSetting(): Dfareporting.Schema.SiteCompanionSetting; - // Create a new instance of SiteContact - newSiteContact(): Dfareporting.Schema.SiteContact; - // Create a new instance of SiteSettings - newSiteSettings(): Dfareporting.Schema.SiteSettings; - // Create a new instance of SiteSkippableSetting - newSiteSkippableSetting(): Dfareporting.Schema.SiteSkippableSetting; - // Create a new instance of SiteTranscodeSetting - newSiteTranscodeSetting(): Dfareporting.Schema.SiteTranscodeSetting; - // Create a new instance of SiteVideoSettings - newSiteVideoSettings(): Dfareporting.Schema.SiteVideoSettings; - // Create a new instance of Size - newSize(): Dfareporting.Schema.Size; - // Create a new instance of SkippableSetting - newSkippableSetting(): Dfareporting.Schema.SkippableSetting; - // Create a new instance of SortedDimension - newSortedDimension(): Dfareporting.Schema.SortedDimension; - // Create a new instance of Subaccount - newSubaccount(): Dfareporting.Schema.Subaccount; - // Create a new instance of TagSetting - newTagSetting(): Dfareporting.Schema.TagSetting; - // Create a new instance of TagSettings - newTagSettings(): Dfareporting.Schema.TagSettings; - // Create a new instance of TargetWindow - newTargetWindow(): Dfareporting.Schema.TargetWindow; - // Create a new instance of TargetingTemplate - newTargetingTemplate(): Dfareporting.Schema.TargetingTemplate; - // Create a new instance of TechnologyTargeting - newTechnologyTargeting(): Dfareporting.Schema.TechnologyTargeting; - // Create a new instance of ThirdPartyAuthenticationToken - newThirdPartyAuthenticationToken(): Dfareporting.Schema.ThirdPartyAuthenticationToken; - // Create a new instance of ThirdPartyTrackingUrl - newThirdPartyTrackingUrl(): Dfareporting.Schema.ThirdPartyTrackingUrl; - // Create a new instance of TranscodeSetting - newTranscodeSetting(): Dfareporting.Schema.TranscodeSetting; - // Create a new instance of UniversalAdId - newUniversalAdId(): Dfareporting.Schema.UniversalAdId; - // Create a new instance of UserDefinedVariableConfiguration - newUserDefinedVariableConfiguration(): Dfareporting.Schema.UserDefinedVariableConfiguration; - // Create a new instance of UserRole - newUserRole(): Dfareporting.Schema.UserRole; - // Create a new instance of UserRolePermission - newUserRolePermission(): Dfareporting.Schema.UserRolePermission; - // Create a new instance of VideoOffset - newVideoOffset(): Dfareporting.Schema.VideoOffset; - // Create a new instance of VideoSettings - newVideoSettings(): Dfareporting.Schema.VideoSettings; - } -} - -declare var Dfareporting: GoogleAppsScript.Dfareporting; diff --git a/node_modules/@types/google-apps-script/apis/directory_v1.d.ts b/node_modules/@types/google-apps-script/apis/directory_v1.d.ts deleted file mode 100644 index 8e57a7f..0000000 --- a/node_modules/@types/google-apps-script/apis/directory_v1.d.ts +++ /dev/null @@ -1,1218 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminDirectory { - namespace Collection { - namespace Groups { - interface AliasesCollection { - // Add a alias for the group - insert(resource: Schema.Alias, groupKey: string): AdminDirectory.Schema.Alias; - // List all aliases for a group - list(groupKey: string): AdminDirectory.Schema.Aliases; - // Remove a alias for the group - remove(groupKey: string, alias: string): void; - } - } - namespace Resources { - interface BuildingsCollection { - // Retrieves a building. - get(customer: string, buildingId: string): AdminDirectory.Schema.Building; - // Inserts a building. - insert(resource: Schema.Building, customer: string): AdminDirectory.Schema.Building; - // Inserts a building. - insert( - resource: Schema.Building, - customer: string, - optionalArgs: object, - ): AdminDirectory.Schema.Building; - // Retrieves a list of buildings for an account. - list(customer: string): AdminDirectory.Schema.Buildings; - // Retrieves a list of buildings for an account. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.Buildings; - // Updates a building. This method supports patch semantics. - patch( - resource: Schema.Building, - customer: string, - buildingId: string, - ): AdminDirectory.Schema.Building; - // Updates a building. This method supports patch semantics. - patch( - resource: Schema.Building, - customer: string, - buildingId: string, - optionalArgs: object, - ): AdminDirectory.Schema.Building; - // Deletes a building. - remove(customer: string, buildingId: string): void; - // Updates a building. - update( - resource: Schema.Building, - customer: string, - buildingId: string, - ): AdminDirectory.Schema.Building; - // Updates a building. - update( - resource: Schema.Building, - customer: string, - buildingId: string, - optionalArgs: object, - ): AdminDirectory.Schema.Building; - } - interface CalendarsCollection { - // Retrieves a calendar resource. - get(customer: string, calendarResourceId: string): AdminDirectory.Schema.CalendarResource; - // Inserts a calendar resource. - insert(resource: Schema.CalendarResource, customer: string): AdminDirectory.Schema.CalendarResource; - // Retrieves a list of calendar resources for an account. - list(customer: string): AdminDirectory.Schema.CalendarResources; - // Retrieves a list of calendar resources for an account. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.CalendarResources; - // Updates a calendar resource. - // This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics. - patch( - resource: Schema.CalendarResource, - customer: string, - calendarResourceId: string, - ): AdminDirectory.Schema.CalendarResource; - // Deletes a calendar resource. - remove(customer: string, calendarResourceId: string): void; - // Updates a calendar resource. - // This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. - update( - resource: Schema.CalendarResource, - customer: string, - calendarResourceId: string, - ): AdminDirectory.Schema.CalendarResource; - } - interface FeaturesCollection { - // Retrieves a feature. - get(customer: string, featureKey: string): AdminDirectory.Schema.Feature; - // Inserts a feature. - insert(resource: Schema.Feature, customer: string): AdminDirectory.Schema.Feature; - // Retrieves a list of features for an account. - list(customer: string): AdminDirectory.Schema.Features; - // Retrieves a list of features for an account. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.Features; - // Updates a feature. This method supports patch semantics. - patch( - resource: Schema.Feature, - customer: string, - featureKey: string, - ): AdminDirectory.Schema.Feature; - // Deletes a feature. - remove(customer: string, featureKey: string): void; - // Renames a feature. - rename(resource: Schema.FeatureRename, customer: string, oldName: string): void; - // Updates a feature. - update( - resource: Schema.Feature, - customer: string, - featureKey: string, - ): AdminDirectory.Schema.Feature; - } - } - namespace Users { - interface AliasesCollection { - // Add a alias for the user - insert(resource: Schema.Alias, userKey: string): AdminDirectory.Schema.Alias; - // List all aliases for a user - list(userKey: string): AdminDirectory.Schema.Aliases; - // List all aliases for a user - list(userKey: string, optionalArgs: object): AdminDirectory.Schema.Aliases; - // Remove a alias for the user - remove(userKey: string, alias: string): void; - // Watch for changes in user aliases list - watch(resource: Schema.Channel, userKey: string): AdminDirectory.Schema.Channel; - // Watch for changes in user aliases list - watch( - resource: Schema.Channel, - userKey: string, - optionalArgs: object, - ): AdminDirectory.Schema.Channel; - } - interface PhotosCollection { - // Retrieve photo of a user - get(userKey: string): AdminDirectory.Schema.UserPhoto; - // Add a photo for the user. This method supports patch semantics. - patch(resource: Schema.UserPhoto, userKey: string): AdminDirectory.Schema.UserPhoto; - // Remove photos for the user - remove(userKey: string): void; - // Add a photo for the user - update(resource: Schema.UserPhoto, userKey: string): AdminDirectory.Schema.UserPhoto; - } - } - interface AspsCollection { - // Get information about an ASP issued by a user. - get(userKey: string, codeId: number): AdminDirectory.Schema.Asp; - // List the ASPs issued by a user. - list(userKey: string): AdminDirectory.Schema.Asps; - // Delete an ASP issued by a user. - remove(userKey: string, codeId: number): void; - } - interface ChannelsCollection { - // Stop watching resources through this channel - stop(resource: Schema.Channel): void; - } - interface ChromeosdevicesCollection { - // Take action on Chrome OS Device - action(resource: Schema.ChromeOsDeviceAction, customerId: string, resourceId: string): void; - // Retrieve Chrome OS Device - get(customerId: string, deviceId: string): AdminDirectory.Schema.ChromeOsDevice; - // Retrieve Chrome OS Device - get(customerId: string, deviceId: string, optionalArgs: object): AdminDirectory.Schema.ChromeOsDevice; - // Retrieve all Chrome OS Devices of a customer (paginated) - list(customerId: string): AdminDirectory.Schema.ChromeOsDevices; - // Retrieve all Chrome OS Devices of a customer (paginated) - list(customerId: string, optionalArgs: object): AdminDirectory.Schema.ChromeOsDevices; - // Move or insert multiple Chrome OS Devices to organizational unit - moveDevicesToOu( - resource: Schema.ChromeOsMoveDevicesToOu, - customerId: string, - orgUnitPath: string, - ): void; - // Update Chrome OS Device. This method supports patch semantics. - patch( - resource: Schema.ChromeOsDevice, - customerId: string, - deviceId: string, - ): AdminDirectory.Schema.ChromeOsDevice; - // Update Chrome OS Device. This method supports patch semantics. - patch( - resource: Schema.ChromeOsDevice, - customerId: string, - deviceId: string, - optionalArgs: object, - ): AdminDirectory.Schema.ChromeOsDevice; - // Update Chrome OS Device - update( - resource: Schema.ChromeOsDevice, - customerId: string, - deviceId: string, - ): AdminDirectory.Schema.ChromeOsDevice; - // Update Chrome OS Device - update( - resource: Schema.ChromeOsDevice, - customerId: string, - deviceId: string, - optionalArgs: object, - ): AdminDirectory.Schema.ChromeOsDevice; - } - interface CustomersCollection { - // Retrieves a customer. - get(customerKey: string): AdminDirectory.Schema.Customer; - // Updates a customer. This method supports patch semantics. - patch(resource: Schema.Customer, customerKey: string): AdminDirectory.Schema.Customer; - // Updates a customer. - update(resource: Schema.Customer, customerKey: string): AdminDirectory.Schema.Customer; - } - interface DomainAliasesCollection { - // Retrieves a domain alias of the customer. - get(customer: string, domainAliasName: string): AdminDirectory.Schema.DomainAlias; - // Inserts a Domain alias of the customer. - insert(resource: Schema.DomainAlias, customer: string): AdminDirectory.Schema.DomainAlias; - // Lists the domain aliases of the customer. - list(customer: string): AdminDirectory.Schema.DomainAliases; - // Lists the domain aliases of the customer. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.DomainAliases; - // Deletes a Domain Alias of the customer. - remove(customer: string, domainAliasName: string): void; - } - interface DomainsCollection { - // Retrieves a domain of the customer. - get(customer: string, domainName: string): AdminDirectory.Schema.Domains; - // Inserts a domain of the customer. - insert(resource: Schema.Domains, customer: string): AdminDirectory.Schema.Domains; - // Lists the domains of the customer. - list(customer: string): AdminDirectory.Schema.Domains2; - // Deletes a domain of the customer. - remove(customer: string, domainName: string): void; - } - interface GroupsCollection { - Aliases?: AdminDirectory.Collection.Groups.AliasesCollection | undefined; - // Retrieve Group - get(groupKey: string): AdminDirectory.Schema.Group; - // Create Group - insert(resource: Schema.Group): AdminDirectory.Schema.Group; - // Retrieve all groups of a domain or of a user given a userKey (paginated) - list(): AdminDirectory.Schema.Groups; - // Retrieve all groups of a domain or of a user given a userKey (paginated) - list(optionalArgs: object): AdminDirectory.Schema.Groups; - // Update Group. This method supports patch semantics. - patch(resource: Schema.Group, groupKey: string): AdminDirectory.Schema.Group; - // Delete Group - remove(groupKey: string): void; - // Update Group - update(resource: Schema.Group, groupKey: string): AdminDirectory.Schema.Group; - } - interface MembersCollection { - // Retrieve Group Member - get(groupKey: string, memberKey: string): AdminDirectory.Schema.Member; - // Checks whether the given user is a member of the group. Membership can be direct or nested. - hasMember(groupKey: string, memberKey: string): AdminDirectory.Schema.MembersHasMember; - // Add user to the specified group. - insert(resource: Schema.Member, groupKey: string): AdminDirectory.Schema.Member; - // Retrieve all members in a group (paginated) - list(groupKey: string): AdminDirectory.Schema.Members; - // Retrieve all members in a group (paginated) - list(groupKey: string, optionalArgs: object): AdminDirectory.Schema.Members; - // Update membership of a user in the specified group. This method supports patch semantics. - patch(resource: Schema.Member, groupKey: string, memberKey: string): AdminDirectory.Schema.Member; - // Remove membership. - remove(groupKey: string, memberKey: string): void; - // Update membership of a user in the specified group. - update(resource: Schema.Member, groupKey: string, memberKey: string): AdminDirectory.Schema.Member; - } - interface MobiledevicesCollection { - // Take action on Mobile Device - action(resource: Schema.MobileDeviceAction, customerId: string, resourceId: string): void; - // Retrieve Mobile Device - get(customerId: string, resourceId: string): AdminDirectory.Schema.MobileDevice; - // Retrieve Mobile Device - get(customerId: string, resourceId: string, optionalArgs: object): AdminDirectory.Schema.MobileDevice; - // Retrieve all Mobile Devices of a customer (paginated) - list(customerId: string): AdminDirectory.Schema.MobileDevices; - // Retrieve all Mobile Devices of a customer (paginated) - list(customerId: string, optionalArgs: object): AdminDirectory.Schema.MobileDevices; - // Delete Mobile Device - remove(customerId: string, resourceId: string): void; - } - interface NotificationsCollection { - // Retrieves a notification. - get(customer: string, notificationId: string): AdminDirectory.Schema.Notification; - // Retrieves a list of notifications. - list(customer: string): AdminDirectory.Schema.Notifications; - // Retrieves a list of notifications. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.Notifications; - // Updates a notification. This method supports patch semantics. - patch( - resource: Schema.Notification, - customer: string, - notificationId: string, - ): AdminDirectory.Schema.Notification; - // Deletes a notification - remove(customer: string, notificationId: string): void; - // Updates a notification. - update( - resource: Schema.Notification, - customer: string, - notificationId: string, - ): AdminDirectory.Schema.Notification; - } - interface OrgunitsCollection { - // Retrieve organizational unit - get(customerId: string, orgUnitPath: string[]): AdminDirectory.Schema.OrgUnit; - // Add organizational unit - insert(resource: Schema.OrgUnit, customerId: string): AdminDirectory.Schema.OrgUnit; - // Retrieve all organizational units - list(customerId: string): AdminDirectory.Schema.OrgUnits; - // Retrieve all organizational units - list(customerId: string, optionalArgs: object): AdminDirectory.Schema.OrgUnits; - // Update organizational unit. This method supports patch semantics. - patch( - resource: Schema.OrgUnit, - customerId: string, - orgUnitPath: string[], - ): AdminDirectory.Schema.OrgUnit; - // Remove organizational unit - remove(customerId: string, orgUnitPath: string[]): void; - // Update organizational unit - update( - resource: Schema.OrgUnit, - customerId: string, - orgUnitPath: string[], - ): AdminDirectory.Schema.OrgUnit; - } - interface PrivilegesCollection { - // Retrieves a paginated list of all privileges for a customer. - list(customer: string): AdminDirectory.Schema.Privileges; - } - interface ResolvedAppAccessSettingsCollection { - // Retrieves resolved app access settings of the logged in user. - GetSettings(): AdminDirectory.Schema.AppAccessCollections; - // Retrieves the list of apps trusted by the admin of the logged in user. - ListTrustedApps(): AdminDirectory.Schema.TrustedApps; - } - interface ResourcesCollection { - Buildings?: AdminDirectory.Collection.Resources.BuildingsCollection | undefined; - Calendars?: AdminDirectory.Collection.Resources.CalendarsCollection | undefined; - Features?: AdminDirectory.Collection.Resources.FeaturesCollection | undefined; - } - interface RoleAssignmentsCollection { - // Retrieve a role assignment. - get(customer: string, roleAssignmentId: string): AdminDirectory.Schema.RoleAssignment; - // Creates a role assignment. - insert(resource: Schema.RoleAssignment, customer: string): AdminDirectory.Schema.RoleAssignment; - // Retrieves a paginated list of all roleAssignments. - list(customer: string): AdminDirectory.Schema.RoleAssignments; - // Retrieves a paginated list of all roleAssignments. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.RoleAssignments; - // Deletes a role assignment. - remove(customer: string, roleAssignmentId: string): void; - } - interface RolesCollection { - // Retrieves a role. - get(customer: string, roleId: string): AdminDirectory.Schema.Role; - // Creates a role. - insert(resource: Schema.Role, customer: string): AdminDirectory.Schema.Role; - // Retrieves a paginated list of all the roles in a domain. - list(customer: string): AdminDirectory.Schema.Roles; - // Retrieves a paginated list of all the roles in a domain. - list(customer: string, optionalArgs: object): AdminDirectory.Schema.Roles; - // Updates a role. This method supports patch semantics. - patch(resource: Schema.Role, customer: string, roleId: string): AdminDirectory.Schema.Role; - // Deletes a role. - remove(customer: string, roleId: string): void; - // Updates a role. - update(resource: Schema.Role, customer: string, roleId: string): AdminDirectory.Schema.Role; - } - interface SchemasCollection { - // Retrieve schema - get(customerId: string, schemaKey: string): AdminDirectory.Schema.Schema; - // Create schema. - insert(resource: Schema.Schema, customerId: string): AdminDirectory.Schema.Schema; - // Retrieve all schemas for a customer - list(customerId: string): AdminDirectory.Schema.Schemas; - // Update schema. This method supports patch semantics. - patch(resource: Schema.Schema, customerId: string, schemaKey: string): AdminDirectory.Schema.Schema; - // Delete schema - remove(customerId: string, schemaKey: string): void; - // Update schema - update(resource: Schema.Schema, customerId: string, schemaKey: string): AdminDirectory.Schema.Schema; - } - interface TokensCollection { - // Get information about an access token issued by a user. - get(userKey: string, clientId: string): AdminDirectory.Schema.Token; - // Returns the set of tokens specified user has issued to 3rd party applications. - list(userKey: string): AdminDirectory.Schema.Tokens; - // Delete all access tokens issued by a user for an application. - remove(userKey: string, clientId: string): void; - } - interface UsersCollection { - Aliases?: AdminDirectory.Collection.Users.AliasesCollection | undefined; - Photos?: AdminDirectory.Collection.Users.PhotosCollection | undefined; - // retrieve user - get(userKey: string): AdminDirectory.Schema.User; - // retrieve user - get(userKey: string, optionalArgs: object): AdminDirectory.Schema.User; - // create user. - insert(resource: Schema.User): AdminDirectory.Schema.User; - // Retrieve either deleted users or all users in a domain (paginated) - list(): AdminDirectory.Schema.Users; - // Retrieve either deleted users or all users in a domain (paginated) - list(optionalArgs: object): AdminDirectory.Schema.Users; - // change admin status of a user - makeAdmin(resource: Schema.UserMakeAdmin, userKey: string): void; - // update user. This method supports patch semantics. - patch(resource: Schema.User, userKey: string): AdminDirectory.Schema.User; - // Delete user - remove(userKey: string): void; - // Undelete a deleted user - undelete(resource: Schema.UserUndelete, userKey: string): void; - // update user - update(resource: Schema.User, userKey: string): AdminDirectory.Schema.User; - // Watch for changes in users list - watch(resource: Schema.Channel): AdminDirectory.Schema.Channel; - // Watch for changes in users list - watch(resource: Schema.Channel, optionalArgs: object): AdminDirectory.Schema.Channel; - } - interface VerificationCodesCollection { - // Generate new backup verification codes for the user. - generate(userKey: string): void; - // Invalidate the current backup verification codes for the user. - invalidate(userKey: string): void; - // Returns the current set of valid backup verification codes for the specified user. - list(userKey: string): AdminDirectory.Schema.VerificationCodes; - } - } - namespace Schema { - interface Alias { - alias?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - primaryEmail?: string | undefined; - } - interface Aliases { - aliases?: any[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - } - interface AppAccessCollections { - blockedApiAccessBuckets?: string[] | undefined; - enforceSettingsForAndroidDrive?: boolean | undefined; - errorMessage?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - resourceId?: string | undefined; - resourceName?: string | undefined; - trustDomainOwnedApps?: boolean | undefined; - } - interface Asp { - codeId?: number | undefined; - creationTime?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - lastTimeUsed?: string | undefined; - name?: string | undefined; - userKey?: string | undefined; - } - interface Asps { - etag?: string | undefined; - items?: AdminDirectory.Schema.Asp[] | undefined; - kind?: string | undefined; - } - interface Building { - address?: AdminDirectory.Schema.BuildingAddress | undefined; - buildingId?: string | undefined; - buildingName?: string | undefined; - coordinates?: AdminDirectory.Schema.BuildingCoordinates | undefined; - description?: string | undefined; - etags?: string | undefined; - floorNames?: string[] | undefined; - kind?: string | undefined; - } - interface BuildingAddress { - addressLines?: string[] | undefined; - administrativeArea?: string | undefined; - languageCode?: string | undefined; - locality?: string | undefined; - postalCode?: string | undefined; - regionCode?: string | undefined; - sublocality?: string | undefined; - } - interface BuildingCoordinates { - latitude?: number | undefined; - longitude?: number | undefined; - } - interface Buildings { - buildings?: AdminDirectory.Schema.Building[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface CalendarResource { - buildingId?: string | undefined; - capacity?: number | undefined; - etags?: string | undefined; - featureInstances?: object | undefined; - floorName?: string | undefined; - floorSection?: string | undefined; - generatedResourceName?: string | undefined; - kind?: string | undefined; - resourceCategory?: string | undefined; - resourceDescription?: string | undefined; - resourceEmail?: string | undefined; - resourceId?: string | undefined; - resourceName?: string | undefined; - resourceType?: string | undefined; - userVisibleDescription?: string | undefined; - } - interface CalendarResources { - etag?: string | undefined; - items?: AdminDirectory.Schema.CalendarResource[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Channel { - address?: string | undefined; - expiration?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - params?: object | undefined; - payload?: boolean | undefined; - resourceId?: string | undefined; - resourceUri?: string | undefined; - token?: string | undefined; - type?: string | undefined; - } - interface ChromeOsDevice { - activeTimeRanges?: AdminDirectory.Schema.ChromeOsDeviceActiveTimeRanges[] | undefined; - annotatedAssetId?: string | undefined; - annotatedLocation?: string | undefined; - annotatedUser?: string | undefined; - autoUpdateExpiration?: string | undefined; - bootMode?: string | undefined; - cpuStatusReports?: AdminDirectory.Schema.ChromeOsDeviceCpuStatusReports[] | undefined; - deviceFiles?: AdminDirectory.Schema.ChromeOsDeviceDeviceFiles[] | undefined; - deviceId?: string | undefined; - diskVolumeReports?: AdminDirectory.Schema.ChromeOsDeviceDiskVolumeReports[] | undefined; - etag?: string | undefined; - ethernetMacAddress?: string | undefined; - firmwareVersion?: string | undefined; - kind?: string | undefined; - lastEnrollmentTime?: string | undefined; - lastSync?: string | undefined; - macAddress?: string | undefined; - meid?: string | undefined; - model?: string | undefined; - notes?: string | undefined; - orderNumber?: string | undefined; - orgUnitPath?: string | undefined; - osVersion?: string | undefined; - platformVersion?: string | undefined; - recentUsers?: AdminDirectory.Schema.ChromeOsDeviceRecentUsers[] | undefined; - serialNumber?: string | undefined; - status?: string | undefined; - supportEndDate?: string | undefined; - systemRamFreeReports?: AdminDirectory.Schema.ChromeOsDeviceSystemRamFreeReports[] | undefined; - systemRamTotal?: string | undefined; - tpmVersionInfo?: AdminDirectory.Schema.ChromeOsDeviceTpmVersionInfo | undefined; - willAutoRenew?: boolean | undefined; - } - interface ChromeOsDeviceAction { - action?: string | undefined; - deprovisionReason?: string | undefined; - } - interface ChromeOsDeviceActiveTimeRanges { - activeTime?: number | undefined; - date?: string | undefined; - } - interface ChromeOsDeviceCpuStatusReports { - cpuTemperatureInfo?: - | AdminDirectory.Schema.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo[] - | undefined; - cpuUtilizationPercentageInfo?: number[] | undefined; - reportTime?: string | undefined; - } - interface ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo { - label?: string | undefined; - temperature?: number | undefined; - } - interface ChromeOsDeviceDeviceFiles { - createTime?: string | undefined; - downloadUrl?: string | undefined; - name?: string | undefined; - type?: string | undefined; - } - interface ChromeOsDeviceDiskVolumeReports { - volumeInfo?: AdminDirectory.Schema.ChromeOsDeviceDiskVolumeReportsVolumeInfo[] | undefined; - } - interface ChromeOsDeviceDiskVolumeReportsVolumeInfo { - storageFree?: string | undefined; - storageTotal?: string | undefined; - volumeId?: string | undefined; - } - interface ChromeOsDeviceRecentUsers { - email?: string | undefined; - type?: string | undefined; - } - interface ChromeOsDeviceSystemRamFreeReports { - reportTime?: string | undefined; - systemRamFreeInfo?: string[] | undefined; - } - interface ChromeOsDeviceTpmVersionInfo { - family?: string | undefined; - firmwareVersion?: string | undefined; - manufacturer?: string | undefined; - specLevel?: string | undefined; - tpmModel?: string | undefined; - vendorSpecific?: string | undefined; - } - interface ChromeOsDevices { - chromeosdevices?: AdminDirectory.Schema.ChromeOsDevice[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface ChromeOsMoveDevicesToOu { - deviceIds?: string[] | undefined; - } - interface Customer { - alternateEmail?: string | undefined; - customerCreationTime?: string | undefined; - customerDomain?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - language?: string | undefined; - phoneNumber?: string | undefined; - postalAddress?: AdminDirectory.Schema.CustomerPostalAddress | undefined; - } - interface CustomerPostalAddress { - addressLine1?: string | undefined; - addressLine2?: string | undefined; - addressLine3?: string | undefined; - contactName?: string | undefined; - countryCode?: string | undefined; - locality?: string | undefined; - organizationName?: string | undefined; - postalCode?: string | undefined; - region?: string | undefined; - } - interface DomainAlias { - creationTime?: string | undefined; - domainAliasName?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - parentDomainName?: string | undefined; - verified?: boolean | undefined; - } - interface DomainAliases { - domainAliases?: AdminDirectory.Schema.DomainAlias[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - } - interface Domains { - creationTime?: string | undefined; - domainAliases?: AdminDirectory.Schema.DomainAlias[] | undefined; - domainName?: string | undefined; - etag?: string | undefined; - isPrimary?: boolean | undefined; - kind?: string | undefined; - verified?: boolean | undefined; - } - interface Domains2 { - domains?: AdminDirectory.Schema.Domains[] | undefined; - etag?: string | undefined; - kind?: string | undefined; - } - interface Feature { - etags?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface FeatureInstance { - feature?: AdminDirectory.Schema.Feature | undefined; - } - interface FeatureRename { - newName?: string | undefined; - } - interface Features { - etag?: string | undefined; - features?: AdminDirectory.Schema.Feature[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Group { - adminCreated?: boolean | undefined; - aliases?: string[] | undefined; - description?: string | undefined; - directMembersCount?: string | undefined; - email?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - nonEditableAliases?: string[] | undefined; - } - interface Groups { - etag?: string | undefined; - groups?: AdminDirectory.Schema.Group[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Member { - delivery_settings?: string | undefined; - email?: string | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - role?: string | undefined; - status?: string | undefined; - type?: string | undefined; - } - interface Members { - etag?: string | undefined; - kind?: string | undefined; - members?: AdminDirectory.Schema.Member[] | undefined; - nextPageToken?: string | undefined; - } - interface MembersHasMember { - isMember?: boolean | undefined; - } - interface MobileDevice { - adbStatus?: boolean | undefined; - applications?: AdminDirectory.Schema.MobileDeviceApplications[] | undefined; - basebandVersion?: string | undefined; - bootloaderVersion?: string | undefined; - brand?: string | undefined; - buildNumber?: string | undefined; - defaultLanguage?: string | undefined; - developerOptionsStatus?: boolean | undefined; - deviceCompromisedStatus?: string | undefined; - deviceId?: string | undefined; - devicePasswordStatus?: string | undefined; - email?: string[] | undefined; - encryptionStatus?: string | undefined; - etag?: string | undefined; - firstSync?: string | undefined; - hardware?: string | undefined; - hardwareId?: string | undefined; - imei?: string | undefined; - kernelVersion?: string | undefined; - kind?: string | undefined; - lastSync?: string | undefined; - managedAccountIsOnOwnerProfile?: boolean | undefined; - manufacturer?: string | undefined; - meid?: string | undefined; - model?: string | undefined; - name?: string[] | undefined; - networkOperator?: string | undefined; - os?: string | undefined; - otherAccountsInfo?: string[] | undefined; - privilege?: string | undefined; - releaseVersion?: string | undefined; - resourceId?: string | undefined; - securityPatchLevel?: string | undefined; - serialNumber?: string | undefined; - status?: string | undefined; - supportsWorkProfile?: boolean | undefined; - type?: string | undefined; - unknownSourcesStatus?: boolean | undefined; - userAgent?: string | undefined; - wifiMacAddress?: string | undefined; - } - interface MobileDeviceAction { - action?: string | undefined; - } - interface MobileDeviceApplications { - displayName?: string | undefined; - packageName?: string | undefined; - permission?: string[] | undefined; - versionCode?: number | undefined; - versionName?: string | undefined; - } - interface MobileDevices { - etag?: string | undefined; - kind?: string | undefined; - mobiledevices?: AdminDirectory.Schema.MobileDevice[] | undefined; - nextPageToken?: string | undefined; - } - interface Notification { - body?: string | undefined; - etag?: string | undefined; - fromAddress?: string | undefined; - isUnread?: boolean | undefined; - kind?: string | undefined; - notificationId?: string | undefined; - sendTime?: string | undefined; - subject?: string | undefined; - } - interface Notifications { - etag?: string | undefined; - items?: AdminDirectory.Schema.Notification[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - unreadNotificationsCount?: number | undefined; - } - interface OrgUnit { - blockInheritance?: boolean | undefined; - description?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - orgUnitId?: string | undefined; - orgUnitPath?: string | undefined; - parentOrgUnitId?: string | undefined; - parentOrgUnitPath?: string | undefined; - } - interface OrgUnits { - etag?: string | undefined; - kind?: string | undefined; - organizationUnits?: AdminDirectory.Schema.OrgUnit[] | undefined; - } - interface Privilege { - childPrivileges?: AdminDirectory.Schema.Privilege[] | undefined; - etag?: string | undefined; - isOuScopable?: boolean | undefined; - kind?: string | undefined; - privilegeName?: string | undefined; - serviceId?: string | undefined; - serviceName?: string | undefined; - } - interface Privileges { - etag?: string | undefined; - items?: AdminDirectory.Schema.Privilege[] | undefined; - kind?: string | undefined; - } - interface Role { - etag?: string | undefined; - isSuperAdminRole?: boolean | undefined; - isSystemRole?: boolean | undefined; - kind?: string | undefined; - roleDescription?: string | undefined; - roleId?: string | undefined; - roleName?: string | undefined; - rolePrivileges?: AdminDirectory.Schema.RoleRolePrivileges[] | undefined; - } - interface RoleAssignment { - assignedTo?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - orgUnitId?: string | undefined; - roleAssignmentId?: string | undefined; - roleId?: string | undefined; - scopeType?: string | undefined; - } - interface RoleAssignments { - etag?: string | undefined; - items?: AdminDirectory.Schema.RoleAssignment[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface RoleRolePrivileges { - privilegeName?: string | undefined; - serviceId?: string | undefined; - } - interface Roles { - etag?: string | undefined; - items?: AdminDirectory.Schema.Role[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Schema { - displayName?: string | undefined; - etag?: string | undefined; - fields?: AdminDirectory.Schema.SchemaFieldSpec[] | undefined; - kind?: string | undefined; - schemaId?: string | undefined; - schemaName?: string | undefined; - } - interface SchemaFieldSpec { - displayName?: string | undefined; - etag?: string | undefined; - fieldId?: string | undefined; - fieldName?: string | undefined; - fieldType?: string | undefined; - indexed?: boolean | undefined; - kind?: string | undefined; - multiValued?: boolean | undefined; - numericIndexingSpec?: AdminDirectory.Schema.SchemaFieldSpecNumericIndexingSpec | undefined; - readAccessType?: string | undefined; - } - interface SchemaFieldSpecNumericIndexingSpec { - maxValue?: number | undefined; - minValue?: number | undefined; - } - interface Schemas { - etag?: string | undefined; - kind?: string | undefined; - schemas?: AdminDirectory.Schema.Schema[] | undefined; - } - interface Token { - anonymous?: boolean | undefined; - clientId?: string | undefined; - displayText?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - nativeApp?: boolean | undefined; - scopes?: string[] | undefined; - userKey?: string | undefined; - } - interface Tokens { - etag?: string | undefined; - items?: AdminDirectory.Schema.Token[] | undefined; - kind?: string | undefined; - } - interface TrustedAppId { - androidPackageName?: string | undefined; - certificateHashSHA1?: string | undefined; - certificateHashSHA256?: string | undefined; - etag?: string | undefined; - kind?: string | undefined; - } - interface TrustedApps { - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - trustedApps?: AdminDirectory.Schema.TrustedAppId[] | undefined; - } - interface User { - addresses?: object[] | undefined; - agreedToTerms?: boolean | undefined; - aliases?: string[] | undefined; - archived?: boolean | undefined; - changePasswordAtNextLogin?: boolean | undefined; - creationTime?: string | undefined; - customSchemas?: object | undefined; - customerId?: string | undefined; - deletionTime?: string | undefined; - emails?: object[] | undefined; - etag?: string | undefined; - externalIds?: object[] | undefined; - gender?: object | undefined; - hashFunction?: string | undefined; - id?: string | undefined; - ims?: object[] | undefined; - includeInGlobalAddressList?: boolean | undefined; - ipWhitelisted?: boolean | undefined; - isAdmin?: boolean | undefined; - isDelegatedAdmin?: boolean | undefined; - isEnforcedIn2Sv?: boolean | undefined; - isEnrolledIn2Sv?: boolean | undefined; - isMailboxSetup?: boolean | undefined; - keywords?: object[] | undefined; - kind?: string | undefined; - languages?: object[] | undefined; - lastLoginTime?: string | undefined; - locations?: object[] | undefined; - name?: AdminDirectory.Schema.UserName | undefined; - nonEditableAliases?: string[] | undefined; - notes?: object[] | undefined; - orgUnitPath?: string | undefined; - organizations?: UserOrganization[] | undefined; - password?: string | undefined; - phones?: object[] | undefined; - posixAccounts?: object[] | undefined; - primaryEmail?: string | undefined; - relations?: object[] | undefined; - sshPublicKeys?: object[] | undefined; - suspended?: boolean | undefined; - suspensionReason?: string | undefined; - thumbnailPhotoEtag?: string | undefined; - thumbnailPhotoUrl?: string | undefined; - websites?: object[] | undefined; - } - interface UserAbout { - contentType?: string | undefined; - value?: string | undefined; - } - interface UserAddress { - country?: string | undefined; - countryCode?: string | undefined; - customType?: string | undefined; - extendedAddress?: string | undefined; - formatted?: string | undefined; - locality?: string | undefined; - poBox?: string | undefined; - postalCode?: string | undefined; - primary?: boolean | undefined; - region?: string | undefined; - sourceIsStructured?: boolean | undefined; - streetAddress?: string | undefined; - type?: string | undefined; - } - interface UserEmail { - address?: string | undefined; - customType?: string | undefined; - primary?: boolean | undefined; - type?: string | undefined; - } - interface UserExternalId { - customType?: string | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface UserGender { - addressMeAs?: string | undefined; - customGender?: string | undefined; - type?: string | undefined; - } - interface UserIm { - customProtocol?: string | undefined; - customType?: string | undefined; - im?: string | undefined; - primary?: boolean | undefined; - protocol?: string | undefined; - type?: string | undefined; - } - interface UserKeyword { - customType?: string | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface UserLanguage { - customLanguage?: string | undefined; - languageCode?: string | undefined; - } - interface UserLocation { - area?: string | undefined; - buildingId?: string | undefined; - customType?: string | undefined; - deskCode?: string | undefined; - floorName?: string | undefined; - floorSection?: string | undefined; - type?: string | undefined; - } - interface UserMakeAdmin { - status?: boolean | undefined; - } - interface UserName { - familyName?: string | undefined; - fullName?: string | undefined; - givenName?: string | undefined; - } - interface UserOrganization { - costCenter?: string | undefined; - customType?: string | undefined; - department?: string | undefined; - description?: string | undefined; - domain?: string | undefined; - fullTimeEquivalent?: number | undefined; - location?: string | undefined; - name?: string | undefined; - primary?: boolean | undefined; - symbol?: string | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface UserPhone { - customType?: string | undefined; - primary?: boolean | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface UserPhoto { - etag?: string | undefined; - height?: number | undefined; - id?: string | undefined; - kind?: string | undefined; - mimeType?: string | undefined; - photoData?: string | undefined; - primaryEmail?: string | undefined; - width?: number | undefined; - } - interface UserPosixAccount { - accountId?: string | undefined; - gecos?: string | undefined; - gid?: string | undefined; - homeDirectory?: string | undefined; - operatingSystemType?: string | undefined; - primary?: boolean | undefined; - shell?: string | undefined; - systemId?: string | undefined; - uid?: string | undefined; - username?: string | undefined; - } - interface UserRelation { - customType?: string | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface UserSshPublicKey { - expirationTimeUsec?: string | undefined; - fingerprint?: string | undefined; - key?: string | undefined; - } - interface UserUndelete { - orgUnitPath?: string | undefined; - } - interface UserWebsite { - customType?: string | undefined; - primary?: boolean | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface Users { - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - trigger_event?: string | undefined; - users?: AdminDirectory.Schema.User[] | undefined; - } - interface VerificationCode { - etag?: string | undefined; - kind?: string | undefined; - userId?: string | undefined; - verificationCode?: string | undefined; - } - interface VerificationCodes { - etag?: string | undefined; - items?: AdminDirectory.Schema.VerificationCode[] | undefined; - kind?: string | undefined; - } - } - } - interface AdminDirectory { - Asps?: AdminDirectory.Collection.AspsCollection | undefined; - Channels?: AdminDirectory.Collection.ChannelsCollection | undefined; - Chromeosdevices?: AdminDirectory.Collection.ChromeosdevicesCollection | undefined; - Customers?: AdminDirectory.Collection.CustomersCollection | undefined; - DomainAliases?: AdminDirectory.Collection.DomainAliasesCollection | undefined; - Domains?: AdminDirectory.Collection.DomainsCollection | undefined; - Groups?: AdminDirectory.Collection.GroupsCollection | undefined; - Members?: AdminDirectory.Collection.MembersCollection | undefined; - Mobiledevices?: AdminDirectory.Collection.MobiledevicesCollection | undefined; - Notifications?: AdminDirectory.Collection.NotificationsCollection | undefined; - Orgunits?: AdminDirectory.Collection.OrgunitsCollection | undefined; - Privileges?: AdminDirectory.Collection.PrivilegesCollection | undefined; - ResolvedAppAccessSettings?: AdminDirectory.Collection.ResolvedAppAccessSettingsCollection | undefined; - Resources?: AdminDirectory.Collection.ResourcesCollection | undefined; - RoleAssignments?: AdminDirectory.Collection.RoleAssignmentsCollection | undefined; - Roles?: AdminDirectory.Collection.RolesCollection | undefined; - Schemas?: AdminDirectory.Collection.SchemasCollection | undefined; - Tokens?: AdminDirectory.Collection.TokensCollection | undefined; - Users?: AdminDirectory.Collection.UsersCollection | undefined; - VerificationCodes?: AdminDirectory.Collection.VerificationCodesCollection | undefined; - // Create a new instance of Alias - newAlias(): AdminDirectory.Schema.Alias; - // Create a new instance of Building - newBuilding(): AdminDirectory.Schema.Building; - // Create a new instance of BuildingAddress - newBuildingAddress(): AdminDirectory.Schema.BuildingAddress; - // Create a new instance of BuildingCoordinates - newBuildingCoordinates(): AdminDirectory.Schema.BuildingCoordinates; - // Create a new instance of CalendarResource - newCalendarResource(): AdminDirectory.Schema.CalendarResource; - // Create a new instance of Channel - newChannel(): AdminDirectory.Schema.Channel; - // Create a new instance of ChromeOsDevice - newChromeOsDevice(): AdminDirectory.Schema.ChromeOsDevice; - // Create a new instance of ChromeOsDeviceAction - newChromeOsDeviceAction(): AdminDirectory.Schema.ChromeOsDeviceAction; - // Create a new instance of ChromeOsDeviceActiveTimeRanges - newChromeOsDeviceActiveTimeRanges(): AdminDirectory.Schema.ChromeOsDeviceActiveTimeRanges; - // Create a new instance of ChromeOsDeviceCpuStatusReports - newChromeOsDeviceCpuStatusReports(): AdminDirectory.Schema.ChromeOsDeviceCpuStatusReports; - // Create a new instance of ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo - newChromeOsDeviceCpuStatusReportsCpuTemperatureInfo(): AdminDirectory.Schema.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo; - // Create a new instance of ChromeOsDeviceDeviceFiles - newChromeOsDeviceDeviceFiles(): AdminDirectory.Schema.ChromeOsDeviceDeviceFiles; - // Create a new instance of ChromeOsDeviceDiskVolumeReports - newChromeOsDeviceDiskVolumeReports(): AdminDirectory.Schema.ChromeOsDeviceDiskVolumeReports; - // Create a new instance of ChromeOsDeviceDiskVolumeReportsVolumeInfo - newChromeOsDeviceDiskVolumeReportsVolumeInfo(): AdminDirectory.Schema.ChromeOsDeviceDiskVolumeReportsVolumeInfo; - // Create a new instance of ChromeOsDeviceRecentUsers - newChromeOsDeviceRecentUsers(): AdminDirectory.Schema.ChromeOsDeviceRecentUsers; - // Create a new instance of ChromeOsDeviceSystemRamFreeReports - newChromeOsDeviceSystemRamFreeReports(): AdminDirectory.Schema.ChromeOsDeviceSystemRamFreeReports; - // Create a new instance of ChromeOsDeviceTpmVersionInfo - newChromeOsDeviceTpmVersionInfo(): AdminDirectory.Schema.ChromeOsDeviceTpmVersionInfo; - // Create a new instance of ChromeOsMoveDevicesToOu - newChromeOsMoveDevicesToOu(): AdminDirectory.Schema.ChromeOsMoveDevicesToOu; - // Create a new instance of Customer - newCustomer(): AdminDirectory.Schema.Customer; - // Create a new instance of CustomerPostalAddress - newCustomerPostalAddress(): AdminDirectory.Schema.CustomerPostalAddress; - // Create a new instance of DomainAlias - newDomainAlias(): AdminDirectory.Schema.DomainAlias; - // Create a new instance of Domains - newDomains(): AdminDirectory.Schema.Domains; - // Create a new instance of Feature - newFeature(): AdminDirectory.Schema.Feature; - // Create a new instance of FeatureRename - newFeatureRename(): AdminDirectory.Schema.FeatureRename; - // Create a new instance of Group - newGroup(): AdminDirectory.Schema.Group; - // Create a new instance of Member - newMember(): AdminDirectory.Schema.Member; - // Create a new instance of MobileDeviceAction - newMobileDeviceAction(): AdminDirectory.Schema.MobileDeviceAction; - // Create a new instance of Notification - newNotification(): AdminDirectory.Schema.Notification; - // Create a new instance of OrgUnit - newOrgUnit(): AdminDirectory.Schema.OrgUnit; - // Create a new instance of Role - newRole(): AdminDirectory.Schema.Role; - // Create a new instance of RoleAssignment - newRoleAssignment(): AdminDirectory.Schema.RoleAssignment; - // Create a new instance of RoleRolePrivileges - newRoleRolePrivileges(): AdminDirectory.Schema.RoleRolePrivileges; - // Create a new instance of Schema - newSchema(): AdminDirectory.Schema.Schema; - // Create a new instance of SchemaFieldSpec - newSchemaFieldSpec(): AdminDirectory.Schema.SchemaFieldSpec; - // Create a new instance of SchemaFieldSpecNumericIndexingSpec - newSchemaFieldSpecNumericIndexingSpec(): AdminDirectory.Schema.SchemaFieldSpecNumericIndexingSpec; - // Create a new instance of User - newUser(): AdminDirectory.Schema.User; - // Create a new instance of UserMakeAdmin - newUserMakeAdmin(): AdminDirectory.Schema.UserMakeAdmin; - // Create a new instance of UserName - newUserName(): AdminDirectory.Schema.UserName; - // Create a new instance of UserPhoto - newUserPhoto(): AdminDirectory.Schema.UserPhoto; - // Create a new instance of UserUndelete - newUserUndelete(): AdminDirectory.Schema.UserUndelete; - } -} - -declare var AdminDirectory: GoogleAppsScript.AdminDirectory; diff --git a/node_modules/@types/google-apps-script/apis/docs_v1.d.ts b/node_modules/@types/google-apps-script/apis/docs_v1.d.ts deleted file mode 100644 index 6e728fe..0000000 --- a/node_modules/@types/google-apps-script/apis/docs_v1.d.ts +++ /dev/null @@ -1,909 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Docs { - namespace Collection { - interface DocumentsCollection { - // Applies one or more updates to the document. - // Each request is validated before - // being applied. If any request is not valid, then the entire request will - // fail and nothing will be applied. - // Some requests have replies to - // give you some information about how they are applied. Other requests do - // not need to return information; these each return an empty reply. - // The order of replies matches that of the requests. - // For example, suppose you call batchUpdate with four updates, and only the - // third one returns information. The response would have two empty replies, - // the reply to the third request, and another empty reply, in that order. - // Because other users may be editing the document, the document - // might not exactly reflect your changes: your changes may - // be altered with respect to collaborator changes. If there are no - // collaborators, the document should reflect your changes. In any case, - // the updates in your request are guaranteed to be applied together - // atomically. - batchUpdate( - resource: Schema.BatchUpdateDocumentRequest, - documentId: string, - ): Docs.Schema.BatchUpdateDocumentResponse; - // Creates a blank document using the title given in the request. Other fields - // in the request, including any provided content, are ignored. - // Returns the created document. - create(resource: Schema.Document): Docs.Schema.Document; - // Gets the latest version of the specified document. - get(documentId: string): Docs.Schema.Document; - // Gets the latest version of the specified document. - get(documentId: string, optionalArgs: object): Docs.Schema.Document; - } - } - namespace Schema { - interface AutoText { - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - type?: string | undefined; - } - interface Background { - color?: Docs.Schema.OptionalColor | undefined; - } - interface BackgroundSuggestionState { - backgroundColorSuggested?: boolean | undefined; - } - interface BatchUpdateDocumentRequest { - requests?: Docs.Schema.Request[] | undefined; - writeControl?: Docs.Schema.WriteControl | undefined; - } - interface BatchUpdateDocumentResponse { - documentId?: string | undefined; - replies?: Docs.Schema.Response[] | undefined; - writeControl?: Docs.Schema.WriteControl | undefined; - } - interface Body { - content?: Docs.Schema.StructuralElement[] | undefined; - } - interface Bullet { - listId?: string | undefined; - nestingLevel?: number | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface BulletSuggestionState { - listIdSuggested?: boolean | undefined; - nestingLevelSuggested?: boolean | undefined; - textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState | undefined; - } - interface Color { - rgbColor?: Docs.Schema.RgbColor | undefined; - } - interface ColumnBreak { - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface CreateNamedRangeRequest { - name?: string | undefined; - range?: Docs.Schema.Range | undefined; - } - interface CreateNamedRangeResponse { - namedRangeId?: string | undefined; - } - interface CreateParagraphBulletsRequest { - bulletPreset?: string | undefined; - range?: Docs.Schema.Range | undefined; - } - interface CropProperties { - angle?: number | undefined; - offsetBottom?: number | undefined; - offsetLeft?: number | undefined; - offsetRight?: number | undefined; - offsetTop?: number | undefined; - } - interface CropPropertiesSuggestionState { - angleSuggested?: boolean | undefined; - offsetBottomSuggested?: boolean | undefined; - offsetLeftSuggested?: boolean | undefined; - offsetRightSuggested?: boolean | undefined; - offsetTopSuggested?: boolean | undefined; - } - interface DeleteContentRangeRequest { - range?: Docs.Schema.Range | undefined; - } - interface DeleteNamedRangeRequest { - name?: string | undefined; - namedRangeId?: string | undefined; - } - interface DeleteParagraphBulletsRequest { - range?: Docs.Schema.Range | undefined; - } - interface DeletePositionedObjectRequest { - objectId?: string | undefined; - } - interface DeleteTableColumnRequest { - tableCellLocation?: Docs.Schema.TableCellLocation | undefined; - } - interface DeleteTableRowRequest { - tableCellLocation?: Docs.Schema.TableCellLocation | undefined; - } - interface Dimension { - magnitude?: number | undefined; - unit?: string | undefined; - } - interface Document { - body?: Docs.Schema.Body | undefined; - documentId?: string | undefined; - documentStyle?: Docs.Schema.DocumentStyle | undefined; - footers?: object | undefined; - footnotes?: object | undefined; - headers?: object | undefined; - inlineObjects?: object | undefined; - lists?: object | undefined; - namedRanges?: object | undefined; - namedStyles?: Docs.Schema.NamedStyles | undefined; - positionedObjects?: object | undefined; - revisionId?: string | undefined; - suggestedDocumentStyleChanges?: object | undefined; - suggestedNamedStylesChanges?: object | undefined; - suggestionsViewMode?: string | undefined; - title?: string | undefined; - } - interface DocumentStyle { - background?: Docs.Schema.Background | undefined; - defaultFooterId?: string | undefined; - defaultHeaderId?: string | undefined; - evenPageFooterId?: string | undefined; - evenPageHeaderId?: string | undefined; - firstPageFooterId?: string | undefined; - firstPageHeaderId?: string | undefined; - marginBottom?: Docs.Schema.Dimension | undefined; - marginLeft?: Docs.Schema.Dimension | undefined; - marginRight?: Docs.Schema.Dimension | undefined; - marginTop?: Docs.Schema.Dimension | undefined; - pageNumberStart?: number | undefined; - pageSize?: Docs.Schema.Size | undefined; - useEvenPageHeaderFooter?: boolean | undefined; - useFirstPageHeaderFooter?: boolean | undefined; - } - interface DocumentStyleSuggestionState { - backgroundSuggestionState?: Docs.Schema.BackgroundSuggestionState | undefined; - defaultFooterIdSuggested?: boolean | undefined; - defaultHeaderIdSuggested?: boolean | undefined; - evenPageFooterIdSuggested?: boolean | undefined; - evenPageHeaderIdSuggested?: boolean | undefined; - firstPageFooterIdSuggested?: boolean | undefined; - firstPageHeaderIdSuggested?: boolean | undefined; - marginBottomSuggested?: boolean | undefined; - marginLeftSuggested?: boolean | undefined; - marginRightSuggested?: boolean | undefined; - marginTopSuggested?: boolean | undefined; - pageNumberStartSuggested?: boolean | undefined; - pageSizeSuggestionState?: Docs.Schema.SizeSuggestionState | undefined; - useEvenPageHeaderFooterSuggested?: boolean | undefined; - useFirstPageHeaderFooterSuggested?: boolean | undefined; - } - interface EmbeddedObject { - description?: string | undefined; - embeddedDrawingProperties?: any; - embeddedObjectBorder?: Docs.Schema.EmbeddedObjectBorder | undefined; - imageProperties?: Docs.Schema.ImageProperties | undefined; - linkedContentReference?: Docs.Schema.LinkedContentReference | undefined; - marginBottom?: Docs.Schema.Dimension | undefined; - marginLeft?: Docs.Schema.Dimension | undefined; - marginRight?: Docs.Schema.Dimension | undefined; - marginTop?: Docs.Schema.Dimension | undefined; - size?: Docs.Schema.Size | undefined; - title?: string | undefined; - } - interface EmbeddedObjectBorder { - color?: Docs.Schema.OptionalColor | undefined; - dashStyle?: string | undefined; - propertyState?: string | undefined; - width?: Docs.Schema.Dimension | undefined; - } - interface EmbeddedObjectBorderSuggestionState { - colorSuggested?: boolean | undefined; - dashStyleSuggested?: boolean | undefined; - propertyStateSuggested?: boolean | undefined; - widthSuggested?: boolean | undefined; - } - interface EmbeddedObjectSuggestionState { - descriptionSuggested?: boolean | undefined; - embeddedDrawingPropertiesSuggestionState?: any; - embeddedObjectBorderSuggestionState?: Docs.Schema.EmbeddedObjectBorderSuggestionState | undefined; - imagePropertiesSuggestionState?: Docs.Schema.ImagePropertiesSuggestionState | undefined; - linkedContentReferenceSuggestionState?: Docs.Schema.LinkedContentReferenceSuggestionState | undefined; - marginBottomSuggested?: boolean | undefined; - marginLeftSuggested?: boolean | undefined; - marginRightSuggested?: boolean | undefined; - marginTopSuggested?: boolean | undefined; - sizeSuggestionState?: Docs.Schema.SizeSuggestionState | undefined; - titleSuggested?: boolean | undefined; - } - interface EndOfSegmentLocation { - segmentId?: string | undefined; - } - interface Equation { - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - } - interface Footer { - content?: Docs.Schema.StructuralElement[] | undefined; - footerId?: string | undefined; - } - interface Footnote { - content?: Docs.Schema.StructuralElement[] | undefined; - footnoteId?: string | undefined; - } - interface FootnoteReference { - footnoteId?: string | undefined; - footnoteNumber?: string | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface Header { - content?: Docs.Schema.StructuralElement[] | undefined; - headerId?: string | undefined; - } - interface HorizontalRule { - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface ImageProperties { - angle?: number | undefined; - brightness?: number | undefined; - contentUri?: string | undefined; - contrast?: number | undefined; - cropProperties?: Docs.Schema.CropProperties | undefined; - sourceUri?: string | undefined; - transparency?: number | undefined; - } - interface ImagePropertiesSuggestionState { - angleSuggested?: boolean | undefined; - brightnessSuggested?: boolean | undefined; - contentUriSuggested?: boolean | undefined; - contrastSuggested?: boolean | undefined; - cropPropertiesSuggestionState?: Docs.Schema.CropPropertiesSuggestionState | undefined; - sourceUriSuggested?: boolean | undefined; - transparencySuggested?: boolean | undefined; - } - interface InlineObject { - inlineObjectProperties?: Docs.Schema.InlineObjectProperties | undefined; - objectId?: string | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInlineObjectPropertiesChanges?: object | undefined; - suggestedInsertionId?: string | undefined; - } - interface InlineObjectElement { - inlineObjectId?: string | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface InlineObjectProperties { - embeddedObject?: Docs.Schema.EmbeddedObject | undefined; - } - interface InlineObjectPropertiesSuggestionState { - embeddedObjectSuggestionState?: Docs.Schema.EmbeddedObjectSuggestionState | undefined; - } - interface InsertInlineImageRequest { - endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation | undefined; - location?: Docs.Schema.Location | undefined; - objectSize?: Docs.Schema.Size | undefined; - uri?: string | undefined; - } - interface InsertInlineImageResponse { - objectId?: string | undefined; - } - interface InsertInlineSheetsChartResponse { - objectId?: string | undefined; - } - interface InsertPageBreakRequest { - endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation | undefined; - location?: Docs.Schema.Location | undefined; - } - interface InsertTableRequest { - columns?: number | undefined; - endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation | undefined; - location?: Docs.Schema.Location | undefined; - rows?: number | undefined; - } - interface InsertTableRowRequest { - insertBelow?: boolean | undefined; - tableCellLocation?: Docs.Schema.TableCellLocation | undefined; - } - interface InsertTextRequest { - endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation | undefined; - location?: Docs.Schema.Location | undefined; - text?: string | undefined; - } - interface Link { - bookmarkId?: string | undefined; - headingId?: string | undefined; - url?: string | undefined; - } - interface LinkedContentReference { - sheetsChartReference?: Docs.Schema.SheetsChartReference | undefined; - } - interface LinkedContentReferenceSuggestionState { - sheetsChartReferenceSuggestionState?: Docs.Schema.SheetsChartReferenceSuggestionState | undefined; - } - interface List { - listProperties?: Docs.Schema.ListProperties | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionId?: string | undefined; - suggestedListPropertiesChanges?: object | undefined; - } - interface ListProperties { - nestingLevels?: Docs.Schema.NestingLevel[] | undefined; - } - interface ListPropertiesSuggestionState { - nestingLevelsSuggestionStates?: Docs.Schema.NestingLevelSuggestionState[] | undefined; - } - interface Location { - index?: number | undefined; - segmentId?: string | undefined; - } - interface NamedRange { - name?: string | undefined; - namedRangeId?: string | undefined; - ranges?: Docs.Schema.Range[] | undefined; - } - interface NamedRanges { - name?: string | undefined; - namedRanges?: Docs.Schema.NamedRange[] | undefined; - } - interface NamedStyle { - namedStyleType?: string | undefined; - paragraphStyle?: Docs.Schema.ParagraphStyle | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface NamedStyleSuggestionState { - namedStyleType?: string | undefined; - paragraphStyleSuggestionState?: Docs.Schema.ParagraphStyleSuggestionState | undefined; - textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState | undefined; - } - interface NamedStyles { - styles?: Docs.Schema.NamedStyle[] | undefined; - } - interface NamedStylesSuggestionState { - stylesSuggestionStates?: Docs.Schema.NamedStyleSuggestionState[] | undefined; - } - interface NestingLevel { - bulletAlignment?: string | undefined; - glyphFormat?: string | undefined; - glyphSymbol?: string | undefined; - glyphType?: string | undefined; - indentFirstLine?: Docs.Schema.Dimension | undefined; - indentStart?: Docs.Schema.Dimension | undefined; - startNumber?: number | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface NestingLevelSuggestionState { - bulletAlignmentSuggested?: boolean | undefined; - glyphFormatSuggested?: boolean | undefined; - glyphSymbolSuggested?: boolean | undefined; - glyphTypeSuggested?: boolean | undefined; - indentFirstLineSuggested?: boolean | undefined; - indentStartSuggested?: boolean | undefined; - startNumberSuggested?: boolean | undefined; - textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState | undefined; - } - interface ObjectReferences { - objectIds?: string[] | undefined; - } - interface OptionalColor { - color?: Docs.Schema.Color | undefined; - } - interface PageBreak { - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface Paragraph { - bullet?: Docs.Schema.Bullet | undefined; - elements?: Docs.Schema.ParagraphElement[] | undefined; - paragraphStyle?: Docs.Schema.ParagraphStyle | undefined; - positionedObjectIds?: string[] | undefined; - suggestedBulletChanges?: object | undefined; - suggestedParagraphStyleChanges?: object | undefined; - suggestedPositionedObjectIds?: object | undefined; - } - interface ParagraphBorder { - color?: Docs.Schema.OptionalColor | undefined; - dashStyle?: string | undefined; - padding?: Docs.Schema.Dimension | undefined; - width?: Docs.Schema.Dimension | undefined; - } - interface ParagraphElement { - autoText?: Docs.Schema.AutoText | undefined; - columnBreak?: Docs.Schema.ColumnBreak | undefined; - endIndex?: number | undefined; - equation?: Docs.Schema.Equation | undefined; - footnoteReference?: Docs.Schema.FootnoteReference | undefined; - horizontalRule?: Docs.Schema.HorizontalRule | undefined; - inlineObjectElement?: Docs.Schema.InlineObjectElement | undefined; - pageBreak?: Docs.Schema.PageBreak | undefined; - startIndex?: number | undefined; - textRun?: Docs.Schema.TextRun | undefined; - } - interface ParagraphStyle { - alignment?: string | undefined; - avoidWidowAndOrphan?: boolean | undefined; - borderBetween?: Docs.Schema.ParagraphBorder | undefined; - borderBottom?: Docs.Schema.ParagraphBorder | undefined; - borderLeft?: Docs.Schema.ParagraphBorder | undefined; - borderRight?: Docs.Schema.ParagraphBorder | undefined; - borderTop?: Docs.Schema.ParagraphBorder | undefined; - direction?: string | undefined; - headingId?: string | undefined; - indentEnd?: Docs.Schema.Dimension | undefined; - indentFirstLine?: Docs.Schema.Dimension | undefined; - indentStart?: Docs.Schema.Dimension | undefined; - keepLinesTogether?: boolean | undefined; - keepWithNext?: boolean | undefined; - lineSpacing?: number | undefined; - namedStyleType?: string | undefined; - shading?: Docs.Schema.Shading | undefined; - spaceAbove?: Docs.Schema.Dimension | undefined; - spaceBelow?: Docs.Schema.Dimension | undefined; - spacingMode?: string | undefined; - tabStops?: Docs.Schema.TabStop[] | undefined; - } - interface ParagraphStyleSuggestionState { - alignmentSuggested?: boolean | undefined; - avoidWidowAndOrphanSuggested?: boolean | undefined; - borderBetweenSuggested?: boolean | undefined; - borderBottomSuggested?: boolean | undefined; - borderLeftSuggested?: boolean | undefined; - borderRightSuggested?: boolean | undefined; - borderTopSuggested?: boolean | undefined; - directionSuggested?: boolean | undefined; - headingIdSuggested?: boolean | undefined; - indentEndSuggested?: boolean | undefined; - indentFirstLineSuggested?: boolean | undefined; - indentStartSuggested?: boolean | undefined; - keepLinesTogetherSuggested?: boolean | undefined; - keepWithNextSuggested?: boolean | undefined; - lineSpacingSuggested?: boolean | undefined; - namedStyleTypeSuggested?: boolean | undefined; - shadingSuggestionState?: Docs.Schema.ShadingSuggestionState | undefined; - spaceAboveSuggested?: boolean | undefined; - spaceBelowSuggested?: boolean | undefined; - spacingModeSuggested?: boolean | undefined; - } - interface PositionedObject { - objectId?: string | undefined; - positionedObjectProperties?: Docs.Schema.PositionedObjectProperties | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionId?: string | undefined; - suggestedPositionedObjectPropertiesChanges?: object | undefined; - } - interface PositionedObjectPositioning { - layout?: string | undefined; - leftOffset?: Docs.Schema.Dimension | undefined; - topOffset?: Docs.Schema.Dimension | undefined; - } - interface PositionedObjectPositioningSuggestionState { - layoutSuggested?: boolean | undefined; - leftOffsetSuggested?: boolean | undefined; - topOffsetSuggested?: boolean | undefined; - } - interface PositionedObjectProperties { - embeddedObject?: Docs.Schema.EmbeddedObject | undefined; - positioning?: Docs.Schema.PositionedObjectPositioning | undefined; - } - interface PositionedObjectPropertiesSuggestionState { - embeddedObjectSuggestionState?: Docs.Schema.EmbeddedObjectSuggestionState | undefined; - positioningSuggestionState?: Docs.Schema.PositionedObjectPositioningSuggestionState | undefined; - } - interface Range { - endIndex?: number | undefined; - segmentId?: string | undefined; - startIndex?: number | undefined; - } - interface ReplaceAllTextRequest { - containsText?: Docs.Schema.SubstringMatchCriteria | undefined; - replaceText?: string | undefined; - } - interface ReplaceAllTextResponse { - occurrencesChanged?: number | undefined; - } - interface Request { - createNamedRange?: Docs.Schema.CreateNamedRangeRequest | undefined; - createParagraphBullets?: Docs.Schema.CreateParagraphBulletsRequest | undefined; - deleteContentRange?: Docs.Schema.DeleteContentRangeRequest | undefined; - deleteNamedRange?: Docs.Schema.DeleteNamedRangeRequest | undefined; - deleteParagraphBullets?: Docs.Schema.DeleteParagraphBulletsRequest | undefined; - deletePositionedObject?: Docs.Schema.DeletePositionedObjectRequest | undefined; - deleteTableColumn?: Docs.Schema.DeleteTableColumnRequest | undefined; - deleteTableRow?: Docs.Schema.DeleteTableRowRequest | undefined; - insertInlineImage?: Docs.Schema.InsertInlineImageRequest | undefined; - insertPageBreak?: Docs.Schema.InsertPageBreakRequest | undefined; - insertTable?: Docs.Schema.InsertTableRequest | undefined; - insertTableRow?: Docs.Schema.InsertTableRowRequest | undefined; - insertText?: Docs.Schema.InsertTextRequest | undefined; - replaceAllText?: Docs.Schema.ReplaceAllTextRequest | undefined; - updateParagraphStyle?: Docs.Schema.UpdateParagraphStyleRequest | undefined; - updateTextStyle?: Docs.Schema.UpdateTextStyleRequest | undefined; - } - interface Response { - createNamedRange?: Docs.Schema.CreateNamedRangeResponse | undefined; - insertInlineImage?: Docs.Schema.InsertInlineImageResponse | undefined; - insertInlineSheetsChart?: Docs.Schema.InsertInlineSheetsChartResponse | undefined; - replaceAllText?: Docs.Schema.ReplaceAllTextResponse | undefined; - } - interface RgbColor { - blue?: number | undefined; - green?: number | undefined; - red?: number | undefined; - } - interface SectionBreak { - sectionStyle?: Docs.Schema.SectionStyle | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - } - interface SectionColumnProperties { - paddingEnd?: Docs.Schema.Dimension | undefined; - width?: Docs.Schema.Dimension | undefined; - } - interface SectionStyle { - columnProperties?: Docs.Schema.SectionColumnProperties[] | undefined; - columnSeparatorStyle?: string | undefined; - contentDirection?: string | undefined; - } - interface Shading { - backgroundColor?: Docs.Schema.OptionalColor | undefined; - } - interface ShadingSuggestionState { - backgroundColorSuggested?: boolean | undefined; - } - interface SheetsChartReference { - chartId?: number | undefined; - spreadsheetId?: string | undefined; - } - interface SheetsChartReferenceSuggestionState { - chartIdSuggested?: boolean | undefined; - spreadsheetIdSuggested?: boolean | undefined; - } - interface Size { - height?: Docs.Schema.Dimension | undefined; - width?: Docs.Schema.Dimension | undefined; - } - interface SizeSuggestionState { - heightSuggested?: boolean | undefined; - widthSuggested?: boolean | undefined; - } - interface StructuralElement { - endIndex?: number | undefined; - paragraph?: Docs.Schema.Paragraph | undefined; - sectionBreak?: Docs.Schema.SectionBreak | undefined; - startIndex?: number | undefined; - table?: Docs.Schema.Table | undefined; - tableOfContents?: Docs.Schema.TableOfContents | undefined; - } - interface SubstringMatchCriteria { - matchCase?: boolean | undefined; - text?: string | undefined; - } - interface SuggestedBullet { - bullet?: Docs.Schema.Bullet | undefined; - bulletSuggestionState?: Docs.Schema.BulletSuggestionState | undefined; - } - interface SuggestedDocumentStyle { - documentStyle?: Docs.Schema.DocumentStyle | undefined; - documentStyleSuggestionState?: Docs.Schema.DocumentStyleSuggestionState | undefined; - } - interface SuggestedInlineObjectProperties { - inlineObjectProperties?: Docs.Schema.InlineObjectProperties | undefined; - inlineObjectPropertiesSuggestionState?: Docs.Schema.InlineObjectPropertiesSuggestionState | undefined; - } - interface SuggestedListProperties { - listProperties?: Docs.Schema.ListProperties | undefined; - listPropertiesSuggestionState?: Docs.Schema.ListPropertiesSuggestionState | undefined; - } - interface SuggestedNamedStyles { - namedStyles?: Docs.Schema.NamedStyles | undefined; - namedStylesSuggestionState?: Docs.Schema.NamedStylesSuggestionState | undefined; - } - interface SuggestedParagraphStyle { - paragraphStyle?: Docs.Schema.ParagraphStyle | undefined; - paragraphStyleSuggestionState?: Docs.Schema.ParagraphStyleSuggestionState | undefined; - } - interface SuggestedPositionedObjectProperties { - positionedObjectProperties?: Docs.Schema.PositionedObjectProperties | undefined; - positionedObjectPropertiesSuggestionState?: - | Docs.Schema.PositionedObjectPropertiesSuggestionState - | undefined; - } - interface SuggestedTableCellStyle { - tableCellStyle?: Docs.Schema.TableCellStyle | undefined; - tableCellStyleSuggestionState?: Docs.Schema.TableCellStyleSuggestionState | undefined; - } - interface SuggestedTableRowStyle { - tableRowStyle?: Docs.Schema.TableRowStyle | undefined; - tableRowStyleSuggestionState?: Docs.Schema.TableRowStyleSuggestionState | undefined; - } - interface SuggestedTextStyle { - textStyle?: Docs.Schema.TextStyle | undefined; - textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState | undefined; - } - interface TabStop { - alignment?: string | undefined; - offset?: Docs.Schema.Dimension | undefined; - } - interface Table { - columns?: number | undefined; - rows?: number | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - tableRows?: Docs.Schema.TableRow[] | undefined; - tableStyle?: Docs.Schema.TableStyle | undefined; - } - interface TableCell { - content?: Docs.Schema.StructuralElement[] | undefined; - endIndex?: number | undefined; - startIndex?: number | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTableCellStyleChanges?: object | undefined; - tableCellStyle?: Docs.Schema.TableCellStyle | undefined; - } - interface TableCellBorder { - color?: Docs.Schema.OptionalColor | undefined; - dashStyle?: string | undefined; - width?: Docs.Schema.Dimension | undefined; - } - interface TableCellLocation { - columnIndex?: number | undefined; - rowIndex?: number | undefined; - tableStartLocation?: Docs.Schema.Location | undefined; - } - interface TableCellStyle { - backgroundColor?: Docs.Schema.OptionalColor | undefined; - borderBottom?: Docs.Schema.TableCellBorder | undefined; - borderLeft?: Docs.Schema.TableCellBorder | undefined; - borderRight?: Docs.Schema.TableCellBorder | undefined; - borderTop?: Docs.Schema.TableCellBorder | undefined; - columnSpan?: number | undefined; - contentAlignment?: string | undefined; - paddingBottom?: Docs.Schema.Dimension | undefined; - paddingLeft?: Docs.Schema.Dimension | undefined; - paddingRight?: Docs.Schema.Dimension | undefined; - paddingTop?: Docs.Schema.Dimension | undefined; - rowSpan?: number | undefined; - } - interface TableCellStyleSuggestionState { - backgroundColorSuggested?: boolean | undefined; - borderBottomSuggested?: boolean | undefined; - borderLeftSuggested?: boolean | undefined; - borderRightSuggested?: boolean | undefined; - borderTopSuggested?: boolean | undefined; - columnSpanSuggested?: boolean | undefined; - contentAlignmentSuggested?: boolean | undefined; - paddingBottomSuggested?: boolean | undefined; - paddingLeftSuggested?: boolean | undefined; - paddingRightSuggested?: boolean | undefined; - paddingTopSuggested?: boolean | undefined; - rowSpanSuggested?: boolean | undefined; - } - interface TableColumnProperties { - width?: Docs.Schema.Dimension | undefined; - widthType?: string | undefined; - } - interface TableOfContents { - content?: Docs.Schema.StructuralElement[] | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - } - interface TableRow { - endIndex?: number | undefined; - startIndex?: number | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTableRowStyleChanges?: object | undefined; - tableCells?: Docs.Schema.TableCell[] | undefined; - tableRowStyle?: Docs.Schema.TableRowStyle | undefined; - } - interface TableRowStyle { - minRowHeight?: Docs.Schema.Dimension | undefined; - } - interface TableRowStyleSuggestionState { - minRowHeightSuggested?: boolean | undefined; - } - interface TableStyle { - tableColumnProperties?: Docs.Schema.TableColumnProperties[] | undefined; - } - interface TextRun { - content?: string | undefined; - suggestedDeletionIds?: string[] | undefined; - suggestedInsertionIds?: string[] | undefined; - suggestedTextStyleChanges?: object | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface TextStyle { - backgroundColor?: Docs.Schema.OptionalColor | undefined; - baselineOffset?: string | undefined; - bold?: boolean | undefined; - fontSize?: Docs.Schema.Dimension | undefined; - foregroundColor?: Docs.Schema.OptionalColor | undefined; - italic?: boolean | undefined; - link?: Docs.Schema.Link | undefined; - smallCaps?: boolean | undefined; - strikethrough?: boolean | undefined; - underline?: boolean | undefined; - weightedFontFamily?: Docs.Schema.WeightedFontFamily | undefined; - } - interface TextStyleSuggestionState { - backgroundColorSuggested?: boolean | undefined; - baselineOffsetSuggested?: boolean | undefined; - boldSuggested?: boolean | undefined; - fontSizeSuggested?: boolean | undefined; - foregroundColorSuggested?: boolean | undefined; - italicSuggested?: boolean | undefined; - linkSuggested?: boolean | undefined; - smallCapsSuggested?: boolean | undefined; - strikethroughSuggested?: boolean | undefined; - underlineSuggested?: boolean | undefined; - weightedFontFamilySuggested?: boolean | undefined; - } - interface UpdateParagraphStyleRequest { - fields?: string | undefined; - paragraphStyle?: Docs.Schema.ParagraphStyle | undefined; - range?: Docs.Schema.Range | undefined; - } - interface UpdateTextStyleRequest { - fields?: string | undefined; - range?: Docs.Schema.Range | undefined; - textStyle?: Docs.Schema.TextStyle | undefined; - } - interface WeightedFontFamily { - fontFamily?: string | undefined; - weight?: number | undefined; - } - interface WriteControl { - requiredRevisionId?: string | undefined; - targetRevisionId?: string | undefined; - } - } - } - interface Docs { - Documents?: Docs.Collection.DocumentsCollection | undefined; - // Create a new instance of AutoText - newAutoText(): Docs.Schema.AutoText; - // Create a new instance of Background - newBackground(): Docs.Schema.Background; - // Create a new instance of BatchUpdateDocumentRequest - newBatchUpdateDocumentRequest(): Docs.Schema.BatchUpdateDocumentRequest; - // Create a new instance of Body - newBody(): Docs.Schema.Body; - // Create a new instance of Bullet - newBullet(): Docs.Schema.Bullet; - // Create a new instance of Color - newColor(): Docs.Schema.Color; - // Create a new instance of ColumnBreak - newColumnBreak(): Docs.Schema.ColumnBreak; - // Create a new instance of CreateNamedRangeRequest - newCreateNamedRangeRequest(): Docs.Schema.CreateNamedRangeRequest; - // Create a new instance of CreateParagraphBulletsRequest - newCreateParagraphBulletsRequest(): Docs.Schema.CreateParagraphBulletsRequest; - // Create a new instance of DeleteContentRangeRequest - newDeleteContentRangeRequest(): Docs.Schema.DeleteContentRangeRequest; - // Create a new instance of DeleteNamedRangeRequest - newDeleteNamedRangeRequest(): Docs.Schema.DeleteNamedRangeRequest; - // Create a new instance of DeleteParagraphBulletsRequest - newDeleteParagraphBulletsRequest(): Docs.Schema.DeleteParagraphBulletsRequest; - // Create a new instance of DeletePositionedObjectRequest - newDeletePositionedObjectRequest(): Docs.Schema.DeletePositionedObjectRequest; - // Create a new instance of DeleteTableColumnRequest - newDeleteTableColumnRequest(): Docs.Schema.DeleteTableColumnRequest; - // Create a new instance of DeleteTableRowRequest - newDeleteTableRowRequest(): Docs.Schema.DeleteTableRowRequest; - // Create a new instance of Dimension - newDimension(): Docs.Schema.Dimension; - // Create a new instance of Document - newDocument(): Docs.Schema.Document; - // Create a new instance of DocumentStyle - newDocumentStyle(): Docs.Schema.DocumentStyle; - // Create a new instance of EndOfSegmentLocation - newEndOfSegmentLocation(): Docs.Schema.EndOfSegmentLocation; - // Create a new instance of Equation - newEquation(): Docs.Schema.Equation; - // Create a new instance of FootnoteReference - newFootnoteReference(): Docs.Schema.FootnoteReference; - // Create a new instance of HorizontalRule - newHorizontalRule(): Docs.Schema.HorizontalRule; - // Create a new instance of InlineObjectElement - newInlineObjectElement(): Docs.Schema.InlineObjectElement; - // Create a new instance of InsertInlineImageRequest - newInsertInlineImageRequest(): Docs.Schema.InsertInlineImageRequest; - // Create a new instance of InsertPageBreakRequest - newInsertPageBreakRequest(): Docs.Schema.InsertPageBreakRequest; - // Create a new instance of InsertTableRequest - newInsertTableRequest(): Docs.Schema.InsertTableRequest; - // Create a new instance of InsertTableRowRequest - newInsertTableRowRequest(): Docs.Schema.InsertTableRowRequest; - // Create a new instance of InsertTextRequest - newInsertTextRequest(): Docs.Schema.InsertTextRequest; - // Create a new instance of Link - newLink(): Docs.Schema.Link; - // Create a new instance of Location - newLocation(): Docs.Schema.Location; - // Create a new instance of NamedStyle - newNamedStyle(): Docs.Schema.NamedStyle; - // Create a new instance of NamedStyles - newNamedStyles(): Docs.Schema.NamedStyles; - // Create a new instance of OptionalColor - newOptionalColor(): Docs.Schema.OptionalColor; - // Create a new instance of PageBreak - newPageBreak(): Docs.Schema.PageBreak; - // Create a new instance of Paragraph - newParagraph(): Docs.Schema.Paragraph; - // Create a new instance of ParagraphBorder - newParagraphBorder(): Docs.Schema.ParagraphBorder; - // Create a new instance of ParagraphElement - newParagraphElement(): Docs.Schema.ParagraphElement; - // Create a new instance of ParagraphStyle - newParagraphStyle(): Docs.Schema.ParagraphStyle; - // Create a new instance of Range - newRange(): Docs.Schema.Range; - // Create a new instance of ReplaceAllTextRequest - newReplaceAllTextRequest(): Docs.Schema.ReplaceAllTextRequest; - // Create a new instance of Request - newRequest(): Docs.Schema.Request; - // Create a new instance of RgbColor - newRgbColor(): Docs.Schema.RgbColor; - // Create a new instance of SectionBreak - newSectionBreak(): Docs.Schema.SectionBreak; - // Create a new instance of SectionColumnProperties - newSectionColumnProperties(): Docs.Schema.SectionColumnProperties; - // Create a new instance of SectionStyle - newSectionStyle(): Docs.Schema.SectionStyle; - // Create a new instance of Shading - newShading(): Docs.Schema.Shading; - // Create a new instance of Size - newSize(): Docs.Schema.Size; - // Create a new instance of StructuralElement - newStructuralElement(): Docs.Schema.StructuralElement; - // Create a new instance of SubstringMatchCriteria - newSubstringMatchCriteria(): Docs.Schema.SubstringMatchCriteria; - // Create a new instance of TabStop - newTabStop(): Docs.Schema.TabStop; - // Create a new instance of Table - newTable(): Docs.Schema.Table; - // Create a new instance of TableCell - newTableCell(): Docs.Schema.TableCell; - // Create a new instance of TableCellBorder - newTableCellBorder(): Docs.Schema.TableCellBorder; - // Create a new instance of TableCellLocation - newTableCellLocation(): Docs.Schema.TableCellLocation; - // Create a new instance of TableCellStyle - newTableCellStyle(): Docs.Schema.TableCellStyle; - // Create a new instance of TableColumnProperties - newTableColumnProperties(): Docs.Schema.TableColumnProperties; - // Create a new instance of TableOfContents - newTableOfContents(): Docs.Schema.TableOfContents; - // Create a new instance of TableRow - newTableRow(): Docs.Schema.TableRow; - // Create a new instance of TableRowStyle - newTableRowStyle(): Docs.Schema.TableRowStyle; - // Create a new instance of TableStyle - newTableStyle(): Docs.Schema.TableStyle; - // Create a new instance of TextRun - newTextRun(): Docs.Schema.TextRun; - // Create a new instance of TextStyle - newTextStyle(): Docs.Schema.TextStyle; - // Create a new instance of UpdateParagraphStyleRequest - newUpdateParagraphStyleRequest(): Docs.Schema.UpdateParagraphStyleRequest; - // Create a new instance of UpdateTextStyleRequest - newUpdateTextStyleRequest(): Docs.Schema.UpdateTextStyleRequest; - // Create a new instance of WeightedFontFamily - newWeightedFontFamily(): Docs.Schema.WeightedFontFamily; - // Create a new instance of WriteControl - newWriteControl(): Docs.Schema.WriteControl; - } -} - -declare var Docs: GoogleAppsScript.Docs; diff --git a/node_modules/@types/google-apps-script/apis/drive_v2.d.ts b/node_modules/@types/google-apps-script/apis/drive_v2.d.ts deleted file mode 100644 index 26fa6e9..0000000 --- a/node_modules/@types/google-apps-script/apis/drive_v2.d.ts +++ /dev/null @@ -1,984 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Drive { - namespace Collection { - interface AboutCollection { - // Gets the information about the current user along with Drive API settings - get(): Drive.Schema.About; - // Gets the information about the current user along with Drive API settings - get(optionalArgs: object): Drive.Schema.About; - } - interface AppsCollection { - // Gets a specific app. - get(appId: string): Drive.Schema.App; - // Lists a user's installed apps. - list(): Drive.Schema.AppList; - // Lists a user's installed apps. - list(optionalArgs: object): Drive.Schema.AppList; - } - interface ChangesCollection { - // Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. - get(changeId: string): Drive.Schema.Change; - // Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. - get(changeId: string, optionalArgs: object): Drive.Schema.Change; - // Gets the starting pageToken for listing future changes. - getStartPageToken(): Drive.Schema.StartPageToken; - // Gets the starting pageToken for listing future changes. - getStartPageToken(optionalArgs: object): Drive.Schema.StartPageToken; - // Lists the changes for a user or Team Drive. - list(): Drive.Schema.ChangeList; - // Lists the changes for a user or Team Drive. - list(optionalArgs: object): Drive.Schema.ChangeList; - // Subscribe to changes for a user. - watch(resource: Schema.Channel): Drive.Schema.Channel; - // Subscribe to changes for a user. - watch(resource: Schema.Channel, optionalArgs: object): Drive.Schema.Channel; - } - interface ChannelsCollection { - // Stop watching resources through this channel - stop(resource: Schema.Channel): void; - } - interface ChildrenCollection { - // Gets a specific child reference. - get(folderId: string, childId: string): Drive.Schema.ChildReference; - // Inserts a file into a folder. - insert(resource: Schema.ChildReference, folderId: string): Drive.Schema.ChildReference; - // Inserts a file into a folder. - insert( - resource: Schema.ChildReference, - folderId: string, - optionalArgs: object, - ): Drive.Schema.ChildReference; - // Lists a folder's children. - list(folderId: string): Drive.Schema.ChildList; - // Lists a folder's children. - list(folderId: string, optionalArgs: object): Drive.Schema.ChildList; - // Removes a child from a folder. - remove(folderId: string, childId: string): void; - } - interface CommentsCollection { - // Gets a comment by ID. - get(fileId: string, commentId: string): Drive.Schema.Comment; - // Gets a comment by ID. - get(fileId: string, commentId: string, optionalArgs: object): Drive.Schema.Comment; - // Creates a new comment on the given file. - insert(resource: Schema.Comment, fileId: string): Drive.Schema.Comment; - // Lists a file's comments. - list(fileId: string): Drive.Schema.CommentList; - // Lists a file's comments. - list(fileId: string, optionalArgs: object): Drive.Schema.CommentList; - // Updates an existing comment. This method supports patch semantics. - patch(resource: Schema.Comment, fileId: string, commentId: string): Drive.Schema.Comment; - // Deletes a comment. - remove(fileId: string, commentId: string): void; - // Updates an existing comment. - update(resource: Schema.Comment, fileId: string, commentId: string): Drive.Schema.Comment; - } - interface DrivesCollection { - // Gets a shared drive's metadata by ID. - get(driveId: string): Drive.Schema.Drive; - // Gets a shared drive's metadata by ID. - get(driveId: string, optionalArgs: object): Drive.Schema.Drive; - // Hides a shared drive from the default view. - hide(driveId: string): Drive.Schema.Drive; - // Creates a new shared drive. - insert(resource: Schema.Drive, requestId: string): Drive.Schema.Drive; - // Lists the user's shared drives. - list(): Drive.Schema.DriveList; - // Lists the user's shared drives. - list(optionalArgs: object): Drive.Schema.DriveList; - // Permanently deletes a shared drive for which the user is an organizer. The shared drive cannot contain any untrashed items. - remove(driveId: string): void; - // Restores a shared drive to the default view. - unhide(driveId: string): Drive.Schema.Drive; - // Updates the metadata for a shared drive. - update(resource: Schema.Drive, driveId: string): Drive.Schema.Drive; - // Updates the metadata for a shared drive. - update(resource: Schema.Drive, driveId: string, optionalArgs: object): Drive.Schema.Drive; - } - interface FilesCollection { - // Creates a copy of the specified file. - copy(resource: Schema.File, fileId: string): Drive.Schema.File; - // Creates a copy of the specified file. - copy(resource: Schema.File, fileId: string, optionalArgs: object): Drive.Schema.File; - // Permanently deletes all of the user's trashed files. - emptyTrash(): void; - // Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. - export(fileId: string, mimeType: string): void; - // Generates a set of file IDs which can be provided in insert requests. - generateIds(): Drive.Schema.GeneratedIds; - // Generates a set of file IDs which can be provided in insert requests. - generateIds(optionalArgs: object): Drive.Schema.GeneratedIds; - // Gets a file's metadata by ID. - get(fileId: string): Drive.Schema.File; - // Gets a file's metadata by ID. - get(fileId: string, optionalArgs: object): Drive.Schema.File; - // Insert a new file. - insert(resource: Schema.File): Drive.Schema.File; - // Insert a new file. - insert(resource: Schema.File, mediaData: any): Drive.Schema.File; - // Insert a new file. - insert(resource: Schema.File, mediaData: any, optionalArgs: object): Drive.Schema.File; - // Lists the user's files. - list(): Drive.Schema.FileList; - // Lists the user's files. - list(optionalArgs: object): Drive.Schema.FileList; - // Updates file metadata and/or content. This method supports patch semantics. - patch(resource: Schema.File, fileId: string): Drive.Schema.File; - // Updates file metadata and/or content. This method supports patch semantics. - patch(resource: Schema.File, fileId: string, optionalArgs: object): Drive.Schema.File; - // Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. - remove(fileId: string): void; - // Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. - remove(fileId: string, optionalArgs: object): void; - // Set the file's updated time to the current server time. - touch(fileId: string): Drive.Schema.File; - // Set the file's updated time to the current server time. - touch(fileId: string, optionalArgs: object): Drive.Schema.File; - // Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for Team Drive files. - trash(fileId: string): Drive.Schema.File; - // Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for Team Drive files. - trash(fileId: string, optionalArgs: object): Drive.Schema.File; - // Restores a file from the trash. - untrash(fileId: string): Drive.Schema.File; - // Restores a file from the trash. - untrash(fileId: string, optionalArgs: object): Drive.Schema.File; - // Updates file metadata and/or content. - update(resource: Schema.File, fileId: string): Drive.Schema.File; - // Updates file metadata and/or content. - update(resource: Schema.File, fileId: string, mediaData: any): Drive.Schema.File; - // Updates file metadata and/or content. - update(resource: Schema.File, fileId: string, mediaData: any, optionalArgs: object): Drive.Schema.File; - // Subscribe to changes on a file - watch(resource: Schema.Channel, fileId: string): Drive.Schema.Channel; - // Subscribe to changes on a file - watch(resource: Schema.Channel, fileId: string, optionalArgs: object): Drive.Schema.Channel; - } - interface ParentsCollection { - // Gets a specific parent reference. - get(fileId: string, parentId: string): Drive.Schema.ParentReference; - // Adds a parent folder for a file. - insert(resource: Schema.ParentReference, fileId: string): Drive.Schema.ParentReference; - // Adds a parent folder for a file. - insert( - resource: Schema.ParentReference, - fileId: string, - optionalArgs: object, - ): Drive.Schema.ParentReference; - // Lists a file's parents. - list(fileId: string): Drive.Schema.ParentList; - // Removes a parent from a file. - remove(fileId: string, parentId: string): void; - } - interface PermissionsCollection { - // Gets a permission by ID. - get(fileId: string, permissionId: string): Drive.Schema.Permission; - // Gets a permission by ID. - get(fileId: string, permissionId: string, optionalArgs: object): Drive.Schema.Permission; - // Returns the permission ID for an email address. - getIdForEmail(email: string): Drive.Schema.PermissionId; - // Inserts a permission for a file or Team Drive. - insert(resource: Schema.Permission, fileId: string): Drive.Schema.Permission; - // Inserts a permission for a file or Team Drive. - insert(resource: Schema.Permission, fileId: string, optionalArgs: object): Drive.Schema.Permission; - // Lists a file's or Team Drive's permissions. - list(fileId: string): Drive.Schema.PermissionList; - // Lists a file's or Team Drive's permissions. - list(fileId: string, optionalArgs: object): Drive.Schema.PermissionList; - // Updates a permission using patch semantics. - patch(resource: Schema.Permission, fileId: string, permissionId: string): Drive.Schema.Permission; - // Updates a permission using patch semantics. - patch( - resource: Schema.Permission, - fileId: string, - permissionId: string, - optionalArgs: object, - ): Drive.Schema.Permission; - // Deletes a permission from a file or Team Drive. - remove(fileId: string, permissionId: string): void; - // Deletes a permission from a file or Team Drive. - remove(fileId: string, permissionId: string, optionalArgs: object): void; - // Updates a permission. - update(resource: Schema.Permission, fileId: string, permissionId: string): Drive.Schema.Permission; - // Updates a permission. - update( - resource: Schema.Permission, - fileId: string, - permissionId: string, - optionalArgs: object, - ): Drive.Schema.Permission; - } - interface PropertiesCollection { - // Gets a property by its key. - get(fileId: string, propertyKey: string): Drive.Schema.Property; - // Gets a property by its key. - get(fileId: string, propertyKey: string, optionalArgs: object): Drive.Schema.Property; - // Adds a property to a file, or updates it if it already exists. - insert(resource: Schema.Property, fileId: string): Drive.Schema.Property; - // Lists a file's properties. - list(fileId: string): Drive.Schema.PropertyList; - // Updates a property. - patch(resource: Schema.Property, fileId: string, propertyKey: string): Drive.Schema.Property; - // Updates a property. - patch( - resource: Schema.Property, - fileId: string, - propertyKey: string, - optionalArgs: object, - ): Drive.Schema.Property; - // Deletes a property. - remove(fileId: string, propertyKey: string): void; - // Deletes a property. - remove(fileId: string, propertyKey: string, optionalArgs: object): void; - // Updates a property. - update(resource: Schema.Property, fileId: string, propertyKey: string): Drive.Schema.Property; - // Updates a property. - update( - resource: Schema.Property, - fileId: string, - propertyKey: string, - optionalArgs: object, - ): Drive.Schema.Property; - } - interface RealtimeCollection { - // Exports the contents of the Realtime API data model associated with this file as JSON. - get(fileId: string): void; - // Exports the contents of the Realtime API data model associated with this file as JSON. - get(fileId: string, optionalArgs: object): void; - // Overwrites the Realtime API data model associated with this file with the provided JSON data model. - update(fileId: string): void; - // Overwrites the Realtime API data model associated with this file with the provided JSON data model. - update(fileId: string, mediaData: any): void; - // Overwrites the Realtime API data model associated with this file with the provided JSON data model. - update(fileId: string, mediaData: any, optionalArgs: object): void; - } - interface RepliesCollection { - // Gets a reply. - get(fileId: string, commentId: string, replyId: string): Drive.Schema.CommentReply; - // Gets a reply. - get( - fileId: string, - commentId: string, - replyId: string, - optionalArgs: object, - ): Drive.Schema.CommentReply; - // Creates a new reply to the given comment. - insert(resource: Schema.CommentReply, fileId: string, commentId: string): Drive.Schema.CommentReply; - // Lists all of the replies to a comment. - list(fileId: string, commentId: string): Drive.Schema.CommentReplyList; - // Lists all of the replies to a comment. - list(fileId: string, commentId: string, optionalArgs: object): Drive.Schema.CommentReplyList; - // Updates an existing reply. This method supports patch semantics. - patch( - resource: Schema.CommentReply, - fileId: string, - commentId: string, - replyId: string, - ): Drive.Schema.CommentReply; - // Deletes a reply. - remove(fileId: string, commentId: string, replyId: string): void; - // Updates an existing reply. - update( - resource: Schema.CommentReply, - fileId: string, - commentId: string, - replyId: string, - ): Drive.Schema.CommentReply; - } - interface RevisionsCollection { - // Gets a specific revision. - get(fileId: string, revisionId: string): Drive.Schema.Revision; - // Lists a file's revisions. - list(fileId: string): Drive.Schema.RevisionList; - // Lists a file's revisions. - list(fileId: string, optionalArgs: object): Drive.Schema.RevisionList; - // Updates a revision. This method supports patch semantics. - patch(resource: Schema.Revision, fileId: string, revisionId: string): Drive.Schema.Revision; - // Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. - remove(fileId: string, revisionId: string): void; - // Updates a revision. - update(resource: Schema.Revision, fileId: string, revisionId: string): Drive.Schema.Revision; - } - interface TeamdrivesCollection { - // Gets a Team Drive's metadata by ID. - get(teamDriveId: string): Drive.Schema.TeamDrive; - // Gets a Team Drive's metadata by ID. - get(teamDriveId: string, optionalArgs: object): Drive.Schema.TeamDrive; - // Creates a new Team Drive. - insert(resource: Schema.TeamDrive, requestId: string): Drive.Schema.TeamDrive; - // Lists the user's Team Drives. - list(): Drive.Schema.TeamDriveList; - // Lists the user's Team Drives. - list(optionalArgs: object): Drive.Schema.TeamDriveList; - // Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items. - remove(teamDriveId: string): void; - // Updates a Team Drive's metadata - update(resource: Schema.TeamDrive, teamDriveId: string): Drive.Schema.TeamDrive; - // Updates a Team Drive's metadata - update(resource: Schema.TeamDrive, teamDriveId: string, optionalArgs: object): Drive.Schema.TeamDrive; - } - } - namespace Schema { - interface About { - additionalRoleInfo?: Drive.Schema.AboutAdditionalRoleInfo[] | undefined; - canCreateDrives?: boolean | undefined; - canCreateTeamDrives?: boolean | undefined; - domainSharingPolicy?: string | undefined; - driveThemes?: Drive.Schema.AboutDriveThemes[] | undefined; - etag?: string | undefined; - exportFormats?: Drive.Schema.AboutExportFormats[] | undefined; - features?: Drive.Schema.AboutFeatures[] | undefined; - folderColorPalette?: string[] | undefined; - importFormats?: Drive.Schema.AboutImportFormats[] | undefined; - isCurrentAppInstalled?: boolean | undefined; - kind?: string | undefined; - languageCode?: string | undefined; - largestChangeId?: string | undefined; - maxUploadSizes?: Drive.Schema.AboutMaxUploadSizes[] | undefined; - name?: string | undefined; - permissionId?: string | undefined; - quotaBytesByService?: Drive.Schema.AboutQuotaBytesByService[] | undefined; - quotaBytesTotal?: string | undefined; - quotaBytesUsed?: string | undefined; - quotaBytesUsedAggregate?: string | undefined; - quotaBytesUsedInTrash?: string | undefined; - quotaType?: string | undefined; - remainingChangeIds?: string | undefined; - rootFolderId?: string | undefined; - selfLink?: string | undefined; - teamDriveThemes?: Drive.Schema.AboutTeamDriveThemes[] | undefined; - user?: Drive.Schema.User | undefined; - } - interface AboutAdditionalRoleInfo { - roleSets?: Drive.Schema.AboutAdditionalRoleInfoRoleSets[] | undefined; - type?: string | undefined; - } - interface AboutAdditionalRoleInfoRoleSets { - additionalRoles?: string[] | undefined; - primaryRole?: string | undefined; - } - interface AboutDriveThemes { - backgroundImageLink?: string | undefined; - colorRgb?: string | undefined; - id?: string | undefined; - } - interface AboutExportFormats { - source?: string | undefined; - targets?: string[] | undefined; - } - interface AboutFeatures { - featureName?: string | undefined; - featureRate?: number | undefined; - } - interface AboutImportFormats { - source?: string | undefined; - targets?: string[] | undefined; - } - interface AboutMaxUploadSizes { - size?: string | undefined; - type?: string | undefined; - } - interface AboutQuotaBytesByService { - bytesUsed?: string | undefined; - serviceName?: string | undefined; - } - interface AboutTeamDriveThemes { - backgroundImageLink?: string | undefined; - colorRgb?: string | undefined; - id?: string | undefined; - } - interface App { - authorized?: boolean | undefined; - createInFolderTemplate?: string | undefined; - createUrl?: string | undefined; - hasDriveWideScope?: boolean | undefined; - icons?: Drive.Schema.AppIcons[] | undefined; - id?: string | undefined; - installed?: boolean | undefined; - kind?: string | undefined; - longDescription?: string | undefined; - name?: string | undefined; - objectType?: string | undefined; - openUrlTemplate?: string | undefined; - primaryFileExtensions?: string[] | undefined; - primaryMimeTypes?: string[] | undefined; - productId?: string | undefined; - productUrl?: string | undefined; - secondaryFileExtensions?: string[] | undefined; - secondaryMimeTypes?: string[] | undefined; - shortDescription?: string | undefined; - supportsCreate?: boolean | undefined; - supportsImport?: boolean | undefined; - supportsMultiOpen?: boolean | undefined; - supportsOfflineCreate?: boolean | undefined; - useByDefault?: boolean | undefined; - } - interface AppIcons { - category?: string | undefined; - iconUrl?: string | undefined; - size?: number | undefined; - } - interface AppList { - defaultAppIds?: string[] | undefined; - etag?: string | undefined; - items?: Drive.Schema.App[] | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - } - interface Change { - deleted?: boolean | undefined; - drive?: Drive.Schema.Drive | undefined; - driveId?: string | undefined; - file?: Drive.Schema.File | undefined; - fileId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - modificationDate?: string | undefined; - selfLink?: string | undefined; - teamDrive?: Drive.Schema.TeamDrive | undefined; - teamDriveId?: string | undefined; - type?: string | undefined; - } - interface ChangeList { - etag?: string | undefined; - items?: Drive.Schema.Change[] | undefined; - kind?: string | undefined; - largestChangeId?: string | undefined; - newStartPageToken?: string | undefined; - nextLink?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface Channel { - address?: string | undefined; - expiration?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - params?: object | undefined; - payload?: boolean | undefined; - resourceId?: string | undefined; - resourceUri?: string | undefined; - token?: string | undefined; - type?: string | undefined; - } - interface ChildList { - etag?: string | undefined; - items?: Drive.Schema.ChildReference[] | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface ChildReference { - childLink?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - } - interface Comment { - anchor?: string | undefined; - author?: Drive.Schema.User | undefined; - commentId?: string | undefined; - content?: string | undefined; - context?: Drive.Schema.CommentContext | undefined; - createdDate?: string | undefined; - deleted?: boolean | undefined; - fileId?: string | undefined; - fileTitle?: string | undefined; - htmlContent?: string | undefined; - kind?: string | undefined; - modifiedDate?: string | undefined; - replies?: Drive.Schema.CommentReply[] | undefined; - selfLink?: string | undefined; - status?: string | undefined; - } - interface CommentContext { - type?: string | undefined; - value?: string | undefined; - } - interface CommentList { - items?: Drive.Schema.Comment[] | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface CommentReply { - author?: Drive.Schema.User | undefined; - content?: string | undefined; - createdDate?: string | undefined; - deleted?: boolean | undefined; - htmlContent?: string | undefined; - kind?: string | undefined; - modifiedDate?: string | undefined; - replyId?: string | undefined; - verb?: string | undefined; - } - interface CommentReplyList { - items?: Drive.Schema.CommentReply[] | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface Drive { - backgroundImageFile?: Drive.Schema.DriveBackgroundImageFile | undefined; - backgroundImageLink?: string | undefined; - capabilities?: Drive.Schema.DriveCapabilities | undefined; - colorRgb?: string | undefined; - createdDate?: string | undefined; - hidden?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - restrictions?: Drive.Schema.DriveRestrictions | undefined; - themeId?: string | undefined; - } - interface DriveBackgroundImageFile { - id?: string | undefined; - width?: number | undefined; - xCoordinate?: number | undefined; - yCoordinate?: number | undefined; - } - interface DriveCapabilities { - canAddChildren?: boolean | undefined; - canChangeCopyRequiresWriterPermissionRestriction?: boolean | undefined; - canChangeDomainUsersOnlyRestriction?: boolean | undefined; - canChangeDriveBackground?: boolean | undefined; - canChangeDriveMembersOnlyRestriction?: boolean | undefined; - canComment?: boolean | undefined; - canCopy?: boolean | undefined; - canDeleteChildren?: boolean | undefined; - canDeleteDrive?: boolean | undefined; - canDownload?: boolean | undefined; - canEdit?: boolean | undefined; - canListChildren?: boolean | undefined; - canManageMembers?: boolean | undefined; - canReadRevisions?: boolean | undefined; - canRename?: boolean | undefined; - canRenameDrive?: boolean | undefined; - canShare?: boolean | undefined; - canTrashChildren?: boolean | undefined; - } - interface DriveList { - items?: Drive.Schema.Drive[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface DriveRestrictions { - adminManagedRestrictions?: boolean | undefined; - copyRequiresWriterPermission?: boolean | undefined; - domainUsersOnly?: boolean | undefined; - driveMembersOnly?: boolean | undefined; - } - interface File { - alternateLink?: string | undefined; - appDataContents?: boolean | undefined; - canComment?: boolean | undefined; - canReadRevisions?: boolean | undefined; - capabilities?: Drive.Schema.FileCapabilities | undefined; - copyRequiresWriterPermission?: boolean | undefined; - copyable?: boolean | undefined; - createdDate?: string | undefined; - defaultOpenWithLink?: string | undefined; - description?: string | undefined; - downloadUrl?: string | undefined; - driveId?: string | undefined; - editable?: boolean | undefined; - embedLink?: string | undefined; - etag?: string | undefined; - explicitlyTrashed?: boolean | undefined; - exportLinks?: object | undefined; - fileExtension?: string | undefined; - fileSize?: string | undefined; - folderColorRgb?: string | undefined; - fullFileExtension?: string | undefined; - hasAugmentedPermissions?: boolean | undefined; - hasThumbnail?: boolean | undefined; - headRevisionId?: string | undefined; - iconLink?: string | undefined; - id?: string | undefined; - imageMediaMetadata?: Drive.Schema.FileImageMediaMetadata | undefined; - indexableText?: Drive.Schema.FileIndexableText | undefined; - isAppAuthorized?: boolean | undefined; - kind?: string | undefined; - labels?: Drive.Schema.FileLabels | undefined; - lastModifyingUser?: Drive.Schema.User | undefined; - lastModifyingUserName?: string | undefined; - lastViewedByMeDate?: string | undefined; - markedViewedByMeDate?: string | undefined; - md5Checksum?: string | undefined; - mimeType?: string | undefined; - modifiedByMeDate?: string | undefined; - modifiedDate?: string | undefined; - openWithLinks?: object | undefined; - originalFilename?: string | undefined; - ownedByMe?: boolean | undefined; - ownerNames?: string[] | undefined; - owners?: Drive.Schema.User[] | undefined; - parents?: Drive.Schema.ParentReference[] | undefined; - permissionIds?: string[] | undefined; - permissions?: Drive.Schema.Permission[] | undefined; - properties?: Drive.Schema.Property[] | undefined; - quotaBytesUsed?: string | undefined; - selfLink?: string | undefined; - shareable?: boolean | undefined; - shared?: boolean | undefined; - sharedWithMeDate?: string | undefined; - sharingUser?: Drive.Schema.User | undefined; - shortcutDetails?: Drive.Schema.ShortcutDetails | undefined; - spaces?: string[] | undefined; - teamDriveId?: string | undefined; - thumbnail?: Drive.Schema.FileThumbnail | undefined; - thumbnailLink?: string | undefined; - thumbnailVersion?: string | undefined; - title?: string | undefined; - trashedDate?: string | undefined; - trashingUser?: Drive.Schema.User | undefined; - userPermission?: Drive.Schema.Permission | undefined; - version?: string | undefined; - videoMediaMetadata?: Drive.Schema.FileVideoMediaMetadata | undefined; - webContentLink?: string | undefined; - webViewLink?: string | undefined; - writersCanShare?: boolean | undefined; - } - interface FileCapabilities { - canAddChildren?: boolean | undefined; - canChangeCopyRequiresWriterPermission?: boolean | undefined; - canChangeRestrictedDownload?: boolean | undefined; - canComment?: boolean | undefined; - canCopy?: boolean | undefined; - canDelete?: boolean | undefined; - canDeleteChildren?: boolean | undefined; - canDownload?: boolean | undefined; - canEdit?: boolean | undefined; - canListChildren?: boolean | undefined; - canMoveChildrenOutOfDrive?: boolean | undefined; - canMoveChildrenOutOfTeamDrive?: boolean | undefined; - canMoveChildrenWithinDrive?: boolean | undefined; - canMoveChildrenWithinTeamDrive?: boolean | undefined; - canMoveItemIntoTeamDrive?: boolean | undefined; - canMoveItemOutOfDrive?: boolean | undefined; - canMoveItemOutOfTeamDrive?: boolean | undefined; - canMoveItemWithinDrive?: boolean | undefined; - canMoveItemWithinTeamDrive?: boolean | undefined; - canMoveTeamDriveItem?: boolean | undefined; - canReadRevisions?: boolean | undefined; - canReadDrive?: boolean | undefined; - canReadTeamDrive?: boolean | undefined; - canRemoveChildren?: boolean | undefined; - canRename?: boolean | undefined; - canShare?: boolean | undefined; - canTrash?: boolean | undefined; - canTrashChildren?: boolean | undefined; - canUntrash?: boolean | undefined; - } - interface FileImageMediaMetadata { - aperture?: number | undefined; - cameraMake?: string | undefined; - cameraModel?: string | undefined; - colorSpace?: string | undefined; - date?: string | undefined; - exposureBias?: number | undefined; - exposureMode?: string | undefined; - exposureTime?: number | undefined; - flashUsed?: boolean | undefined; - focalLength?: number | undefined; - height?: number | undefined; - isoSpeed?: number | undefined; - lens?: string | undefined; - location?: Drive.Schema.FileImageMediaMetadataLocation | undefined; - maxApertureValue?: number | undefined; - meteringMode?: string | undefined; - rotation?: number | undefined; - sensor?: string | undefined; - subjectDistance?: number | undefined; - whiteBalance?: string | undefined; - width?: number | undefined; - } - interface FileImageMediaMetadataLocation { - altitude?: number | undefined; - latitude?: number | undefined; - longitude?: number | undefined; - } - interface FileIndexableText { - text?: string | undefined; - } - interface FileLabels { - hidden?: boolean | undefined; - modified?: boolean | undefined; - restricted?: boolean | undefined; - starred?: boolean | undefined; - trashed?: boolean | undefined; - viewed?: boolean | undefined; - } - interface FileList { - etag?: string | undefined; - incompleteSearch?: boolean | undefined; - items?: Drive.Schema.File[] | undefined; - kind?: string | undefined; - nextLink?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface FileThumbnail { - image?: string | undefined; - mimeType?: string | undefined; - } - interface FileVideoMediaMetadata { - durationMillis?: string | undefined; - height?: number | undefined; - width?: number | undefined; - } - interface GeneratedIds { - ids?: string[] | undefined; - kind?: string | undefined; - space?: string | undefined; - } - interface ParentList { - etag?: string | undefined; - items?: Drive.Schema.ParentReference[] | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - } - interface ParentReference { - id?: string | undefined; - isRoot?: boolean | undefined; - kind?: string | undefined; - parentLink?: string | undefined; - selfLink?: string | undefined; - } - interface Permission { - additionalRoles?: string[] | undefined; - authKey?: string | undefined; - deleted?: boolean | undefined; - domain?: string | undefined; - emailAddress?: string | undefined; - etag?: string | undefined; - expirationDate?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - permissionDetails?: Drive.Schema.PermissionPermissionDetails[] | undefined; - photoLink?: string | undefined; - role?: "owner" | "organizer" | "fileOrganizer" | "writer" | "reader" | undefined; - selfLink?: string | undefined; - teamDrivePermissionDetails?: Drive.Schema.PermissionTeamDrivePermissionDetails[] | undefined; - type?: string | undefined; - value?: string | undefined; - withLink?: boolean | undefined; - } - interface PermissionId { - id?: string | undefined; - kind?: string | undefined; - } - interface PermissionList { - etag?: string | undefined; - items?: Drive.Schema.Permission[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface PermissionPermissionDetails { - additionalRoles?: string[] | undefined; - inherited?: boolean | undefined; - inheritedFrom?: string | undefined; - permissionType?: string | undefined; - role?: "organizer" | "fileOrganizer" | "writer" | "reader" | undefined; - } - interface PermissionTeamDrivePermissionDetails { - additionalRoles?: string[] | undefined; - inherited?: boolean | undefined; - inheritedFrom?: string | undefined; - role?: string | undefined; - teamDrivePermissionType?: string | undefined; - } - interface Property { - etag?: string | undefined; - key?: string | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - value?: string | undefined; - visibility?: string | undefined; - } - interface PropertyList { - etag?: string | undefined; - items?: Drive.Schema.Property[] | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - } - interface Revision { - downloadUrl?: string | undefined; - etag?: string | undefined; - exportLinks?: object | undefined; - fileSize?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - lastModifyingUser?: Drive.Schema.User | undefined; - lastModifyingUserName?: string | undefined; - md5Checksum?: string | undefined; - mimeType?: string | undefined; - modifiedDate?: string | undefined; - originalFilename?: string | undefined; - pinned?: boolean | undefined; - publishAuto?: boolean | undefined; - published?: boolean | undefined; - publishedLink?: string | undefined; - publishedOutsideDomain?: boolean | undefined; - selfLink?: string | undefined; - } - interface RevisionList { - etag?: string | undefined; - items?: Drive.Schema.Revision[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - selfLink?: string | undefined; - } - interface ShortcutDetails { - targetId?: string | undefined; - targetMimeType?: string | undefined; - } - interface StartPageToken { - kind?: string | undefined; - startPageToken?: string | undefined; - } - interface TeamDrive { - backgroundImageFile?: Drive.Schema.TeamDriveBackgroundImageFile | undefined; - backgroundImageLink?: string | undefined; - capabilities?: Drive.Schema.TeamDriveCapabilities | undefined; - colorRgb?: string | undefined; - createdDate?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - restrictions?: Drive.Schema.TeamDriveRestrictions | undefined; - themeId?: string | undefined; - } - interface TeamDriveBackgroundImageFile { - id?: string | undefined; - width?: number | undefined; - xCoordinate?: number | undefined; - yCoordinate?: number | undefined; - } - interface TeamDriveCapabilities { - canAddChildren?: boolean | undefined; - canChangeCopyRequiresWriterPermissionRestriction?: boolean | undefined; - canChangeDomainUsersOnlyRestriction?: boolean | undefined; - canChangeTeamDriveBackground?: boolean | undefined; - canChangeTeamMembersOnlyRestriction?: boolean | undefined; - canComment?: boolean | undefined; - canCopy?: boolean | undefined; - canDeleteChildren?: boolean | undefined; - canDeleteTeamDrive?: boolean | undefined; - canDownload?: boolean | undefined; - canEdit?: boolean | undefined; - canListChildren?: boolean | undefined; - canManageMembers?: boolean | undefined; - canReadRevisions?: boolean | undefined; - canRemoveChildren?: boolean | undefined; - canRename?: boolean | undefined; - canRenameTeamDrive?: boolean | undefined; - canShare?: boolean | undefined; - canTrashChildren?: boolean | undefined; - } - interface TeamDriveList { - items?: Drive.Schema.TeamDrive[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface TeamDriveRestrictions { - adminManagedRestrictions?: boolean | undefined; - copyRequiresWriterPermission?: boolean | undefined; - domainUsersOnly?: boolean | undefined; - teamMembersOnly?: boolean | undefined; - } - interface User { - displayName?: string | undefined; - emailAddress?: string | undefined; - isAuthenticatedUser?: boolean | undefined; - kind?: string | undefined; - permissionId?: string | undefined; - picture?: Drive.Schema.UserPicture | undefined; - } - interface UserPicture { - url?: string | undefined; - } - } - } - interface Drive { - About?: Drive.Collection.AboutCollection | undefined; - Apps?: Drive.Collection.AppsCollection | undefined; - Changes?: Drive.Collection.ChangesCollection | undefined; - Channels?: Drive.Collection.ChannelsCollection | undefined; - Children?: Drive.Collection.ChildrenCollection | undefined; - Comments?: Drive.Collection.CommentsCollection | undefined; - Drives?: Drive.Collection.DrivesCollection | undefined; - Files?: Drive.Collection.FilesCollection | undefined; - Parents?: Drive.Collection.ParentsCollection | undefined; - Permissions?: Drive.Collection.PermissionsCollection | undefined; - Properties?: Drive.Collection.PropertiesCollection | undefined; - Realtime?: Drive.Collection.RealtimeCollection | undefined; - Replies?: Drive.Collection.RepliesCollection | undefined; - Revisions?: Drive.Collection.RevisionsCollection | undefined; - Teamdrives?: Drive.Collection.TeamdrivesCollection | undefined; - // Create a new instance of Channel - newChannel(): Drive.Schema.Channel; - // Create a new instance of ChildReference - newChildReference(): Drive.Schema.ChildReference; - // Create a new instance of Comment - newComment(): Drive.Schema.Comment; - // Create a new instance of CommentContext - newCommentContext(): Drive.Schema.CommentContext; - // Create a new instance of CommentReply - newCommentReply(): Drive.Schema.CommentReply; - // Create a new instance of Drive - newDrive(): Drive.Schema.Drive; - // Create a new instance of DriveBackgroundImageFile - newDriveBackgroundImageFile(): Drive.Schema.DriveBackgroundImageFile; - // Create a new instance of DriveCapabilities - newDriveCapabilities(): Drive.Schema.DriveCapabilities; - // Create a new instance of DriveRestrictions - newDriveRestrictions(): Drive.Schema.DriveRestrictions; - // Create a new instance of File - newFile(): Drive.Schema.File; - // Create a new instance of FileCapabilities - newFileCapabilities(): Drive.Schema.FileCapabilities; - // Create a new instance of FileImageMediaMetadata - newFileImageMediaMetadata(): Drive.Schema.FileImageMediaMetadata; - // Create a new instance of FileImageMediaMetadataLocation - newFileImageMediaMetadataLocation(): Drive.Schema.FileImageMediaMetadataLocation; - // Create a new instance of FileIndexableText - newFileIndexableText(): Drive.Schema.FileIndexableText; - // Create a new instance of FileLabels - newFileLabels(): Drive.Schema.FileLabels; - // Create a new instance of FileThumbnail - newFileThumbnail(): Drive.Schema.FileThumbnail; - // Create a new instance of FileVideoMediaMetadata - newFileVideoMediaMetadata(): Drive.Schema.FileVideoMediaMetadata; - // Create a new instance of ParentReference - newParentReference(): Drive.Schema.ParentReference; - // Create a new instance of Permission - newPermission(): Drive.Schema.Permission; - // Create a new instance of PermissionPermissionDetails - newPermissionPermissionDetails(): Drive.Schema.PermissionPermissionDetails; - // Create a new instance of PermissionTeamDrivePermissionDetails - newPermissionTeamDrivePermissionDetails(): Drive.Schema.PermissionTeamDrivePermissionDetails; - // Create a new instance of Property - newProperty(): Drive.Schema.Property; - // Create a new instance of Revision - newRevision(): Drive.Schema.Revision; - // Create a new instance of TeamDrive - newTeamDrive(): Drive.Schema.TeamDrive; - // Create a new instance of TeamDriveBackgroundImageFile - newTeamDriveBackgroundImageFile(): Drive.Schema.TeamDriveBackgroundImageFile; - // Create a new instance of TeamDriveCapabilities - newTeamDriveCapabilities(): Drive.Schema.TeamDriveCapabilities; - // Create a new instance of TeamDriveRestrictions - newTeamDriveRestrictions(): Drive.Schema.TeamDriveRestrictions; - // Create a new instance of User - newUser(): Drive.Schema.User; - // Create a new instance of UserPicture - newUserPicture(): Drive.Schema.UserPicture; - } -} - -declare var Drive: GoogleAppsScript.Drive; diff --git a/node_modules/@types/google-apps-script/apis/driveactivity_v2.d.ts b/node_modules/@types/google-apps-script/apis/driveactivity_v2.d.ts deleted file mode 100644 index 2c8b0cb..0000000 --- a/node_modules/@types/google-apps-script/apis/driveactivity_v2.d.ts +++ /dev/null @@ -1,219 +0,0 @@ -declare namespace GoogleAppsScript { - namespace DriveActivity { - namespace Collection { - interface ActivityCollection { - // Query past activity in Google Drive. - query(resource: Schema.QueryDriveActivityRequest): DriveActivity.Schema.QueryDriveActivityResponse; - } - } - namespace Schema { - interface Action { - actor?: DriveActivity.Schema.Actor | undefined; - detail?: DriveActivity.Schema.ActionDetail | undefined; - target?: DriveActivity.Schema.Target | undefined; - timeRange?: DriveActivity.Schema.TimeRange | undefined; - timestamp?: string | undefined; - } - interface ActionDetail { - comment?: DriveActivity.Schema.Comment | undefined; - create?: DriveActivity.Schema.Create | undefined; - delete?: DriveActivity.Schema.Delete | undefined; - dlpChange?: DriveActivity.Schema.DataLeakPreventionChange | undefined; - edit?: any; - move?: DriveActivity.Schema.Move | undefined; - permissionChange?: DriveActivity.Schema.PermissionChange | undefined; - reference?: DriveActivity.Schema.ApplicationReference | undefined; - rename?: DriveActivity.Schema.Rename | undefined; - restore?: DriveActivity.Schema.Restore | undefined; - settingsChange?: DriveActivity.Schema.SettingsChange | undefined; - } - interface Actor { - administrator?: string | undefined; - anonymous?: string | undefined; - impersonation?: DriveActivity.Schema.Impersonation | undefined; - system?: DriveActivity.Schema.SystemEvent | undefined; - user?: DriveActivity.Schema.User | undefined; - } - interface ApplicationReference { - type?: string | undefined; - } - interface Assignment { - subtype?: string | undefined; - } - interface Comment { - assignment?: DriveActivity.Schema.Assignment | undefined; - mentionedUsers?: DriveActivity.Schema.User[] | undefined; - post?: DriveActivity.Schema.Post | undefined; - suggestion?: DriveActivity.Schema.Suggestion | undefined; - } - interface ConsolidationStrategy { - legacy?: any; - none?: any; - } - interface Copy { - originalObject?: DriveActivity.Schema.TargetReference | undefined; - } - interface Create { - copy?: DriveActivity.Schema.Copy | undefined; - new?: any; - upload?: any; - } - interface DataLeakPreventionChange { - type?: string | undefined; - } - interface Delete { - type?: string | undefined; - } - interface Domain { - legacyId?: string | undefined; - name?: string | undefined; - } - interface DriveActivity { - actions?: DriveActivity.Schema.Action[] | undefined; - actors?: DriveActivity.Schema.Actor[] | undefined; - primaryActionDetail?: DriveActivity.Schema.ActionDetail | undefined; - targets?: DriveActivity.Schema.Target[] | undefined; - timeRange?: DriveActivity.Schema.TimeRange | undefined; - timestamp?: string | undefined; - } - interface DriveItem { - /** @deprecated Use driveFile instead. */ - file?: any; - /** @deprecated Use driveFolder instead. */ - folder?: DriveActivity.Schema.Folder | undefined; - mimeType?: string | undefined; - name?: string | undefined; - owner?: DriveActivity.Schema.Owner | undefined; - title?: string | undefined; - driveFile?: any; - driveFolder?: DriveActivity.Schema.Folder; - } - interface DriveItemReference { - // file is deprecated; please use the driveFile instead. - file?: any; - // folder is deprecated; please use the driveFolder instead. - folder?: DriveActivity.Schema.Folder | undefined; - name?: string | undefined; - title?: string | undefined; - driveFile?: any; - driveFolder?: DriveActivity.Schema.Folder; - } - interface FileComment { - legacyCommentId?: string | undefined; - legacyDiscussionId?: string | undefined; - linkToDiscussion?: string | undefined; - parent?: DriveActivity.Schema.DriveItem | undefined; - } - interface Folder { - type?: string | undefined; - } - interface Group { - email?: string | undefined; - title?: string | undefined; - } - interface Impersonation { - impersonatedUser?: DriveActivity.Schema.User | undefined; - } - interface KnownUser { - isCurrentUser?: boolean | undefined; - personName?: string | undefined; - } - interface Move { - addedParents?: DriveActivity.Schema.TargetReference[] | undefined; - removedParents?: DriveActivity.Schema.TargetReference[] | undefined; - } - interface Owner { - domain?: DriveActivity.Schema.Domain | undefined; - teamDrive?: DriveActivity.Schema.TeamDriveReference | undefined; - user?: DriveActivity.Schema.User | undefined; - } - interface Permission { - allowDiscovery?: boolean | undefined; - anyone?: any; - domain?: DriveActivity.Schema.Domain | undefined; - group?: DriveActivity.Schema.Group | undefined; - role?: string | undefined; - user?: DriveActivity.Schema.User | undefined; - } - interface PermissionChange { - addedPermissions?: DriveActivity.Schema.Permission[] | undefined; - removedPermissions?: DriveActivity.Schema.Permission[] | undefined; - } - interface Post { - subtype?: string | undefined; - } - interface QueryDriveActivityRequest { - ancestorName?: string | undefined; - consolidationStrategy?: DriveActivity.Schema.ConsolidationStrategy | undefined; - filter?: string | undefined; - itemName?: string | undefined; - pageSize?: number | undefined; - pageToken?: string | undefined; - } - interface QueryDriveActivityResponse { - activities?: DriveActivity.Schema.DriveActivity[] | undefined; - nextPageToken?: string | undefined; - } - interface Rename { - newTitle?: string | undefined; - oldTitle?: string | undefined; - } - interface Restore { - type?: string | undefined; - } - interface RestrictionChange { - feature?: string | undefined; - newRestriction?: string | undefined; - } - interface SettingsChange { - restrictionChanges?: DriveActivity.Schema.RestrictionChange[] | undefined; - } - interface Suggestion { - subtype?: string | undefined; - } - interface SystemEvent { - type?: string | undefined; - } - interface Target { - driveItem?: DriveActivity.Schema.DriveItem | undefined; - fileComment?: any; - teamDrive?: DriveActivity.Schema.TeamDrive | undefined; - } - interface TargetReference { - driveItem?: DriveActivity.Schema.DriveItemReference | undefined; - teamDrive?: DriveActivity.Schema.TeamDriveReference | undefined; - } - interface TeamDrive { - name?: string | undefined; - root?: DriveActivity.Schema.DriveItem | undefined; - title?: string | undefined; - } - interface TeamDriveReference { - name?: string | undefined; - title?: string | undefined; - } - interface TimeRange { - endTime?: string | undefined; - startTime?: string | undefined; - } - interface User { - deletedUser?: any; - knownUser?: DriveActivity.Schema.KnownUser | undefined; - unknownUser?: any; - } - } - } - interface DriveActivity { - Activity?: DriveActivity.Collection.ActivityCollection | undefined; - // Create a new instance of ConsolidationStrategy - newConsolidationStrategy(): DriveActivity.Schema.ConsolidationStrategy; - // Create a new instance of Legacy - newLegacy(): any; - // Create a new instance of NoConsolidation - newNoConsolidation(): any; - // Create a new instance of QueryDriveActivityRequest - newQueryDriveActivityRequest(): DriveActivity.Schema.QueryDriveActivityRequest; - } -} - -declare var DriveActivity: GoogleAppsScript.DriveActivity; diff --git a/node_modules/@types/google-apps-script/apis/gmail_v1.d.ts b/node_modules/@types/google-apps-script/apis/gmail_v1.d.ts deleted file mode 100644 index 87c7696..0000000 --- a/node_modules/@types/google-apps-script/apis/gmail_v1.d.ts +++ /dev/null @@ -1,526 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Gmail { - namespace Collection { - namespace Users { - namespace Messages { - interface AttachmentsCollection { - // Gets the specified message attachment. - get(userId: string, messageId: string, id: string): Gmail.Schema.MessagePartBody; - } - } - namespace Settings { - namespace SendAs { - interface SmimeInfoCollection { - // Gets the specified S/MIME config for the specified send-as alias. - get(userId: string, sendAsEmail: string, id: string): Gmail.Schema.SmimeInfo; - // Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. - insert( - resource: Schema.SmimeInfo, - userId: string, - sendAsEmail: string, - ): Gmail.Schema.SmimeInfo; - // Lists S/MIME configs for the specified send-as alias. - list(userId: string, sendAsEmail: string): Gmail.Schema.ListSmimeInfoResponse; - // Deletes the specified S/MIME config for the specified send-as alias. - remove(userId: string, sendAsEmail: string, id: string): void; - // Sets the default S/MIME config for the specified send-as alias. - setDefault(userId: string, sendAsEmail: string, id: string): void; - } - } - interface DelegatesCollection { - // Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. - // Gmail imposes limtations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. - // Note that a delegate user must be referred to by their primary email address, and not an email alias. - // Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. - // This method is only available to service account clients that have been delegated domain-wide authority. - create(resource: Schema.Delegate, userId: string): Gmail.Schema.Delegate; - // Gets the specified delegate. - // Note that a delegate user must be referred to by their primary email address, and not an email alias. - // This method is only available to service account clients that have been delegated domain-wide authority. - get(userId: string, delegateEmail: string): Gmail.Schema.Delegate; - // Lists the delegates for the specified account. - // This method is only available to service account clients that have been delegated domain-wide authority. - list(userId: string): Gmail.Schema.ListDelegatesResponse; - // Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. - // Note that a delegate user must be referred to by their primary email address, and not an email alias. - // This method is only available to service account clients that have been delegated domain-wide authority. - remove(userId: string, delegateEmail: string): void; - } - interface FiltersCollection { - // Creates a filter. - create(resource: Schema.Filter, userId: string): Gmail.Schema.Filter; - // Gets a filter. - get(userId: string, id: string): Gmail.Schema.Filter; - // Lists the message filters of a Gmail user. - list(userId: string): Gmail.Schema.ListFiltersResponse; - // Deletes a filter. - remove(userId: string, id: string): void; - } - interface ForwardingAddressesCollection { - // Creates a forwarding address. If ownership verification is required, a message will be sent to the recipient and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. - // This method is only available to service account clients that have been delegated domain-wide authority. - create(resource: Schema.ForwardingAddress, userId: string): Gmail.Schema.ForwardingAddress; - // Gets the specified forwarding address. - get(userId: string, forwardingEmail: string): Gmail.Schema.ForwardingAddress; - // Lists the forwarding addresses for the specified account. - list(userId: string): Gmail.Schema.ListForwardingAddressesResponse; - // Deletes the specified forwarding address and revokes any verification that may have been required. - // This method is only available to service account clients that have been delegated domain-wide authority. - remove(userId: string, forwardingEmail: string): void; - } - interface SendAsCollection { - SmimeInfo?: Gmail.Collection.Users.Settings.SendAs.SmimeInfoCollection | undefined; - // Creates a custom "from" send-as alias. If an SMTP MSA is specified, Gmail will attempt to connect to the SMTP service to validate the configuration before creating the alias. If ownership verification is required for the alias, a message will be sent to the email address and the resource's verification status will be set to pending; otherwise, the resource will be created with verification status set to accepted. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. - // This method is only available to service account clients that have been delegated domain-wide authority. - create(resource: Schema.SendAs, userId: string): Gmail.Schema.SendAs; - // Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. - get(userId: string, sendAsEmail: string): Gmail.Schema.SendAs; - // Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. - list(userId: string): Gmail.Schema.ListSendAsResponse; - // Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. - // Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics. - patch(resource: Schema.SendAs, userId: string, sendAsEmail: string): Gmail.Schema.SendAs; - // Deletes the specified send-as alias. Revokes any verification that may have been required for using it. - // This method is only available to service account clients that have been delegated domain-wide authority. - remove(userId: string, sendAsEmail: string): void; - // Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. - // Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. - update(resource: Schema.SendAs, userId: string, sendAsEmail: string): Gmail.Schema.SendAs; - // Sends a verification email to the specified send-as alias address. The verification status must be pending. - // This method is only available to service account clients that have been delegated domain-wide authority. - verify(userId: string, sendAsEmail: string): void; - } - } - interface DraftsCollection { - // Creates a new draft with the DRAFT label. - create(resource: Schema.Draft, userId: string): Gmail.Schema.Draft; - // Creates a new draft with the DRAFT label. - create(resource: Schema.Draft, userId: string, mediaData: any): Gmail.Schema.Draft; - // Gets the specified draft. - get(userId: string, id: string): Gmail.Schema.Draft; - // Gets the specified draft. - get(userId: string, id: string, optionalArgs: object): Gmail.Schema.Draft; - // Lists the drafts in the user's mailbox. - list(userId: string): Gmail.Schema.ListDraftsResponse; - // Lists the drafts in the user's mailbox. - list(userId: string, optionalArgs: object): Gmail.Schema.ListDraftsResponse; - // Immediately and permanently deletes the specified draft. Does not simply trash it. - remove(userId: string, id: string): void; - // Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. - send(resource: Schema.Draft, userId: string): Gmail.Schema.Message; - // Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. - send(resource: Schema.Draft, userId: string, mediaData: any): Gmail.Schema.Message; - // Replaces a draft's content. - update(resource: Schema.Draft, userId: string, id: string): Gmail.Schema.Draft; - // Replaces a draft's content. - update(resource: Schema.Draft, userId: string, id: string, mediaData: any): Gmail.Schema.Draft; - } - interface HistoryCollection { - // Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). - list(userId: string): Gmail.Schema.ListHistoryResponse; - // Lists the history of all changes to the given mailbox. History results are returned in chronological order (increasing historyId). - list(userId: string, optionalArgs: object): Gmail.Schema.ListHistoryResponse; - } - interface LabelsCollection { - // Creates a new label. - create(resource: Schema.Label, userId: string): Gmail.Schema.Label; - // Gets the specified label. - get(userId: string, id: string): Gmail.Schema.Label; - // Lists all labels in the user's mailbox. - list(userId: string): Gmail.Schema.ListLabelsResponse; - // Updates the specified label. This method supports patch semantics. - patch(resource: Schema.Label, userId: string, id: string): Gmail.Schema.Label; - // Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. - remove(userId: string, id: string): void; - // Updates the specified label. - update(resource: Schema.Label, userId: string, id: string): Gmail.Schema.Label; - } - interface MessagesCollection { - Attachments?: Gmail.Collection.Users.Messages.AttachmentsCollection | undefined; - // Deletes many messages by message ID. Provides no guarantees that messages were not already deleted or even existed at all. - batchDelete(resource: Schema.BatchDeleteMessagesRequest, userId: string): void; - // Modifies the labels on the specified messages. - batchModify(resource: Schema.BatchModifyMessagesRequest, userId: string): void; - // Gets the specified message. - get(userId: string, id: string): Gmail.Schema.Message; - // Gets the specified message. - get(userId: string, id: string, optionalArgs: object): Gmail.Schema.Message; - // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. - import(resource: Schema.Message, userId: string): Gmail.Schema.Message; - // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. - import(resource: Schema.Message, userId: string, mediaData: any): Gmail.Schema.Message; - // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. - import( - resource: Schema.Message, - userId: string, - mediaData: any, - optionalArgs: object, - ): Gmail.Schema.Message; - // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. - insert(resource: Schema.Message, userId: string): Gmail.Schema.Message; - // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. - insert(resource: Schema.Message, userId: string, mediaData: any): Gmail.Schema.Message; - // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. - insert( - resource: Schema.Message, - userId: string, - mediaData: any, - optionalArgs: object, - ): Gmail.Schema.Message; - // Lists the messages in the user's mailbox. - list(userId: string): Gmail.Schema.ListMessagesResponse; - // Lists the messages in the user's mailbox. - list(userId: string, optionalArgs: object): Gmail.Schema.ListMessagesResponse; - // Modifies the labels on the specified message. - modify(resource: Schema.ModifyMessageRequest, userId: string, id: string): Gmail.Schema.Message; - // Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. - remove(userId: string, id: string): void; - // Sends the specified message to the recipients in the To, Cc, and Bcc headers. - send(resource: Schema.Message, userId: string): Gmail.Schema.Message; - // Sends the specified message to the recipients in the To, Cc, and Bcc headers. - send(resource: Schema.Message, userId: string, mediaData: any): Gmail.Schema.Message; - // Moves the specified message to the trash. - trash(userId: string, id: string): Gmail.Schema.Message; - // Removes the specified message from the trash. - untrash(userId: string, id: string): Gmail.Schema.Message; - } - interface SettingsCollection { - Delegates?: Gmail.Collection.Users.Settings.DelegatesCollection | undefined; - Filters?: Gmail.Collection.Users.Settings.FiltersCollection | undefined; - ForwardingAddresses?: Gmail.Collection.Users.Settings.ForwardingAddressesCollection | undefined; - SendAs?: Gmail.Collection.Users.Settings.SendAsCollection | undefined; - // Gets the auto-forwarding setting for the specified account. - getAutoForwarding(userId: string): Gmail.Schema.AutoForwarding; - // Gets IMAP settings. - getImap(userId: string): Gmail.Schema.ImapSettings; - // Gets POP settings. - getPop(userId: string): Gmail.Schema.PopSettings; - // Gets vacation responder settings. - getVacation(userId: string): Gmail.Schema.VacationSettings; - // Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. - // This method is only available to service account clients that have been delegated domain-wide authority. - updateAutoForwarding(resource: Schema.AutoForwarding, userId: string): Gmail.Schema.AutoForwarding; - // Updates IMAP settings. - updateImap(resource: Schema.ImapSettings, userId: string): Gmail.Schema.ImapSettings; - // Updates POP settings. - updatePop(resource: Schema.PopSettings, userId: string): Gmail.Schema.PopSettings; - // Updates vacation responder settings. - updateVacation(resource: Schema.VacationSettings, userId: string): Gmail.Schema.VacationSettings; - } - interface ThreadsCollection { - // Gets the specified thread. - get(userId: string, id: string): Gmail.Schema.Thread; - // Gets the specified thread. - get(userId: string, id: string, optionalArgs: object): Gmail.Schema.Thread; - // Lists the threads in the user's mailbox. - list(userId: string): Gmail.Schema.ListThreadsResponse; - // Lists the threads in the user's mailbox. - list(userId: string, optionalArgs: object): Gmail.Schema.ListThreadsResponse; - // Modifies the labels applied to the thread. This applies to all messages in the thread. - modify(resource: Schema.ModifyThreadRequest, userId: string, id: string): Gmail.Schema.Thread; - // Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. - remove(userId: string, id: string): void; - // Moves the specified thread to the trash. - trash(userId: string, id: string): Gmail.Schema.Thread; - // Removes the specified thread from the trash. - untrash(userId: string, id: string): Gmail.Schema.Thread; - } - } - interface UsersCollection { - Drafts?: Gmail.Collection.Users.DraftsCollection | undefined; - History?: Gmail.Collection.Users.HistoryCollection | undefined; - Labels?: Gmail.Collection.Users.LabelsCollection | undefined; - Messages?: Gmail.Collection.Users.MessagesCollection | undefined; - Settings?: Gmail.Collection.Users.SettingsCollection | undefined; - Threads?: Gmail.Collection.Users.ThreadsCollection | undefined; - // Gets the current user's Gmail profile. - getProfile(userId: string): Gmail.Schema.Profile; - // Stop receiving push notifications for the given user mailbox. - stop(userId: string): void; - // Set up or update a push notification watch on the given user mailbox. - watch(resource: Schema.WatchRequest, userId: string): Gmail.Schema.WatchResponse; - } - } - namespace Schema { - interface AutoForwarding { - disposition?: string | undefined; - emailAddress?: string | undefined; - enabled?: boolean | undefined; - } - interface BatchDeleteMessagesRequest { - ids?: string[] | undefined; - } - interface BatchModifyMessagesRequest { - addLabelIds?: string[] | undefined; - ids?: string[] | undefined; - removeLabelIds?: string[] | undefined; - } - interface Delegate { - delegateEmail?: string | undefined; - verificationStatus?: string | undefined; - } - interface Draft { - id?: string | undefined; - message?: Gmail.Schema.Message | undefined; - } - interface Filter { - action?: Gmail.Schema.FilterAction | undefined; - criteria?: Gmail.Schema.FilterCriteria | undefined; - id?: string | undefined; - } - interface FilterAction { - addLabelIds?: string[] | undefined; - forward?: string | undefined; - removeLabelIds?: string[] | undefined; - } - interface FilterCriteria { - excludeChats?: boolean | undefined; - from?: string | undefined; - hasAttachment?: boolean | undefined; - negatedQuery?: string | undefined; - query?: string | undefined; - size?: number | undefined; - sizeComparison?: string | undefined; - subject?: string | undefined; - to?: string | undefined; - } - interface ForwardingAddress { - forwardingEmail?: string | undefined; - verificationStatus?: string | undefined; - } - interface History { - id?: string | undefined; - labelsAdded?: Gmail.Schema.HistoryLabelAdded[] | undefined; - labelsRemoved?: Gmail.Schema.HistoryLabelRemoved[] | undefined; - messages?: Gmail.Schema.Message[] | undefined; - messagesAdded?: Gmail.Schema.HistoryMessageAdded[] | undefined; - messagesDeleted?: Gmail.Schema.HistoryMessageDeleted[] | undefined; - } - interface HistoryLabelAdded { - labelIds?: string[] | undefined; - message?: Gmail.Schema.Message | undefined; - } - interface HistoryLabelRemoved { - labelIds?: string[] | undefined; - message?: Gmail.Schema.Message | undefined; - } - interface HistoryMessageAdded { - message?: Gmail.Schema.Message | undefined; - } - interface HistoryMessageDeleted { - message?: Gmail.Schema.Message | undefined; - } - interface ImapSettings { - autoExpunge?: boolean | undefined; - enabled?: boolean | undefined; - expungeBehavior?: string | undefined; - maxFolderSize?: number | undefined; - } - interface Label { - color?: Gmail.Schema.LabelColor | undefined; - id?: string | undefined; - labelListVisibility?: string | undefined; - messageListVisibility?: string | undefined; - messagesTotal?: number | undefined; - messagesUnread?: number | undefined; - name?: string | undefined; - threadsTotal?: number | undefined; - threadsUnread?: number | undefined; - type?: string | undefined; - } - interface LabelColor { - backgroundColor?: string | undefined; - textColor?: string | undefined; - } - interface ListDelegatesResponse { - delegates?: Gmail.Schema.Delegate[] | undefined; - } - interface ListDraftsResponse { - drafts?: Gmail.Schema.Draft[] | undefined; - nextPageToken?: string | undefined; - resultSizeEstimate?: number | undefined; - } - interface ListFiltersResponse { - filter?: Gmail.Schema.Filter[] | undefined; - } - interface ListForwardingAddressesResponse { - forwardingAddresses?: Gmail.Schema.ForwardingAddress[] | undefined; - } - interface ListHistoryResponse { - history?: Gmail.Schema.History[] | undefined; - historyId?: string | undefined; - nextPageToken?: string | undefined; - } - interface ListLabelsResponse { - labels?: Gmail.Schema.Label[] | undefined; - } - interface ListMessagesResponse { - messages?: Gmail.Schema.Message[] | undefined; - nextPageToken?: string | undefined; - resultSizeEstimate?: number | undefined; - } - interface ListSendAsResponse { - sendAs?: Gmail.Schema.SendAs[] | undefined; - } - interface ListSmimeInfoResponse { - smimeInfo?: Gmail.Schema.SmimeInfo[] | undefined; - } - interface ListThreadsResponse { - nextPageToken?: string | undefined; - resultSizeEstimate?: number | undefined; - threads?: Gmail.Schema.Thread[] | undefined; - } - interface Message { - historyId?: string | undefined; - id?: string | undefined; - internalDate?: string | undefined; - labelIds?: string[] | undefined; - payload?: Gmail.Schema.MessagePart | undefined; - raw?: string | undefined; - sizeEstimate?: number | undefined; - snippet?: string | undefined; - threadId?: string | undefined; - } - interface MessagePart { - body?: Gmail.Schema.MessagePartBody | undefined; - filename?: string | undefined; - headers?: Gmail.Schema.MessagePartHeader[] | undefined; - mimeType?: string | undefined; - partId?: string | undefined; - parts?: Gmail.Schema.MessagePart[] | undefined; - } - interface MessagePartBody { - attachmentId?: string | undefined; - data?: string | undefined; - size?: number | undefined; - } - interface MessagePartHeader { - name?: string | undefined; - value?: string | undefined; - } - interface ModifyMessageRequest { - addLabelIds?: string[] | undefined; - removeLabelIds?: string[] | undefined; - } - interface ModifyThreadRequest { - addLabelIds?: string[] | undefined; - removeLabelIds?: string[] | undefined; - } - interface PopSettings { - accessWindow?: string | undefined; - disposition?: string | undefined; - } - interface Profile { - emailAddress?: string | undefined; - historyId?: string | undefined; - messagesTotal?: number | undefined; - threadsTotal?: number | undefined; - } - interface SendAs { - displayName?: string | undefined; - isDefault?: boolean | undefined; - isPrimary?: boolean | undefined; - replyToAddress?: string | undefined; - sendAsEmail?: string | undefined; - signature?: string | undefined; - smtpMsa?: Gmail.Schema.SmtpMsa | undefined; - treatAsAlias?: boolean | undefined; - verificationStatus?: string | undefined; - } - interface SmimeInfo { - encryptedKeyPassword?: string | undefined; - expiration?: string | undefined; - id?: string | undefined; - isDefault?: boolean | undefined; - issuerCn?: string | undefined; - pem?: string | undefined; - pkcs12?: string | undefined; - } - interface SmtpMsa { - host?: string | undefined; - password?: string | undefined; - port?: number | undefined; - securityMode?: string | undefined; - username?: string | undefined; - } - interface Thread { - historyId?: string | undefined; - id?: string | undefined; - messages?: Gmail.Schema.Message[] | undefined; - snippet?: string | undefined; - } - interface VacationSettings { - enableAutoReply?: boolean | undefined; - endTime?: string | undefined; - responseBodyHtml?: string | undefined; - responseBodyPlainText?: string | undefined; - responseSubject?: string | undefined; - restrictToContacts?: boolean | undefined; - restrictToDomain?: boolean | undefined; - startTime?: string | undefined; - } - interface WatchRequest { - labelFilterAction?: string | undefined; - labelIds?: string[] | undefined; - topicName?: string | undefined; - } - interface WatchResponse { - expiration?: string | undefined; - historyId?: string | undefined; - } - } - } - interface Gmail { - Users?: Gmail.Collection.UsersCollection | undefined; - // Create a new instance of AutoForwarding - newAutoForwarding(): Gmail.Schema.AutoForwarding; - // Create a new instance of BatchDeleteMessagesRequest - newBatchDeleteMessagesRequest(): Gmail.Schema.BatchDeleteMessagesRequest; - // Create a new instance of BatchModifyMessagesRequest - newBatchModifyMessagesRequest(): Gmail.Schema.BatchModifyMessagesRequest; - // Create a new instance of Delegate - newDelegate(): Gmail.Schema.Delegate; - // Create a new instance of Draft - newDraft(): Gmail.Schema.Draft; - // Create a new instance of Filter - newFilter(): Gmail.Schema.Filter; - // Create a new instance of FilterAction - newFilterAction(): Gmail.Schema.FilterAction; - // Create a new instance of FilterCriteria - newFilterCriteria(): Gmail.Schema.FilterCriteria; - // Create a new instance of ForwardingAddress - newForwardingAddress(): Gmail.Schema.ForwardingAddress; - // Create a new instance of ImapSettings - newImapSettings(): Gmail.Schema.ImapSettings; - // Create a new instance of Label - newLabel(): Gmail.Schema.Label; - // Create a new instance of LabelColor - newLabelColor(): Gmail.Schema.LabelColor; - // Create a new instance of Message - newMessage(): Gmail.Schema.Message; - // Create a new instance of MessagePart - newMessagePart(): Gmail.Schema.MessagePart; - // Create a new instance of MessagePartBody - newMessagePartBody(): Gmail.Schema.MessagePartBody; - // Create a new instance of MessagePartHeader - newMessagePartHeader(): Gmail.Schema.MessagePartHeader; - // Create a new instance of ModifyMessageRequest - newModifyMessageRequest(): Gmail.Schema.ModifyMessageRequest; - // Create a new instance of ModifyThreadRequest - newModifyThreadRequest(): Gmail.Schema.ModifyThreadRequest; - // Create a new instance of PopSettings - newPopSettings(): Gmail.Schema.PopSettings; - // Create a new instance of SendAs - newSendAs(): Gmail.Schema.SendAs; - // Create a new instance of SmimeInfo - newSmimeInfo(): Gmail.Schema.SmimeInfo; - // Create a new instance of SmtpMsa - newSmtpMsa(): Gmail.Schema.SmtpMsa; - // Create a new instance of VacationSettings - newVacationSettings(): Gmail.Schema.VacationSettings; - // Create a new instance of WatchRequest - newWatchRequest(): Gmail.Schema.WatchRequest; - } -} - -declare var Gmail: GoogleAppsScript.Gmail; diff --git a/node_modules/@types/google-apps-script/apis/groupsmigration_v1.d.ts b/node_modules/@types/google-apps-script/apis/groupsmigration_v1.d.ts deleted file mode 100644 index 5be73c9..0000000 --- a/node_modules/@types/google-apps-script/apis/groupsmigration_v1.d.ts +++ /dev/null @@ -1,23 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminGroupsMigration { - namespace Collection { - interface ArchiveCollection { - // Inserts a new mail into the archive of the Google group. - insert(groupId: string): AdminGroupsMigration.Schema.Groups; - // Inserts a new mail into the archive of the Google group. - insert(groupId: string, mediaData: any): AdminGroupsMigration.Schema.Groups; - } - } - namespace Schema { - interface Groups { - kind?: string | undefined; - responseCode?: string | undefined; - } - } - } - interface AdminGroupsMigration { - Archive?: AdminGroupsMigration.Collection.ArchiveCollection | undefined; - } -} - -declare var AdminGroupsMigration: GoogleAppsScript.AdminGroupsMigration; diff --git a/node_modules/@types/google-apps-script/apis/groupssettings_v1.d.ts b/node_modules/@types/google-apps-script/apis/groupssettings_v1.d.ts deleted file mode 100644 index 841d6ca..0000000 --- a/node_modules/@types/google-apps-script/apis/groupssettings_v1.d.ts +++ /dev/null @@ -1,86 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminGroupsSettings { - namespace Collection { - interface GroupsCollection { - // Gets one resource by id. - get(groupUniqueId: string): AdminGroupsSettings.Schema.Groups; - // Updates an existing resource. This method supports patch semantics. - patch(resource: Schema.Groups, groupUniqueId: string): AdminGroupsSettings.Schema.Groups; - // Updates an existing resource. - update(resource: Schema.Groups, groupUniqueId: string): AdminGroupsSettings.Schema.Groups; - } - } - namespace Schema { - interface Groups { - allowExternalMembers?: string | undefined; - allowGoogleCommunication?: string | undefined; - allowWebPosting?: string | undefined; - archiveOnly?: string | undefined; - customFooterText?: string | undefined; - customReplyTo?: string | undefined; - customRolesEnabledForSettingsToBeMerged?: string | undefined; - defaultMessageDenyNotificationText?: string | undefined; - description?: string | undefined; - email?: string | undefined; - enableCollaborativeInbox?: string | undefined; - favoriteRepliesOnTop?: string | undefined; - includeCustomFooter?: string | undefined; - includeInGlobalAddressList?: string | undefined; - isArchived?: string | undefined; - kind?: string | undefined; - maxMessageBytes?: number | undefined; - membersCanPostAsTheGroup?: string | undefined; - messageDisplayFont?: string | undefined; - messageModerationLevel?: string | undefined; - name?: string | undefined; - primaryLanguage?: string | undefined; - replyTo?: string | undefined; - sendMessageDenyNotification?: string | undefined; - showInGroupDirectory?: string | undefined; - spamModerationLevel?: string | undefined; - whoCanAdd?: string | undefined; - whoCanAddReferences?: string | undefined; - whoCanApproveMembers?: string | undefined; - whoCanApproveMessages?: string | undefined; - whoCanAssignTopics?: string | undefined; - whoCanAssistContent?: string | undefined; - whoCanBanUsers?: string | undefined; - whoCanContactOwner?: string | undefined; - whoCanDeleteAnyPost?: string | undefined; - whoCanDeleteTopics?: string | undefined; - whoCanDiscoverGroup?: string | undefined; - whoCanEnterFreeFormTags?: string | undefined; - whoCanHideAbuse?: string | undefined; - whoCanInvite?: string | undefined; - whoCanJoin?: string | undefined; - whoCanLeaveGroup?: string | undefined; - whoCanLockTopics?: string | undefined; - whoCanMakeTopicsSticky?: string | undefined; - whoCanMarkDuplicate?: string | undefined; - whoCanMarkFavoriteReplyOnAnyTopic?: string | undefined; - whoCanMarkFavoriteReplyOnOwnTopic?: string | undefined; - whoCanMarkNoResponseNeeded?: string | undefined; - whoCanModerateContent?: string | undefined; - whoCanModerateMembers?: string | undefined; - whoCanModifyMembers?: string | undefined; - whoCanModifyTagsAndCategories?: string | undefined; - whoCanMoveTopicsIn?: string | undefined; - whoCanMoveTopicsOut?: string | undefined; - whoCanPostAnnouncements?: string | undefined; - whoCanPostMessage?: string | undefined; - whoCanTakeTopics?: string | undefined; - whoCanUnassignTopic?: string | undefined; - whoCanUnmarkFavoriteReplyOnAnyTopic?: string | undefined; - whoCanViewGroup?: string | undefined; - whoCanViewMembership?: string | undefined; - } - } - } - interface AdminGroupsSettings { - Groups?: AdminGroupsSettings.Collection.GroupsCollection | undefined; - // Create a new instance of Groups - newGroups(): AdminGroupsSettings.Schema.Groups; - } -} - -declare var AdminGroupsSettings: GoogleAppsScript.AdminGroupsSettings; diff --git a/node_modules/@types/google-apps-script/apis/licensing_v1.d.ts b/node_modules/@types/google-apps-script/apis/licensing_v1.d.ts deleted file mode 100644 index 4308140..0000000 --- a/node_modules/@types/google-apps-script/apis/licensing_v1.d.ts +++ /dev/null @@ -1,83 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminLicenseManager { - namespace Collection { - interface LicenseAssignmentsCollection { - // Get license assignment of a particular product and sku for a user - get(productId: string, skuId: string, userId: string): AdminLicenseManager.Schema.LicenseAssignment; - // Assign License. - insert( - resource: Schema.LicenseAssignmentInsert, - productId: string, - skuId: string, - ): AdminLicenseManager.Schema.LicenseAssignment; - // List license assignments for given product of the customer. - listForProduct(productId: string, customerId: string): AdminLicenseManager.Schema.LicenseAssignmentList; - // List license assignments for given product of the customer. - listForProduct( - productId: string, - customerId: string, - optionalArgs: object, - ): AdminLicenseManager.Schema.LicenseAssignmentList; - // List license assignments for given product and sku of the customer. - listForProductAndSku( - productId: string, - skuId: string, - customerId: string, - ): AdminLicenseManager.Schema.LicenseAssignmentList; - // List license assignments for given product and sku of the customer. - listForProductAndSku( - productId: string, - skuId: string, - customerId: string, - optionalArgs: object, - ): AdminLicenseManager.Schema.LicenseAssignmentList; - // Assign License. This method supports patch semantics. - patch( - resource: Schema.LicenseAssignment, - productId: string, - skuId: string, - userId: string, - ): AdminLicenseManager.Schema.LicenseAssignment; - // Revoke License. - remove(productId: string, skuId: string, userId: string): void; - // Assign License. - update( - resource: Schema.LicenseAssignment, - productId: string, - skuId: string, - userId: string, - ): AdminLicenseManager.Schema.LicenseAssignment; - } - } - namespace Schema { - interface LicenseAssignment { - etags?: string | undefined; - kind?: string | undefined; - productId?: string | undefined; - productName?: string | undefined; - selfLink?: string | undefined; - skuId?: string | undefined; - skuName?: string | undefined; - userId?: string | undefined; - } - interface LicenseAssignmentInsert { - userId?: string | undefined; - } - interface LicenseAssignmentList { - etag?: string | undefined; - items?: AdminLicenseManager.Schema.LicenseAssignment[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - } - } - interface AdminLicenseManager { - LicenseAssignments?: AdminLicenseManager.Collection.LicenseAssignmentsCollection | undefined; - // Create a new instance of LicenseAssignment - newLicenseAssignment(): AdminLicenseManager.Schema.LicenseAssignment; - // Create a new instance of LicenseAssignmentInsert - newLicenseAssignmentInsert(): AdminLicenseManager.Schema.LicenseAssignmentInsert; - } -} - -declare var AdminLicenseManager: GoogleAppsScript.AdminLicenseManager; diff --git a/node_modules/@types/google-apps-script/apis/mirror_v1.d.ts b/node_modules/@types/google-apps-script/apis/mirror_v1.d.ts deleted file mode 100644 index 3f0f180..0000000 --- a/node_modules/@types/google-apps-script/apis/mirror_v1.d.ts +++ /dev/null @@ -1,265 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Mirror { - namespace Collection { - namespace Timeline { - interface AttachmentsCollection { - // Retrieves an attachment on a timeline item by item ID and attachment ID. - get(itemId: string, attachmentId: string): Mirror.Schema.Attachment; - // Adds a new attachment to a timeline item. - insert(itemId: string): Mirror.Schema.Attachment; - // Adds a new attachment to a timeline item. - insert(itemId: string, mediaData: any): Mirror.Schema.Attachment; - // Returns a list of attachments for a timeline item. - list(itemId: string): Mirror.Schema.AttachmentsListResponse; - // Deletes an attachment from a timeline item. - remove(itemId: string, attachmentId: string): void; - } - } - interface AccountsCollection { - // Inserts a new account for a user - insert( - resource: Schema.Account, - userToken: string, - accountType: string, - accountName: string, - ): Mirror.Schema.Account; - } - interface ContactsCollection { - // Gets a single contact by ID. - get(id: string): Mirror.Schema.Contact; - // Inserts a new contact. - insert(resource: Schema.Contact): Mirror.Schema.Contact; - // Retrieves a list of contacts for the authenticated user. - list(): Mirror.Schema.ContactsListResponse; - // Updates a contact in place. This method supports patch semantics. - patch(resource: Schema.Contact, id: string): Mirror.Schema.Contact; - // Deletes a contact. - remove(id: string): void; - // Updates a contact in place. - update(resource: Schema.Contact, id: string): Mirror.Schema.Contact; - } - interface LocationsCollection { - // Gets a single location by ID. - get(id: string): Mirror.Schema.Location; - // Retrieves a list of locations for the user. - list(): Mirror.Schema.LocationsListResponse; - } - interface SettingsCollection { - // Gets a single setting by ID. - get(id: string): Mirror.Schema.Setting; - } - interface SubscriptionsCollection { - // Creates a new subscription. - insert(resource: Schema.Subscription): Mirror.Schema.Subscription; - // Retrieves a list of subscriptions for the authenticated user and service. - list(): Mirror.Schema.SubscriptionsListResponse; - // Deletes a subscription. - remove(id: string): void; - // Updates an existing subscription in place. - update(resource: Schema.Subscription, id: string): Mirror.Schema.Subscription; - } - interface TimelineCollection { - Attachments?: Mirror.Collection.Timeline.AttachmentsCollection | undefined; - // Gets a single timeline item by ID. - get(id: string): Mirror.Schema.TimelineItem; - // Inserts a new item into the timeline. - insert(resource: Schema.TimelineItem): Mirror.Schema.TimelineItem; - // Inserts a new item into the timeline. - insert(resource: Schema.TimelineItem, mediaData: any): Mirror.Schema.TimelineItem; - // Retrieves a list of timeline items for the authenticated user. - list(): Mirror.Schema.TimelineListResponse; - // Retrieves a list of timeline items for the authenticated user. - list(optionalArgs: object): Mirror.Schema.TimelineListResponse; - // Updates a timeline item in place. This method supports patch semantics. - patch(resource: Schema.TimelineItem, id: string): Mirror.Schema.TimelineItem; - // Deletes a timeline item. - remove(id: string): void; - // Updates a timeline item in place. - update(resource: Schema.TimelineItem, id: string): Mirror.Schema.TimelineItem; - // Updates a timeline item in place. - update(resource: Schema.TimelineItem, id: string, mediaData: any): Mirror.Schema.TimelineItem; - } - } - namespace Schema { - interface Account { - authTokens?: Mirror.Schema.AuthToken[] | undefined; - features?: string[] | undefined; - password?: string | undefined; - userData?: Mirror.Schema.UserData[] | undefined; - } - interface Attachment { - contentType?: string | undefined; - contentUrl?: string | undefined; - id?: string | undefined; - isProcessingContent?: boolean | undefined; - } - interface AttachmentsListResponse { - items?: Mirror.Schema.Attachment[] | undefined; - kind?: string | undefined; - } - interface AuthToken { - authToken?: string | undefined; - type?: string | undefined; - } - interface Command { - type?: string | undefined; - } - interface Contact { - acceptCommands?: Mirror.Schema.Command[] | undefined; - acceptTypes?: string[] | undefined; - displayName?: string | undefined; - id?: string | undefined; - imageUrls?: string[] | undefined; - kind?: string | undefined; - phoneNumber?: string | undefined; - priority?: number | undefined; - sharingFeatures?: string[] | undefined; - source?: string | undefined; - speakableName?: string | undefined; - type?: string | undefined; - } - interface ContactsListResponse { - items?: Mirror.Schema.Contact[] | undefined; - kind?: string | undefined; - } - interface Location { - accuracy?: number | undefined; - address?: string | undefined; - displayName?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - latitude?: number | undefined; - longitude?: number | undefined; - timestamp?: string | undefined; - } - interface LocationsListResponse { - items?: Mirror.Schema.Location[] | undefined; - kind?: string | undefined; - } - interface MenuItem { - action?: string | undefined; - contextual_command?: string | undefined; - id?: string | undefined; - payload?: string | undefined; - removeWhenSelected?: boolean | undefined; - values?: Mirror.Schema.MenuValue[] | undefined; - } - interface MenuValue { - displayName?: string | undefined; - iconUrl?: string | undefined; - state?: string | undefined; - } - interface Notification { - collection?: string | undefined; - itemId?: string | undefined; - operation?: string | undefined; - userActions?: Mirror.Schema.UserAction[] | undefined; - userToken?: string | undefined; - verifyToken?: string | undefined; - } - interface NotificationConfig { - deliveryTime?: string | undefined; - level?: string | undefined; - } - interface Setting { - id?: string | undefined; - kind?: string | undefined; - value?: string | undefined; - } - interface Subscription { - callbackUrl?: string | undefined; - collection?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - notification?: Mirror.Schema.Notification | undefined; - operation?: string[] | undefined; - updated?: string | undefined; - userToken?: string | undefined; - verifyToken?: string | undefined; - } - interface SubscriptionsListResponse { - items?: Mirror.Schema.Subscription[] | undefined; - kind?: string | undefined; - } - interface TimelineItem { - attachments?: Mirror.Schema.Attachment[] | undefined; - bundleId?: string | undefined; - canonicalUrl?: string | undefined; - created?: string | undefined; - creator?: Mirror.Schema.Contact | undefined; - displayTime?: string | undefined; - etag?: string | undefined; - html?: string | undefined; - id?: string | undefined; - inReplyTo?: string | undefined; - isBundleCover?: boolean | undefined; - isDeleted?: boolean | undefined; - isPinned?: boolean | undefined; - kind?: string | undefined; - location?: Mirror.Schema.Location | undefined; - menuItems?: Mirror.Schema.MenuItem[] | undefined; - notification?: Mirror.Schema.NotificationConfig | undefined; - pinScore?: number | undefined; - recipients?: Mirror.Schema.Contact[] | undefined; - selfLink?: string | undefined; - sourceItemId?: string | undefined; - speakableText?: string | undefined; - speakableType?: string | undefined; - text?: string | undefined; - title?: string | undefined; - updated?: string | undefined; - } - interface TimelineListResponse { - items?: Mirror.Schema.TimelineItem[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface UserAction { - payload?: string | undefined; - type?: string | undefined; - } - interface UserData { - key?: string | undefined; - value?: string | undefined; - } - } - } - interface Mirror { - Accounts?: Mirror.Collection.AccountsCollection | undefined; - Contacts?: Mirror.Collection.ContactsCollection | undefined; - Locations?: Mirror.Collection.LocationsCollection | undefined; - Settings?: Mirror.Collection.SettingsCollection | undefined; - Subscriptions?: Mirror.Collection.SubscriptionsCollection | undefined; - Timeline?: Mirror.Collection.TimelineCollection | undefined; - // Create a new instance of Account - newAccount(): Mirror.Schema.Account; - // Create a new instance of Attachment - newAttachment(): Mirror.Schema.Attachment; - // Create a new instance of AuthToken - newAuthToken(): Mirror.Schema.AuthToken; - // Create a new instance of Command - newCommand(): Mirror.Schema.Command; - // Create a new instance of Contact - newContact(): Mirror.Schema.Contact; - // Create a new instance of Location - newLocation(): Mirror.Schema.Location; - // Create a new instance of MenuItem - newMenuItem(): Mirror.Schema.MenuItem; - // Create a new instance of MenuValue - newMenuValue(): Mirror.Schema.MenuValue; - // Create a new instance of Notification - newNotification(): Mirror.Schema.Notification; - // Create a new instance of NotificationConfig - newNotificationConfig(): Mirror.Schema.NotificationConfig; - // Create a new instance of Subscription - newSubscription(): Mirror.Schema.Subscription; - // Create a new instance of TimelineItem - newTimelineItem(): Mirror.Schema.TimelineItem; - // Create a new instance of UserAction - newUserAction(): Mirror.Schema.UserAction; - // Create a new instance of UserData - newUserData(): Mirror.Schema.UserData; - } -} - -declare var Mirror: GoogleAppsScript.Mirror; diff --git a/node_modules/@types/google-apps-script/apis/peopleapi_v1.d.ts b/node_modules/@types/google-apps-script/apis/peopleapi_v1.d.ts deleted file mode 100644 index 2901e95..0000000 --- a/node_modules/@types/google-apps-script/apis/peopleapi_v1.d.ts +++ /dev/null @@ -1,706 +0,0 @@ -declare namespace GoogleAppsScript { - namespace People { - namespace Collection { - namespace ContactGroups { - interface MembersCollection { - // Modify the members of a contact group owned by the authenticated user. - //
- // The only system contact groups that can have members added are - // `contactGroups/myContacts` and `contactGroups/starred`. Other system - // contact groups are deprecated and can only have contacts removed. - modify( - resource: Schema.ModifyContactGroupMembersRequest, - resourceName: string, - ): Schema.ModifyContactGroupMembersResponse; - } - } - namespace People { - interface ConnectionsCollection { - // Provides a list of the authenticated user's contacts merged with any - // connected profiles. - //
- // The request throws a 400 error if 'personFields' is not specified. - list(resourceName: string): Schema.ListConnectionsResponse; - // Provides a list of the authenticated user's contacts merged with any - // connected profiles. - //
- // The request throws a 400 error if 'personFields' is not specified. - list(resourceName: string, optionalArgs: object): Schema.ListConnectionsResponse; - } - } - interface ContactGroupsCollection { - Members?: Collection.ContactGroups.MembersCollection | undefined; - // Get a list of contact groups owned by the authenticated user by specifying - // a list of contact group resource names. - batchGet(): Schema.BatchGetContactGroupsResponse; - // Get a list of contact groups owned by the authenticated user by specifying - // a list of contact group resource names. - batchGet(optionalArgs: object): Schema.BatchGetContactGroupsResponse; - // Create a new contact group owned by the authenticated user. - create(resource: Schema.CreateContactGroupRequest): Schema.ContactGroup; - // Get a specific contact group owned by the authenticated user by specifying - // a contact group resource name. - get(resourceName: string): Schema.ContactGroup; - // Get a specific contact group owned by the authenticated user by specifying - // a contact group resource name. - get(resourceName: string, optionalArgs: object): Schema.ContactGroup; - // List all contact groups owned by the authenticated user. Members of the - // contact groups are not populated. - list(): Schema.ListContactGroupsResponse; - // List all contact groups owned by the authenticated user. Members of the - // contact groups are not populated. - list(optionalArgs: object): Schema.ListContactGroupsResponse; - // Delete an existing contact group owned by the authenticated user by - // specifying a contact group resource name. - remove(resourceName: string): void; - // Delete an existing contact group owned by the authenticated user by - // specifying a contact group resource name. - remove(resourceName: string, optionalArgs: object): void; - // Update the name of an existing contact group owned by the authenticated - // user. - update(resource: Schema.UpdateContactGroupRequest, resourceName: string): Schema.ContactGroup; - } - interface OtherContactsCollection { - // Copies an "Other contact" to a new contact in the user's "myContacts" - // group Mutate requests for the same user should be sent sequentially - // to avoid increased latency and failures. - copyOtherContactToMyContactsGroup( - resource: Schema.CopyOtherContactToMyContactsGroupRequest, - resourceName: string, - ): Schema.Person; - // List all "Other contacts", that is contacts that are not in a contact group. - list(): Schema.ListOtherContactsResponse; - // List all "Other contacts", that is contacts that are not in a contact group. - list(optionalArgs: object): Schema.ListOtherContactsResponse; - // Provides a list of contacts in the authenticated user's other contacts - // that matches the search query. - search(): Schema.SearchDirectoryPeopleResponse; - // Provides a list of contacts in the authenticated user's other contacts - // that matches the search query. - search(optionalArgs: object): Schema.SearchDirectoryPeopleResponse; - } - interface PeopleCollection { - Connections?: Collection.People.ConnectionsCollection | undefined; - // Create a batch of new contacts and return the PersonResponses for the - // newly Mutate requests for the same user should be sent sequentially - // to avoid increased latency and failures. - batchCreateContacts(resource: Schema.BatchCreateContactsRequest): Schema.BatchCreateContactsResponse; - // Delete a batch of contacts. Any non-contact data will not be deleted. - // Mutate requests for the same user should be sent sequentially to avoid - // increased latency and failures. - batchDeleteContacts(resource: Schema.BatchDeleteContactsRequest): Schema.Empty; - // Update a batch of contacts and return a map of resource names to - // PersonResponses for the updated contacts. - batchUpdateContacts(resource: Schema.BatchUpdateContactsRequest): Schema.BatchUpdateContactsResponse; - // Create a new contact and return the person resource for that contact. - createContact(resource: Schema.Person): Schema.Person; - // Create a new contact and return the person resource for that contact. - createContact(resource: Schema.Person, optionalArgs: object): Schema.Person; - // Delete a contact person. Any non-contact data will not be deleted. - deleteContact(resourceName: string): void; - // Delete a contact's photo. Mutate requests for the same user should - // be done sequentially to avoid // lock contention. - deleteContactPhoto(resourceName: string): Schema.DeleteContactPhotoResponse; - // Delete a contact's photo. Mutate requests for the same user should - // be done sequentially to avoid // lock contention. - deleteContactPhoto(resourceName: string, optionalArgs: object): Schema.DeleteContactPhotoResponse; - // Provides information about a person by specifying a resource name. Use - // `people/me` to indicate the authenticated user. - //
- // The request throws a 400 error if 'personFields' is not specified. - get(resourceName: string): Schema.Person; - // Provides information about a person by specifying a resource name. Use - // `people/me` to indicate the authenticated user. - //
- // The request throws a 400 error if 'personFields' is not specified. - get(resourceName: string, optionalArgs: object): Schema.Person; - // Provides information about a list of specific people by specifying a list - // of requested resource names. Use `people/me` to indicate the authenticated - // user. - //
- // The request throws a 400 error if 'personFields' is not specified. - getBatchGet(): Schema.GetPeopleResponse; - // Provides information about a list of specific people by specifying a list - // of requested resource names. Use `people/me` to indicate the authenticated - // user. - //
- // The request throws a 400 error if 'personFields' is not specified. - getBatchGet(optionalArgs: object): Schema.GetPeopleResponse; - // Provides a list of domain profiles and domain contacts in the authenticated - // user's domain directory. - listDirectoryPeople(): Schema.ListDirectoryPeopleResponse; - // Provides a list of domain profiles and domain contacts in the authenticated - // user's domain directory. - listDirectoryPeople(optionalArgs: object): Schema.ListDirectoryPeopleResponse; - // Provides a list of contacts in the authenticated user's grouped contacts - // that matches the search query. - searchContacts(): Schema.SearchResponse; - // Provides a list of contacts in the authenticated user's grouped contacts - // that matches the search query. - searchContacts(optionalArgs: object): Schema.SearchResponse; - // Provides a list of domain profiles and domain contacts in the - // authenticated user's domain directory that match the search query. - searchDirectoryPeople(): Schema.SearchDirectoryPeopleResponse; - // Provides a list of domain profiles and domain contacts in the - // authenticated user's domain directory that match the search query. - searchDirectoryPeople(optionalArgs: object): Schema.SearchDirectoryPeopleResponse; - // Update contact data for an existing contact person. Any non-contact data - // will not be modified. - // The request throws a 400 error if `updatePersonFields` is not specified. - //
- // The request throws a 400 error if `person.metadata.sources` is not - // specified for the contact to be updated. - //
- // The request throws a 412 error if `person.metadata.sources.etag` is - // different than the contact's etag, which indicates the contact has changed - // since its data was read. Clients should get the latest person and re-apply - // their updates to the latest person. - updateContact(resource: Schema.Person, resourceName: string): Schema.Person; - // Update contact data for an existing contact person. Any non-contact data - // will not be modified. - // The request throws a 400 error if `updatePersonFields` is not specified. - //
- // The request throws a 400 error if `person.metadata.sources` is not - // specified for the contact to be updated. - //
- // The request throws a 412 error if `person.metadata.sources.etag` is - // different than the contact's etag, which indicates the contact has changed - // since its data was read. Clients should get the latest person and re-apply - // their updates to the latest person. - updateContact(resource: Schema.Person, resourceName: string, optionalArgs: object): Schema.Person; - // Update a contact's photo. Mutate requests for the same user should be sent - // sequentially to avoid increased latency and failures. - updateContactPhoto( - resource: Schema.UpdateContactPhotoRequest, - resourceName: string, - ): Schema.UpdateContactPhotoResponse; - } - } - namespace Schema { - interface Address { - city?: string | undefined; - country?: string | undefined; - countryCode?: string | undefined; - extendedAddress?: string | undefined; - formattedType?: string | undefined; - formattedValue?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - poBox?: string | undefined; - postalCode?: string | undefined; - region?: string | undefined; - streetAddress?: string | undefined; - type?: string | undefined; - } - interface AgeRangeType { - ageRange?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - } - interface BatchCreateContactsRequest { - contacts?: People.Schema.ContactToCreate[] | undefined; - readMask?: string | undefined; - sources?: string[] | undefined; - } - interface BatchCreateContactsResponse { - createdPeople?: People.Schema.PersonResponse[] | undefined; - } - interface BatchDeleteContactsRequest { - resourceNames?: string[] | undefined; - } - interface BatchGetContactGroupsResponse { - responses?: People.Schema.ContactGroupResponse[] | undefined; - } - interface BatchUpdateContactsRequest { - contacts?: { [key: string]: People.Schema.Person } | undefined; - readMask?: string | undefined; - sources?: string[] | undefined; - updateMask?: string | undefined; - } - interface BatchUpdateContactsResponse { - updateResult?: { [key: string]: People.Schema.PersonResponse } | undefined; - } - interface Biography { - contentType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Birthday { - date?: People.Schema.Date | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - text?: string | undefined; - } - interface BraggingRights { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface CalendarUrl { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - url?: string | undefined; - } - interface ClientData { - key?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface ContactGroup { - etag?: string | undefined; - formattedName?: string | undefined; - groupType?: string | undefined; - memberCount?: number | undefined; - memberResourceNames?: string[] | undefined; - metadata?: People.Schema.ContactGroupMetadata | undefined; - name?: string | undefined; - resourceName?: string | undefined; - } - interface ContactGroupMembership { - contactGroupId?: string | undefined; - } - interface ContactGroupMetadata { - deleted?: boolean | undefined; - updateTime?: string | undefined; - } - interface ContactGroupResponse { - contactGroup?: People.Schema.ContactGroup | undefined; - requestedResourceName?: string | undefined; - status?: People.Schema.Status | undefined; - } - interface ContactToCreate { - contactPerson?: People.Schema.Person | undefined; - } - interface CopyOtherContactToMyContactsGroupRequest { - copyMask?: string | undefined; - readMask?: string | undefined; - sources?: string[] | undefined; - } - interface CoverPhoto { - default?: boolean | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - url?: string | undefined; - } - interface CreateContactGroupRequest { - contactGroup?: People.Schema.ContactGroup | undefined; - } - interface Date { - day?: number | undefined; - month?: number | undefined; - year?: number | undefined; - } - interface DeleteContactPhotoResponse { - person?: People.Schema.Person | undefined; - } - interface DomainMembership { - inViewerDomain?: boolean | undefined; - } - interface EmailAddress { - displayName?: string | undefined; - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface Empty {} - interface Event { - date?: People.Schema.Date | undefined; - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - } - interface ExternalId { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface FieldMetadata { - primary?: boolean | undefined; - source?: People.Schema.Source | undefined; - verified?: boolean | undefined; - } - interface FileAs { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Gender { - formattedValue?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface GetPeopleResponse { - responses?: People.Schema.PersonResponse[] | undefined; - } - interface GroupClientData { - key?: string | undefined; - value?: string | undefined; - } - interface ImClient { - formattedProtocol?: string | undefined; - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - protocol?: string | undefined; - type?: string | undefined; - username?: string | undefined; - } - interface Interest { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface ListConnectionsResponse { - connections?: People.Schema.Person[] | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - totalItems?: number | undefined; - totalPeople?: number | undefined; - } - interface ListContactGroupsResponse { - contactGroups?: People.Schema.ContactGroup[] | undefined; - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - totalItems?: number | undefined; - } - interface ListDirectoryPeopleResponse { - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - people?: People.Schema.Person[] | undefined; - } - interface ListOtherContactsResponse { - nextPageToken?: string | undefined; - nextSyncToken?: string | undefined; - otherContacts?: People.Schema.Person[] | undefined; - totalSize?: number | undefined; - } - interface Locale { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Location { - buildingId?: string | undefined; - current?: boolean | undefined; - deskCode?: string | undefined; - floor?: string | undefined; - floorSection?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface Membership { - contactGroupMembership?: People.Schema.ContactGroupMembership | undefined; - domainMembership?: People.Schema.DomainMembership | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - } - interface MiscKeyword { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface ModifyContactGroupMembersRequest { - resourceNamesToAdd?: string[] | undefined; - resourceNamesToRemove?: string[] | undefined; - } - interface ModifyContactGroupMembersResponse { - notFoundResourceNames?: string[] | undefined; - } - interface Name { - displayName?: string | undefined; - displayNameLastFirst?: string | undefined; - familyName?: string | undefined; - givenName?: string | undefined; - honorificPrefix?: string | undefined; - honorificSuffix?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - middleName?: string | undefined; - phoneticFamilyName?: string | undefined; - phoneticFullName?: string | undefined; - phoneticGivenName?: string | undefined; - phoneticHonorificPrefix?: string | undefined; - phoneticHonorificSuffix?: string | undefined; - phoneticMiddleName?: string | undefined; - } - interface Nickname { - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface Occupation { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Organization { - current?: boolean | undefined; - department?: string | undefined; - domain?: string | undefined; - endDate?: People.Schema.Date | undefined; - formattedType?: string | undefined; - jobDescription?: string | undefined; - location?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - name?: string | undefined; - phoneticName?: string | undefined; - startDate?: People.Schema.Date | undefined; - symbol?: string | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface Person { - addresses?: People.Schema.Address[] | undefined; - ageRange?: string | undefined; - ageRanges?: People.Schema.AgeRangeType[] | undefined; - biographies?: People.Schema.Biography[] | undefined; - birthdays?: People.Schema.Birthday[] | undefined; - braggingRights?: People.Schema.BraggingRights[] | undefined; - coverPhotos?: People.Schema.CoverPhoto[] | undefined; - emailAddresses?: People.Schema.EmailAddress[] | undefined; - etag?: string | undefined; - events?: People.Schema.Event[] | undefined; - genders?: People.Schema.Gender[] | undefined; - imClients?: People.Schema.ImClient[] | undefined; - interests?: People.Schema.Interest[] | undefined; - locales?: People.Schema.Locale[] | undefined; - memberships?: People.Schema.Membership[] | undefined; - metadata?: People.Schema.PersonMetadata | undefined; - names?: People.Schema.Name[] | undefined; - nicknames?: People.Schema.Nickname[] | undefined; - occupations?: People.Schema.Occupation[] | undefined; - organizations?: People.Schema.Organization[] | undefined; - phoneNumbers?: People.Schema.PhoneNumber[] | undefined; - photos?: People.Schema.Photo[] | undefined; - relations?: People.Schema.Relation[] | undefined; - relationshipInterests?: People.Schema.RelationshipInterest[] | undefined; - relationshipStatuses?: People.Schema.RelationshipStatus[] | undefined; - residences?: People.Schema.Residence[] | undefined; - resourceName?: string | undefined; - sipAddresses?: People.Schema.SipAddress[] | undefined; - skills?: People.Schema.Skill[] | undefined; - taglines?: People.Schema.Tagline[] | undefined; - urls?: People.Schema.Url[] | undefined; - userDefined?: People.Schema.UserDefined[] | undefined; - } - interface PersonMetadata { - deleted?: boolean | undefined; - linkedPeopleResourceNames?: string[] | undefined; - objectType?: string | undefined; - previousResourceNames?: string[] | undefined; - sources?: People.Schema.Source[] | undefined; - } - interface PersonResponse { - httpStatusCode?: number | undefined; - person?: People.Schema.Person | undefined; - requestedResourceName?: string | undefined; - status?: People.Schema.Status | undefined; - } - interface PhoneNumber { - canonicalForm?: string | undefined; - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface Photo { - default?: boolean | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - url?: string | undefined; - } - interface ProfileMetadata { - objectType?: string | undefined; - userTypes?: string[] | undefined; - } - interface Relation { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - person?: string | undefined; - type?: string | undefined; - } - interface RelationshipInterest { - formattedValue?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface RelationshipStatus { - formattedValue?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Residence { - current?: boolean | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface SearchDirectoryPeopleResponse { - nextPageToken?: string | undefined; - people?: People.Schema.Person[] | undefined; - totalSize?: number | undefined; - } - interface SearchResponse { - results?: People.Schema.SearchResult[] | undefined; - } - interface SearchResult { - person?: People.Schema.Person | undefined; - } - interface SipAddress { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface Skill { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface Source { - etag?: string | undefined; - id?: string | undefined; - profileMetadata?: People.Schema.ProfileMetadata | undefined; - type?: string | undefined; - updateTime?: string | undefined; - } - interface Status { - code?: number | undefined; - details?: object[] | undefined; - message?: string | undefined; - } - interface Tagline { - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - interface UpdateContactGroupRequest { - contactGroup?: People.Schema.ContactGroup | undefined; - } - interface UpdateContactPhotoRequest { - personFields?: string | undefined; - photoBytes?: string | undefined; - sources?: string[] | undefined; - } - interface UpdateContactPhotoResponse { - person?: People.Schema.Person | undefined; - } - interface Url { - formattedType?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface UserDefined { - key?: string | undefined; - metadata?: People.Schema.FieldMetadata | undefined; - value?: string | undefined; - } - } - } - interface People { - ContactGroups?: People.Collection.ContactGroupsCollection | undefined; - OtherContacts?: People.Collection.OtherContactsCollection | undefined; - People?: People.Collection.PeopleCollection | undefined; - // Create a new instance of Address - newAddress(): People.Schema.Address; - // Create a new instance of AgeRangeType - newAgeRangeType(): People.Schema.AgeRangeType; - // Create a new instance of BatchCreateContactsRequest - newBatchCreateContactsRequest(): People.Schema.BatchCreateContactsRequest; - // Create a new instance of BatchDeleteContactsRequest - newBatchDeleteContactsRequest(): People.Schema.BatchDeleteContactsRequest; - // Create a new instance of BatchUpdateContactsRequest - newBatchUpdateContactsRequest(): People.Schema.BatchUpdateContactsRequest; - // Create a new instance of Biography - newBiography(): People.Schema.Biography; - // Create a new instance of Birthday - newBirthday(): People.Schema.Birthday; - // Create a new instance of BraggingRights - newBraggingRights(): People.Schema.BraggingRights; - // Create a new instance of CalendarUrl - newCalendarUrl(): People.Schema.CalendarUrl; - // Create a new instance of ClientData - newClientData(): People.Schema.ClientData; - // Create a new instance of ContactGroup - newContactGroup(): People.Schema.ContactGroup; - // Create a new instance of ContactGroupMembership - newContactGroupMembership(): People.Schema.ContactGroupMembership; - // Create a new instance of ContactGroupMetadata - newContactGroupMetadata(): People.Schema.ContactGroupMetadata; - // Create a new instance of ContactToCreate - newContactToCreate(): People.Schema.ContactToCreate; - // Create a new instance of CopyOtherContactToMyContactsGroupRequest - newCopyOtherContactToMyContactsGroupRequest(): People.Schema.CopyOtherContactToMyContactsGroupRequest; - // Create a new instance of CoverPhoto - newCoverPhoto(): People.Schema.CoverPhoto; - // Create a new instance of CreateContactGroupRequest - newCreateContactGroupRequest(): People.Schema.CreateContactGroupRequest; - // Create a new instance of Date - newDate(): People.Schema.Date; - // Create a new instance of DomainMembership - newDomainMembership(): People.Schema.DomainMembership; - // Create a new instance of EmailAddress - newEmailAddress(): People.Schema.EmailAddress; - // Create a new instance of Event - newEvent(): People.Schema.Event; - // Create a new instance of ExternalId - newExternalId(): People.Schema.ExternalId; - // Create a new instance of FieldMetadata - newFieldMetadata(): People.Schema.FieldMetadata; - // Create a new instance of newFileAs - newFileAs(): People.Schema.FileAs; - // Create a new instance of Gender - newGender(): People.Schema.Gender; - // Create a new instance of GroupClientData - newGroupClientData(): People.Schema.GroupClientData; - // Create a new instance of ImClient - newImClient(): People.Schema.ImClient; - // Create a new instance of Interest - newInterest(): People.Schema.Interest; - // Create a new instance of Locale - newLocale(): People.Schema.Locale; - // Create a new instance of Location - newLocation(): People.Schema.Location; - // Create a new instance of Membership - newMembership(): People.Schema.Membership; - // Create a new instance of MiscKeyword - newMiscKeyword(): People.Schema.MiscKeyword; - // Create a new instance of ModifyContactGroupMembersRequest - newModifyContactGroupMembersRequest(): People.Schema.ModifyContactGroupMembersRequest; - // Create a new instance of Name - newName(): People.Schema.Name; - // Create a new instance of Nickname - newNickname(): People.Schema.Nickname; - // Create a new instance of Occupation - newOccupation(): People.Schema.Occupation; - // Create a new instance of Organization - newOrganization(): People.Schema.Organization; - // Create a new instance of Person - newPerson(): People.Schema.Person; - // Create a new instance of PersonMetadata - newPersonMetadata(): People.Schema.PersonMetadata; - // Create a new instance of PhoneNumber - newPhoneNumber(): People.Schema.PhoneNumber; - // Create a new instance of Photo - newPhoto(): People.Schema.Photo; - // Create a new instance of ProfileMetadata - newProfileMetadata(): People.Schema.ProfileMetadata; - // Create a new instance of Relation - newRelation(): People.Schema.Relation; - // Create a new instance of RelationshipInterest - newRelationshipInterest(): People.Schema.RelationshipInterest; - // Create a new instance of RelationshipStatus - newRelationshipStatus(): People.Schema.RelationshipStatus; - // Create a new instance of Residence - newResidence(): People.Schema.Residence; - // Create a new instance of SipAddress - newSipAddress(): People.Schema.SipAddress; - // Create a new instance of Skill - newSkill(): People.Schema.Skill; - // Create a new instance of Source - newSource(): People.Schema.Source; - // Create a new instance of Tagline - newTagline(): People.Schema.Tagline; - // Create a new instance of UpdateContactGroupRequest - newUpdateContactGroupRequest(): People.Schema.UpdateContactGroupRequest; - // Create a new instance of UpdateContactPhotoRequest - newUpdateContactPhotoRequest(): People.Schema.UpdateContactPhotoRequest; - // Create a new instance of Url - newUrl(): People.Schema.Url; - // Create a new instance of UserDefined - newUserDefined(): People.Schema.UserDefined; - } -} - -declare var People: GoogleAppsScript.People; diff --git a/node_modules/@types/google-apps-script/apis/reports_v1.d.ts b/node_modules/@types/google-apps-script/apis/reports_v1.d.ts deleted file mode 100644 index 77aa13c..0000000 --- a/node_modules/@types/google-apps-script/apis/reports_v1.d.ts +++ /dev/null @@ -1,151 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminReports { - namespace Collection { - interface ActivitiesCollection { - // Retrieves a list of activities for a specific customer and application. - list(userKey: string, applicationName: string): AdminReports.Schema.Activities; - // Retrieves a list of activities for a specific customer and application. - list(userKey: string, applicationName: string, optionalArgs: object): AdminReports.Schema.Activities; - // Push changes to activities - watch(resource: Schema.Channel, userKey: string, applicationName: string): AdminReports.Schema.Channel; - // Push changes to activities - watch( - resource: Schema.Channel, - userKey: string, - applicationName: string, - optionalArgs: object, - ): AdminReports.Schema.Channel; - } - interface ChannelsCollection { - // Stop watching resources through this channel - stop(resource: Schema.Channel): void; - } - interface CustomerUsageReportsCollection { - // Retrieves a report which is a collection of properties / statistics for a specific customer. - get(date: string): AdminReports.Schema.UsageReports; - // Retrieves a report which is a collection of properties / statistics for a specific customer. - get(date: string, optionalArgs: object): AdminReports.Schema.UsageReports; - } - interface EntityUsageReportsCollection { - // Retrieves a report which is a collection of properties / statistics for a set of objects. - get(entityType: string, entityKey: string, date: string): AdminReports.Schema.UsageReports; - // Retrieves a report which is a collection of properties / statistics for a set of objects. - get( - entityType: string, - entityKey: string, - date: string, - optionalArgs: object, - ): AdminReports.Schema.UsageReports; - } - interface UserUsageReportCollection { - // Retrieves a report which is a collection of properties / statistics for a set of users. - get(userKey: string, date: string): AdminReports.Schema.UsageReports; - // Retrieves a report which is a collection of properties / statistics for a set of users. - get(userKey: string, date: string, optionalArgs: object): AdminReports.Schema.UsageReports; - } - } - namespace Schema { - interface Activities { - etag?: string | undefined; - items?: AdminReports.Schema.Activity[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Activity { - actor?: AdminReports.Schema.ActivityActor | undefined; - etag?: string | undefined; - events?: AdminReports.Schema.ActivityEvents[] | undefined; - id?: AdminReports.Schema.ActivityId | undefined; - ipAddress?: string | undefined; - kind?: string | undefined; - ownerDomain?: string | undefined; - } - interface ActivityActor { - callerType?: string | undefined; - email?: string | undefined; - key?: string | undefined; - profileId?: string | undefined; - } - interface ActivityEvents { - name?: string | undefined; - parameters?: AdminReports.Schema.ActivityEventsParameters[] | undefined; - type?: string | undefined; - } - interface ActivityEventsParameters { - boolValue?: boolean | undefined; - intValue?: string | undefined; - multiIntValue?: string[] | undefined; - multiValue?: string[] | undefined; - name?: string | undefined; - value?: string | undefined; - } - interface ActivityId { - applicationName?: string | undefined; - customerId?: string | undefined; - time?: string | undefined; - uniqueQualifier?: string | undefined; - } - interface Channel { - address?: string | undefined; - expiration?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - params?: object | undefined; - payload?: boolean | undefined; - resourceId?: string | undefined; - resourceUri?: string | undefined; - token?: string | undefined; - type?: string | undefined; - } - interface UsageReport { - date?: string | undefined; - entity?: AdminReports.Schema.UsageReportEntity | undefined; - etag?: string | undefined; - kind?: string | undefined; - parameters?: AdminReports.Schema.UsageReportParameters[] | undefined; - } - interface UsageReportEntity { - customerId?: string | undefined; - entityId?: string | undefined; - profileId?: string | undefined; - type?: string | undefined; - userEmail?: string | undefined; - } - interface UsageReportParameters { - boolValue?: boolean | undefined; - datetimeValue?: string | undefined; - intValue?: string | undefined; - msgValue?: object[] | undefined; - name?: string | undefined; - stringValue?: string | undefined; - } - interface UsageReports { - etag?: string | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - usageReports?: AdminReports.Schema.UsageReport[] | undefined; - warnings?: AdminReports.Schema.UsageReportsWarnings[] | undefined; - } - interface UsageReportsWarnings { - code?: string | undefined; - data?: AdminReports.Schema.UsageReportsWarningsData[] | undefined; - message?: string | undefined; - } - interface UsageReportsWarningsData { - key?: string | undefined; - value?: string | undefined; - } - } - } - interface AdminReports { - Activities?: AdminReports.Collection.ActivitiesCollection | undefined; - Channels?: AdminReports.Collection.ChannelsCollection | undefined; - CustomerUsageReports?: AdminReports.Collection.CustomerUsageReportsCollection | undefined; - EntityUsageReports?: AdminReports.Collection.EntityUsageReportsCollection | undefined; - UserUsageReport?: AdminReports.Collection.UserUsageReportCollection | undefined; - // Create a new instance of Channel - newChannel(): AdminReports.Schema.Channel; - } -} - -declare var AdminReports: GoogleAppsScript.AdminReports; diff --git a/node_modules/@types/google-apps-script/apis/reseller_v1.d.ts b/node_modules/@types/google-apps-script/apis/reseller_v1.d.ts deleted file mode 100644 index c9dcf79..0000000 --- a/node_modules/@types/google-apps-script/apis/reseller_v1.d.ts +++ /dev/null @@ -1,189 +0,0 @@ -declare namespace GoogleAppsScript { - namespace AdminReseller { - namespace Collection { - interface CustomersCollection { - // Get a customer account. - get(customerId: string): AdminReseller.Schema.Customer; - // Order a new customer's account. - insert(resource: Schema.Customer): AdminReseller.Schema.Customer; - // Order a new customer's account. - insert(resource: Schema.Customer, optionalArgs: object): AdminReseller.Schema.Customer; - // Update a customer account's settings. This method supports patch semantics. - patch(resource: Schema.Customer, customerId: string): AdminReseller.Schema.Customer; - // Update a customer account's settings. - update(resource: Schema.Customer, customerId: string): AdminReseller.Schema.Customer; - } - interface ResellernotifyCollection { - // Returns all the details of the watch corresponding to the reseller. - getwatchdetails(): AdminReseller.Schema.ResellernotifyGetwatchdetailsResponse; - // Registers a Reseller for receiving notifications. - register(): AdminReseller.Schema.ResellernotifyResource; - // Registers a Reseller for receiving notifications. - register(optionalArgs: object): AdminReseller.Schema.ResellernotifyResource; - // Unregisters a Reseller for receiving notifications. - unregister(): AdminReseller.Schema.ResellernotifyResource; - // Unregisters a Reseller for receiving notifications. - unregister(optionalArgs: object): AdminReseller.Schema.ResellernotifyResource; - } - interface SubscriptionsCollection { - // Activates a subscription previously suspended by the reseller - activate(customerId: string, subscriptionId: string): AdminReseller.Schema.Subscription; - // Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. - changePlan( - resource: Schema.ChangePlanRequest, - customerId: string, - subscriptionId: string, - ): AdminReseller.Schema.Subscription; - // Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. - changeRenewalSettings( - resource: Schema.RenewalSettings, - customerId: string, - subscriptionId: string, - ): AdminReseller.Schema.Subscription; - // Update a subscription's user license settings. - changeSeats( - resource: Schema.Seats, - customerId: string, - subscriptionId: string, - ): AdminReseller.Schema.Subscription; - // Get a specific subscription. - get(customerId: string, subscriptionId: string): AdminReseller.Schema.Subscription; - // Create or transfer a subscription. - insert(resource: Schema.Subscription, customerId: string): AdminReseller.Schema.Subscription; - // Create or transfer a subscription. - insert( - resource: Schema.Subscription, - customerId: string, - optionalArgs: object, - ): AdminReseller.Schema.Subscription; - // List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. - list(): AdminReseller.Schema.Subscriptions; - // List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. - list(optionalArgs: object): AdminReseller.Schema.Subscriptions; - // Cancel or transfer a subscription to direct. - remove(customerId: string, subscriptionId: string, deletionType: string): void; - // Immediately move a 30-day free trial subscription to a paid service subscription. - startPaidService(customerId: string, subscriptionId: string): AdminReseller.Schema.Subscription; - // Suspends an active subscription. - suspend(customerId: string, subscriptionId: string): AdminReseller.Schema.Subscription; - } - } - namespace Schema { - interface Address { - addressLine1?: string | undefined; - addressLine2?: string | undefined; - addressLine3?: string | undefined; - contactName?: string | undefined; - countryCode?: string | undefined; - kind?: string | undefined; - locality?: string | undefined; - organizationName?: string | undefined; - postalCode?: string | undefined; - region?: string | undefined; - } - interface ChangePlanRequest { - dealCode?: string | undefined; - kind?: string | undefined; - planName?: string | undefined; - purchaseOrderId?: string | undefined; - seats?: AdminReseller.Schema.Seats | undefined; - } - interface Customer { - alternateEmail?: string | undefined; - customerDomain?: string | undefined; - customerDomainVerified?: boolean | undefined; - customerId?: string | undefined; - kind?: string | undefined; - phoneNumber?: string | undefined; - postalAddress?: AdminReseller.Schema.Address | undefined; - resourceUiUrl?: string | undefined; - } - interface RenewalSettings { - kind?: string | undefined; - renewalType?: string | undefined; - } - interface ResellernotifyGetwatchdetailsResponse { - serviceAccountEmailAddresses?: string[] | undefined; - topicName?: string | undefined; - } - interface ResellernotifyResource { - topicName?: string | undefined; - } - interface Seats { - kind?: string | undefined; - licensedNumberOfSeats?: number | undefined; - maximumNumberOfSeats?: number | undefined; - numberOfSeats?: number | undefined; - } - interface Subscription { - billingMethod?: string | undefined; - creationTime?: string | undefined; - customerDomain?: string | undefined; - customerId?: string | undefined; - dealCode?: string | undefined; - kind?: string | undefined; - plan?: AdminReseller.Schema.SubscriptionPlan | undefined; - purchaseOrderId?: string | undefined; - renewalSettings?: AdminReseller.Schema.RenewalSettings | undefined; - resourceUiUrl?: string | undefined; - seats?: AdminReseller.Schema.Seats | undefined; - skuId?: string | undefined; - skuName?: string | undefined; - status?: string | undefined; - subscriptionId?: string | undefined; - suspensionReasons?: string[] | undefined; - transferInfo?: AdminReseller.Schema.SubscriptionTransferInfo | undefined; - trialSettings?: AdminReseller.Schema.SubscriptionTrialSettings | undefined; - } - interface SubscriptionPlan { - commitmentInterval?: AdminReseller.Schema.SubscriptionPlanCommitmentInterval | undefined; - isCommitmentPlan?: boolean | undefined; - planName?: string | undefined; - } - interface SubscriptionPlanCommitmentInterval { - endTime?: string | undefined; - startTime?: string | undefined; - } - interface SubscriptionTransferInfo { - minimumTransferableSeats?: number | undefined; - transferabilityExpirationTime?: string | undefined; - } - interface SubscriptionTrialSettings { - isInTrial?: boolean | undefined; - trialEndTime?: string | undefined; - } - interface Subscriptions { - kind?: string | undefined; - nextPageToken?: string | undefined; - subscriptions?: AdminReseller.Schema.Subscription[] | undefined; - } - } - } - interface AdminReseller { - Customers?: AdminReseller.Collection.CustomersCollection | undefined; - Resellernotify?: AdminReseller.Collection.ResellernotifyCollection | undefined; - Subscriptions?: AdminReseller.Collection.SubscriptionsCollection | undefined; - // Create a new instance of Address - newAddress(): AdminReseller.Schema.Address; - // Create a new instance of ChangePlanRequest - newChangePlanRequest(): AdminReseller.Schema.ChangePlanRequest; - // Create a new instance of Customer - newCustomer(): AdminReseller.Schema.Customer; - // Create a new instance of RenewalSettings - newRenewalSettings(): AdminReseller.Schema.RenewalSettings; - // Create a new instance of Seats - newSeats(): AdminReseller.Schema.Seats; - // Create a new instance of Subscription - newSubscription(): AdminReseller.Schema.Subscription; - // Create a new instance of SubscriptionPlan - newSubscriptionPlan(): AdminReseller.Schema.SubscriptionPlan; - // Create a new instance of SubscriptionPlanCommitmentInterval - newSubscriptionPlanCommitmentInterval(): AdminReseller.Schema.SubscriptionPlanCommitmentInterval; - // Create a new instance of SubscriptionTransferInfo - newSubscriptionTransferInfo(): AdminReseller.Schema.SubscriptionTransferInfo; - // Create a new instance of SubscriptionTrialSettings - newSubscriptionTrialSettings(): AdminReseller.Schema.SubscriptionTrialSettings; - } -} - -declare var AdminReseller: GoogleAppsScript.AdminReseller; diff --git a/node_modules/@types/google-apps-script/apis/sheets_v4.d.ts b/node_modules/@types/google-apps-script/apis/sheets_v4.d.ts deleted file mode 100644 index 9e683cc..0000000 --- a/node_modules/@types/google-apps-script/apis/sheets_v4.d.ts +++ /dev/null @@ -1,1568 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Sheets { - namespace Collection { - namespace Spreadsheets { - interface DeveloperMetadataCollection { - // Returns the developer metadata with the specified ID. - // The caller must specify the spreadsheet ID and the developer metadata's - // unique metadataId. - get(spreadsheetId: string, metadataId: number): Sheets.Schema.DeveloperMetadata; - // Returns all developer metadata matching the specified DataFilter. - // If the provided DataFilter represents a DeveloperMetadataLookup object, - // this will return all DeveloperMetadata entries selected by it. If the - // DataFilter represents a location in a spreadsheet, this will return all - // developer metadata associated with locations intersecting that region. - search( - resource: Schema.SearchDeveloperMetadataRequest, - spreadsheetId: string, - ): Sheets.Schema.SearchDeveloperMetadataResponse; - } - interface SheetsCollection { - // Copies a single sheet from a spreadsheet to another spreadsheet. - // Returns the properties of the newly created sheet. - copyTo( - resource: Schema.CopySheetToAnotherSpreadsheetRequest, - spreadsheetId: string, - sheetId: number, - ): Sheets.Schema.SheetProperties; - } - interface ValuesCollection { - // Appends values to a spreadsheet. The input range is used to search for - // existing data and find a "table" within that range. Values will be - // appended to the next row of the table, starting with the first column of - // the table. See the - // [guide](/sheets/api/guides/values#appending_values) - // and - // [sample code](/sheets/api/samples/writing#append_values) - // for specific details of how tables are detected and data is appended. - // The caller must specify the spreadsheet ID, range, and - // a valueInputOption. The `valueInputOption` only - // controls how the input data will be added to the sheet (column-wise or - // row-wise), it does not influence what cell the data starts being written - // to. - append( - resource: Schema.ValueRange, - spreadsheetId: string, - range: string, - ): Sheets.Schema.AppendValuesResponse; - // Appends values to a spreadsheet. The input range is used to search for - // existing data and find a "table" within that range. Values will be - // appended to the next row of the table, starting with the first column of - // the table. See the - // [guide](/sheets/api/guides/values#appending_values) - // and - // [sample code](/sheets/api/samples/writing#append_values) - // for specific details of how tables are detected and data is appended. - // The caller must specify the spreadsheet ID, range, and - // a valueInputOption. The `valueInputOption` only - // controls how the input data will be added to the sheet (column-wise or - // row-wise), it does not influence what cell the data starts being written - // to. - append( - resource: Schema.ValueRange, - spreadsheetId: string, - range: string, - optionalArgs: object, - ): Sheets.Schema.AppendValuesResponse; - // Clears one or more ranges of values from a spreadsheet. - // The caller must specify the spreadsheet ID and one or more ranges. - // Only values are cleared -- all other properties of the cell (such as - // formatting, data validation, etc..) are kept. - batchClear( - resource: Schema.BatchClearValuesRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchClearValuesResponse; - // Clears one or more ranges of values from a spreadsheet. - // The caller must specify the spreadsheet ID and one or more - // DataFilters. Ranges matching any of the specified data - // filters will be cleared. Only values are cleared -- all other properties - // of the cell (such as formatting, data validation, etc..) are kept. - batchClearByDataFilter( - resource: Schema.BatchClearValuesByDataFilterRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchClearValuesByDataFilterResponse; - // Returns one or more ranges of values from a spreadsheet. - // The caller must specify the spreadsheet ID and one or more ranges. - batchGet(spreadsheetId: string): Sheets.Schema.BatchGetValuesResponse; - // Returns one or more ranges of values from a spreadsheet. - // The caller must specify the spreadsheet ID and one or more ranges. - batchGet(spreadsheetId: string, optionalArgs: object): Sheets.Schema.BatchGetValuesResponse; - // Returns one or more ranges of values that match the specified data filters. - // The caller must specify the spreadsheet ID and one or more - // DataFilters. Ranges that match any of the data filters in - // the request will be returned. - batchGetByDataFilter( - resource: Schema.BatchGetValuesByDataFilterRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchGetValuesByDataFilterResponse; - // Sets values in one or more ranges of a spreadsheet. - // The caller must specify the spreadsheet ID, - // a valueInputOption, and one or more - // ValueRanges. - batchUpdate( - resource: Schema.BatchUpdateValuesRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchUpdateValuesResponse; - // Sets values in one or more ranges of a spreadsheet. - // The caller must specify the spreadsheet ID, - // a valueInputOption, and one or more - // DataFilterValueRanges. - batchUpdateByDataFilter( - resource: Schema.BatchUpdateValuesByDataFilterRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchUpdateValuesByDataFilterResponse; - // Clears values from a spreadsheet. - // The caller must specify the spreadsheet ID and range. - // Only values are cleared -- all other properties of the cell (such as - // formatting, data validation, etc..) are kept. - clear( - resource: any, - /* Schema.ClearValuesRequest */ spreadsheetId: string, - range: string, - ): Sheets.Schema.ClearValuesResponse; - // Returns a range of values from a spreadsheet. - // The caller must specify the spreadsheet ID and a range. - get(spreadsheetId: string, range: string): Sheets.Schema.ValueRange; - // Returns a range of values from a spreadsheet. - // The caller must specify the spreadsheet ID and a range. - get(spreadsheetId: string, range: string, optionalArgs: object): Sheets.Schema.ValueRange; - // Sets values in a range of a spreadsheet. - // The caller must specify the spreadsheet ID, range, and - // a valueInputOption. - update( - resource: Schema.ValueRange, - spreadsheetId: string, - range: string, - ): Sheets.Schema.UpdateValuesResponse; - // Sets values in a range of a spreadsheet. - // The caller must specify the spreadsheet ID, range, and - // a valueInputOption. - update( - resource: Schema.ValueRange, - spreadsheetId: string, - range: string, - optionalArgs: object, - ): Sheets.Schema.UpdateValuesResponse; - } - } - interface SpreadsheetsCollection { - DeveloperMetadata?: Sheets.Collection.Spreadsheets.DeveloperMetadataCollection | undefined; - Sheets?: Sheets.Collection.Spreadsheets.SheetsCollection | undefined; - Values?: Sheets.Collection.Spreadsheets.ValuesCollection | undefined; - // Applies one or more updates to the spreadsheet. - // Each request is validated before - // being applied. If any request is not valid then the entire request will - // fail and nothing will be applied. - // Some requests have replies to - // give you some information about how - // they are applied. The replies will mirror the requests. For example, - // if you applied 4 updates and the 3rd one had a reply, then the - // response will have 2 empty replies, the actual reply, and another empty - // reply, in that order. - // Due to the collaborative nature of spreadsheets, it is not guaranteed that - // the spreadsheet will reflect exactly your changes after this completes, - // however it is guaranteed that the updates in the request will be - // applied together atomically. Your changes may be altered with respect to - // collaborator changes. If there are no collaborators, the spreadsheet - // should reflect your changes. - batchUpdate( - resource: Schema.BatchUpdateSpreadsheetRequest, - spreadsheetId: string, - ): Sheets.Schema.BatchUpdateSpreadsheetResponse; - // Creates a spreadsheet, returning the newly created spreadsheet. - create(resource: Schema.Spreadsheet): Sheets.Schema.Spreadsheet; - // Returns the spreadsheet at the given ID. - // The caller must specify the spreadsheet ID. - // By default, data within grids will not be returned. - // You can include grid data one of two ways: - // * Specify a field mask listing your desired fields using the `fields` URL - // parameter in HTTP - // * Set the includeGridData - // URL parameter to true. If a field mask is set, the `includeGridData` - // parameter is ignored - // For large spreadsheets, it is recommended to retrieve only the specific - // fields of the spreadsheet that you want. - // To retrieve only subsets of the spreadsheet, use the - // ranges URL parameter. - // Multiple ranges can be specified. Limiting the range will - // return only the portions of the spreadsheet that intersect the requested - // ranges. Ranges are specified using A1 notation. - get(spreadsheetId: string): Sheets.Schema.Spreadsheet; - // Returns the spreadsheet at the given ID. - // The caller must specify the spreadsheet ID. - // By default, data within grids will not be returned. - // You can include grid data one of two ways: - // * Specify a field mask listing your desired fields using the `fields` URL - // parameter in HTTP - // * Set the includeGridData - // URL parameter to true. If a field mask is set, the `includeGridData` - // parameter is ignored - // For large spreadsheets, it is recommended to retrieve only the specific - // fields of the spreadsheet that you want. - // To retrieve only subsets of the spreadsheet, use the - // ranges URL parameter. - // Multiple ranges can be specified. Limiting the range will - // return only the portions of the spreadsheet that intersect the requested - // ranges. Ranges are specified using A1 notation. - get(spreadsheetId: string, optionalArgs: object): Sheets.Schema.Spreadsheet; - // Returns the spreadsheet at the given ID. - // The caller must specify the spreadsheet ID. - // This method differs from GetSpreadsheet in that it allows selecting - // which subsets of spreadsheet data to return by specifying a - // dataFilters parameter. - // Multiple DataFilters can be specified. Specifying one or - // more data filters will return the portions of the spreadsheet that - // intersect ranges matched by any of the filters. - // By default, data within grids will not be returned. - // You can include grid data one of two ways: - // * Specify a field mask listing your desired fields using the `fields` URL - // parameter in HTTP - // * Set the includeGridData - // parameter to true. If a field mask is set, the `includeGridData` - // parameter is ignored - // For large spreadsheets, it is recommended to retrieve only the specific - // fields of the spreadsheet that you want. - getByDataFilter( - resource: Schema.GetSpreadsheetByDataFilterRequest, - spreadsheetId: string, - ): Sheets.Schema.Spreadsheet; - } - } - namespace Schema { - interface AddBandingRequest { - bandedRange?: Sheets.Schema.BandedRange | undefined; - } - interface AddBandingResponse { - bandedRange?: Sheets.Schema.BandedRange | undefined; - } - interface AddChartRequest { - chart?: Sheets.Schema.EmbeddedChart | undefined; - } - interface AddChartResponse { - chart?: Sheets.Schema.EmbeddedChart | undefined; - } - interface AddConditionalFormatRuleRequest { - index?: number | undefined; - rule?: Sheets.Schema.ConditionalFormatRule | undefined; - } - interface AddDimensionGroupRequest { - range?: Sheets.Schema.DimensionRange | undefined; - } - interface AddDimensionGroupResponse { - dimensionGroups?: Sheets.Schema.DimensionGroup[] | undefined; - } - interface AddFilterViewRequest { - filter?: Sheets.Schema.FilterView | undefined; - } - interface AddFilterViewResponse { - filter?: Sheets.Schema.FilterView | undefined; - } - interface AddNamedRangeRequest { - namedRange?: Sheets.Schema.NamedRange | undefined; - } - interface AddNamedRangeResponse { - namedRange?: Sheets.Schema.NamedRange | undefined; - } - interface AddProtectedRangeRequest { - protectedRange?: Sheets.Schema.ProtectedRange | undefined; - } - interface AddProtectedRangeResponse { - protectedRange?: Sheets.Schema.ProtectedRange | undefined; - } - interface AddSheetRequest { - properties?: Sheets.Schema.SheetProperties | undefined; - } - interface AddSheetResponse { - properties?: Sheets.Schema.SheetProperties | undefined; - } - interface AppendCellsRequest { - fields?: string | undefined; - rows?: Sheets.Schema.RowData[] | undefined; - sheetId?: number | undefined; - } - interface AppendDimensionRequest { - dimension?: string | undefined; - length?: number | undefined; - sheetId?: number | undefined; - } - interface AppendValuesResponse { - spreadsheetId?: string | undefined; - tableRange?: string | undefined; - updates?: Sheets.Schema.UpdateValuesResponse | undefined; - } - interface AutoFillRequest { - range?: Sheets.Schema.GridRange | undefined; - sourceAndDestination?: Sheets.Schema.SourceAndDestination | undefined; - useAlternateSeries?: boolean | undefined; - } - interface AutoResizeDimensionsRequest { - dimensions?: Sheets.Schema.DimensionRange | undefined; - } - interface BandedRange { - bandedRangeId?: number | undefined; - columnProperties?: Sheets.Schema.BandingProperties | undefined; - range?: Sheets.Schema.GridRange | undefined; - rowProperties?: Sheets.Schema.BandingProperties | undefined; - } - interface BandingProperties { - firstBandColor?: Sheets.Schema.Color | undefined; - footerColor?: Sheets.Schema.Color | undefined; - headerColor?: Sheets.Schema.Color | undefined; - secondBandColor?: Sheets.Schema.Color | undefined; - } - interface BasicChartAxis { - format?: Sheets.Schema.TextFormat | undefined; - position?: string | undefined; - title?: string | undefined; - titleTextPosition?: Sheets.Schema.TextPosition | undefined; - } - interface BasicChartDomain { - domain?: Sheets.Schema.ChartData | undefined; - reversed?: boolean | undefined; - } - interface BasicChartSeries { - color?: Sheets.Schema.Color | undefined; - lineStyle?: Sheets.Schema.LineStyle | undefined; - series?: Sheets.Schema.ChartData | undefined; - targetAxis?: string | undefined; - type?: string | undefined; - } - interface BasicChartSpec { - axis?: Sheets.Schema.BasicChartAxis[] | undefined; - chartType?: string | undefined; - compareMode?: string | undefined; - domains?: Sheets.Schema.BasicChartDomain[] | undefined; - headerCount?: number | undefined; - interpolateNulls?: boolean | undefined; - legendPosition?: string | undefined; - lineSmoothing?: boolean | undefined; - series?: Sheets.Schema.BasicChartSeries[] | undefined; - stackedType?: string | undefined; - threeDimensional?: boolean | undefined; - } - interface BasicFilter { - criteria?: object | undefined; - range?: Sheets.Schema.GridRange | undefined; - sortSpecs?: Sheets.Schema.SortSpec[] | undefined; - } - interface BatchClearValuesByDataFilterRequest { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - } - interface BatchClearValuesByDataFilterResponse { - clearedRanges?: string[] | undefined; - spreadsheetId?: string | undefined; - } - interface BatchClearValuesRequest { - ranges?: string[] | undefined; - } - interface BatchClearValuesResponse { - clearedRanges?: string[] | undefined; - spreadsheetId?: string | undefined; - } - interface BatchGetValuesByDataFilterRequest { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - dateTimeRenderOption?: string | undefined; - majorDimension?: string | undefined; - valueRenderOption?: string | undefined; - } - interface BatchGetValuesByDataFilterResponse { - spreadsheetId?: string | undefined; - valueRanges?: Sheets.Schema.MatchedValueRange[] | undefined; - } - interface BatchGetValuesResponse { - spreadsheetId?: string | undefined; - valueRanges?: Sheets.Schema.ValueRange[] | undefined; - } - interface BatchUpdateSpreadsheetRequest { - includeSpreadsheetInResponse?: boolean | undefined; - requests?: Sheets.Schema.Request[] | undefined; - responseIncludeGridData?: boolean | undefined; - responseRanges?: string[] | undefined; - } - interface BatchUpdateSpreadsheetResponse { - replies?: Sheets.Schema.Response[] | undefined; - spreadsheetId?: string | undefined; - updatedSpreadsheet?: Sheets.Schema.Spreadsheet | undefined; - } - interface BatchUpdateValuesByDataFilterRequest { - data?: Sheets.Schema.DataFilterValueRange[] | undefined; - includeValuesInResponse?: boolean | undefined; - responseDateTimeRenderOption?: string | undefined; - responseValueRenderOption?: string | undefined; - valueInputOption?: string | undefined; - } - interface BatchUpdateValuesByDataFilterResponse { - responses?: Sheets.Schema.UpdateValuesByDataFilterResponse[] | undefined; - spreadsheetId?: string | undefined; - totalUpdatedCells?: number | undefined; - totalUpdatedColumns?: number | undefined; - totalUpdatedRows?: number | undefined; - totalUpdatedSheets?: number | undefined; - } - interface BatchUpdateValuesRequest { - data?: Sheets.Schema.ValueRange[] | undefined; - includeValuesInResponse?: boolean | undefined; - responseDateTimeRenderOption?: string | undefined; - responseValueRenderOption?: string | undefined; - valueInputOption?: string | undefined; - } - interface BatchUpdateValuesResponse { - responses?: Sheets.Schema.UpdateValuesResponse[] | undefined; - spreadsheetId?: string | undefined; - totalUpdatedCells?: number | undefined; - totalUpdatedColumns?: number | undefined; - totalUpdatedRows?: number | undefined; - totalUpdatedSheets?: number | undefined; - } - interface BooleanCondition { - type?: string | undefined; - values?: Sheets.Schema.ConditionValue[] | undefined; - } - interface BooleanRule { - condition?: Sheets.Schema.BooleanCondition | undefined; - format?: Sheets.Schema.CellFormat | undefined; - } - interface Border { - color?: Sheets.Schema.Color | undefined; - style?: string | undefined; - width?: number | undefined; - } - interface Borders { - bottom?: Sheets.Schema.Border | undefined; - left?: Sheets.Schema.Border | undefined; - right?: Sheets.Schema.Border | undefined; - top?: Sheets.Schema.Border | undefined; - } - interface BubbleChartSpec { - bubbleBorderColor?: Sheets.Schema.Color | undefined; - bubbleLabels?: Sheets.Schema.ChartData | undefined; - bubbleMaxRadiusSize?: number | undefined; - bubbleMinRadiusSize?: number | undefined; - bubbleOpacity?: number | undefined; - bubbleSizes?: Sheets.Schema.ChartData | undefined; - bubbleTextStyle?: Sheets.Schema.TextFormat | undefined; - domain?: Sheets.Schema.ChartData | undefined; - groupIds?: Sheets.Schema.ChartData | undefined; - legendPosition?: string | undefined; - series?: Sheets.Schema.ChartData | undefined; - } - interface CandlestickChartSpec { - data?: Sheets.Schema.CandlestickData[] | undefined; - domain?: Sheets.Schema.CandlestickDomain | undefined; - } - interface CandlestickData { - closeSeries?: Sheets.Schema.CandlestickSeries | undefined; - highSeries?: Sheets.Schema.CandlestickSeries | undefined; - lowSeries?: Sheets.Schema.CandlestickSeries | undefined; - openSeries?: Sheets.Schema.CandlestickSeries | undefined; - } - interface CandlestickDomain { - data?: Sheets.Schema.ChartData | undefined; - reversed?: boolean | undefined; - } - interface CandlestickSeries { - data?: Sheets.Schema.ChartData | undefined; - } - interface CellData { - dataValidation?: Sheets.Schema.DataValidationRule | undefined; - effectiveFormat?: Sheets.Schema.CellFormat | undefined; - effectiveValue?: Sheets.Schema.ExtendedValue | undefined; - formattedValue?: string | undefined; - hyperlink?: string | undefined; - note?: string | undefined; - pivotTable?: Sheets.Schema.PivotTable | undefined; - textFormatRuns?: Sheets.Schema.TextFormatRun[] | undefined; - userEnteredFormat?: Sheets.Schema.CellFormat | undefined; - userEnteredValue?: Sheets.Schema.ExtendedValue | undefined; - } - interface CellFormat { - backgroundColor?: Sheets.Schema.Color | undefined; - borders?: Sheets.Schema.Borders | undefined; - horizontalAlignment?: string | undefined; - hyperlinkDisplayType?: string | undefined; - numberFormat?: Sheets.Schema.NumberFormat | undefined; - padding?: Sheets.Schema.Padding | undefined; - textDirection?: string | undefined; - textFormat?: Sheets.Schema.TextFormat | undefined; - textRotation?: Sheets.Schema.TextRotation | undefined; - verticalAlignment?: string | undefined; - wrapStrategy?: string | undefined; - } - interface ChartData { - sourceRange?: Sheets.Schema.ChartSourceRange | undefined; - } - interface ChartSourceRange { - sources?: Sheets.Schema.GridRange[] | undefined; - } - interface ChartSpec { - altText?: string | undefined; - backgroundColor?: Sheets.Schema.Color | undefined; - basicChart?: Sheets.Schema.BasicChartSpec | undefined; - bubbleChart?: Sheets.Schema.BubbleChartSpec | undefined; - candlestickChart?: Sheets.Schema.CandlestickChartSpec | undefined; - fontName?: string | undefined; - hiddenDimensionStrategy?: string | undefined; - histogramChart?: Sheets.Schema.HistogramChartSpec | undefined; - maximized?: boolean | undefined; - orgChart?: Sheets.Schema.OrgChartSpec | undefined; - pieChart?: Sheets.Schema.PieChartSpec | undefined; - subtitle?: string | undefined; - subtitleTextFormat?: Sheets.Schema.TextFormat | undefined; - subtitleTextPosition?: Sheets.Schema.TextPosition | undefined; - title?: string | undefined; - titleTextFormat?: Sheets.Schema.TextFormat | undefined; - titleTextPosition?: Sheets.Schema.TextPosition | undefined; - treemapChart?: Sheets.Schema.TreemapChartSpec | undefined; - waterfallChart?: Sheets.Schema.WaterfallChartSpec | undefined; - } - interface ClearBasicFilterRequest { - sheetId?: number | undefined; - } - interface ClearValuesResponse { - clearedRange?: string | undefined; - spreadsheetId?: string | undefined; - } - interface Color { - alpha?: number | undefined; - blue?: number | undefined; - green?: number | undefined; - red?: number | undefined; - } - interface ConditionValue { - relativeDate?: string | undefined; - userEnteredValue?: string | undefined; - } - interface ConditionalFormatRule { - booleanRule?: Sheets.Schema.BooleanRule | undefined; - gradientRule?: Sheets.Schema.GradientRule | undefined; - ranges?: Sheets.Schema.GridRange[] | undefined; - } - interface CopyPasteRequest { - destination?: Sheets.Schema.GridRange | undefined; - pasteOrientation?: string | undefined; - pasteType?: string | undefined; - source?: Sheets.Schema.GridRange | undefined; - } - interface CopySheetToAnotherSpreadsheetRequest { - destinationSpreadsheetId?: string | undefined; - } - interface CreateDeveloperMetadataRequest { - developerMetadata?: Sheets.Schema.DeveloperMetadata | undefined; - } - interface CreateDeveloperMetadataResponse { - developerMetadata?: Sheets.Schema.DeveloperMetadata | undefined; - } - interface CutPasteRequest { - destination?: Sheets.Schema.GridCoordinate | undefined; - pasteType?: string | undefined; - source?: Sheets.Schema.GridRange | undefined; - } - interface DataFilter { - a1Range?: string | undefined; - developerMetadataLookup?: Sheets.Schema.DeveloperMetadataLookup | undefined; - gridRange?: Sheets.Schema.GridRange | undefined; - } - interface DataFilterValueRange { - dataFilter?: Sheets.Schema.DataFilter | undefined; - majorDimension?: string | undefined; - values?: any[][] | undefined; - } - interface DataValidationRule { - condition?: Sheets.Schema.BooleanCondition | undefined; - inputMessage?: string | undefined; - showCustomUi?: boolean | undefined; - strict?: boolean | undefined; - } - interface DateTimeRule { - type?: string | undefined; - } - interface DeleteBandingRequest { - bandedRangeId?: number | undefined; - } - interface DeleteConditionalFormatRuleRequest { - index?: number | undefined; - sheetId?: number | undefined; - } - interface DeleteConditionalFormatRuleResponse { - rule?: Sheets.Schema.ConditionalFormatRule | undefined; - } - interface DeleteDeveloperMetadataRequest { - dataFilter?: Sheets.Schema.DataFilter | undefined; - } - interface DeleteDeveloperMetadataResponse { - deletedDeveloperMetadata?: Sheets.Schema.DeveloperMetadata[] | undefined; - } - interface DeleteDimensionGroupRequest { - range?: Sheets.Schema.DimensionRange | undefined; - } - interface DeleteDimensionGroupResponse { - dimensionGroups?: Sheets.Schema.DimensionGroup[] | undefined; - } - interface DeleteDimensionRequest { - range?: Sheets.Schema.DimensionRange | undefined; - } - interface DeleteEmbeddedObjectRequest { - objectId?: number | undefined; - } - interface DeleteFilterViewRequest { - filterId?: number | undefined; - } - interface DeleteNamedRangeRequest { - namedRangeId?: string | undefined; - } - interface DeleteProtectedRangeRequest { - protectedRangeId?: number | undefined; - } - interface DeleteRangeRequest { - range?: Sheets.Schema.GridRange | undefined; - shiftDimension?: string | undefined; - } - interface DeleteSheetRequest { - sheetId?: number | undefined; - } - interface DeveloperMetadata { - location?: Sheets.Schema.DeveloperMetadataLocation | undefined; - metadataId?: number | undefined; - metadataKey?: string | undefined; - metadataValue?: string | undefined; - visibility?: string | undefined; - } - interface DeveloperMetadataLocation { - dimensionRange?: Sheets.Schema.DimensionRange | undefined; - locationType?: string | undefined; - sheetId?: number | undefined; - spreadsheet?: boolean | undefined; - } - interface DeveloperMetadataLookup { - locationMatchingStrategy?: string | undefined; - locationType?: string | undefined; - metadataId?: number | undefined; - metadataKey?: string | undefined; - metadataLocation?: Sheets.Schema.DeveloperMetadataLocation | undefined; - metadataValue?: string | undefined; - visibility?: string | undefined; - } - interface DimensionGroup { - collapsed?: boolean | undefined; - depth?: number | undefined; - range?: Sheets.Schema.DimensionRange | undefined; - } - interface DimensionProperties { - developerMetadata?: Sheets.Schema.DeveloperMetadata[] | undefined; - hiddenByFilter?: boolean | undefined; - hiddenByUser?: boolean | undefined; - pixelSize?: number | undefined; - } - interface DimensionRange { - dimension?: string | undefined; - endIndex?: number | undefined; - sheetId?: number | undefined; - startIndex?: number | undefined; - } - interface DuplicateFilterViewRequest { - filterId?: number | undefined; - } - interface DuplicateFilterViewResponse { - filter?: Sheets.Schema.FilterView | undefined; - } - interface DuplicateSheetRequest { - insertSheetIndex?: number | undefined; - newSheetId?: number | undefined; - newSheetName?: string | undefined; - sourceSheetId?: number | undefined; - } - interface DuplicateSheetResponse { - properties?: Sheets.Schema.SheetProperties | undefined; - } - interface Editors { - domainUsersCanEdit?: boolean | undefined; - groups?: string[] | undefined; - users?: string[] | undefined; - } - interface EmbeddedChart { - chartId?: number | undefined; - position?: Sheets.Schema.EmbeddedObjectPosition | undefined; - spec?: Sheets.Schema.ChartSpec | undefined; - } - interface EmbeddedObjectPosition { - newSheet?: boolean | undefined; - overlayPosition?: Sheets.Schema.OverlayPosition | undefined; - sheetId?: number | undefined; - } - interface ErrorValue { - message?: string | undefined; - type?: string | undefined; - } - interface ExtendedValue { - boolValue?: boolean | undefined; - errorValue?: Sheets.Schema.ErrorValue | undefined; - formulaValue?: string | undefined; - numberValue?: number | undefined; - stringValue?: string | undefined; - } - interface FilterCriteria { - condition?: Sheets.Schema.BooleanCondition | undefined; - hiddenValues?: string[] | undefined; - } - interface FilterView { - criteria?: object | undefined; - filterViewId?: number | undefined; - namedRangeId?: string | undefined; - range?: Sheets.Schema.GridRange | undefined; - sortSpecs?: Sheets.Schema.SortSpec[] | undefined; - title?: string | undefined; - } - interface FindReplaceRequest { - allSheets?: boolean | undefined; - find?: string | undefined; - includeFormulas?: boolean | undefined; - matchCase?: boolean | undefined; - matchEntireCell?: boolean | undefined; - range?: Sheets.Schema.GridRange | undefined; - replacement?: string | undefined; - searchByRegex?: boolean | undefined; - sheetId?: number | undefined; - } - interface FindReplaceResponse { - formulasChanged?: number | undefined; - occurrencesChanged?: number | undefined; - rowsChanged?: number | undefined; - sheetsChanged?: number | undefined; - valuesChanged?: number | undefined; - } - interface GetSpreadsheetByDataFilterRequest { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - includeGridData?: boolean | undefined; - } - interface GradientRule { - maxpoint?: Sheets.Schema.InterpolationPoint | undefined; - midpoint?: Sheets.Schema.InterpolationPoint | undefined; - minpoint?: Sheets.Schema.InterpolationPoint | undefined; - } - interface GridCoordinate { - columnIndex?: number | undefined; - rowIndex?: number | undefined; - sheetId?: number | undefined; - } - interface GridData { - columnMetadata?: Sheets.Schema.DimensionProperties[] | undefined; - rowData?: Sheets.Schema.RowData[] | undefined; - rowMetadata?: Sheets.Schema.DimensionProperties[] | undefined; - startColumn?: number | undefined; - startRow?: number | undefined; - } - interface GridProperties { - columnCount?: number | undefined; - columnGroupControlAfter?: boolean | undefined; - frozenColumnCount?: number | undefined; - frozenRowCount?: number | undefined; - hideGridlines?: boolean | undefined; - rowCount?: number | undefined; - rowGroupControlAfter?: boolean | undefined; - } - interface GridRange { - endColumnIndex?: number | undefined; - endRowIndex?: number | undefined; - sheetId?: number | undefined; - startColumnIndex?: number | undefined; - startRowIndex?: number | undefined; - } - interface HistogramChartSpec { - bucketSize?: number | undefined; - legendPosition?: string | undefined; - outlierPercentile?: number | undefined; - series?: Sheets.Schema.HistogramSeries[] | undefined; - showItemDividers?: boolean | undefined; - } - interface HistogramRule { - end?: number | undefined; - interval?: number | undefined; - start?: number | undefined; - } - interface HistogramSeries { - barColor?: Sheets.Schema.Color | undefined; - data?: Sheets.Schema.ChartData | undefined; - } - interface InsertDimensionRequest { - inheritFromBefore?: boolean | undefined; - range?: Sheets.Schema.DimensionRange | undefined; - } - interface InsertRangeRequest { - range?: Sheets.Schema.GridRange | undefined; - shiftDimension?: string | undefined; - } - interface InterpolationPoint { - color?: Sheets.Schema.Color | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface IterativeCalculationSettings { - convergenceThreshold?: number | undefined; - maxIterations?: number | undefined; - } - interface LineStyle { - type?: string | undefined; - width?: number | undefined; - } - interface ManualRule { - groups?: Sheets.Schema.ManualRuleGroup[] | undefined; - } - interface ManualRuleGroup { - groupName?: Sheets.Schema.ExtendedValue | undefined; - items?: Sheets.Schema.ExtendedValue[] | undefined; - } - interface MatchedDeveloperMetadata { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - developerMetadata?: Sheets.Schema.DeveloperMetadata | undefined; - } - interface MatchedValueRange { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - valueRange?: Sheets.Schema.ValueRange | undefined; - } - interface MergeCellsRequest { - mergeType?: string | undefined; - range?: Sheets.Schema.GridRange | undefined; - } - interface MoveDimensionRequest { - destinationIndex?: number | undefined; - source?: Sheets.Schema.DimensionRange | undefined; - } - interface NamedRange { - name?: string | undefined; - namedRangeId?: string | undefined; - range?: Sheets.Schema.GridRange | undefined; - } - interface NumberFormat { - pattern?: string | undefined; - type?: string | undefined; - } - interface OrgChartSpec { - labels?: Sheets.Schema.ChartData | undefined; - nodeColor?: Sheets.Schema.Color | undefined; - nodeSize?: string | undefined; - parentLabels?: Sheets.Schema.ChartData | undefined; - selectedNodeColor?: Sheets.Schema.Color | undefined; - tooltips?: Sheets.Schema.ChartData | undefined; - } - interface OverlayPosition { - anchorCell?: Sheets.Schema.GridCoordinate | undefined; - heightPixels?: number | undefined; - offsetXPixels?: number | undefined; - offsetYPixels?: number | undefined; - widthPixels?: number | undefined; - } - interface Padding { - bottom?: number | undefined; - left?: number | undefined; - right?: number | undefined; - top?: number | undefined; - } - interface PasteDataRequest { - coordinate?: Sheets.Schema.GridCoordinate | undefined; - data?: string | undefined; - delimiter?: string | undefined; - html?: boolean | undefined; - type?: string | undefined; - } - interface PieChartSpec { - domain?: Sheets.Schema.ChartData | undefined; - legendPosition?: string | undefined; - pieHole?: number | undefined; - series?: Sheets.Schema.ChartData | undefined; - threeDimensional?: boolean | undefined; - } - interface PivotFilterCriteria { - visibleValues?: string[] | undefined; - } - interface PivotGroup { - groupRule?: Sheets.Schema.PivotGroupRule | undefined; - label?: string | undefined; - repeatHeadings?: boolean | undefined; - showTotals?: boolean | undefined; - sortOrder?: string | undefined; - sourceColumnOffset?: number | undefined; - valueBucket?: Sheets.Schema.PivotGroupSortValueBucket | undefined; - valueMetadata?: Sheets.Schema.PivotGroupValueMetadata[] | undefined; - } - interface PivotGroupRule { - dateTimeRule?: Sheets.Schema.DateTimeRule | undefined; - histogramRule?: Sheets.Schema.HistogramRule | undefined; - manualRule?: Sheets.Schema.ManualRule | undefined; - } - interface PivotGroupSortValueBucket { - buckets?: Sheets.Schema.ExtendedValue[] | undefined; - valuesIndex?: number | undefined; - } - interface PivotGroupValueMetadata { - collapsed?: boolean | undefined; - value?: Sheets.Schema.ExtendedValue | undefined; - } - interface PivotTable { - columns?: Sheets.Schema.PivotGroup[] | undefined; - criteria?: object | undefined; - rows?: Sheets.Schema.PivotGroup[] | undefined; - source?: Sheets.Schema.GridRange | undefined; - valueLayout?: string | undefined; - values?: Sheets.Schema.PivotValue[] | undefined; - } - interface PivotValue { - calculatedDisplayType?: string | undefined; - formula?: string | undefined; - name?: string | undefined; - sourceColumnOffset?: number | undefined; - summarizeFunction?: string | undefined; - } - interface ProtectedRange { - description?: string | undefined; - editors?: Sheets.Schema.Editors | undefined; - namedRangeId?: string | undefined; - protectedRangeId?: number | undefined; - range?: Sheets.Schema.GridRange | undefined; - requestingUserCanEdit?: boolean | undefined; - unprotectedRanges?: Sheets.Schema.GridRange[] | undefined; - warningOnly?: boolean | undefined; - } - interface RandomizeRangeRequest { - range?: Sheets.Schema.GridRange | undefined; - } - interface RepeatCellRequest { - cell?: Sheets.Schema.CellData | undefined; - fields?: string | undefined; - range?: Sheets.Schema.GridRange | undefined; - } - interface Request { - addBanding?: Sheets.Schema.AddBandingRequest | undefined; - addChart?: Sheets.Schema.AddChartRequest | undefined; - addConditionalFormatRule?: Sheets.Schema.AddConditionalFormatRuleRequest | undefined; - addDimensionGroup?: Sheets.Schema.AddDimensionGroupRequest | undefined; - addFilterView?: Sheets.Schema.AddFilterViewRequest | undefined; - addNamedRange?: Sheets.Schema.AddNamedRangeRequest | undefined; - addProtectedRange?: Sheets.Schema.AddProtectedRangeRequest | undefined; - addSheet?: Sheets.Schema.AddSheetRequest | undefined; - appendCells?: Sheets.Schema.AppendCellsRequest | undefined; - appendDimension?: Sheets.Schema.AppendDimensionRequest | undefined; - autoFill?: Sheets.Schema.AutoFillRequest | undefined; - autoResizeDimensions?: Sheets.Schema.AutoResizeDimensionsRequest | undefined; - clearBasicFilter?: Sheets.Schema.ClearBasicFilterRequest | undefined; - copyPaste?: Sheets.Schema.CopyPasteRequest | undefined; - createDeveloperMetadata?: Sheets.Schema.CreateDeveloperMetadataRequest | undefined; - cutPaste?: Sheets.Schema.CutPasteRequest | undefined; - deleteBanding?: Sheets.Schema.DeleteBandingRequest | undefined; - deleteConditionalFormatRule?: Sheets.Schema.DeleteConditionalFormatRuleRequest | undefined; - deleteDeveloperMetadata?: Sheets.Schema.DeleteDeveloperMetadataRequest | undefined; - deleteDimension?: Sheets.Schema.DeleteDimensionRequest | undefined; - deleteDimensionGroup?: Sheets.Schema.DeleteDimensionGroupRequest | undefined; - deleteEmbeddedObject?: Sheets.Schema.DeleteEmbeddedObjectRequest | undefined; - deleteFilterView?: Sheets.Schema.DeleteFilterViewRequest | undefined; - deleteNamedRange?: Sheets.Schema.DeleteNamedRangeRequest | undefined; - deleteProtectedRange?: Sheets.Schema.DeleteProtectedRangeRequest | undefined; - deleteRange?: Sheets.Schema.DeleteRangeRequest | undefined; - deleteSheet?: Sheets.Schema.DeleteSheetRequest | undefined; - duplicateFilterView?: Sheets.Schema.DuplicateFilterViewRequest | undefined; - duplicateSheet?: Sheets.Schema.DuplicateSheetRequest | undefined; - findReplace?: Sheets.Schema.FindReplaceRequest | undefined; - insertDimension?: Sheets.Schema.InsertDimensionRequest | undefined; - insertRange?: Sheets.Schema.InsertRangeRequest | undefined; - mergeCells?: Sheets.Schema.MergeCellsRequest | undefined; - moveDimension?: Sheets.Schema.MoveDimensionRequest | undefined; - pasteData?: Sheets.Schema.PasteDataRequest | undefined; - randomizeRange?: Sheets.Schema.RandomizeRangeRequest | undefined; - repeatCell?: Sheets.Schema.RepeatCellRequest | undefined; - setBasicFilter?: Sheets.Schema.SetBasicFilterRequest | undefined; - setDataValidation?: Sheets.Schema.SetDataValidationRequest | undefined; - sortRange?: Sheets.Schema.SortRangeRequest | undefined; - textToColumns?: Sheets.Schema.TextToColumnsRequest | undefined; - unmergeCells?: Sheets.Schema.UnmergeCellsRequest | undefined; - updateBanding?: Sheets.Schema.UpdateBandingRequest | undefined; - updateBorders?: Sheets.Schema.UpdateBordersRequest | undefined; - updateCells?: Sheets.Schema.UpdateCellsRequest | undefined; - updateChartSpec?: Sheets.Schema.UpdateChartSpecRequest | undefined; - updateConditionalFormatRule?: Sheets.Schema.UpdateConditionalFormatRuleRequest | undefined; - updateDeveloperMetadata?: Sheets.Schema.UpdateDeveloperMetadataRequest | undefined; - updateDimensionGroup?: Sheets.Schema.UpdateDimensionGroupRequest | undefined; - updateDimensionProperties?: Sheets.Schema.UpdateDimensionPropertiesRequest | undefined; - updateEmbeddedObjectPosition?: Sheets.Schema.UpdateEmbeddedObjectPositionRequest | undefined; - updateFilterView?: Sheets.Schema.UpdateFilterViewRequest | undefined; - updateNamedRange?: Sheets.Schema.UpdateNamedRangeRequest | undefined; - updateProtectedRange?: Sheets.Schema.UpdateProtectedRangeRequest | undefined; - updateSheetProperties?: Sheets.Schema.UpdateSheetPropertiesRequest | undefined; - updateSpreadsheetProperties?: Sheets.Schema.UpdateSpreadsheetPropertiesRequest | undefined; - } - interface Response { - addBanding?: Sheets.Schema.AddBandingResponse | undefined; - addChart?: Sheets.Schema.AddChartResponse | undefined; - addDimensionGroup?: Sheets.Schema.AddDimensionGroupResponse | undefined; - addFilterView?: Sheets.Schema.AddFilterViewResponse | undefined; - addNamedRange?: Sheets.Schema.AddNamedRangeResponse | undefined; - addProtectedRange?: Sheets.Schema.AddProtectedRangeResponse | undefined; - addSheet?: Sheets.Schema.AddSheetResponse | undefined; - createDeveloperMetadata?: Sheets.Schema.CreateDeveloperMetadataResponse | undefined; - deleteConditionalFormatRule?: Sheets.Schema.DeleteConditionalFormatRuleResponse | undefined; - deleteDeveloperMetadata?: Sheets.Schema.DeleteDeveloperMetadataResponse | undefined; - deleteDimensionGroup?: Sheets.Schema.DeleteDimensionGroupResponse | undefined; - duplicateFilterView?: Sheets.Schema.DuplicateFilterViewResponse | undefined; - duplicateSheet?: Sheets.Schema.DuplicateSheetResponse | undefined; - findReplace?: Sheets.Schema.FindReplaceResponse | undefined; - updateConditionalFormatRule?: Sheets.Schema.UpdateConditionalFormatRuleResponse | undefined; - updateDeveloperMetadata?: Sheets.Schema.UpdateDeveloperMetadataResponse | undefined; - updateEmbeddedObjectPosition?: Sheets.Schema.UpdateEmbeddedObjectPositionResponse | undefined; - } - interface RowData { - values?: Sheets.Schema.CellData[] | undefined; - } - interface SearchDeveloperMetadataRequest { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - } - interface SearchDeveloperMetadataResponse { - matchedDeveloperMetadata?: Sheets.Schema.MatchedDeveloperMetadata[] | undefined; - } - interface SetBasicFilterRequest { - filter?: Sheets.Schema.BasicFilter | undefined; - } - interface SetDataValidationRequest { - range?: Sheets.Schema.GridRange | undefined; - rule?: Sheets.Schema.DataValidationRule | undefined; - } - interface Sheet { - bandedRanges?: Sheets.Schema.BandedRange[] | undefined; - basicFilter?: Sheets.Schema.BasicFilter | undefined; - charts?: Sheets.Schema.EmbeddedChart[] | undefined; - columnGroups?: Sheets.Schema.DimensionGroup[] | undefined; - conditionalFormats?: Sheets.Schema.ConditionalFormatRule[] | undefined; - data?: Sheets.Schema.GridData[] | undefined; - developerMetadata?: Sheets.Schema.DeveloperMetadata[] | undefined; - filterViews?: Sheets.Schema.FilterView[] | undefined; - merges?: Sheets.Schema.GridRange[] | undefined; - properties?: Sheets.Schema.SheetProperties | undefined; - protectedRanges?: Sheets.Schema.ProtectedRange[] | undefined; - rowGroups?: Sheets.Schema.DimensionGroup[] | undefined; - } - interface SheetProperties { - gridProperties?: Sheets.Schema.GridProperties | undefined; - hidden?: boolean | undefined; - index?: number | undefined; - rightToLeft?: boolean | undefined; - sheetId?: number | undefined; - sheetType?: string | undefined; - tabColor?: Sheets.Schema.Color | undefined; - title?: string | undefined; - } - interface SortRangeRequest { - range?: Sheets.Schema.GridRange | undefined; - sortSpecs?: Sheets.Schema.SortSpec[] | undefined; - } - interface SortSpec { - dimensionIndex?: number | undefined; - sortOrder?: string | undefined; - } - interface SourceAndDestination { - dimension?: string | undefined; - fillLength?: number | undefined; - source?: Sheets.Schema.GridRange | undefined; - } - interface Spreadsheet { - developerMetadata?: Sheets.Schema.DeveloperMetadata[] | undefined; - namedRanges?: Sheets.Schema.NamedRange[] | undefined; - properties?: Sheets.Schema.SpreadsheetProperties | undefined; - sheets?: Sheets.Schema.Sheet[] | undefined; - spreadsheetId?: string | undefined; - spreadsheetUrl?: string | undefined; - } - interface SpreadsheetProperties { - autoRecalc?: string | undefined; - defaultFormat?: Sheets.Schema.CellFormat | undefined; - iterativeCalculationSettings?: Sheets.Schema.IterativeCalculationSettings | undefined; - locale?: string | undefined; - timeZone?: string | undefined; - title?: string | undefined; - } - interface TextFormat { - bold?: boolean | undefined; - fontFamily?: string | undefined; - fontSize?: number | undefined; - foregroundColor?: Sheets.Schema.Color | undefined; - italic?: boolean | undefined; - strikethrough?: boolean | undefined; - underline?: boolean | undefined; - } - interface TextFormatRun { - format?: Sheets.Schema.TextFormat | undefined; - startIndex?: number | undefined; - } - interface TextPosition { - horizontalAlignment?: string | undefined; - } - interface TextRotation { - angle?: number | undefined; - vertical?: boolean | undefined; - } - interface TextToColumnsRequest { - delimiter?: string | undefined; - delimiterType?: string | undefined; - source?: Sheets.Schema.GridRange | undefined; - } - interface TreemapChartColorScale { - maxValueColor?: Sheets.Schema.Color | undefined; - midValueColor?: Sheets.Schema.Color | undefined; - minValueColor?: Sheets.Schema.Color | undefined; - noDataColor?: Sheets.Schema.Color | undefined; - } - interface TreemapChartSpec { - colorData?: Sheets.Schema.ChartData | undefined; - colorScale?: Sheets.Schema.TreemapChartColorScale | undefined; - headerColor?: Sheets.Schema.Color | undefined; - hideTooltips?: boolean | undefined; - hintedLevels?: number | undefined; - labels?: Sheets.Schema.ChartData | undefined; - levels?: number | undefined; - maxValue?: number | undefined; - minValue?: number | undefined; - parentLabels?: Sheets.Schema.ChartData | undefined; - sizeData?: Sheets.Schema.ChartData | undefined; - textFormat?: Sheets.Schema.TextFormat | undefined; - } - interface UnmergeCellsRequest { - range?: Sheets.Schema.GridRange | undefined; - } - interface UpdateBandingRequest { - bandedRange?: Sheets.Schema.BandedRange | undefined; - fields?: string | undefined; - } - interface UpdateBordersRequest { - bottom?: Sheets.Schema.Border | undefined; - innerHorizontal?: Sheets.Schema.Border | undefined; - innerVertical?: Sheets.Schema.Border | undefined; - left?: Sheets.Schema.Border | undefined; - range?: Sheets.Schema.GridRange | undefined; - right?: Sheets.Schema.Border | undefined; - top?: Sheets.Schema.Border | undefined; - } - interface UpdateCellsRequest { - fields?: string | undefined; - range?: Sheets.Schema.GridRange | undefined; - rows?: Sheets.Schema.RowData[] | undefined; - start?: Sheets.Schema.GridCoordinate | undefined; - } - interface UpdateChartSpecRequest { - chartId?: number | undefined; - spec?: Sheets.Schema.ChartSpec | undefined; - } - interface UpdateConditionalFormatRuleRequest { - index?: number | undefined; - newIndex?: number | undefined; - rule?: Sheets.Schema.ConditionalFormatRule | undefined; - sheetId?: number | undefined; - } - interface UpdateConditionalFormatRuleResponse { - newIndex?: number | undefined; - newRule?: Sheets.Schema.ConditionalFormatRule | undefined; - oldIndex?: number | undefined; - oldRule?: Sheets.Schema.ConditionalFormatRule | undefined; - } - interface UpdateDeveloperMetadataRequest { - dataFilters?: Sheets.Schema.DataFilter[] | undefined; - developerMetadata?: Sheets.Schema.DeveloperMetadata | undefined; - fields?: string | undefined; - } - interface UpdateDeveloperMetadataResponse { - developerMetadata?: Sheets.Schema.DeveloperMetadata[] | undefined; - } - interface UpdateDimensionGroupRequest { - dimensionGroup?: Sheets.Schema.DimensionGroup | undefined; - fields?: string | undefined; - } - interface UpdateDimensionPropertiesRequest { - fields?: string | undefined; - properties?: Sheets.Schema.DimensionProperties | undefined; - range?: Sheets.Schema.DimensionRange | undefined; - } - interface UpdateEmbeddedObjectPositionRequest { - fields?: string | undefined; - newPosition?: Sheets.Schema.EmbeddedObjectPosition | undefined; - objectId?: number | undefined; - } - interface UpdateEmbeddedObjectPositionResponse { - position?: Sheets.Schema.EmbeddedObjectPosition | undefined; - } - interface UpdateFilterViewRequest { - fields?: string | undefined; - filter?: Sheets.Schema.FilterView | undefined; - } - interface UpdateNamedRangeRequest { - fields?: string | undefined; - namedRange?: Sheets.Schema.NamedRange | undefined; - } - interface UpdateProtectedRangeRequest { - fields?: string | undefined; - protectedRange?: Sheets.Schema.ProtectedRange | undefined; - } - interface UpdateSheetPropertiesRequest { - fields?: string | undefined; - properties?: Sheets.Schema.SheetProperties | undefined; - } - interface UpdateSpreadsheetPropertiesRequest { - fields?: string | undefined; - properties?: Sheets.Schema.SpreadsheetProperties | undefined; - } - interface UpdateValuesByDataFilterResponse { - dataFilter?: Sheets.Schema.DataFilter | undefined; - updatedCells?: number | undefined; - updatedColumns?: number | undefined; - updatedData?: Sheets.Schema.ValueRange | undefined; - updatedRange?: string | undefined; - updatedRows?: number | undefined; - } - interface UpdateValuesResponse { - spreadsheetId?: string | undefined; - updatedCells?: number | undefined; - updatedColumns?: number | undefined; - updatedData?: Sheets.Schema.ValueRange | undefined; - updatedRange?: string | undefined; - updatedRows?: number | undefined; - } - interface ValueRange { - majorDimension?: string | undefined; - range?: string | undefined; - values?: any[][] | undefined; - } - interface WaterfallChartColumnStyle { - color?: Sheets.Schema.Color | undefined; - label?: string | undefined; - } - interface WaterfallChartCustomSubtotal { - dataIsSubtotal?: boolean | undefined; - label?: string | undefined; - subtotalIndex?: number | undefined; - } - interface WaterfallChartDomain { - data?: Sheets.Schema.ChartData | undefined; - reversed?: boolean | undefined; - } - interface WaterfallChartSeries { - customSubtotals?: Sheets.Schema.WaterfallChartCustomSubtotal[] | undefined; - data?: Sheets.Schema.ChartData | undefined; - hideTrailingSubtotal?: boolean | undefined; - negativeColumnsStyle?: Sheets.Schema.WaterfallChartColumnStyle | undefined; - positiveColumnsStyle?: Sheets.Schema.WaterfallChartColumnStyle | undefined; - subtotalColumnsStyle?: Sheets.Schema.WaterfallChartColumnStyle | undefined; - } - interface WaterfallChartSpec { - connectorLineStyle?: Sheets.Schema.LineStyle | undefined; - domain?: Sheets.Schema.WaterfallChartDomain | undefined; - firstValueIsTotal?: boolean | undefined; - hideConnectorLines?: boolean | undefined; - series?: Sheets.Schema.WaterfallChartSeries[] | undefined; - stackedType?: string | undefined; - } - } - } - interface Sheets { - Spreadsheets?: Sheets.Collection.SpreadsheetsCollection | undefined; - // Create a new instance of AddBandingRequest - newAddBandingRequest(): Sheets.Schema.AddBandingRequest; - // Create a new instance of AddChartRequest - newAddChartRequest(): Sheets.Schema.AddChartRequest; - // Create a new instance of AddConditionalFormatRuleRequest - newAddConditionalFormatRuleRequest(): Sheets.Schema.AddConditionalFormatRuleRequest; - // Create a new instance of AddDimensionGroupRequest - newAddDimensionGroupRequest(): Sheets.Schema.AddDimensionGroupRequest; - // Create a new instance of AddFilterViewRequest - newAddFilterViewRequest(): Sheets.Schema.AddFilterViewRequest; - // Create a new instance of AddNamedRangeRequest - newAddNamedRangeRequest(): Sheets.Schema.AddNamedRangeRequest; - // Create a new instance of AddProtectedRangeRequest - newAddProtectedRangeRequest(): Sheets.Schema.AddProtectedRangeRequest; - // Create a new instance of AddSheetRequest - newAddSheetRequest(): Sheets.Schema.AddSheetRequest; - // Create a new instance of AppendCellsRequest - newAppendCellsRequest(): Sheets.Schema.AppendCellsRequest; - // Create a new instance of AppendDimensionRequest - newAppendDimensionRequest(): Sheets.Schema.AppendDimensionRequest; - // Create a new instance of AutoFillRequest - newAutoFillRequest(): Sheets.Schema.AutoFillRequest; - // Create a new instance of AutoResizeDimensionsRequest - newAutoResizeDimensionsRequest(): Sheets.Schema.AutoResizeDimensionsRequest; - // Create a new instance of BandedRange - newBandedRange(): Sheets.Schema.BandedRange; - // Create a new instance of BandingProperties - newBandingProperties(): Sheets.Schema.BandingProperties; - // Create a new instance of BasicChartAxis - newBasicChartAxis(): Sheets.Schema.BasicChartAxis; - // Create a new instance of BasicChartDomain - newBasicChartDomain(): Sheets.Schema.BasicChartDomain; - // Create a new instance of BasicChartSeries - newBasicChartSeries(): Sheets.Schema.BasicChartSeries; - // Create a new instance of BasicChartSpec - newBasicChartSpec(): Sheets.Schema.BasicChartSpec; - // Create a new instance of BasicFilter - newBasicFilter(): Sheets.Schema.BasicFilter; - // Create a new instance of BatchClearValuesByDataFilterRequest - newBatchClearValuesByDataFilterRequest(): Sheets.Schema.BatchClearValuesByDataFilterRequest; - // Create a new instance of BatchClearValuesRequest - newBatchClearValuesRequest(): Sheets.Schema.BatchClearValuesRequest; - // Create a new instance of BatchGetValuesByDataFilterRequest - newBatchGetValuesByDataFilterRequest(): Sheets.Schema.BatchGetValuesByDataFilterRequest; - // Create a new instance of BatchUpdateSpreadsheetRequest - newBatchUpdateSpreadsheetRequest(): Sheets.Schema.BatchUpdateSpreadsheetRequest; - // Create a new instance of BatchUpdateValuesByDataFilterRequest - newBatchUpdateValuesByDataFilterRequest(): Sheets.Schema.BatchUpdateValuesByDataFilterRequest; - // Create a new instance of BatchUpdateValuesRequest - newBatchUpdateValuesRequest(): Sheets.Schema.BatchUpdateValuesRequest; - // Create a new instance of BooleanCondition - newBooleanCondition(): Sheets.Schema.BooleanCondition; - // Create a new instance of BooleanRule - newBooleanRule(): Sheets.Schema.BooleanRule; - // Create a new instance of Border - newBorder(): Sheets.Schema.Border; - // Create a new instance of Borders - newBorders(): Sheets.Schema.Borders; - // Create a new instance of BubbleChartSpec - newBubbleChartSpec(): Sheets.Schema.BubbleChartSpec; - // Create a new instance of CandlestickChartSpec - newCandlestickChartSpec(): Sheets.Schema.CandlestickChartSpec; - // Create a new instance of CandlestickData - newCandlestickData(): Sheets.Schema.CandlestickData; - // Create a new instance of CandlestickDomain - newCandlestickDomain(): Sheets.Schema.CandlestickDomain; - // Create a new instance of CandlestickSeries - newCandlestickSeries(): Sheets.Schema.CandlestickSeries; - // Create a new instance of CellData - newCellData(): Sheets.Schema.CellData; - // Create a new instance of CellFormat - newCellFormat(): Sheets.Schema.CellFormat; - // Create a new instance of ChartData - newChartData(): Sheets.Schema.ChartData; - // Create a new instance of ChartSourceRange - newChartSourceRange(): Sheets.Schema.ChartSourceRange; - // Create a new instance of ChartSpec - newChartSpec(): Sheets.Schema.ChartSpec; - // Create a new instance of ClearBasicFilterRequest - newClearBasicFilterRequest(): Sheets.Schema.ClearBasicFilterRequest; - // Create a new instance of ClearValuesRequest - newClearValuesRequest(): any; // Schema.ClearValuesRequest; - // Create a new instance of Color - newColor(): Sheets.Schema.Color; - // Create a new instance of ConditionValue - newConditionValue(): Sheets.Schema.ConditionValue; - // Create a new instance of ConditionalFormatRule - newConditionalFormatRule(): Sheets.Schema.ConditionalFormatRule; - // Create a new instance of CopyPasteRequest - newCopyPasteRequest(): Sheets.Schema.CopyPasteRequest; - // Create a new instance of CopySheetToAnotherSpreadsheetRequest - newCopySheetToAnotherSpreadsheetRequest(): Sheets.Schema.CopySheetToAnotherSpreadsheetRequest; - // Create a new instance of CreateDeveloperMetadataRequest - newCreateDeveloperMetadataRequest(): Sheets.Schema.CreateDeveloperMetadataRequest; - // Create a new instance of CutPasteRequest - newCutPasteRequest(): Sheets.Schema.CutPasteRequest; - // Create a new instance of DataFilter - newDataFilter(): Sheets.Schema.DataFilter; - // Create a new instance of DataFilterValueRange - newDataFilterValueRange(): Sheets.Schema.DataFilterValueRange; - // Create a new instance of DataValidationRule - newDataValidationRule(): Sheets.Schema.DataValidationRule; - // Create a new instance of DateTimeRule - newDateTimeRule(): Sheets.Schema.DateTimeRule; - // Create a new instance of DeleteBandingRequest - newDeleteBandingRequest(): Sheets.Schema.DeleteBandingRequest; - // Create a new instance of DeleteConditionalFormatRuleRequest - newDeleteConditionalFormatRuleRequest(): Sheets.Schema.DeleteConditionalFormatRuleRequest; - // Create a new instance of DeleteDeveloperMetadataRequest - newDeleteDeveloperMetadataRequest(): Sheets.Schema.DeleteDeveloperMetadataRequest; - // Create a new instance of DeleteDimensionGroupRequest - newDeleteDimensionGroupRequest(): Sheets.Schema.DeleteDimensionGroupRequest; - // Create a new instance of DeleteDimensionRequest - newDeleteDimensionRequest(): Sheets.Schema.DeleteDimensionRequest; - // Create a new instance of DeleteEmbeddedObjectRequest - newDeleteEmbeddedObjectRequest(): Sheets.Schema.DeleteEmbeddedObjectRequest; - // Create a new instance of DeleteFilterViewRequest - newDeleteFilterViewRequest(): Sheets.Schema.DeleteFilterViewRequest; - // Create a new instance of DeleteNamedRangeRequest - newDeleteNamedRangeRequest(): Sheets.Schema.DeleteNamedRangeRequest; - // Create a new instance of DeleteProtectedRangeRequest - newDeleteProtectedRangeRequest(): Sheets.Schema.DeleteProtectedRangeRequest; - // Create a new instance of DeleteRangeRequest - newDeleteRangeRequest(): Sheets.Schema.DeleteRangeRequest; - // Create a new instance of DeleteSheetRequest - newDeleteSheetRequest(): Sheets.Schema.DeleteSheetRequest; - // Create a new instance of DeveloperMetadata - newDeveloperMetadata(): Sheets.Schema.DeveloperMetadata; - // Create a new instance of DeveloperMetadataLocation - newDeveloperMetadataLocation(): Sheets.Schema.DeveloperMetadataLocation; - // Create a new instance of DeveloperMetadataLookup - newDeveloperMetadataLookup(): Sheets.Schema.DeveloperMetadataLookup; - // Create a new instance of DimensionGroup - newDimensionGroup(): Sheets.Schema.DimensionGroup; - // Create a new instance of DimensionProperties - newDimensionProperties(): Sheets.Schema.DimensionProperties; - // Create a new instance of DimensionRange - newDimensionRange(): Sheets.Schema.DimensionRange; - // Create a new instance of DuplicateFilterViewRequest - newDuplicateFilterViewRequest(): Sheets.Schema.DuplicateFilterViewRequest; - // Create a new instance of DuplicateSheetRequest - newDuplicateSheetRequest(): Sheets.Schema.DuplicateSheetRequest; - // Create a new instance of Editors - newEditors(): Sheets.Schema.Editors; - // Create a new instance of EmbeddedChart - newEmbeddedChart(): Sheets.Schema.EmbeddedChart; - // Create a new instance of EmbeddedObjectPosition - newEmbeddedObjectPosition(): Sheets.Schema.EmbeddedObjectPosition; - // Create a new instance of ErrorValue - newErrorValue(): Sheets.Schema.ErrorValue; - // Create a new instance of ExtendedValue - newExtendedValue(): Sheets.Schema.ExtendedValue; - // Create a new instance of FilterView - newFilterView(): Sheets.Schema.FilterView; - // Create a new instance of FindReplaceRequest - newFindReplaceRequest(): Sheets.Schema.FindReplaceRequest; - // Create a new instance of GetSpreadsheetByDataFilterRequest - newGetSpreadsheetByDataFilterRequest(): Sheets.Schema.GetSpreadsheetByDataFilterRequest; - // Create a new instance of GradientRule - newGradientRule(): Sheets.Schema.GradientRule; - // Create a new instance of GridCoordinate - newGridCoordinate(): Sheets.Schema.GridCoordinate; - // Create a new instance of GridData - newGridData(): Sheets.Schema.GridData; - // Create a new instance of GridProperties - newGridProperties(): Sheets.Schema.GridProperties; - // Create a new instance of GridRange - newGridRange(): Sheets.Schema.GridRange; - // Create a new instance of HistogramChartSpec - newHistogramChartSpec(): Sheets.Schema.HistogramChartSpec; - // Create a new instance of HistogramRule - newHistogramRule(): Sheets.Schema.HistogramRule; - // Create a new instance of HistogramSeries - newHistogramSeries(): Sheets.Schema.HistogramSeries; - // Create a new instance of InsertDimensionRequest - newInsertDimensionRequest(): Sheets.Schema.InsertDimensionRequest; - // Create a new instance of InsertRangeRequest - newInsertRangeRequest(): Sheets.Schema.InsertRangeRequest; - // Create a new instance of InterpolationPoint - newInterpolationPoint(): Sheets.Schema.InterpolationPoint; - // Create a new instance of IterativeCalculationSettings - newIterativeCalculationSettings(): Sheets.Schema.IterativeCalculationSettings; - // Create a new instance of LineStyle - newLineStyle(): Sheets.Schema.LineStyle; - // Create a new instance of ManualRule - newManualRule(): Sheets.Schema.ManualRule; - // Create a new instance of ManualRuleGroup - newManualRuleGroup(): Sheets.Schema.ManualRuleGroup; - // Create a new instance of MergeCellsRequest - newMergeCellsRequest(): Sheets.Schema.MergeCellsRequest; - // Create a new instance of MoveDimensionRequest - newMoveDimensionRequest(): Sheets.Schema.MoveDimensionRequest; - // Create a new instance of NamedRange - newNamedRange(): Sheets.Schema.NamedRange; - // Create a new instance of NumberFormat - newNumberFormat(): Sheets.Schema.NumberFormat; - // Create a new instance of OrgChartSpec - newOrgChartSpec(): Sheets.Schema.OrgChartSpec; - // Create a new instance of OverlayPosition - newOverlayPosition(): Sheets.Schema.OverlayPosition; - // Create a new instance of Padding - newPadding(): Sheets.Schema.Padding; - // Create a new instance of PasteDataRequest - newPasteDataRequest(): Sheets.Schema.PasteDataRequest; - // Create a new instance of PieChartSpec - newPieChartSpec(): Sheets.Schema.PieChartSpec; - // Create a new instance of PivotGroup - newPivotGroup(): Sheets.Schema.PivotGroup; - // Create a new instance of PivotGroupRule - newPivotGroupRule(): Sheets.Schema.PivotGroupRule; - // Create a new instance of PivotGroupSortValueBucket - newPivotGroupSortValueBucket(): Sheets.Schema.PivotGroupSortValueBucket; - // Create a new instance of PivotGroupValueMetadata - newPivotGroupValueMetadata(): Sheets.Schema.PivotGroupValueMetadata; - // Create a new instance of PivotTable - newPivotTable(): Sheets.Schema.PivotTable; - // Create a new instance of PivotValue - newPivotValue(): Sheets.Schema.PivotValue; - // Create a new instance of ProtectedRange - newProtectedRange(): Sheets.Schema.ProtectedRange; - // Create a new instance of RandomizeRangeRequest - newRandomizeRangeRequest(): Sheets.Schema.RandomizeRangeRequest; - // Create a new instance of RepeatCellRequest - newRepeatCellRequest(): Sheets.Schema.RepeatCellRequest; - // Create a new instance of Request - newRequest(): Sheets.Schema.Request; - // Create a new instance of RowData - newRowData(): Sheets.Schema.RowData; - // Create a new instance of SearchDeveloperMetadataRequest - newSearchDeveloperMetadataRequest(): Sheets.Schema.SearchDeveloperMetadataRequest; - // Create a new instance of SetBasicFilterRequest - newSetBasicFilterRequest(): Sheets.Schema.SetBasicFilterRequest; - // Create a new instance of SetDataValidationRequest - newSetDataValidationRequest(): Sheets.Schema.SetDataValidationRequest; - // Create a new instance of Sheet - newSheet(): Sheets.Schema.Sheet; - // Create a new instance of SheetProperties - newSheetProperties(): Sheets.Schema.SheetProperties; - // Create a new instance of SortRangeRequest - newSortRangeRequest(): Sheets.Schema.SortRangeRequest; - // Create a new instance of SortSpec - newSortSpec(): Sheets.Schema.SortSpec; - // Create a new instance of SourceAndDestination - newSourceAndDestination(): Sheets.Schema.SourceAndDestination; - // Create a new instance of Spreadsheet - newSpreadsheet(): Sheets.Schema.Spreadsheet; - // Create a new instance of SpreadsheetProperties - newSpreadsheetProperties(): Sheets.Schema.SpreadsheetProperties; - // Create a new instance of TextFormat - newTextFormat(): Sheets.Schema.TextFormat; - // Create a new instance of TextFormatRun - newTextFormatRun(): Sheets.Schema.TextFormatRun; - // Create a new instance of TextPosition - newTextPosition(): Sheets.Schema.TextPosition; - // Create a new instance of TextRotation - newTextRotation(): Sheets.Schema.TextRotation; - // Create a new instance of TextToColumnsRequest - newTextToColumnsRequest(): Sheets.Schema.TextToColumnsRequest; - // Create a new instance of TreemapChartColorScale - newTreemapChartColorScale(): Sheets.Schema.TreemapChartColorScale; - // Create a new instance of TreemapChartSpec - newTreemapChartSpec(): Sheets.Schema.TreemapChartSpec; - // Create a new instance of UnmergeCellsRequest - newUnmergeCellsRequest(): Sheets.Schema.UnmergeCellsRequest; - // Create a new instance of UpdateBandingRequest - newUpdateBandingRequest(): Sheets.Schema.UpdateBandingRequest; - // Create a new instance of UpdateBordersRequest - newUpdateBordersRequest(): Sheets.Schema.UpdateBordersRequest; - // Create a new instance of UpdateCellsRequest - newUpdateCellsRequest(): Sheets.Schema.UpdateCellsRequest; - // Create a new instance of UpdateChartSpecRequest - newUpdateChartSpecRequest(): Sheets.Schema.UpdateChartSpecRequest; - // Create a new instance of UpdateConditionalFormatRuleRequest - newUpdateConditionalFormatRuleRequest(): Sheets.Schema.UpdateConditionalFormatRuleRequest; - // Create a new instance of UpdateDeveloperMetadataRequest - newUpdateDeveloperMetadataRequest(): Sheets.Schema.UpdateDeveloperMetadataRequest; - // Create a new instance of UpdateDimensionGroupRequest - newUpdateDimensionGroupRequest(): Sheets.Schema.UpdateDimensionGroupRequest; - // Create a new instance of UpdateDimensionPropertiesRequest - newUpdateDimensionPropertiesRequest(): Sheets.Schema.UpdateDimensionPropertiesRequest; - // Create a new instance of UpdateEmbeddedObjectPositionRequest - newUpdateEmbeddedObjectPositionRequest(): Sheets.Schema.UpdateEmbeddedObjectPositionRequest; - // Create a new instance of UpdateFilterViewRequest - newUpdateFilterViewRequest(): Sheets.Schema.UpdateFilterViewRequest; - // Create a new instance of UpdateNamedRangeRequest - newUpdateNamedRangeRequest(): Sheets.Schema.UpdateNamedRangeRequest; - // Create a new instance of UpdateProtectedRangeRequest - newUpdateProtectedRangeRequest(): Sheets.Schema.UpdateProtectedRangeRequest; - // Create a new instance of UpdateSheetPropertiesRequest - newUpdateSheetPropertiesRequest(): Sheets.Schema.UpdateSheetPropertiesRequest; - // Create a new instance of UpdateSpreadsheetPropertiesRequest - newUpdateSpreadsheetPropertiesRequest(): Sheets.Schema.UpdateSpreadsheetPropertiesRequest; - // Create a new instance of ValueRange - newValueRange(): Sheets.Schema.ValueRange; - // Create a new instance of WaterfallChartColumnStyle - newWaterfallChartColumnStyle(): Sheets.Schema.WaterfallChartColumnStyle; - // Create a new instance of WaterfallChartCustomSubtotal - newWaterfallChartCustomSubtotal(): Sheets.Schema.WaterfallChartCustomSubtotal; - // Create a new instance of WaterfallChartDomain - newWaterfallChartDomain(): Sheets.Schema.WaterfallChartDomain; - // Create a new instance of WaterfallChartSeries - newWaterfallChartSeries(): Sheets.Schema.WaterfallChartSeries; - // Create a new instance of WaterfallChartSpec - newWaterfallChartSpec(): Sheets.Schema.WaterfallChartSpec; - } -} - -declare var Sheets: GoogleAppsScript.Sheets; diff --git a/node_modules/@types/google-apps-script/apis/slides_v1.d.ts b/node_modules/@types/google-apps-script/apis/slides_v1.d.ts deleted file mode 100644 index 2e3e85d..0000000 --- a/node_modules/@types/google-apps-script/apis/slides_v1.d.ts +++ /dev/null @@ -1,1009 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Slides { - namespace Collection { - namespace Presentations { - interface PagesCollection { - // Gets the latest version of the specified page in the presentation. - get(presentationId: string, pageObjectId: string): Slides.Schema.Page; - // Generates a thumbnail of the latest version of the specified page in the - // presentation and returns a URL to the thumbnail image. - // This request counts as an [expensive read request](/slides/limits) for - // quota purposes. - getThumbnail(presentationId: string, pageObjectId: string): Slides.Schema.Thumbnail; - // Generates a thumbnail of the latest version of the specified page in the - // presentation and returns a URL to the thumbnail image. - // This request counts as an [expensive read request](/slides/limits) for - // quota purposes. - getThumbnail( - presentationId: string, - pageObjectId: string, - optionalArgs: object, - ): Slides.Schema.Thumbnail; - } - } - interface PresentationsCollection { - Pages?: Slides.Collection.Presentations.PagesCollection | undefined; - // Applies one or more updates to the presentation. - // Each request is validated before - // being applied. If any request is not valid, then the entire request will - // fail and nothing will be applied. - // Some requests have replies to - // give you some information about how they are applied. Other requests do - // not need to return information; these each return an empty reply. - // The order of replies matches that of the requests. - // For example, suppose you call batchUpdate with four updates, and only the - // third one returns information. The response would have two empty replies: - // the reply to the third request, and another empty reply, in that order. - // Because other users may be editing the presentation, the presentation - // might not exactly reflect your changes: your changes may - // be altered with respect to collaborator changes. If there are no - // collaborators, the presentation should reflect your changes. In any case, - // the updates in your request are guaranteed to be applied together - // atomically. - batchUpdate( - resource: Schema.BatchUpdatePresentationRequest, - presentationId: string, - ): Slides.Schema.BatchUpdatePresentationResponse; - // Creates a blank presentation using the title given in the request. If a - // `presentationId` is provided, it is used as the ID of the new presentation. - // Otherwise, a new ID is generated. Other fields in the request, including - // any provided content, are ignored. - // Returns the created presentation. - create(resource: Schema.Presentation): Slides.Schema.Presentation; - // Gets the latest version of the specified presentation. - get(presentationId: string): Slides.Schema.Presentation; - } - } - namespace Schema { - interface AffineTransform { - scaleX?: number | undefined; - scaleY?: number | undefined; - shearX?: number | undefined; - shearY?: number | undefined; - translateX?: number | undefined; - translateY?: number | undefined; - unit?: string | undefined; - } - interface AutoText { - content?: string | undefined; - style?: Slides.Schema.TextStyle | undefined; - type?: string | undefined; - } - interface BatchUpdatePresentationRequest { - requests?: Slides.Schema.Request[] | undefined; - writeControl?: Slides.Schema.WriteControl | undefined; - } - interface BatchUpdatePresentationResponse { - presentationId?: string | undefined; - replies?: Slides.Schema.Response[] | undefined; - writeControl?: Slides.Schema.WriteControl | undefined; - } - interface Bullet { - bulletStyle?: Slides.Schema.TextStyle | undefined; - glyph?: string | undefined; - listId?: string | undefined; - nestingLevel?: number | undefined; - } - interface ColorScheme { - colors?: Slides.Schema.ThemeColorPair[] | undefined; - } - interface ColorStop { - alpha?: number | undefined; - color?: Slides.Schema.OpaqueColor | undefined; - position?: number | undefined; - } - interface CreateImageRequest { - elementProperties?: Slides.Schema.PageElementProperties | undefined; - objectId?: string | undefined; - url?: string | undefined; - } - interface CreateImageResponse { - objectId?: string | undefined; - } - interface CreateLineRequest { - category?: string | undefined; - elementProperties?: Slides.Schema.PageElementProperties | undefined; - lineCategory?: string | undefined; - objectId?: string | undefined; - } - interface CreateLineResponse { - objectId?: string | undefined; - } - interface CreateParagraphBulletsRequest { - bulletPreset?: string | undefined; - cellLocation?: Slides.Schema.TableCellLocation | undefined; - objectId?: string | undefined; - textRange?: Slides.Schema.Range | undefined; - } - interface CreateShapeRequest { - elementProperties?: Slides.Schema.PageElementProperties | undefined; - objectId?: string | undefined; - shapeType?: string | undefined; - } - interface CreateShapeResponse { - objectId?: string | undefined; - } - interface CreateSheetsChartRequest { - chartId?: number | undefined; - elementProperties?: Slides.Schema.PageElementProperties | undefined; - linkingMode?: string | undefined; - objectId?: string | undefined; - spreadsheetId?: string | undefined; - } - interface CreateSheetsChartResponse { - objectId?: string | undefined; - } - interface CreateSlideRequest { - insertionIndex?: number | undefined; - objectId?: string | undefined; - placeholderIdMappings?: Slides.Schema.LayoutPlaceholderIdMapping[] | undefined; - slideLayoutReference?: Slides.Schema.LayoutReference | undefined; - } - interface CreateSlideResponse { - objectId?: string | undefined; - } - interface CreateTableRequest { - columns?: number | undefined; - elementProperties?: Slides.Schema.PageElementProperties | undefined; - objectId?: string | undefined; - rows?: number | undefined; - } - interface CreateTableResponse { - objectId?: string | undefined; - } - interface CreateVideoRequest { - elementProperties?: Slides.Schema.PageElementProperties | undefined; - id?: string | undefined; - objectId?: string | undefined; - source?: string | undefined; - } - interface CreateVideoResponse { - objectId?: string | undefined; - } - interface CropProperties { - angle?: number | undefined; - bottomOffset?: number | undefined; - leftOffset?: number | undefined; - rightOffset?: number | undefined; - topOffset?: number | undefined; - } - interface DeleteObjectRequest { - objectId?: string | undefined; - } - interface DeleteParagraphBulletsRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - objectId?: string | undefined; - textRange?: Slides.Schema.Range | undefined; - } - interface DeleteTableColumnRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - tableObjectId?: string | undefined; - } - interface DeleteTableRowRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - tableObjectId?: string | undefined; - } - interface DeleteTextRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - objectId?: string | undefined; - textRange?: Slides.Schema.Range | undefined; - } - interface Dimension { - magnitude?: number | undefined; - unit?: string | undefined; - } - interface DuplicateObjectRequest { - objectId?: string | undefined; - objectIds?: object | undefined; - } - interface DuplicateObjectResponse { - objectId?: string | undefined; - } - interface Group { - children?: Slides.Schema.PageElement[] | undefined; - } - interface GroupObjectsRequest { - childrenObjectIds?: string[] | undefined; - groupObjectId?: string | undefined; - } - interface GroupObjectsResponse { - objectId?: string | undefined; - } - interface Image { - contentUrl?: string | undefined; - imageProperties?: Slides.Schema.ImageProperties | undefined; - sourceUrl?: string | undefined; - } - interface ImageProperties { - brightness?: number | undefined; - contrast?: number | undefined; - cropProperties?: Slides.Schema.CropProperties | undefined; - link?: Slides.Schema.Link | undefined; - outline?: Slides.Schema.Outline | undefined; - recolor?: Slides.Schema.Recolor | undefined; - shadow?: Slides.Schema.Shadow | undefined; - transparency?: number | undefined; - } - interface InsertTableColumnsRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - insertRight?: boolean | undefined; - number?: number | undefined; - tableObjectId?: string | undefined; - } - interface InsertTableRowsRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - insertBelow?: boolean | undefined; - number?: number | undefined; - tableObjectId?: string | undefined; - } - interface InsertTextRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - insertionIndex?: number | undefined; - objectId?: string | undefined; - text?: string | undefined; - } - interface LayoutPlaceholderIdMapping { - layoutPlaceholder?: Slides.Schema.Placeholder | undefined; - layoutPlaceholderObjectId?: string | undefined; - objectId?: string | undefined; - } - interface LayoutProperties { - displayName?: string | undefined; - masterObjectId?: string | undefined; - name?: string | undefined; - } - interface LayoutReference { - layoutId?: string | undefined; - predefinedLayout?: string | undefined; - } - interface Line { - lineCategory?: string | undefined; - lineProperties?: Slides.Schema.LineProperties | undefined; - lineType?: string | undefined; - } - interface LineConnection { - connectedObjectId?: string | undefined; - connectionSiteIndex?: number | undefined; - } - interface LineFill { - solidFill?: Slides.Schema.SolidFill | undefined; - } - interface LineProperties { - dashStyle?: string | undefined; - endArrow?: string | undefined; - endConnection?: Slides.Schema.LineConnection | undefined; - lineFill?: Slides.Schema.LineFill | undefined; - link?: Slides.Schema.Link | undefined; - startArrow?: string | undefined; - startConnection?: Slides.Schema.LineConnection | undefined; - weight?: Slides.Schema.Dimension | undefined; - } - interface Link { - pageObjectId?: string | undefined; - relativeLink?: string | undefined; - slideIndex?: number | undefined; - url?: string | undefined; - } - interface List { - listId?: string | undefined; - nestingLevel?: object | undefined; - } - interface MasterProperties { - displayName?: string | undefined; - } - interface MergeTableCellsRequest { - objectId?: string | undefined; - tableRange?: Slides.Schema.TableRange | undefined; - } - interface NestingLevel { - bulletStyle?: Slides.Schema.TextStyle | undefined; - } - interface NotesProperties { - speakerNotesObjectId?: string | undefined; - } - interface OpaqueColor { - rgbColor?: Slides.Schema.RgbColor | undefined; - themeColor?: string | undefined; - } - interface OptionalColor { - opaqueColor?: Slides.Schema.OpaqueColor | undefined; - } - interface Outline { - dashStyle?: string | undefined; - outlineFill?: Slides.Schema.OutlineFill | undefined; - propertyState?: string | undefined; - weight?: Slides.Schema.Dimension | undefined; - } - interface OutlineFill { - solidFill?: Slides.Schema.SolidFill | undefined; - } - interface Page { - layoutProperties?: Slides.Schema.LayoutProperties | undefined; - masterProperties?: Slides.Schema.MasterProperties | undefined; - notesProperties?: Slides.Schema.NotesProperties | undefined; - objectId?: string | undefined; - pageElements?: Slides.Schema.PageElement[] | undefined; - pageProperties?: Slides.Schema.PageProperties | undefined; - pageType?: string | undefined; - revisionId?: string | undefined; - slideProperties?: Slides.Schema.SlideProperties | undefined; - } - interface PageBackgroundFill { - propertyState?: string | undefined; - solidFill?: Slides.Schema.SolidFill | undefined; - stretchedPictureFill?: Slides.Schema.StretchedPictureFill | undefined; - } - interface PageElement { - description?: string | undefined; - elementGroup?: Slides.Schema.Group | undefined; - image?: Slides.Schema.Image | undefined; - line?: Slides.Schema.Line | undefined; - objectId?: string | undefined; - shape?: Slides.Schema.Shape | undefined; - sheetsChart?: Slides.Schema.SheetsChart | undefined; - size?: Slides.Schema.Size | undefined; - table?: Slides.Schema.Table | undefined; - title?: string | undefined; - transform?: Slides.Schema.AffineTransform | undefined; - video?: Slides.Schema.Video | undefined; - wordArt?: Slides.Schema.WordArt | undefined; - } - interface PageElementProperties { - pageObjectId?: string | undefined; - size?: Slides.Schema.Size | undefined; - transform?: Slides.Schema.AffineTransform | undefined; - } - interface PageProperties { - colorScheme?: Slides.Schema.ColorScheme | undefined; - pageBackgroundFill?: Slides.Schema.PageBackgroundFill | undefined; - } - interface ParagraphMarker { - bullet?: Slides.Schema.Bullet | undefined; - style?: Slides.Schema.ParagraphStyle | undefined; - } - interface ParagraphStyle { - alignment?: string | undefined; - direction?: string | undefined; - indentEnd?: Slides.Schema.Dimension | undefined; - indentFirstLine?: Slides.Schema.Dimension | undefined; - indentStart?: Slides.Schema.Dimension | undefined; - lineSpacing?: number | undefined; - spaceAbove?: Slides.Schema.Dimension | undefined; - spaceBelow?: Slides.Schema.Dimension | undefined; - spacingMode?: string | undefined; - } - interface Placeholder { - index?: number | undefined; - parentObjectId?: string | undefined; - type?: string | undefined; - } - interface Presentation { - layouts?: Slides.Schema.Page[] | undefined; - locale?: string | undefined; - masters?: Slides.Schema.Page[] | undefined; - notesMaster?: Slides.Schema.Page | undefined; - pageSize?: Slides.Schema.Size | undefined; - presentationId?: string | undefined; - revisionId?: string | undefined; - slides?: Slides.Schema.Page[] | undefined; - title?: string | undefined; - } - interface Range { - endIndex?: number | undefined; - startIndex?: number | undefined; - type?: string | undefined; - } - interface Recolor { - name?: string | undefined; - recolorStops?: Slides.Schema.ColorStop[] | undefined; - } - interface RefreshSheetsChartRequest { - objectId?: string | undefined; - } - interface ReplaceAllShapesWithImageRequest { - containsText?: Slides.Schema.SubstringMatchCriteria | undefined; - imageReplaceMethod?: string | undefined; - imageUrl?: string | undefined; - pageObjectIds?: string[] | undefined; - replaceMethod?: string | undefined; - } - interface ReplaceAllShapesWithImageResponse { - occurrencesChanged?: number | undefined; - } - interface ReplaceAllShapesWithSheetsChartRequest { - chartId?: number | undefined; - containsText?: Slides.Schema.SubstringMatchCriteria | undefined; - linkingMode?: string | undefined; - pageObjectIds?: string[] | undefined; - spreadsheetId?: string | undefined; - } - interface ReplaceAllShapesWithSheetsChartResponse { - occurrencesChanged?: number | undefined; - } - interface ReplaceAllTextRequest { - containsText?: Slides.Schema.SubstringMatchCriteria | undefined; - pageObjectIds?: string[] | undefined; - replaceText?: string | undefined; - } - interface ReplaceAllTextResponse { - occurrencesChanged?: number | undefined; - } - interface ReplaceImageRequest { - imageObjectId?: string | undefined; - imageReplaceMethod?: string | undefined; - url?: string | undefined; - } - interface Request { - createImage?: Slides.Schema.CreateImageRequest | undefined; - createLine?: Slides.Schema.CreateLineRequest | undefined; - createParagraphBullets?: Slides.Schema.CreateParagraphBulletsRequest | undefined; - createShape?: Slides.Schema.CreateShapeRequest | undefined; - createSheetsChart?: Slides.Schema.CreateSheetsChartRequest | undefined; - createSlide?: Slides.Schema.CreateSlideRequest | undefined; - createTable?: Slides.Schema.CreateTableRequest | undefined; - createVideo?: Slides.Schema.CreateVideoRequest | undefined; - deleteObject?: Slides.Schema.DeleteObjectRequest | undefined; - deleteParagraphBullets?: Slides.Schema.DeleteParagraphBulletsRequest | undefined; - deleteTableColumn?: Slides.Schema.DeleteTableColumnRequest | undefined; - deleteTableRow?: Slides.Schema.DeleteTableRowRequest | undefined; - deleteText?: Slides.Schema.DeleteTextRequest | undefined; - duplicateObject?: Slides.Schema.DuplicateObjectRequest | undefined; - groupObjects?: Slides.Schema.GroupObjectsRequest | undefined; - insertTableColumns?: Slides.Schema.InsertTableColumnsRequest | undefined; - insertTableRows?: Slides.Schema.InsertTableRowsRequest | undefined; - insertText?: Slides.Schema.InsertTextRequest | undefined; - mergeTableCells?: Slides.Schema.MergeTableCellsRequest | undefined; - refreshSheetsChart?: Slides.Schema.RefreshSheetsChartRequest | undefined; - replaceAllShapesWithImage?: Slides.Schema.ReplaceAllShapesWithImageRequest | undefined; - replaceAllShapesWithSheetsChart?: Slides.Schema.ReplaceAllShapesWithSheetsChartRequest | undefined; - replaceAllText?: Slides.Schema.ReplaceAllTextRequest | undefined; - replaceImage?: Slides.Schema.ReplaceImageRequest | undefined; - rerouteLine?: Slides.Schema.RerouteLineRequest | undefined; - ungroupObjects?: Slides.Schema.UngroupObjectsRequest | undefined; - unmergeTableCells?: Slides.Schema.UnmergeTableCellsRequest | undefined; - updateImageProperties?: Slides.Schema.UpdateImagePropertiesRequest | undefined; - updateLineCategory?: Slides.Schema.UpdateLineCategoryRequest | undefined; - updateLineProperties?: Slides.Schema.UpdateLinePropertiesRequest | undefined; - updatePageElementAltText?: Slides.Schema.UpdatePageElementAltTextRequest | undefined; - updatePageElementTransform?: Slides.Schema.UpdatePageElementTransformRequest | undefined; - updatePageElementsZOrder?: Slides.Schema.UpdatePageElementsZOrderRequest | undefined; - updatePageProperties?: Slides.Schema.UpdatePagePropertiesRequest | undefined; - updateParagraphStyle?: Slides.Schema.UpdateParagraphStyleRequest | undefined; - updateShapeProperties?: Slides.Schema.UpdateShapePropertiesRequest | undefined; - updateSlidesPosition?: Slides.Schema.UpdateSlidesPositionRequest | undefined; - updateTableBorderProperties?: Slides.Schema.UpdateTableBorderPropertiesRequest | undefined; - updateTableCellProperties?: Slides.Schema.UpdateTableCellPropertiesRequest | undefined; - updateTableColumnProperties?: Slides.Schema.UpdateTableColumnPropertiesRequest | undefined; - updateTableRowProperties?: Slides.Schema.UpdateTableRowPropertiesRequest | undefined; - updateTextStyle?: Slides.Schema.UpdateTextStyleRequest | undefined; - updateVideoProperties?: Slides.Schema.UpdateVideoPropertiesRequest | undefined; - } - interface RerouteLineRequest { - objectId?: string | undefined; - } - interface Response { - createImage?: Slides.Schema.CreateImageResponse | undefined; - createLine?: Slides.Schema.CreateLineResponse | undefined; - createShape?: Slides.Schema.CreateShapeResponse | undefined; - createSheetsChart?: Slides.Schema.CreateSheetsChartResponse | undefined; - createSlide?: Slides.Schema.CreateSlideResponse | undefined; - createTable?: Slides.Schema.CreateTableResponse | undefined; - createVideo?: Slides.Schema.CreateVideoResponse | undefined; - duplicateObject?: Slides.Schema.DuplicateObjectResponse | undefined; - groupObjects?: Slides.Schema.GroupObjectsResponse | undefined; - replaceAllShapesWithImage?: Slides.Schema.ReplaceAllShapesWithImageResponse | undefined; - replaceAllShapesWithSheetsChart?: Slides.Schema.ReplaceAllShapesWithSheetsChartResponse | undefined; - replaceAllText?: Slides.Schema.ReplaceAllTextResponse | undefined; - } - interface RgbColor { - blue?: number | undefined; - green?: number | undefined; - red?: number | undefined; - } - interface Shadow { - alignment?: string | undefined; - alpha?: number | undefined; - blurRadius?: Slides.Schema.Dimension | undefined; - color?: Slides.Schema.OpaqueColor | undefined; - propertyState?: string | undefined; - rotateWithShape?: boolean | undefined; - transform?: Slides.Schema.AffineTransform | undefined; - type?: string | undefined; - } - interface Shape { - placeholder?: Slides.Schema.Placeholder | undefined; - shapeProperties?: Slides.Schema.ShapeProperties | undefined; - shapeType?: string | undefined; - text?: Slides.Schema.TextContent | undefined; - } - interface ShapeBackgroundFill { - propertyState?: string | undefined; - solidFill?: Slides.Schema.SolidFill | undefined; - } - interface ShapeProperties { - contentAlignment?: string | undefined; - link?: Slides.Schema.Link | undefined; - outline?: Slides.Schema.Outline | undefined; - shadow?: Slides.Schema.Shadow | undefined; - shapeBackgroundFill?: Slides.Schema.ShapeBackgroundFill | undefined; - } - interface SheetsChart { - chartId?: number | undefined; - contentUrl?: string | undefined; - sheetsChartProperties?: Slides.Schema.SheetsChartProperties | undefined; - spreadsheetId?: string | undefined; - } - interface SheetsChartProperties { - chartImageProperties?: Slides.Schema.ImageProperties | undefined; - } - interface Size { - height?: Slides.Schema.Dimension | undefined; - width?: Slides.Schema.Dimension | undefined; - } - interface SlideProperties { - layoutObjectId?: string | undefined; - masterObjectId?: string | undefined; - notesPage?: Slides.Schema.Page | undefined; - } - interface SolidFill { - alpha?: number | undefined; - color?: Slides.Schema.OpaqueColor | undefined; - } - interface StretchedPictureFill { - contentUrl?: string | undefined; - size?: Slides.Schema.Size | undefined; - } - interface SubstringMatchCriteria { - matchCase?: boolean | undefined; - text?: string | undefined; - } - interface Table { - columns?: number | undefined; - horizontalBorderRows?: Slides.Schema.TableBorderRow[] | undefined; - rows?: number | undefined; - tableColumns?: Slides.Schema.TableColumnProperties[] | undefined; - tableRows?: Slides.Schema.TableRow[] | undefined; - verticalBorderRows?: Slides.Schema.TableBorderRow[] | undefined; - } - interface TableBorderCell { - location?: Slides.Schema.TableCellLocation | undefined; - tableBorderProperties?: Slides.Schema.TableBorderProperties | undefined; - } - interface TableBorderFill { - solidFill?: Slides.Schema.SolidFill | undefined; - } - interface TableBorderProperties { - dashStyle?: string | undefined; - tableBorderFill?: Slides.Schema.TableBorderFill | undefined; - weight?: Slides.Schema.Dimension | undefined; - } - interface TableBorderRow { - tableBorderCells?: Slides.Schema.TableBorderCell[] | undefined; - } - interface TableCell { - columnSpan?: number | undefined; - location?: Slides.Schema.TableCellLocation | undefined; - rowSpan?: number | undefined; - tableCellProperties?: Slides.Schema.TableCellProperties | undefined; - text?: Slides.Schema.TextContent | undefined; - } - interface TableCellBackgroundFill { - propertyState?: string | undefined; - solidFill?: Slides.Schema.SolidFill | undefined; - } - interface TableCellLocation { - columnIndex?: number | undefined; - rowIndex?: number | undefined; - } - interface TableCellProperties { - contentAlignment?: string | undefined; - tableCellBackgroundFill?: Slides.Schema.TableCellBackgroundFill | undefined; - } - interface TableColumnProperties { - columnWidth?: Slides.Schema.Dimension | undefined; - } - interface TableRange { - columnSpan?: number | undefined; - location?: Slides.Schema.TableCellLocation | undefined; - rowSpan?: number | undefined; - } - interface TableRow { - rowHeight?: Slides.Schema.Dimension | undefined; - tableCells?: Slides.Schema.TableCell[] | undefined; - tableRowProperties?: Slides.Schema.TableRowProperties | undefined; - } - interface TableRowProperties { - minRowHeight?: Slides.Schema.Dimension | undefined; - } - interface TextContent { - lists?: object | undefined; - textElements?: Slides.Schema.TextElement[] | undefined; - } - interface TextElement { - autoText?: Slides.Schema.AutoText | undefined; - endIndex?: number | undefined; - paragraphMarker?: Slides.Schema.ParagraphMarker | undefined; - startIndex?: number | undefined; - textRun?: Slides.Schema.TextRun | undefined; - } - interface TextRun { - content?: string | undefined; - style?: Slides.Schema.TextStyle | undefined; - } - interface TextStyle { - backgroundColor?: Slides.Schema.OptionalColor | undefined; - baselineOffset?: string | undefined; - bold?: boolean | undefined; - fontFamily?: string | undefined; - fontSize?: Slides.Schema.Dimension | undefined; - foregroundColor?: Slides.Schema.OptionalColor | undefined; - italic?: boolean | undefined; - link?: Slides.Schema.Link | undefined; - smallCaps?: boolean | undefined; - strikethrough?: boolean | undefined; - underline?: boolean | undefined; - weightedFontFamily?: Slides.Schema.WeightedFontFamily | undefined; - } - interface ThemeColorPair { - color?: Slides.Schema.RgbColor | undefined; - type?: string | undefined; - } - interface Thumbnail { - contentUrl?: string | undefined; - height?: number | undefined; - width?: number | undefined; - } - interface UngroupObjectsRequest { - objectIds?: string[] | undefined; - } - interface UnmergeTableCellsRequest { - objectId?: string | undefined; - tableRange?: Slides.Schema.TableRange | undefined; - } - interface UpdateImagePropertiesRequest { - fields?: string | undefined; - imageProperties?: Slides.Schema.ImageProperties | undefined; - objectId?: string | undefined; - } - interface UpdateLineCategoryRequest { - lineCategory?: string | undefined; - objectId?: string | undefined; - } - interface UpdateLinePropertiesRequest { - fields?: string | undefined; - lineProperties?: Slides.Schema.LineProperties | undefined; - objectId?: string | undefined; - } - interface UpdatePageElementAltTextRequest { - description?: string | undefined; - objectId?: string | undefined; - title?: string | undefined; - } - interface UpdatePageElementTransformRequest { - applyMode?: string | undefined; - objectId?: string | undefined; - transform?: Slides.Schema.AffineTransform | undefined; - } - interface UpdatePageElementsZOrderRequest { - operation?: string | undefined; - pageElementObjectIds?: string[] | undefined; - } - interface UpdatePagePropertiesRequest { - fields?: string | undefined; - objectId?: string | undefined; - pageProperties?: Slides.Schema.PageProperties | undefined; - } - interface UpdateParagraphStyleRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - fields?: string | undefined; - objectId?: string | undefined; - style?: Slides.Schema.ParagraphStyle | undefined; - textRange?: Slides.Schema.Range | undefined; - } - interface UpdateShapePropertiesRequest { - fields?: string | undefined; - objectId?: string | undefined; - shapeProperties?: Slides.Schema.ShapeProperties | undefined; - } - interface UpdateSlidesPositionRequest { - insertionIndex?: number | undefined; - slideObjectIds?: string[] | undefined; - } - interface UpdateTableBorderPropertiesRequest { - borderPosition?: string | undefined; - fields?: string | undefined; - objectId?: string | undefined; - tableBorderProperties?: Slides.Schema.TableBorderProperties | undefined; - tableRange?: Slides.Schema.TableRange | undefined; - } - interface UpdateTableCellPropertiesRequest { - fields?: string | undefined; - objectId?: string | undefined; - tableCellProperties?: Slides.Schema.TableCellProperties | undefined; - tableRange?: Slides.Schema.TableRange | undefined; - } - interface UpdateTableColumnPropertiesRequest { - columnIndices?: number[] | undefined; - fields?: string | undefined; - objectId?: string | undefined; - tableColumnProperties?: Slides.Schema.TableColumnProperties | undefined; - } - interface UpdateTableRowPropertiesRequest { - fields?: string | undefined; - objectId?: string | undefined; - rowIndices?: number[] | undefined; - tableRowProperties?: Slides.Schema.TableRowProperties | undefined; - } - interface UpdateTextStyleRequest { - cellLocation?: Slides.Schema.TableCellLocation | undefined; - fields?: string | undefined; - objectId?: string | undefined; - style?: Slides.Schema.TextStyle | undefined; - textRange?: Slides.Schema.Range | undefined; - } - interface UpdateVideoPropertiesRequest { - fields?: string | undefined; - objectId?: string | undefined; - videoProperties?: Slides.Schema.VideoProperties | undefined; - } - interface Video { - id?: string | undefined; - source?: string | undefined; - url?: string | undefined; - videoProperties?: Slides.Schema.VideoProperties | undefined; - } - interface VideoProperties { - autoPlay?: boolean | undefined; - end?: number | undefined; - mute?: boolean | undefined; - outline?: Slides.Schema.Outline | undefined; - start?: number | undefined; - } - interface WeightedFontFamily { - fontFamily?: string | undefined; - weight?: number | undefined; - } - interface WordArt { - renderedText?: string | undefined; - } - interface WriteControl { - requiredRevisionId?: string | undefined; - } - } - } - interface Slides { - Presentations?: Slides.Collection.PresentationsCollection | undefined; - // Create a new instance of AffineTransform - newAffineTransform(): Slides.Schema.AffineTransform; - // Create a new instance of AutoText - newAutoText(): Slides.Schema.AutoText; - // Create a new instance of BatchUpdatePresentationRequest - newBatchUpdatePresentationRequest(): Slides.Schema.BatchUpdatePresentationRequest; - // Create a new instance of Bullet - newBullet(): Slides.Schema.Bullet; - // Create a new instance of ColorScheme - newColorScheme(): Slides.Schema.ColorScheme; - // Create a new instance of ColorStop - newColorStop(): Slides.Schema.ColorStop; - // Create a new instance of CreateImageRequest - newCreateImageRequest(): Slides.Schema.CreateImageRequest; - // Create a new instance of CreateLineRequest - newCreateLineRequest(): Slides.Schema.CreateLineRequest; - // Create a new instance of CreateParagraphBulletsRequest - newCreateParagraphBulletsRequest(): Slides.Schema.CreateParagraphBulletsRequest; - // Create a new instance of CreateShapeRequest - newCreateShapeRequest(): Slides.Schema.CreateShapeRequest; - // Create a new instance of CreateSheetsChartRequest - newCreateSheetsChartRequest(): Slides.Schema.CreateSheetsChartRequest; - // Create a new instance of CreateSlideRequest - newCreateSlideRequest(): Slides.Schema.CreateSlideRequest; - // Create a new instance of CreateTableRequest - newCreateTableRequest(): Slides.Schema.CreateTableRequest; - // Create a new instance of CreateVideoRequest - newCreateVideoRequest(): Slides.Schema.CreateVideoRequest; - // Create a new instance of CropProperties - newCropProperties(): Slides.Schema.CropProperties; - // Create a new instance of DeleteObjectRequest - newDeleteObjectRequest(): Slides.Schema.DeleteObjectRequest; - // Create a new instance of DeleteParagraphBulletsRequest - newDeleteParagraphBulletsRequest(): Slides.Schema.DeleteParagraphBulletsRequest; - // Create a new instance of DeleteTableColumnRequest - newDeleteTableColumnRequest(): Slides.Schema.DeleteTableColumnRequest; - // Create a new instance of DeleteTableRowRequest - newDeleteTableRowRequest(): Slides.Schema.DeleteTableRowRequest; - // Create a new instance of DeleteTextRequest - newDeleteTextRequest(): Slides.Schema.DeleteTextRequest; - // Create a new instance of Dimension - newDimension(): Slides.Schema.Dimension; - // Create a new instance of DuplicateObjectRequest - newDuplicateObjectRequest(): Slides.Schema.DuplicateObjectRequest; - // Create a new instance of Group - newGroup(): Slides.Schema.Group; - // Create a new instance of GroupObjectsRequest - newGroupObjectsRequest(): Slides.Schema.GroupObjectsRequest; - // Create a new instance of Image - newImage(): Slides.Schema.Image; - // Create a new instance of ImageProperties - newImageProperties(): Slides.Schema.ImageProperties; - // Create a new instance of InsertTableColumnsRequest - newInsertTableColumnsRequest(): Slides.Schema.InsertTableColumnsRequest; - // Create a new instance of InsertTableRowsRequest - newInsertTableRowsRequest(): Slides.Schema.InsertTableRowsRequest; - // Create a new instance of InsertTextRequest - newInsertTextRequest(): Slides.Schema.InsertTextRequest; - // Create a new instance of LayoutPlaceholderIdMapping - newLayoutPlaceholderIdMapping(): Slides.Schema.LayoutPlaceholderIdMapping; - // Create a new instance of LayoutProperties - newLayoutProperties(): Slides.Schema.LayoutProperties; - // Create a new instance of LayoutReference - newLayoutReference(): Slides.Schema.LayoutReference; - // Create a new instance of Line - newLine(): Slides.Schema.Line; - // Create a new instance of LineConnection - newLineConnection(): Slides.Schema.LineConnection; - // Create a new instance of LineFill - newLineFill(): Slides.Schema.LineFill; - // Create a new instance of LineProperties - newLineProperties(): Slides.Schema.LineProperties; - // Create a new instance of Link - newLink(): Slides.Schema.Link; - // Create a new instance of MasterProperties - newMasterProperties(): Slides.Schema.MasterProperties; - // Create a new instance of MergeTableCellsRequest - newMergeTableCellsRequest(): Slides.Schema.MergeTableCellsRequest; - // Create a new instance of NotesProperties - newNotesProperties(): Slides.Schema.NotesProperties; - // Create a new instance of OpaqueColor - newOpaqueColor(): Slides.Schema.OpaqueColor; - // Create a new instance of OptionalColor - newOptionalColor(): Slides.Schema.OptionalColor; - // Create a new instance of Outline - newOutline(): Slides.Schema.Outline; - // Create a new instance of OutlineFill - newOutlineFill(): Slides.Schema.OutlineFill; - // Create a new instance of Page - newPage(): Slides.Schema.Page; - // Create a new instance of PageBackgroundFill - newPageBackgroundFill(): Slides.Schema.PageBackgroundFill; - // Create a new instance of PageElement - newPageElement(): Slides.Schema.PageElement; - // Create a new instance of PageElementProperties - newPageElementProperties(): Slides.Schema.PageElementProperties; - // Create a new instance of PageProperties - newPageProperties(): Slides.Schema.PageProperties; - // Create a new instance of ParagraphMarker - newParagraphMarker(): Slides.Schema.ParagraphMarker; - // Create a new instance of ParagraphStyle - newParagraphStyle(): Slides.Schema.ParagraphStyle; - // Create a new instance of Placeholder - newPlaceholder(): Slides.Schema.Placeholder; - // Create a new instance of Presentation - newPresentation(): Slides.Schema.Presentation; - // Create a new instance of Range - newRange(): Slides.Schema.Range; - // Create a new instance of Recolor - newRecolor(): Slides.Schema.Recolor; - // Create a new instance of RefreshSheetsChartRequest - newRefreshSheetsChartRequest(): Slides.Schema.RefreshSheetsChartRequest; - // Create a new instance of ReplaceAllShapesWithImageRequest - newReplaceAllShapesWithImageRequest(): Slides.Schema.ReplaceAllShapesWithImageRequest; - // Create a new instance of ReplaceAllShapesWithSheetsChartRequest - newReplaceAllShapesWithSheetsChartRequest(): Slides.Schema.ReplaceAllShapesWithSheetsChartRequest; - // Create a new instance of ReplaceAllTextRequest - newReplaceAllTextRequest(): Slides.Schema.ReplaceAllTextRequest; - // Create a new instance of ReplaceImageRequest - newReplaceImageRequest(): Slides.Schema.ReplaceImageRequest; - // Create a new instance of Request - newRequest(): Slides.Schema.Request; - // Create a new instance of RerouteLineRequest - newRerouteLineRequest(): Slides.Schema.RerouteLineRequest; - // Create a new instance of RgbColor - newRgbColor(): Slides.Schema.RgbColor; - // Create a new instance of Shadow - newShadow(): Slides.Schema.Shadow; - // Create a new instance of Shape - newShape(): Slides.Schema.Shape; - // Create a new instance of ShapeBackgroundFill - newShapeBackgroundFill(): Slides.Schema.ShapeBackgroundFill; - // Create a new instance of ShapeProperties - newShapeProperties(): Slides.Schema.ShapeProperties; - // Create a new instance of SheetsChart - newSheetsChart(): Slides.Schema.SheetsChart; - // Create a new instance of SheetsChartProperties - newSheetsChartProperties(): Slides.Schema.SheetsChartProperties; - // Create a new instance of Size - newSize(): Slides.Schema.Size; - // Create a new instance of SlideProperties - newSlideProperties(): Slides.Schema.SlideProperties; - // Create a new instance of SolidFill - newSolidFill(): Slides.Schema.SolidFill; - // Create a new instance of StretchedPictureFill - newStretchedPictureFill(): Slides.Schema.StretchedPictureFill; - // Create a new instance of SubstringMatchCriteria - newSubstringMatchCriteria(): Slides.Schema.SubstringMatchCriteria; - // Create a new instance of Table - newTable(): Slides.Schema.Table; - // Create a new instance of TableBorderCell - newTableBorderCell(): Slides.Schema.TableBorderCell; - // Create a new instance of TableBorderFill - newTableBorderFill(): Slides.Schema.TableBorderFill; - // Create a new instance of TableBorderProperties - newTableBorderProperties(): Slides.Schema.TableBorderProperties; - // Create a new instance of TableBorderRow - newTableBorderRow(): Slides.Schema.TableBorderRow; - // Create a new instance of TableCell - newTableCell(): Slides.Schema.TableCell; - // Create a new instance of TableCellBackgroundFill - newTableCellBackgroundFill(): Slides.Schema.TableCellBackgroundFill; - // Create a new instance of TableCellLocation - newTableCellLocation(): Slides.Schema.TableCellLocation; - // Create a new instance of TableCellProperties - newTableCellProperties(): Slides.Schema.TableCellProperties; - // Create a new instance of TableColumnProperties - newTableColumnProperties(): Slides.Schema.TableColumnProperties; - // Create a new instance of TableRange - newTableRange(): Slides.Schema.TableRange; - // Create a new instance of TableRow - newTableRow(): Slides.Schema.TableRow; - // Create a new instance of TableRowProperties - newTableRowProperties(): Slides.Schema.TableRowProperties; - // Create a new instance of TextContent - newTextContent(): Slides.Schema.TextContent; - // Create a new instance of TextElement - newTextElement(): Slides.Schema.TextElement; - // Create a new instance of TextRun - newTextRun(): Slides.Schema.TextRun; - // Create a new instance of TextStyle - newTextStyle(): Slides.Schema.TextStyle; - // Create a new instance of ThemeColorPair - newThemeColorPair(): Slides.Schema.ThemeColorPair; - // Create a new instance of UngroupObjectsRequest - newUngroupObjectsRequest(): Slides.Schema.UngroupObjectsRequest; - // Create a new instance of UnmergeTableCellsRequest - newUnmergeTableCellsRequest(): Slides.Schema.UnmergeTableCellsRequest; - // Create a new instance of UpdateImagePropertiesRequest - newUpdateImagePropertiesRequest(): Slides.Schema.UpdateImagePropertiesRequest; - // Create a new instance of UpdateLineCategoryRequest - newUpdateLineCategoryRequest(): Slides.Schema.UpdateLineCategoryRequest; - // Create a new instance of UpdateLinePropertiesRequest - newUpdateLinePropertiesRequest(): Slides.Schema.UpdateLinePropertiesRequest; - // Create a new instance of UpdatePageElementAltTextRequest - newUpdatePageElementAltTextRequest(): Slides.Schema.UpdatePageElementAltTextRequest; - // Create a new instance of UpdatePageElementTransformRequest - newUpdatePageElementTransformRequest(): Slides.Schema.UpdatePageElementTransformRequest; - // Create a new instance of UpdatePageElementsZOrderRequest - newUpdatePageElementsZOrderRequest(): Slides.Schema.UpdatePageElementsZOrderRequest; - // Create a new instance of UpdatePagePropertiesRequest - newUpdatePagePropertiesRequest(): Slides.Schema.UpdatePagePropertiesRequest; - // Create a new instance of UpdateParagraphStyleRequest - newUpdateParagraphStyleRequest(): Slides.Schema.UpdateParagraphStyleRequest; - // Create a new instance of UpdateShapePropertiesRequest - newUpdateShapePropertiesRequest(): Slides.Schema.UpdateShapePropertiesRequest; - // Create a new instance of UpdateSlidesPositionRequest - newUpdateSlidesPositionRequest(): Slides.Schema.UpdateSlidesPositionRequest; - // Create a new instance of UpdateTableBorderPropertiesRequest - newUpdateTableBorderPropertiesRequest(): Slides.Schema.UpdateTableBorderPropertiesRequest; - // Create a new instance of UpdateTableCellPropertiesRequest - newUpdateTableCellPropertiesRequest(): Slides.Schema.UpdateTableCellPropertiesRequest; - // Create a new instance of UpdateTableColumnPropertiesRequest - newUpdateTableColumnPropertiesRequest(): Slides.Schema.UpdateTableColumnPropertiesRequest; - // Create a new instance of UpdateTableRowPropertiesRequest - newUpdateTableRowPropertiesRequest(): Slides.Schema.UpdateTableRowPropertiesRequest; - // Create a new instance of UpdateTextStyleRequest - newUpdateTextStyleRequest(): Slides.Schema.UpdateTextStyleRequest; - // Create a new instance of UpdateVideoPropertiesRequest - newUpdateVideoPropertiesRequest(): Slides.Schema.UpdateVideoPropertiesRequest; - // Create a new instance of Video - newVideo(): Slides.Schema.Video; - // Create a new instance of VideoProperties - newVideoProperties(): Slides.Schema.VideoProperties; - // Create a new instance of WeightedFontFamily - newWeightedFontFamily(): Slides.Schema.WeightedFontFamily; - // Create a new instance of WordArt - newWordArt(): Slides.Schema.WordArt; - // Create a new instance of WriteControl - newWriteControl(): Slides.Schema.WriteControl; - } -} - -declare var Slides: GoogleAppsScript.Slides; diff --git a/node_modules/@types/google-apps-script/apis/tagmanager_v2.d.ts b/node_modules/@types/google-apps-script/apis/tagmanager_v2.d.ts deleted file mode 100644 index adadb35..0000000 --- a/node_modules/@types/google-apps-script/apis/tagmanager_v2.d.ts +++ /dev/null @@ -1,741 +0,0 @@ -declare namespace GoogleAppsScript { - namespace TagManager { - namespace Collection { - namespace Accounts { - namespace Containers { - namespace Workspaces { - interface Built_in_variablesCollection { - // Creates one or more GTM Built-In Variables. - create(parent: string): TagManager.Schema.CreateBuiltInVariableResponse; - // Creates one or more GTM Built-In Variables. - create( - parent: string, - optionalArgs: object, - ): TagManager.Schema.CreateBuiltInVariableResponse; - // Lists all the enabled Built-In Variables of a GTM Container. - list(parent: string): TagManager.Schema.ListEnabledBuiltInVariablesResponse; - // Lists all the enabled Built-In Variables of a GTM Container. - list( - parent: string, - optionalArgs: object, - ): TagManager.Schema.ListEnabledBuiltInVariablesResponse; - // Deletes one or more GTM Built-In Variables. - remove(path: string): void; - // Deletes one or more GTM Built-In Variables. - remove(path: string, optionalArgs: object): void; - // Reverts changes to a GTM Built-In Variables in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertBuiltInVariableResponse; - // Reverts changes to a GTM Built-In Variables in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertBuiltInVariableResponse; - } - interface FoldersCollection { - // Creates a GTM Folder. - create(resource: Schema.Folder, parent: string): TagManager.Schema.Folder; - // List all entities in a GTM Folder. - entities(path: string): TagManager.Schema.FolderEntities; - // List all entities in a GTM Folder. - entities(path: string, optionalArgs: object): TagManager.Schema.FolderEntities; - // Gets a GTM Folder. - get(path: string): TagManager.Schema.Folder; - // Lists all GTM Folders of a Container. - list(parent: string): TagManager.Schema.ListFoldersResponse; - // Lists all GTM Folders of a Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListFoldersResponse; - // Moves entities to a GTM Folder. - move_entities_to_folder(resource: Schema.Folder, path: string): void; - // Moves entities to a GTM Folder. - move_entities_to_folder(resource: Schema.Folder, path: string, optionalArgs: object): void; - // Deletes a GTM Folder. - remove(path: string): void; - // Reverts changes to a GTM Folder in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertFolderResponse; - // Reverts changes to a GTM Folder in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertFolderResponse; - // Updates a GTM Folder. - update(resource: Schema.Folder, path: string): TagManager.Schema.Folder; - // Updates a GTM Folder. - update( - resource: Schema.Folder, - path: string, - optionalArgs: object, - ): TagManager.Schema.Folder; - } - interface TagsCollection { - // Creates a GTM Tag. - create(resource: Schema.Tag, parent: string): TagManager.Schema.Tag; - // Gets a GTM Tag. - get(path: string): TagManager.Schema.Tag; - // Lists all GTM Tags of a Container. - list(parent: string): TagManager.Schema.ListTagsResponse; - // Lists all GTM Tags of a Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListTagsResponse; - // Deletes a GTM Tag. - remove(path: string): void; - // Reverts changes to a GTM Tag in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertTagResponse; - // Reverts changes to a GTM Tag in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertTagResponse; - // Updates a GTM Tag. - update(resource: Schema.Tag, path: string): TagManager.Schema.Tag; - // Updates a GTM Tag. - update(resource: Schema.Tag, path: string, optionalArgs: object): TagManager.Schema.Tag; - } - interface TriggersCollection { - // Creates a GTM Trigger. - create(resource: Schema.Trigger, parent: string): TagManager.Schema.Trigger; - // Gets a GTM Trigger. - get(path: string): TagManager.Schema.Trigger; - // Lists all GTM Triggers of a Container. - list(parent: string): TagManager.Schema.ListTriggersResponse; - // Lists all GTM Triggers of a Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListTriggersResponse; - // Deletes a GTM Trigger. - remove(path: string): void; - // Reverts changes to a GTM Trigger in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertTriggerResponse; - // Reverts changes to a GTM Trigger in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertTriggerResponse; - // Updates a GTM Trigger. - update(resource: Schema.Trigger, path: string): TagManager.Schema.Trigger; - // Updates a GTM Trigger. - update( - resource: Schema.Trigger, - path: string, - optionalArgs: object, - ): TagManager.Schema.Trigger; - } - interface VariablesCollection { - // Creates a GTM Variable. - create(resource: Schema.Variable, parent: string): TagManager.Schema.Variable; - // Gets a GTM Variable. - get(path: string): TagManager.Schema.Variable; - // Lists all GTM Variables of a Container. - list(parent: string): TagManager.Schema.ListVariablesResponse; - // Lists all GTM Variables of a Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListVariablesResponse; - // Deletes a GTM Variable. - remove(path: string): void; - // Reverts changes to a GTM Variable in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertVariableResponse; - // Reverts changes to a GTM Variable in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertVariableResponse; - // Updates a GTM Variable. - update(resource: Schema.Variable, path: string): TagManager.Schema.Variable; - // Updates a GTM Variable. - update( - resource: Schema.Variable, - path: string, - optionalArgs: object, - ): TagManager.Schema.Variable; - } - interface ZonesCollection { - // Creates a GTM Zone. - create(resource: Schema.Zone, parent: string): TagManager.Schema.Zone; - // Gets a GTM Zone. - get(path: string): TagManager.Schema.Zone; - // Lists all GTM Zones of a GTM container workspace. - list(parent: string): TagManager.Schema.ListZonesResponse; - // Lists all GTM Zones of a GTM container workspace. - list(parent: string, optionalArgs: object): TagManager.Schema.ListZonesResponse; - // Deletes a GTM Zone. - remove(path: string): void; - // Reverts changes to a GTM Zone in a GTM Workspace. - revert(path: string): TagManager.Schema.RevertZoneResponse; - // Reverts changes to a GTM Zone in a GTM Workspace. - revert(path: string, optionalArgs: object): TagManager.Schema.RevertZoneResponse; - // Updates a GTM Zone. - update(resource: Schema.Zone, path: string): TagManager.Schema.Zone; - // Updates a GTM Zone. - update(resource: Schema.Zone, path: string, optionalArgs: object): TagManager.Schema.Zone; - } - } - interface EnvironmentsCollection { - // Creates a GTM Environment. - create(resource: Schema.Environment, parent: string): TagManager.Schema.Environment; - // Gets a GTM Environment. - get(path: string): TagManager.Schema.Environment; - // Lists all GTM Environments of a GTM Container. - list(parent: string): TagManager.Schema.ListEnvironmentsResponse; - // Lists all GTM Environments of a GTM Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListEnvironmentsResponse; - // Re-generates the authorization code for a GTM Environment. - reauthorize(resource: Schema.Environment, path: string): TagManager.Schema.Environment; - // Deletes a GTM Environment. - remove(path: string): void; - // Updates a GTM Environment. - update(resource: Schema.Environment, path: string): TagManager.Schema.Environment; - // Updates a GTM Environment. - update( - resource: Schema.Environment, - path: string, - optionalArgs: object, - ): TagManager.Schema.Environment; - } - interface Version_headersCollection { - // Gets the latest container version header - latest(parent: string): TagManager.Schema.ContainerVersionHeader; - // Lists all Container Versions of a GTM Container. - list(parent: string): TagManager.Schema.ListContainerVersionsResponse; - // Lists all Container Versions of a GTM Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListContainerVersionsResponse; - } - interface VersionsCollection { - // Gets a Container Version. - get(path: string): TagManager.Schema.ContainerVersion; - // Gets a Container Version. - get(path: string, optionalArgs: object): TagManager.Schema.ContainerVersion; - // Gets the live (i.e. published) container version - live(parent: string): TagManager.Schema.ContainerVersion; - // Publishes a Container Version. - publish(path: string): TagManager.Schema.PublishContainerVersionResponse; - // Publishes a Container Version. - publish(path: string, optionalArgs: object): TagManager.Schema.PublishContainerVersionResponse; - // Deletes a Container Version. - remove(path: string): void; - // Sets the latest version used for synchronization of workspaces when detecting conflicts and errors. - set_latest(path: string): TagManager.Schema.ContainerVersion; - // Undeletes a Container Version. - undelete(path: string): TagManager.Schema.ContainerVersion; - // Updates a Container Version. - update(resource: Schema.ContainerVersion, path: string): TagManager.Schema.ContainerVersion; - // Updates a Container Version. - update( - resource: Schema.ContainerVersion, - path: string, - optionalArgs: object, - ): TagManager.Schema.ContainerVersion; - } - interface WorkspacesCollection { - Built_in_variables?: - | TagManager.Collection.Accounts.Containers.Workspaces.Built_in_variablesCollection - | undefined; - Folders?: TagManager.Collection.Accounts.Containers.Workspaces.FoldersCollection | undefined; - Tags?: TagManager.Collection.Accounts.Containers.Workspaces.TagsCollection | undefined; - Triggers?: TagManager.Collection.Accounts.Containers.Workspaces.TriggersCollection | undefined; - Variables?: - | TagManager.Collection.Accounts.Containers.Workspaces.VariablesCollection - | undefined; - Zones?: TagManager.Collection.Accounts.Containers.Workspaces.ZonesCollection | undefined; - // Creates a Workspace. - create(resource: Schema.Workspace, parent: string): TagManager.Schema.Workspace; - // Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version. - create_version( - resource: Schema.CreateContainerVersionRequestVersionOptions, - path: string, - ): TagManager.Schema.CreateContainerVersionResponse; - // Gets a Workspace. - get(path: string): TagManager.Schema.Workspace; - // Finds conflicting and modified entities in the workspace. - getStatus(path: string): TagManager.Schema.GetWorkspaceStatusResponse; - // Lists all Workspaces that belong to a GTM Container. - list(parent: string): TagManager.Schema.ListWorkspacesResponse; - // Lists all Workspaces that belong to a GTM Container. - list(parent: string, optionalArgs: object): TagManager.Schema.ListWorkspacesResponse; - // Quick previews a workspace by creating a fake container version from all entities in the provided workspace. - quick_preview(path: string): TagManager.Schema.QuickPreviewResponse; - // Deletes a Workspace. - remove(path: string): void; - // Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. - resolve_conflict(resource: Schema.Entity, path: string): void; - // Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. - resolve_conflict(resource: Schema.Entity, path: string, optionalArgs: object): void; - // Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities. - sync(path: string): TagManager.Schema.SyncWorkspaceResponse; - // Updates a Workspace. - update(resource: Schema.Workspace, path: string): TagManager.Schema.Workspace; - // Updates a Workspace. - update( - resource: Schema.Workspace, - path: string, - optionalArgs: object, - ): TagManager.Schema.Workspace; - } - } - interface ContainersCollection { - Environments?: TagManager.Collection.Accounts.Containers.EnvironmentsCollection | undefined; - Version_headers?: TagManager.Collection.Accounts.Containers.Version_headersCollection | undefined; - Versions?: TagManager.Collection.Accounts.Containers.VersionsCollection | undefined; - Workspaces?: TagManager.Collection.Accounts.Containers.WorkspacesCollection | undefined; - // Creates a Container. - create(resource: Schema.Container, parent: string): TagManager.Schema.Container; - // Gets a Container. - get(path: string): TagManager.Schema.Container; - // Lists all Containers that belongs to a GTM Account. - list(parent: string): TagManager.Schema.ListContainersResponse; - // Lists all Containers that belongs to a GTM Account. - list(parent: string, optionalArgs: object): TagManager.Schema.ListContainersResponse; - // Deletes a Container. - remove(path: string): void; - // Updates a Container. - update(resource: Schema.Container, path: string): TagManager.Schema.Container; - // Updates a Container. - update(resource: Schema.Container, path: string, optionalArgs: object): TagManager.Schema.Container; - } - interface User_permissionsCollection { - // Creates a user's Account & Container access. - create(resource: Schema.UserPermission, parent: string): TagManager.Schema.UserPermission; - // Gets a user's Account & Container access. - get(path: string): TagManager.Schema.UserPermission; - // List all users that have access to the account along with Account and Container user access granted to each of them. - list(parent: string): TagManager.Schema.ListUserPermissionsResponse; - // List all users that have access to the account along with Account and Container user access granted to each of them. - list(parent: string, optionalArgs: object): TagManager.Schema.ListUserPermissionsResponse; - // Removes a user from the account, revoking access to it and all of its containers. - remove(path: string): void; - // Updates a user's Account & Container access. - update(resource: Schema.UserPermission, path: string): TagManager.Schema.UserPermission; - } - } - interface AccountsCollection { - Containers?: TagManager.Collection.Accounts.ContainersCollection | undefined; - User_permissions?: TagManager.Collection.Accounts.User_permissionsCollection | undefined; - // Gets a GTM Account. - get(path: string): TagManager.Schema.Account; - // Lists all GTM Accounts that a user has access to. - list(): TagManager.Schema.ListAccountsResponse; - // Lists all GTM Accounts that a user has access to. - list(optionalArgs: object): TagManager.Schema.ListAccountsResponse; - // Updates a GTM Account. - update(resource: Schema.Account, path: string): TagManager.Schema.Account; - // Updates a GTM Account. - update(resource: Schema.Account, path: string, optionalArgs: object): TagManager.Schema.Account; - } - } - namespace Schema { - interface Account { - accountId?: string | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - path?: string | undefined; - shareData?: boolean | undefined; - tagManagerUrl?: string | undefined; - } - interface AccountAccess { - permission?: string | undefined; - } - interface BuiltInVariable { - accountId?: string | undefined; - containerId?: string | undefined; - name?: string | undefined; - path?: string | undefined; - type?: string | undefined; - workspaceId?: string | undefined; - } - interface Condition { - parameter?: TagManager.Schema.Parameter[] | undefined; - type?: string | undefined; - } - interface Container { - accountId?: string | undefined; - containerId?: string | undefined; - domainName?: string[] | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - notes?: string | undefined; - path?: string | undefined; - publicId?: string | undefined; - tagManagerUrl?: string | undefined; - usageContext?: string[] | undefined; - } - interface ContainerAccess { - containerId?: string | undefined; - permission?: string | undefined; - } - interface ContainerVersion { - accountId?: string | undefined; - builtInVariable?: TagManager.Schema.BuiltInVariable[] | undefined; - container?: TagManager.Schema.Container | undefined; - containerId?: string | undefined; - containerVersionId?: string | undefined; - customTemplate?: TagManager.Schema.CustomTemplate[] | undefined; - deleted?: boolean | undefined; - description?: string | undefined; - fingerprint?: string | undefined; - folder?: TagManager.Schema.Folder[] | undefined; - name?: string | undefined; - path?: string | undefined; - tag?: TagManager.Schema.Tag[] | undefined; - tagManagerUrl?: string | undefined; - trigger?: TagManager.Schema.Trigger[] | undefined; - variable?: TagManager.Schema.Variable[] | undefined; - zone?: TagManager.Schema.Zone[] | undefined; - } - interface ContainerVersionHeader { - accountId?: string | undefined; - containerId?: string | undefined; - containerVersionId?: string | undefined; - deleted?: boolean | undefined; - name?: string | undefined; - numCustomTemplates?: string | undefined; - numMacros?: string | undefined; - numRules?: string | undefined; - numTags?: string | undefined; - numTriggers?: string | undefined; - numVariables?: string | undefined; - numZones?: string | undefined; - path?: string | undefined; - } - interface CreateBuiltInVariableResponse { - builtInVariable?: TagManager.Schema.BuiltInVariable[] | undefined; - } - interface CreateContainerVersionRequestVersionOptions { - name?: string | undefined; - notes?: string | undefined; - } - interface CreateContainerVersionResponse { - compilerError?: boolean | undefined; - containerVersion?: TagManager.Schema.ContainerVersion | undefined; - newWorkspacePath?: string | undefined; - syncStatus?: TagManager.Schema.SyncStatus | undefined; - } - interface CustomTemplate { - accountId?: string | undefined; - containerId?: string | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - path?: string | undefined; - tagManagerUrl?: string | undefined; - templateData?: string | undefined; - templateId?: string | undefined; - workspaceId?: string | undefined; - } - interface Entity { - changeStatus?: string | undefined; - folder?: TagManager.Schema.Folder | undefined; - tag?: TagManager.Schema.Tag | undefined; - trigger?: TagManager.Schema.Trigger | undefined; - variable?: TagManager.Schema.Variable | undefined; - } - interface Environment { - accountId?: string | undefined; - authorizationCode?: string | undefined; - authorizationTimestamp?: TagManager.Schema.Timestamp | undefined; - containerId?: string | undefined; - containerVersionId?: string | undefined; - description?: string | undefined; - enableDebug?: boolean | undefined; - environmentId?: string | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - path?: string | undefined; - tagManagerUrl?: string | undefined; - type?: string | undefined; - url?: string | undefined; - workspaceId?: string | undefined; - } - interface Folder { - accountId?: string | undefined; - containerId?: string | undefined; - fingerprint?: string | undefined; - folderId?: string | undefined; - name?: string | undefined; - notes?: string | undefined; - path?: string | undefined; - tagManagerUrl?: string | undefined; - workspaceId?: string | undefined; - } - interface FolderEntities { - nextPageToken?: string | undefined; - tag?: TagManager.Schema.Tag[] | undefined; - trigger?: TagManager.Schema.Trigger[] | undefined; - variable?: TagManager.Schema.Variable[] | undefined; - } - interface GetWorkspaceStatusResponse { - mergeConflict?: TagManager.Schema.MergeConflict[] | undefined; - workspaceChange?: TagManager.Schema.Entity[] | undefined; - } - interface ListAccountsResponse { - account?: TagManager.Schema.Account[] | undefined; - nextPageToken?: string | undefined; - } - interface ListContainerVersionsResponse { - containerVersionHeader?: TagManager.Schema.ContainerVersionHeader[] | undefined; - nextPageToken?: string | undefined; - } - interface ListContainersResponse { - container?: TagManager.Schema.Container[] | undefined; - nextPageToken?: string | undefined; - } - interface ListEnabledBuiltInVariablesResponse { - builtInVariable?: TagManager.Schema.BuiltInVariable[] | undefined; - nextPageToken?: string | undefined; - } - interface ListEnvironmentsResponse { - environment?: TagManager.Schema.Environment[] | undefined; - nextPageToken?: string | undefined; - } - interface ListFoldersResponse { - folder?: TagManager.Schema.Folder[] | undefined; - nextPageToken?: string | undefined; - } - interface ListTagsResponse { - nextPageToken?: string | undefined; - tag?: TagManager.Schema.Tag[] | undefined; - } - interface ListTriggersResponse { - nextPageToken?: string | undefined; - trigger?: TagManager.Schema.Trigger[] | undefined; - } - interface ListUserPermissionsResponse { - nextPageToken?: string | undefined; - userPermission?: TagManager.Schema.UserPermission[] | undefined; - } - interface ListVariablesResponse { - nextPageToken?: string | undefined; - variable?: TagManager.Schema.Variable[] | undefined; - } - interface ListWorkspacesResponse { - nextPageToken?: string | undefined; - workspace?: TagManager.Schema.Workspace[] | undefined; - } - interface ListZonesResponse { - nextPageToken?: string | undefined; - zone?: TagManager.Schema.Zone[] | undefined; - } - interface MergeConflict { - entityInBaseVersion?: TagManager.Schema.Entity | undefined; - entityInWorkspace?: TagManager.Schema.Entity | undefined; - } - interface Parameter { - key?: string | undefined; - list?: TagManager.Schema.Parameter[] | undefined; - map?: TagManager.Schema.Parameter[] | undefined; - type?: string | undefined; - value?: string | undefined; - } - interface PublishContainerVersionResponse { - compilerError?: boolean | undefined; - containerVersion?: TagManager.Schema.ContainerVersion | undefined; - } - interface QuickPreviewResponse { - compilerError?: boolean | undefined; - containerVersion?: TagManager.Schema.ContainerVersion | undefined; - syncStatus?: TagManager.Schema.SyncStatus | undefined; - } - interface RevertBuiltInVariableResponse { - enabled?: boolean | undefined; - } - interface RevertFolderResponse { - folder?: TagManager.Schema.Folder | undefined; - } - interface RevertTagResponse { - tag?: TagManager.Schema.Tag | undefined; - } - interface RevertTriggerResponse { - trigger?: TagManager.Schema.Trigger | undefined; - } - interface RevertVariableResponse { - variable?: TagManager.Schema.Variable | undefined; - } - interface RevertZoneResponse { - zone?: TagManager.Schema.Zone | undefined; - } - interface SetupTag { - stopOnSetupFailure?: boolean | undefined; - tagName?: string | undefined; - } - interface SyncStatus { - mergeConflict?: boolean | undefined; - syncError?: boolean | undefined; - } - interface SyncWorkspaceResponse { - mergeConflict?: TagManager.Schema.MergeConflict[] | undefined; - syncStatus?: TagManager.Schema.SyncStatus | undefined; - } - interface Tag { - accountId?: string | undefined; - blockingRuleId?: string[] | undefined; - blockingTriggerId?: string[] | undefined; - containerId?: string | undefined; - fingerprint?: string | undefined; - firingRuleId?: string[] | undefined; - firingTriggerId?: string[] | undefined; - liveOnly?: boolean | undefined; - name?: string | undefined; - notes?: string | undefined; - parameter?: TagManager.Schema.Parameter[] | undefined; - parentFolderId?: string | undefined; - path?: string | undefined; - paused?: boolean | undefined; - priority?: TagManager.Schema.Parameter | undefined; - scheduleEndMs?: string | undefined; - scheduleStartMs?: string | undefined; - setupTag?: TagManager.Schema.SetupTag[] | undefined; - tagFiringOption?: string | undefined; - tagId?: string | undefined; - tagManagerUrl?: string | undefined; - teardownTag?: TagManager.Schema.TeardownTag[] | undefined; - type?: string | undefined; - workspaceId?: string | undefined; - } - interface TeardownTag { - stopTeardownOnFailure?: boolean | undefined; - tagName?: string | undefined; - } - interface Timestamp { - nanos?: number | undefined; - seconds?: string | undefined; - } - interface Trigger { - accountId?: string | undefined; - autoEventFilter?: TagManager.Schema.Condition[] | undefined; - checkValidation?: TagManager.Schema.Parameter | undefined; - containerId?: string | undefined; - continuousTimeMinMilliseconds?: TagManager.Schema.Parameter | undefined; - customEventFilter?: TagManager.Schema.Condition[] | undefined; - eventName?: TagManager.Schema.Parameter | undefined; - filter?: TagManager.Schema.Condition[] | undefined; - fingerprint?: string | undefined; - horizontalScrollPercentageList?: TagManager.Schema.Parameter | undefined; - interval?: TagManager.Schema.Parameter | undefined; - intervalSeconds?: TagManager.Schema.Parameter | undefined; - limit?: TagManager.Schema.Parameter | undefined; - maxTimerLengthSeconds?: TagManager.Schema.Parameter | undefined; - name?: string | undefined; - notes?: string | undefined; - parameter?: TagManager.Schema.Parameter[] | undefined; - parentFolderId?: string | undefined; - path?: string | undefined; - selector?: TagManager.Schema.Parameter | undefined; - tagManagerUrl?: string | undefined; - totalTimeMinMilliseconds?: TagManager.Schema.Parameter | undefined; - triggerId?: string | undefined; - type?: string | undefined; - uniqueTriggerId?: TagManager.Schema.Parameter | undefined; - verticalScrollPercentageList?: TagManager.Schema.Parameter | undefined; - visibilitySelector?: TagManager.Schema.Parameter | undefined; - visiblePercentageMax?: TagManager.Schema.Parameter | undefined; - visiblePercentageMin?: TagManager.Schema.Parameter | undefined; - waitForTags?: TagManager.Schema.Parameter | undefined; - waitForTagsTimeout?: TagManager.Schema.Parameter | undefined; - workspaceId?: string | undefined; - } - interface UserPermission { - accountAccess?: TagManager.Schema.AccountAccess | undefined; - accountId?: string | undefined; - containerAccess?: TagManager.Schema.ContainerAccess[] | undefined; - emailAddress?: string | undefined; - path?: string | undefined; - } - interface Variable { - accountId?: string | undefined; - containerId?: string | undefined; - disablingTriggerId?: string[] | undefined; - enablingTriggerId?: string[] | undefined; - fingerprint?: string | undefined; - formatValue?: TagManager.Schema.VariableFormatValue | undefined; - name?: string | undefined; - notes?: string | undefined; - parameter?: TagManager.Schema.Parameter[] | undefined; - parentFolderId?: string | undefined; - path?: string | undefined; - scheduleEndMs?: string | undefined; - scheduleStartMs?: string | undefined; - tagManagerUrl?: string | undefined; - type?: string | undefined; - variableId?: string | undefined; - workspaceId?: string | undefined; - } - interface VariableFormatValue { - caseConversionType?: string | undefined; - convertFalseToValue?: TagManager.Schema.Parameter | undefined; - convertNullToValue?: TagManager.Schema.Parameter | undefined; - convertTrueToValue?: TagManager.Schema.Parameter | undefined; - convertUndefinedToValue?: TagManager.Schema.Parameter | undefined; - } - interface Workspace { - accountId?: string | undefined; - containerId?: string | undefined; - description?: string | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - path?: string | undefined; - tagManagerUrl?: string | undefined; - workspaceId?: string | undefined; - } - interface Zone { - accountId?: string | undefined; - boundary?: TagManager.Schema.ZoneBoundary | undefined; - childContainer?: TagManager.Schema.ZoneChildContainer[] | undefined; - containerId?: string | undefined; - fingerprint?: string | undefined; - name?: string | undefined; - notes?: string | undefined; - path?: string | undefined; - tagManagerUrl?: string | undefined; - typeRestriction?: TagManager.Schema.ZoneTypeRestriction | undefined; - workspaceId?: string | undefined; - zoneId?: string | undefined; - } - interface ZoneBoundary { - condition?: TagManager.Schema.Condition[] | undefined; - customEvaluationTriggerId?: string[] | undefined; - } - interface ZoneChildContainer { - nickname?: string | undefined; - publicId?: string | undefined; - } - interface ZoneTypeRestriction { - enable?: boolean | undefined; - whitelistedTypeId?: string[] | undefined; - } - } - } - interface TagManager { - Accounts?: TagManager.Collection.AccountsCollection | undefined; - // Create a new instance of Account - newAccount(): TagManager.Schema.Account; - // Create a new instance of AccountAccess - newAccountAccess(): TagManager.Schema.AccountAccess; - // Create a new instance of BuiltInVariable - newBuiltInVariable(): TagManager.Schema.BuiltInVariable; - // Create a new instance of Condition - newCondition(): TagManager.Schema.Condition; - // Create a new instance of Container - newContainer(): TagManager.Schema.Container; - // Create a new instance of ContainerAccess - newContainerAccess(): TagManager.Schema.ContainerAccess; - // Create a new instance of ContainerVersion - newContainerVersion(): TagManager.Schema.ContainerVersion; - // Create a new instance of CreateContainerVersionRequestVersionOptions - newCreateContainerVersionRequestVersionOptions(): TagManager.Schema.CreateContainerVersionRequestVersionOptions; - // Create a new instance of CustomTemplate - newCustomTemplate(): TagManager.Schema.CustomTemplate; - // Create a new instance of Entity - newEntity(): TagManager.Schema.Entity; - // Create a new instance of Environment - newEnvironment(): TagManager.Schema.Environment; - // Create a new instance of Folder - newFolder(): TagManager.Schema.Folder; - // Create a new instance of Parameter - newParameter(): TagManager.Schema.Parameter; - // Create a new instance of SetupTag - newSetupTag(): TagManager.Schema.SetupTag; - // Create a new instance of Tag - newTag(): TagManager.Schema.Tag; - // Create a new instance of TeardownTag - newTeardownTag(): TagManager.Schema.TeardownTag; - // Create a new instance of Timestamp - newTimestamp(): TagManager.Schema.Timestamp; - // Create a new instance of Trigger - newTrigger(): TagManager.Schema.Trigger; - // Create a new instance of UserPermission - newUserPermission(): TagManager.Schema.UserPermission; - // Create a new instance of Variable - newVariable(): TagManager.Schema.Variable; - // Create a new instance of VariableFormatValue - newVariableFormatValue(): TagManager.Schema.VariableFormatValue; - // Create a new instance of Workspace - newWorkspace(): TagManager.Schema.Workspace; - // Create a new instance of Zone - newZone(): TagManager.Schema.Zone; - // Create a new instance of ZoneBoundary - newZoneBoundary(): TagManager.Schema.ZoneBoundary; - // Create a new instance of ZoneChildContainer - newZoneChildContainer(): TagManager.Schema.ZoneChildContainer; - // Create a new instance of ZoneTypeRestriction - newZoneTypeRestriction(): TagManager.Schema.ZoneTypeRestriction; - } -} - -declare var TagManager: GoogleAppsScript.TagManager; diff --git a/node_modules/@types/google-apps-script/apis/tasks_v1.d.ts b/node_modules/@types/google-apps-script/apis/tasks_v1.d.ts deleted file mode 100644 index 6e397bb..0000000 --- a/node_modules/@types/google-apps-script/apis/tasks_v1.d.ts +++ /dev/null @@ -1,102 +0,0 @@ -declare namespace GoogleAppsScript { - namespace Tasks { - namespace Collection { - interface TasklistsCollection { - // Returns the authenticated user's specified task list. - get(tasklist: string): Tasks.Schema.TaskList; - // Creates a new task list and adds it to the authenticated user's task lists. - insert(resource: Schema.TaskList): Tasks.Schema.TaskList; - // Returns all the authenticated user's task lists. - list(): Tasks.Schema.TaskLists; - // Returns all the authenticated user's task lists. - list(optionalArgs: object): Tasks.Schema.TaskLists; - // Updates the authenticated user's specified task list. This method supports patch semantics. - patch(resource: Schema.TaskList, tasklist: string): Tasks.Schema.TaskList; - // Deletes the authenticated user's specified task list. - remove(tasklist: string): void; - // Updates the authenticated user's specified task list. - update(resource: Schema.TaskList, tasklist: string): Tasks.Schema.TaskList; - } - interface TasksCollection { - // Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list. - clear(tasklist: string): void; - // Returns the specified task. - get(tasklist: string, task: string): Tasks.Schema.Task; - // Creates a new task on the specified task list. - insert(resource: Schema.Task, tasklist: string): Tasks.Schema.Task; - // Creates a new task on the specified task list. - insert(resource: Schema.Task, tasklist: string, optionalArgs: object): Tasks.Schema.Task; - // Returns all tasks in the specified task list. - list(tasklist: string): Tasks.Schema.Tasks; - // Returns all tasks in the specified task list. - list(tasklist: string, optionalArgs: object): Tasks.Schema.Tasks; - // Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. - move(tasklist: string, task: string): Tasks.Schema.Task; - // Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. - move(tasklist: string, task: string, optionalArgs: object): Tasks.Schema.Task; - // Updates the specified task. This method supports patch semantics. - patch(resource: Schema.Task, tasklist: string, task: string): Tasks.Schema.Task; - // Deletes the specified task from the task list. - remove(tasklist: string, task: string): void; - // Updates the specified task. - update(resource: Schema.Task, tasklist: string, task: string): Tasks.Schema.Task; - } - } - namespace Schema { - interface Task { - completed?: string | undefined; - deleted?: boolean | undefined; - due?: string | undefined; - etag?: string | undefined; - hidden?: boolean | undefined; - id?: string | undefined; - kind?: string | undefined; - links?: Tasks.Schema.TaskLinks[] | undefined; - notes?: string | undefined; - parent?: string | undefined; - position?: string | undefined; - selfLink?: string | undefined; - status?: string | undefined; - title?: string | undefined; - updated?: string | undefined; - } - interface TaskLinks { - description?: string | undefined; - link?: string | undefined; - type?: string | undefined; - } - interface TaskList { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - selfLink?: string | undefined; - title?: string | undefined; - updated?: string | undefined; - } - interface TaskLists { - etag?: string | undefined; - items?: Tasks.Schema.TaskList[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface Tasks { - etag?: string | undefined; - items?: Tasks.Schema.Task[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - } - } - interface Tasks { - Tasklists?: Tasks.Collection.TasklistsCollection | undefined; - Tasks?: Tasks.Collection.TasksCollection | undefined; - // Create a new instance of Task - newTask(): Tasks.Schema.Task; - // Create a new instance of TaskLinks - newTaskLinks(): Tasks.Schema.TaskLinks; - // Create a new instance of TaskList - newTaskList(): Tasks.Schema.TaskList; - } -} - -declare var Tasks: GoogleAppsScript.Tasks; diff --git a/node_modules/@types/google-apps-script/apis/youtube_v3.d.ts b/node_modules/@types/google-apps-script/apis/youtube_v3.d.ts deleted file mode 100644 index 620950c..0000000 --- a/node_modules/@types/google-apps-script/apis/youtube_v3.d.ts +++ /dev/null @@ -1,1953 +0,0 @@ -declare namespace GoogleAppsScript { - namespace YouTube { - namespace Collection { - interface ActivitiesCollection { - // Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.) - // Note: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite. - insert(resource: Schema.Activity, part: string): YouTube.Schema.Activity; - // Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. - list(part: string): YouTube.Schema.ActivityListResponse; - // Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. - list(part: string, optionalArgs: object): YouTube.Schema.ActivityListResponse; - } - interface CaptionsCollection { - // Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. - download(id: string): void; - // Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. - download(id: string, optionalArgs: object): void; - // Uploads a caption track. - insert(resource: Schema.Caption, part: string): YouTube.Schema.Caption; - // Uploads a caption track. - insert(resource: Schema.Caption, part: string, mediaData: any): YouTube.Schema.Caption; - // Uploads a caption track. - insert( - resource: Schema.Caption, - part: string, - mediaData: any, - optionalArgs: object, - ): YouTube.Schema.Caption; - // Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track. - list(part: string, videoId: string): YouTube.Schema.CaptionListResponse; - // Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track. - list(part: string, videoId: string, optionalArgs: object): YouTube.Schema.CaptionListResponse; - // Deletes a specified caption track. - remove(id: string): void; - // Deletes a specified caption track. - remove(id: string, optionalArgs: object): void; - // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. - update(resource: Schema.Caption, part: string): YouTube.Schema.Caption; - // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. - update(resource: Schema.Caption, part: string, mediaData: any): YouTube.Schema.Caption; - // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. - update( - resource: Schema.Caption, - part: string, - mediaData: any, - optionalArgs: object, - ): YouTube.Schema.Caption; - } - interface ChannelBannersCollection { - // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - // - Extract the url property's value from the response that the API returns for step 1. - // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. - insert(resource: Schema.ChannelBannerResource): YouTube.Schema.ChannelBannerResource; - // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - // - Extract the url property's value from the response that the API returns for step 1. - // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. - insert(resource: Schema.ChannelBannerResource, mediaData: any): YouTube.Schema.ChannelBannerResource; - // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: - // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. - // - Extract the url property's value from the response that the API returns for step 1. - // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. - insert( - resource: Schema.ChannelBannerResource, - mediaData: any, - optionalArgs: object, - ): YouTube.Schema.ChannelBannerResource; - } - interface ChannelSectionsCollection { - // Adds a channelSection for the authenticated user's channel. - insert(resource: Schema.ChannelSection, part: string): YouTube.Schema.ChannelSection; - // Adds a channelSection for the authenticated user's channel. - insert( - resource: Schema.ChannelSection, - part: string, - optionalArgs: object, - ): YouTube.Schema.ChannelSection; - // Returns channelSection resources that match the API request criteria. - list(part: string): YouTube.Schema.ChannelSectionListResponse; - // Returns channelSection resources that match the API request criteria. - list(part: string, optionalArgs: object): YouTube.Schema.ChannelSectionListResponse; - // Deletes a channelSection. - remove(id: string): void; - // Deletes a channelSection. - remove(id: string, optionalArgs: object): void; - // Update a channelSection. - update(resource: Schema.ChannelSection, part: string): YouTube.Schema.ChannelSection; - // Update a channelSection. - update( - resource: Schema.ChannelSection, - part: string, - optionalArgs: object, - ): YouTube.Schema.ChannelSection; - } - interface ChannelsCollection { - // Returns a collection of zero or more channel resources that match the request criteria. - list(part: string): YouTube.Schema.ChannelListResponse; - // Returns a collection of zero or more channel resources that match the request criteria. - list(part: string, optionalArgs: object): YouTube.Schema.ChannelListResponse; - // Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties. - update(resource: Schema.Channel, part: string): YouTube.Schema.Channel; - // Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties. - update(resource: Schema.Channel, part: string, optionalArgs: object): YouTube.Schema.Channel; - } - interface CommentThreadsCollection { - // Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead. - insert(resource: Schema.CommentThread, part: string): YouTube.Schema.CommentThread; - // Returns a list of comment threads that match the API request parameters. - list(part: string): YouTube.Schema.CommentThreadListResponse; - // Returns a list of comment threads that match the API request parameters. - list(part: string, optionalArgs: object): YouTube.Schema.CommentThreadListResponse; - // Modifies the top-level comment in a comment thread. - update(resource: Schema.CommentThread, part: string): YouTube.Schema.CommentThread; - } - interface CommentsCollection { - // Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method. - insert(resource: Schema.Comment, part: string): YouTube.Schema.Comment; - // Returns a list of comments that match the API request parameters. - list(part: string): YouTube.Schema.CommentListResponse; - // Returns a list of comments that match the API request parameters. - list(part: string, optionalArgs: object): YouTube.Schema.CommentListResponse; - // Expresses the caller's opinion that one or more comments should be flagged as spam. - markAsSpam(id: string): void; - // Deletes a comment. - remove(id: string): void; - // Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments. - setModerationStatus(id: string, moderationStatus: string): void; - // Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments. - setModerationStatus(id: string, moderationStatus: string, optionalArgs: object): void; - // Modifies a comment. - update(resource: Schema.Comment, part: string): YouTube.Schema.Comment; - } - interface GuideCategoriesCollection { - // Returns a list of categories that can be associated with YouTube channels. - list(part: string): YouTube.Schema.GuideCategoryListResponse; - // Returns a list of categories that can be associated with YouTube channels. - list(part: string, optionalArgs: object): YouTube.Schema.GuideCategoryListResponse; - } - interface I18nLanguagesCollection { - // Returns a list of application languages that the YouTube website supports. - list(part: string): YouTube.Schema.I18nLanguageListResponse; - // Returns a list of application languages that the YouTube website supports. - list(part: string, optionalArgs: object): YouTube.Schema.I18nLanguageListResponse; - } - interface I18nRegionsCollection { - // Returns a list of content regions that the YouTube website supports. - list(part: string): YouTube.Schema.I18nRegionListResponse; - // Returns a list of content regions that the YouTube website supports. - list(part: string, optionalArgs: object): YouTube.Schema.I18nRegionListResponse; - } - interface LiveBroadcastsCollection { - // Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. - bind(id: string, part: string): YouTube.Schema.LiveBroadcast; - // Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. - bind(id: string, part: string, optionalArgs: object): YouTube.Schema.LiveBroadcast; - // Controls the settings for a slate that can be displayed in the broadcast stream. - control(id: string, part: string): YouTube.Schema.LiveBroadcast; - // Controls the settings for a slate that can be displayed in the broadcast stream. - control(id: string, part: string, optionalArgs: object): YouTube.Schema.LiveBroadcast; - // Creates a broadcast. - insert(resource: Schema.LiveBroadcast, part: string): YouTube.Schema.LiveBroadcast; - // Creates a broadcast. - insert( - resource: Schema.LiveBroadcast, - part: string, - optionalArgs: object, - ): YouTube.Schema.LiveBroadcast; - // Returns a list of YouTube broadcasts that match the API request parameters. - list(part: string): YouTube.Schema.LiveBroadcastListResponse; - // Returns a list of YouTube broadcasts that match the API request parameters. - list(part: string, optionalArgs: object): YouTube.Schema.LiveBroadcastListResponse; - // Deletes a broadcast. - remove(id: string): void; - // Deletes a broadcast. - remove(id: string, optionalArgs: object): void; - // Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. - transition(broadcastStatus: string, id: string, part: string): YouTube.Schema.LiveBroadcast; - // Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. - transition( - broadcastStatus: string, - id: string, - part: string, - optionalArgs: object, - ): YouTube.Schema.LiveBroadcast; - // Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. - update(resource: Schema.LiveBroadcast, part: string): YouTube.Schema.LiveBroadcast; - // Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. - update( - resource: Schema.LiveBroadcast, - part: string, - optionalArgs: object, - ): YouTube.Schema.LiveBroadcast; - } - interface LiveChatBansCollection { - // Adds a new ban to the chat. - insert(resource: Schema.LiveChatBan, part: string): YouTube.Schema.LiveChatBan; - // Removes a chat ban. - remove(id: string): void; - } - interface LiveChatMessagesCollection { - // Adds a message to a live chat. - insert(resource: Schema.LiveChatMessage, part: string): YouTube.Schema.LiveChatMessage; - // Lists live chat messages for a specific chat. - list(liveChatId: string, part: string): YouTube.Schema.LiveChatMessageListResponse; - // Lists live chat messages for a specific chat. - list( - liveChatId: string, - part: string, - optionalArgs: object, - ): YouTube.Schema.LiveChatMessageListResponse; - // Deletes a chat message. - remove(id: string): void; - } - interface LiveChatModeratorsCollection { - // Adds a new moderator for the chat. - insert(resource: Schema.LiveChatModerator, part: string): YouTube.Schema.LiveChatModerator; - // Lists moderators for a live chat. - list(liveChatId: string, part: string): YouTube.Schema.LiveChatModeratorListResponse; - // Lists moderators for a live chat. - list( - liveChatId: string, - part: string, - optionalArgs: object, - ): YouTube.Schema.LiveChatModeratorListResponse; - // Removes a chat moderator. - remove(id: string): void; - } - interface LiveStreamsCollection { - // Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience. - insert(resource: Schema.LiveStream, part: string): YouTube.Schema.LiveStream; - // Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience. - insert(resource: Schema.LiveStream, part: string, optionalArgs: object): YouTube.Schema.LiveStream; - // Returns a list of video streams that match the API request parameters. - list(part: string): YouTube.Schema.LiveStreamListResponse; - // Returns a list of video streams that match the API request parameters. - list(part: string, optionalArgs: object): YouTube.Schema.LiveStreamListResponse; - // Deletes a video stream. - remove(id: string): void; - // Deletes a video stream. - remove(id: string, optionalArgs: object): void; - // Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings. - update(resource: Schema.LiveStream, part: string): YouTube.Schema.LiveStream; - // Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings. - update(resource: Schema.LiveStream, part: string, optionalArgs: object): YouTube.Schema.LiveStream; - } - interface PlaylistItemsCollection { - // Adds a resource to a playlist. - insert(resource: Schema.PlaylistItem, part: string): YouTube.Schema.PlaylistItem; - // Adds a resource to a playlist. - insert(resource: Schema.PlaylistItem, part: string, optionalArgs: object): YouTube.Schema.PlaylistItem; - // Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. - list(part: string): YouTube.Schema.PlaylistItemListResponse; - // Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. - list(part: string, optionalArgs: object): YouTube.Schema.PlaylistItemListResponse; - // Deletes a playlist item. - remove(id: string): void; - // Deletes a playlist item. - remove(id: string, optionalArgs: object): void; - // Modifies a playlist item. For example, you could update the item's position in the playlist. - update(resource: Schema.PlaylistItem, part: string): YouTube.Schema.PlaylistItem; - // Modifies a playlist item. For example, you could update the item's position in the playlist. - update(resource: Schema.PlaylistItem, part: string, optionalArgs: object): YouTube.Schema.PlaylistItem; - } - interface PlaylistsCollection { - // Creates a playlist. - insert(resource: Schema.Playlist, part: string): YouTube.Schema.Playlist; - // Creates a playlist. - insert(resource: Schema.Playlist, part: string, optionalArgs: object): YouTube.Schema.Playlist; - // Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. - list(part: string): YouTube.Schema.PlaylistListResponse; - // Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. - list(part: string, optionalArgs: object): YouTube.Schema.PlaylistListResponse; - // Deletes a playlist. - remove(id: string): void; - // Deletes a playlist. - remove(id: string, optionalArgs: object): void; - // Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. - update(resource: Schema.Playlist, part: string): YouTube.Schema.Playlist; - // Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. - update(resource: Schema.Playlist, part: string, optionalArgs: object): YouTube.Schema.Playlist; - } - interface SearchCollection { - // Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. - list(part: string): YouTube.Schema.SearchListResponse; - // Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. - list(part: string, optionalArgs: object): YouTube.Schema.SearchListResponse; - } - interface SponsorsCollection { - // Lists sponsors for a channel. - list(part: string): YouTube.Schema.SponsorListResponse; - // Lists sponsors for a channel. - list(part: string, optionalArgs: object): YouTube.Schema.SponsorListResponse; - } - interface SubscriptionsCollection { - // Adds a subscription for the authenticated user's channel. - insert(resource: Schema.Subscription, part: string): YouTube.Schema.Subscription; - // Returns subscription resources that match the API request criteria. - list(part: string): YouTube.Schema.SubscriptionListResponse; - // Returns subscription resources that match the API request criteria. - list(part: string, optionalArgs: object): YouTube.Schema.SubscriptionListResponse; - // Deletes a subscription. - remove(id: string): void; - } - interface SuperChatEventsCollection { - // Lists Super Chat events for a channel. - list(part: string): YouTube.Schema.SuperChatEventListResponse; - // Lists Super Chat events for a channel. - list(part: string, optionalArgs: object): YouTube.Schema.SuperChatEventListResponse; - } - interface ThumbnailsCollection { - // Uploads a custom video thumbnail to YouTube and sets it for a video. - set(videoId: string): YouTube.Schema.ThumbnailSetResponse; - // Uploads a custom video thumbnail to YouTube and sets it for a video. - set(videoId: string, mediaData: any): YouTube.Schema.ThumbnailSetResponse; - // Uploads a custom video thumbnail to YouTube and sets it for a video. - set(videoId: string, mediaData: any, optionalArgs: object): YouTube.Schema.ThumbnailSetResponse; - } - interface VideoAbuseReportReasonsCollection { - // Returns a list of abuse reasons that can be used for reporting abusive videos. - list(part: string): YouTube.Schema.VideoAbuseReportReasonListResponse; - // Returns a list of abuse reasons that can be used for reporting abusive videos. - list(part: string, optionalArgs: object): YouTube.Schema.VideoAbuseReportReasonListResponse; - } - interface VideoCategoriesCollection { - // Returns a list of categories that can be associated with YouTube videos. - list(part: string): YouTube.Schema.VideoCategoryListResponse; - // Returns a list of categories that can be associated with YouTube videos. - list(part: string, optionalArgs: object): YouTube.Schema.VideoCategoryListResponse; - } - interface VideosCollection { - // Retrieves the ratings that the authorized user gave to a list of specified videos. - getRating(id: string): YouTube.Schema.VideoGetRatingResponse; - // Retrieves the ratings that the authorized user gave to a list of specified videos. - getRating(id: string, optionalArgs: object): YouTube.Schema.VideoGetRatingResponse; - // Uploads a video to YouTube and optionally sets the video's metadata. - insert(resource: Schema.Video, part: string): YouTube.Schema.Video; - // Uploads a video to YouTube and optionally sets the video's metadata. - insert(resource: Schema.Video, part: string, mediaData: any): YouTube.Schema.Video; - // Uploads a video to YouTube and optionally sets the video's metadata. - insert( - resource: Schema.Video, - part: string, - mediaData: any, - optionalArgs: object, - ): YouTube.Schema.Video; - // Returns a list of videos that match the API request parameters. - list(part: string): YouTube.Schema.VideoListResponse; - // Returns a list of videos that match the API request parameters. - list(part: string, optionalArgs: object): YouTube.Schema.VideoListResponse; - // Add a like or dislike rating to a video or remove a rating from a video. - rate(id: string, rating: string): void; - // Deletes a YouTube video. - remove(id: string): void; - // Deletes a YouTube video. - remove(id: string, optionalArgs: object): void; - // Report abuse for a video. - reportAbuse(resource: Schema.VideoAbuseReport): void; - // Report abuse for a video. - reportAbuse(resource: Schema.VideoAbuseReport, optionalArgs: object): void; - // Updates a video's metadata. - update(resource: Schema.Video, part: string): YouTube.Schema.Video; - // Updates a video's metadata. - update(resource: Schema.Video, part: string, optionalArgs: object): YouTube.Schema.Video; - } - interface WatermarksCollection { - // Uploads a watermark image to YouTube and sets it for a channel. - set(resource: Schema.InvideoBranding, channelId: string): void; - // Uploads a watermark image to YouTube and sets it for a channel. - set(resource: Schema.InvideoBranding, channelId: string, mediaData: any): void; - // Uploads a watermark image to YouTube and sets it for a channel. - set(resource: Schema.InvideoBranding, channelId: string, mediaData: any, optionalArgs: object): void; - // Deletes a channel's watermark image. - unset(channelId: string): void; - // Deletes a channel's watermark image. - unset(channelId: string, optionalArgs: object): void; - } - } - namespace Schema { - interface AccessPolicy { - allowed?: boolean | undefined; - exception?: string[] | undefined; - } - interface Activity { - contentDetails?: YouTube.Schema.ActivityContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.ActivitySnippet | undefined; - } - interface ActivityContentDetails { - bulletin?: YouTube.Schema.ActivityContentDetailsBulletin | undefined; - channelItem?: YouTube.Schema.ActivityContentDetailsChannelItem | undefined; - comment?: YouTube.Schema.ActivityContentDetailsComment | undefined; - favorite?: YouTube.Schema.ActivityContentDetailsFavorite | undefined; - like?: YouTube.Schema.ActivityContentDetailsLike | undefined; - playlistItem?: YouTube.Schema.ActivityContentDetailsPlaylistItem | undefined; - promotedItem?: YouTube.Schema.ActivityContentDetailsPromotedItem | undefined; - recommendation?: YouTube.Schema.ActivityContentDetailsRecommendation | undefined; - social?: YouTube.Schema.ActivityContentDetailsSocial | undefined; - subscription?: YouTube.Schema.ActivityContentDetailsSubscription | undefined; - upload?: YouTube.Schema.ActivityContentDetailsUpload | undefined; - } - interface ActivityContentDetailsBulletin { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsChannelItem { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsComment { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsFavorite { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsLike { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsPlaylistItem { - playlistId?: string | undefined; - playlistItemId?: string | undefined; - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsPromotedItem { - adTag?: string | undefined; - clickTrackingUrl?: string | undefined; - creativeViewUrl?: string | undefined; - ctaType?: string | undefined; - customCtaButtonText?: string | undefined; - descriptionText?: string | undefined; - destinationUrl?: string | undefined; - forecastingUrl?: string[] | undefined; - impressionUrl?: string[] | undefined; - videoId?: string | undefined; - } - interface ActivityContentDetailsRecommendation { - reason?: string | undefined; - resourceId?: YouTube.Schema.ResourceId | undefined; - seedResourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsSocial { - author?: string | undefined; - imageUrl?: string | undefined; - referenceUrl?: string | undefined; - resourceId?: YouTube.Schema.ResourceId | undefined; - type?: string | undefined; - } - interface ActivityContentDetailsSubscription { - resourceId?: YouTube.Schema.ResourceId | undefined; - } - interface ActivityContentDetailsUpload { - videoId?: string | undefined; - } - interface ActivityListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Activity[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface ActivitySnippet { - channelId?: string | undefined; - channelTitle?: string | undefined; - description?: string | undefined; - groupId?: string | undefined; - publishedAt?: string | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface Caption { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.CaptionSnippet | undefined; - } - interface CaptionListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Caption[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface CaptionSnippet { - audioTrackType?: string | undefined; - failureReason?: string | undefined; - isAutoSynced?: boolean | undefined; - isCC?: boolean | undefined; - isDraft?: boolean | undefined; - isEasyReader?: boolean | undefined; - isLarge?: boolean | undefined; - language?: string | undefined; - lastUpdated?: string | undefined; - name?: string | undefined; - status?: string | undefined; - trackKind?: string | undefined; - videoId?: string | undefined; - } - interface CdnSettings { - format?: string | undefined; - frameRate?: string | undefined; - ingestionInfo?: YouTube.Schema.IngestionInfo | undefined; - ingestionType?: string | undefined; - resolution?: string | undefined; - } - interface Channel { - auditDetails?: YouTube.Schema.ChannelAuditDetails | undefined; - brandingSettings?: YouTube.Schema.ChannelBrandingSettings | undefined; - contentDetails?: YouTube.Schema.ChannelContentDetails | undefined; - contentOwnerDetails?: YouTube.Schema.ChannelContentOwnerDetails | undefined; - conversionPings?: YouTube.Schema.ChannelConversionPings | undefined; - etag?: string | undefined; - id?: string | undefined; - invideoPromotion?: YouTube.Schema.InvideoPromotion | undefined; - kind?: string | undefined; - localizations?: object | undefined; - snippet?: YouTube.Schema.ChannelSnippet | undefined; - statistics?: YouTube.Schema.ChannelStatistics | undefined; - status?: YouTube.Schema.ChannelStatus | undefined; - topicDetails?: YouTube.Schema.ChannelTopicDetails | undefined; - } - interface ChannelAuditDetails { - communityGuidelinesGoodStanding?: boolean | undefined; - contentIdClaimsGoodStanding?: boolean | undefined; - copyrightStrikesGoodStanding?: boolean | undefined; - } - interface ChannelBannerResource { - etag?: string | undefined; - kind?: string | undefined; - url?: string | undefined; - } - interface ChannelBrandingSettings { - channel?: YouTube.Schema.ChannelSettings | undefined; - hints?: YouTube.Schema.PropertyValue[] | undefined; - image?: YouTube.Schema.ImageSettings | undefined; - watch?: YouTube.Schema.WatchSettings | undefined; - } - interface ChannelContentDetails { - relatedPlaylists?: YouTube.Schema.ChannelContentDetailsRelatedPlaylists | undefined; - } - interface ChannelContentDetailsRelatedPlaylists { - favorites?: string | undefined; - likes?: string | undefined; - uploads?: string | undefined; - watchHistory?: string | undefined; - watchLater?: string | undefined; - } - interface ChannelContentOwnerDetails { - contentOwner?: string | undefined; - timeLinked?: string | undefined; - } - interface ChannelConversionPing { - context?: string | undefined; - conversionUrl?: string | undefined; - } - interface ChannelConversionPings { - pings?: YouTube.Schema.ChannelConversionPing[] | undefined; - } - interface ChannelListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Channel[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface ChannelLocalization { - description?: string | undefined; - title?: string | undefined; - } - interface ChannelProfileDetails { - channelId?: string | undefined; - channelUrl?: string | undefined; - displayName?: string | undefined; - profileImageUrl?: string | undefined; - } - interface ChannelSection { - contentDetails?: YouTube.Schema.ChannelSectionContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - localizations?: object | undefined; - snippet?: YouTube.Schema.ChannelSectionSnippet | undefined; - targeting?: YouTube.Schema.ChannelSectionTargeting | undefined; - } - interface ChannelSectionContentDetails { - channels?: string[] | undefined; - playlists?: string[] | undefined; - } - interface ChannelSectionListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.ChannelSection[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface ChannelSectionLocalization { - title?: string | undefined; - } - interface ChannelSectionSnippet { - channelId?: string | undefined; - defaultLanguage?: string | undefined; - localized?: YouTube.Schema.ChannelSectionLocalization | undefined; - position?: number | undefined; - style?: string | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface ChannelSectionTargeting { - countries?: string[] | undefined; - languages?: string[] | undefined; - regions?: string[] | undefined; - } - interface ChannelSettings { - country?: string | undefined; - defaultLanguage?: string | undefined; - defaultTab?: string | undefined; - description?: string | undefined; - featuredChannelsTitle?: string | undefined; - featuredChannelsUrls?: string[] | undefined; - keywords?: string | undefined; - moderateComments?: boolean | undefined; - profileColor?: string | undefined; - showBrowseView?: boolean | undefined; - showRelatedChannels?: boolean | undefined; - title?: string | undefined; - trackingAnalyticsAccountId?: string | undefined; - unsubscribedTrailer?: string | undefined; - } - interface ChannelSnippet { - country?: string | undefined; - customUrl?: string | undefined; - defaultLanguage?: string | undefined; - description?: string | undefined; - localized?: YouTube.Schema.ChannelLocalization | undefined; - publishedAt?: string | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface ChannelStatistics { - commentCount?: string | undefined; - hiddenSubscriberCount?: boolean | undefined; - subscriberCount?: string | undefined; - videoCount?: string | undefined; - viewCount?: string | undefined; - } - interface ChannelStatus { - isLinked?: boolean | undefined; - longUploadsStatus?: string | undefined; - privacyStatus?: string | undefined; - } - interface ChannelTopicDetails { - topicCategories?: string[] | undefined; - topicIds?: string[] | undefined; - } - interface Comment { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.CommentSnippet | undefined; - } - interface CommentListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Comment[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface CommentSnippet { - authorChannelId?: object | undefined; - authorChannelUrl?: string | undefined; - authorDisplayName?: string | undefined; - authorProfileImageUrl?: string | undefined; - canRate?: boolean | undefined; - channelId?: string | undefined; - likeCount?: number | undefined; - moderationStatus?: string | undefined; - parentId?: string | undefined; - publishedAt?: string | undefined; - textDisplay?: string | undefined; - textOriginal?: string | undefined; - updatedAt?: string | undefined; - videoId?: string | undefined; - viewerRating?: string | undefined; - } - interface CommentThread { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - replies?: YouTube.Schema.CommentThreadReplies | undefined; - snippet?: YouTube.Schema.CommentThreadSnippet | undefined; - } - interface CommentThreadListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.CommentThread[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface CommentThreadReplies { - comments?: YouTube.Schema.Comment[] | undefined; - } - interface CommentThreadSnippet { - canReply?: boolean | undefined; - channelId?: string | undefined; - isPublic?: boolean | undefined; - topLevelComment?: YouTube.Schema.Comment | undefined; - totalReplyCount?: number | undefined; - videoId?: string | undefined; - } - interface ContentRating { - acbRating?: string | undefined; - agcomRating?: string | undefined; - anatelRating?: string | undefined; - bbfcRating?: string | undefined; - bfvcRating?: string | undefined; - bmukkRating?: string | undefined; - catvRating?: string | undefined; - catvfrRating?: string | undefined; - cbfcRating?: string | undefined; - cccRating?: string | undefined; - cceRating?: string | undefined; - chfilmRating?: string | undefined; - chvrsRating?: string | undefined; - cicfRating?: string | undefined; - cnaRating?: string | undefined; - cncRating?: string | undefined; - csaRating?: string | undefined; - cscfRating?: string | undefined; - czfilmRating?: string | undefined; - djctqRating?: string | undefined; - djctqRatingReasons?: string[] | undefined; - ecbmctRating?: string | undefined; - eefilmRating?: string | undefined; - egfilmRating?: string | undefined; - eirinRating?: string | undefined; - fcbmRating?: string | undefined; - fcoRating?: string | undefined; - fmocRating?: string | undefined; - fpbRating?: string | undefined; - fpbRatingReasons?: string[] | undefined; - fskRating?: string | undefined; - grfilmRating?: string | undefined; - icaaRating?: string | undefined; - ifcoRating?: string | undefined; - ilfilmRating?: string | undefined; - incaaRating?: string | undefined; - kfcbRating?: string | undefined; - kijkwijzerRating?: string | undefined; - kmrbRating?: string | undefined; - lsfRating?: string | undefined; - mccaaRating?: string | undefined; - mccypRating?: string | undefined; - mcstRating?: string | undefined; - mdaRating?: string | undefined; - medietilsynetRating?: string | undefined; - mekuRating?: string | undefined; - menaMpaaRating?: string | undefined; - mibacRating?: string | undefined; - mocRating?: string | undefined; - moctwRating?: string | undefined; - mpaaRating?: string | undefined; - mpaatRating?: string | undefined; - mtrcbRating?: string | undefined; - nbcRating?: string | undefined; - nbcplRating?: string | undefined; - nfrcRating?: string | undefined; - nfvcbRating?: string | undefined; - nkclvRating?: string | undefined; - oflcRating?: string | undefined; - pefilmRating?: string | undefined; - rcnofRating?: string | undefined; - resorteviolenciaRating?: string | undefined; - rtcRating?: string | undefined; - rteRating?: string | undefined; - russiaRating?: string | undefined; - skfilmRating?: string | undefined; - smaisRating?: string | undefined; - smsaRating?: string | undefined; - tvpgRating?: string | undefined; - ytRating?: string | undefined; - } - interface GeoPoint { - altitude?: number | undefined; - latitude?: number | undefined; - longitude?: number | undefined; - } - interface GuideCategory { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.GuideCategorySnippet | undefined; - } - interface GuideCategoryListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.GuideCategory[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface GuideCategorySnippet { - channelId?: string | undefined; - title?: string | undefined; - } - interface I18nLanguage { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.I18nLanguageSnippet | undefined; - } - interface I18nLanguageListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.I18nLanguage[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface I18nLanguageSnippet { - hl?: string | undefined; - name?: string | undefined; - } - interface I18nRegion { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.I18nRegionSnippet | undefined; - } - interface I18nRegionListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.I18nRegion[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface I18nRegionSnippet { - gl?: string | undefined; - name?: string | undefined; - } - interface ImageSettings { - backgroundImageUrl?: YouTube.Schema.LocalizedProperty | undefined; - bannerExternalUrl?: string | undefined; - bannerImageUrl?: string | undefined; - bannerMobileExtraHdImageUrl?: string | undefined; - bannerMobileHdImageUrl?: string | undefined; - bannerMobileImageUrl?: string | undefined; - bannerMobileLowImageUrl?: string | undefined; - bannerMobileMediumHdImageUrl?: string | undefined; - bannerTabletExtraHdImageUrl?: string | undefined; - bannerTabletHdImageUrl?: string | undefined; - bannerTabletImageUrl?: string | undefined; - bannerTabletLowImageUrl?: string | undefined; - bannerTvHighImageUrl?: string | undefined; - bannerTvImageUrl?: string | undefined; - bannerTvLowImageUrl?: string | undefined; - bannerTvMediumImageUrl?: string | undefined; - largeBrandedBannerImageImapScript?: YouTube.Schema.LocalizedProperty | undefined; - largeBrandedBannerImageUrl?: YouTube.Schema.LocalizedProperty | undefined; - smallBrandedBannerImageImapScript?: YouTube.Schema.LocalizedProperty | undefined; - smallBrandedBannerImageUrl?: YouTube.Schema.LocalizedProperty | undefined; - trackingImageUrl?: string | undefined; - watchIconImageUrl?: string | undefined; - } - interface IngestionInfo { - backupIngestionAddress?: string | undefined; - ingestionAddress?: string | undefined; - streamName?: string | undefined; - } - interface InvideoBranding { - imageBytes?: string | undefined; - imageUrl?: string | undefined; - position?: YouTube.Schema.InvideoPosition | undefined; - targetChannelId?: string | undefined; - timing?: YouTube.Schema.InvideoTiming | undefined; - } - interface InvideoPosition { - cornerPosition?: string | undefined; - type?: string | undefined; - } - interface InvideoPromotion { - defaultTiming?: YouTube.Schema.InvideoTiming | undefined; - items?: YouTube.Schema.PromotedItem[] | undefined; - position?: YouTube.Schema.InvideoPosition | undefined; - useSmartTiming?: boolean | undefined; - } - interface InvideoTiming { - durationMs?: string | undefined; - offsetMs?: string | undefined; - type?: string | undefined; - } - interface LanguageTag { - value?: string | undefined; - } - interface LiveBroadcast { - contentDetails?: YouTube.Schema.LiveBroadcastContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.LiveBroadcastSnippet | undefined; - statistics?: YouTube.Schema.LiveBroadcastStatistics | undefined; - status?: YouTube.Schema.LiveBroadcastStatus | undefined; - } - interface LiveBroadcastContentDetails { - boundStreamId?: string | undefined; - boundStreamLastUpdateTimeMs?: string | undefined; - closedCaptionsType?: string | undefined; - enableAutoStart?: boolean | undefined; - enableClosedCaptions?: boolean | undefined; - enableContentEncryption?: boolean | undefined; - enableDvr?: boolean | undefined; - enableEmbed?: boolean | undefined; - enableLowLatency?: boolean | undefined; - latencyPreference?: string | undefined; - mesh?: string | undefined; - monitorStream?: YouTube.Schema.MonitorStreamInfo | undefined; - projection?: string | undefined; - recordFromStart?: boolean | undefined; - startWithSlate?: boolean | undefined; - stereoLayout?: string | undefined; - } - interface LiveBroadcastListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.LiveBroadcast[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface LiveBroadcastSnippet { - actualEndTime?: string | undefined; - actualStartTime?: string | undefined; - channelId?: string | undefined; - description?: string | undefined; - isDefaultBroadcast?: boolean | undefined; - liveChatId?: string | undefined; - publishedAt?: string | undefined; - scheduledEndTime?: string | undefined; - scheduledStartTime?: string | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface LiveBroadcastStatistics { - concurrentViewers?: string | undefined; - totalChatCount?: string | undefined; - } - interface LiveBroadcastStatus { - lifeCycleStatus?: string | undefined; - liveBroadcastPriority?: string | undefined; - privacyStatus?: string | undefined; - recordingStatus?: string | undefined; - } - interface LiveChatBan { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.LiveChatBanSnippet | undefined; - } - interface LiveChatBanSnippet { - banDurationSeconds?: string | undefined; - bannedUserDetails?: YouTube.Schema.ChannelProfileDetails | undefined; - liveChatId?: string | undefined; - type?: string | undefined; - } - interface LiveChatFanFundingEventDetails { - amountDisplayString?: string | undefined; - amountMicros?: string | undefined; - currency?: string | undefined; - userComment?: string | undefined; - } - interface LiveChatMessage { - authorDetails?: YouTube.Schema.LiveChatMessageAuthorDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.LiveChatMessageSnippet | undefined; - } - interface LiveChatMessageAuthorDetails { - channelId?: string | undefined; - channelUrl?: string | undefined; - displayName?: string | undefined; - isChatModerator?: boolean | undefined; - isChatOwner?: boolean | undefined; - isChatSponsor?: boolean | undefined; - isVerified?: boolean | undefined; - profileImageUrl?: string | undefined; - } - interface LiveChatMessageDeletedDetails { - deletedMessageId?: string | undefined; - } - interface LiveChatMessageListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.LiveChatMessage[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - offlineAt?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - pollingIntervalMillis?: number | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface LiveChatMessageRetractedDetails { - retractedMessageId?: string | undefined; - } - interface LiveChatMessageSnippet { - authorChannelId?: string | undefined; - displayMessage?: string | undefined; - fanFundingEventDetails?: YouTube.Schema.LiveChatFanFundingEventDetails | undefined; - hasDisplayContent?: boolean | undefined; - liveChatId?: string | undefined; - messageDeletedDetails?: YouTube.Schema.LiveChatMessageDeletedDetails | undefined; - messageRetractedDetails?: YouTube.Schema.LiveChatMessageRetractedDetails | undefined; - pollClosedDetails?: YouTube.Schema.LiveChatPollClosedDetails | undefined; - pollEditedDetails?: YouTube.Schema.LiveChatPollEditedDetails | undefined; - pollOpenedDetails?: YouTube.Schema.LiveChatPollOpenedDetails | undefined; - pollVotedDetails?: YouTube.Schema.LiveChatPollVotedDetails | undefined; - publishedAt?: string | undefined; - superChatDetails?: YouTube.Schema.LiveChatSuperChatDetails | undefined; - superStickerDetails?: YouTube.Schema.LiveChatSuperStickerDetails | undefined; - textMessageDetails?: YouTube.Schema.LiveChatTextMessageDetails | undefined; - type?: string | undefined; - userBannedDetails?: YouTube.Schema.LiveChatUserBannedMessageDetails | undefined; - } - interface LiveChatModerator { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.LiveChatModeratorSnippet | undefined; - } - interface LiveChatModeratorListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.LiveChatModerator[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface LiveChatModeratorSnippet { - liveChatId?: string | undefined; - moderatorDetails?: YouTube.Schema.ChannelProfileDetails | undefined; - } - interface LiveChatPollClosedDetails { - pollId?: string | undefined; - } - interface LiveChatPollEditedDetails { - id?: string | undefined; - items?: YouTube.Schema.LiveChatPollItem[] | undefined; - prompt?: string | undefined; - } - interface LiveChatPollItem { - description?: string | undefined; - itemId?: string | undefined; - } - interface LiveChatPollOpenedDetails { - id?: string | undefined; - items?: YouTube.Schema.LiveChatPollItem[] | undefined; - prompt?: string | undefined; - } - interface LiveChatPollVotedDetails { - itemId?: string | undefined; - pollId?: string | undefined; - } - interface LiveChatSuperChatDetails { - amountDisplayString?: string | undefined; - amountMicros?: string | undefined; - currency?: string | undefined; - tier?: number | undefined; - userComment?: string | undefined; - } - interface LiveChatSuperStickerDetails { - amountDisplayString?: string | undefined; - amountMicros?: string | undefined; - currency?: string | undefined; - superStickerMetadata?: YouTube.Schema.SuperStickerMetadata | undefined; - tier?: number | undefined; - } - interface LiveChatTextMessageDetails { - messageText?: string | undefined; - } - interface LiveChatUserBannedMessageDetails { - banDurationSeconds?: string | undefined; - banType?: string | undefined; - bannedUserDetails?: YouTube.Schema.ChannelProfileDetails | undefined; - } - interface LiveStream { - cdn?: YouTube.Schema.CdnSettings | undefined; - contentDetails?: YouTube.Schema.LiveStreamContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.LiveStreamSnippet | undefined; - status?: YouTube.Schema.LiveStreamStatus | undefined; - } - interface LiveStreamConfigurationIssue { - description?: string | undefined; - reason?: string | undefined; - severity?: string | undefined; - type?: string | undefined; - } - interface LiveStreamContentDetails { - closedCaptionsIngestionUrl?: string | undefined; - isReusable?: boolean | undefined; - } - interface LiveStreamHealthStatus { - configurationIssues?: YouTube.Schema.LiveStreamConfigurationIssue[] | undefined; - lastUpdateTimeSeconds?: string | undefined; - status?: string | undefined; - } - interface LiveStreamListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.LiveStream[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface LiveStreamSnippet { - channelId?: string | undefined; - description?: string | undefined; - isDefaultStream?: boolean | undefined; - publishedAt?: string | undefined; - title?: string | undefined; - } - interface LiveStreamStatus { - healthStatus?: YouTube.Schema.LiveStreamHealthStatus | undefined; - streamStatus?: string | undefined; - } - interface LocalizedProperty { - default?: string | undefined; - defaultLanguage?: YouTube.Schema.LanguageTag | undefined; - localized?: YouTube.Schema.LocalizedString[] | undefined; - } - interface LocalizedString { - language?: string | undefined; - value?: string | undefined; - } - interface MonitorStreamInfo { - broadcastStreamDelayMs?: number | undefined; - embedHtml?: string | undefined; - enableMonitorStream?: boolean | undefined; - } - interface Nonprofit { - nonprofitId?: YouTube.Schema.NonprofitId | undefined; - nonprofitLegalName?: string | undefined; - } - interface NonprofitId { - value?: string | undefined; - } - interface PageInfo { - resultsPerPage?: number | undefined; - totalResults?: number | undefined; - } - interface Playlist { - contentDetails?: YouTube.Schema.PlaylistContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - localizations?: object | undefined; - player?: YouTube.Schema.PlaylistPlayer | undefined; - snippet?: YouTube.Schema.PlaylistSnippet | undefined; - status?: YouTube.Schema.PlaylistStatus | undefined; - } - interface PlaylistContentDetails { - itemCount?: number | undefined; - } - interface PlaylistItem { - contentDetails?: YouTube.Schema.PlaylistItemContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.PlaylistItemSnippet | undefined; - status?: YouTube.Schema.PlaylistItemStatus | undefined; - } - interface PlaylistItemContentDetails { - endAt?: string | undefined; - note?: string | undefined; - startAt?: string | undefined; - videoId?: string | undefined; - videoPublishedAt?: string | undefined; - } - interface PlaylistItemListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.PlaylistItem[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface PlaylistItemSnippet { - channelId?: string | undefined; - channelTitle?: string | undefined; - description?: string | undefined; - playlistId?: string | undefined; - position?: number | undefined; - publishedAt?: string | undefined; - resourceId?: YouTube.Schema.ResourceId | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface PlaylistItemStatus { - privacyStatus?: string | undefined; - } - interface PlaylistListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Playlist[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface PlaylistLocalization { - description?: string | undefined; - title?: string | undefined; - } - interface PlaylistPlayer { - embedHtml?: string | undefined; - } - interface PlaylistSnippet { - channelId?: string | undefined; - channelTitle?: string | undefined; - defaultLanguage?: string | undefined; - description?: string | undefined; - localized?: YouTube.Schema.PlaylistLocalization | undefined; - publishedAt?: string | undefined; - tags?: string[] | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface PlaylistStatus { - privacyStatus?: string | undefined; - } - interface PromotedItem { - customMessage?: string | undefined; - id?: YouTube.Schema.PromotedItemId | undefined; - promotedByContentOwner?: boolean | undefined; - timing?: YouTube.Schema.InvideoTiming | undefined; - } - interface PromotedItemId { - recentlyUploadedBy?: string | undefined; - type?: string | undefined; - videoId?: string | undefined; - websiteUrl?: string | undefined; - } - interface PropertyValue { - property?: string | undefined; - value?: string | undefined; - } - interface ResourceId { - channelId?: string | undefined; - kind?: string | undefined; - playlistId?: string | undefined; - videoId?: string | undefined; - } - interface SearchListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.SearchResult[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - regionCode?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface SearchResult { - etag?: string | undefined; - id?: YouTube.Schema.ResourceId | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.SearchResultSnippet | undefined; - } - interface SearchResultSnippet { - channelId?: string | undefined; - channelTitle?: string | undefined; - description?: string | undefined; - liveBroadcastContent?: string | undefined; - publishedAt?: string | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface Sponsor { - etag?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.SponsorSnippet | undefined; - } - interface SponsorListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Sponsor[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface SponsorSnippet { - channelId?: string | undefined; - cumulativeDurationMonths?: number | undefined; - sponsorDetails?: YouTube.Schema.ChannelProfileDetails | undefined; - sponsorSince?: string | undefined; - } - interface Subscription { - contentDetails?: YouTube.Schema.SubscriptionContentDetails | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.SubscriptionSnippet | undefined; - subscriberSnippet?: YouTube.Schema.SubscriptionSubscriberSnippet | undefined; - } - interface SubscriptionContentDetails { - activityType?: string | undefined; - newItemCount?: number | undefined; - totalItemCount?: number | undefined; - } - interface SubscriptionListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Subscription[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface SubscriptionSnippet { - channelId?: string | undefined; - channelTitle?: string | undefined; - description?: string | undefined; - publishedAt?: string | undefined; - resourceId?: YouTube.Schema.ResourceId | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface SubscriptionSubscriberSnippet { - channelId?: string | undefined; - description?: string | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface SuperChatEvent { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.SuperChatEventSnippet | undefined; - } - interface SuperChatEventListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.SuperChatEvent[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface SuperChatEventSnippet { - amountMicros?: string | undefined; - channelId?: string | undefined; - commentText?: string | undefined; - createdAt?: string | undefined; - currency?: string | undefined; - displayString?: string | undefined; - isSuperChatForGood?: boolean | undefined; - isSuperStickerEvent?: boolean | undefined; - messageType?: number | undefined; - nonprofit?: YouTube.Schema.Nonprofit | undefined; - superStickerMetadata?: YouTube.Schema.SuperStickerMetadata | undefined; - supporterDetails?: YouTube.Schema.ChannelProfileDetails | undefined; - } - interface SuperStickerMetadata { - altText?: string | undefined; - altTextLanguage?: string | undefined; - stickerId?: string | undefined; - } - interface Thumbnail { - height?: number | undefined; - url?: string | undefined; - width?: number | undefined; - } - interface ThumbnailDetails { - default?: YouTube.Schema.Thumbnail | undefined; - high?: YouTube.Schema.Thumbnail | undefined; - maxres?: YouTube.Schema.Thumbnail | undefined; - medium?: YouTube.Schema.Thumbnail | undefined; - standard?: YouTube.Schema.Thumbnail | undefined; - } - interface ThumbnailSetResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.ThumbnailDetails[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface Video { - ageGating?: YouTube.Schema.VideoAgeGating | undefined; - contentDetails?: YouTube.Schema.VideoContentDetails | undefined; - etag?: string | undefined; - fileDetails?: YouTube.Schema.VideoFileDetails | undefined; - id?: string | undefined; - kind?: string | undefined; - liveStreamingDetails?: YouTube.Schema.VideoLiveStreamingDetails | undefined; - localizations?: object | undefined; - monetizationDetails?: YouTube.Schema.VideoMonetizationDetails | undefined; - player?: YouTube.Schema.VideoPlayer | undefined; - processingDetails?: YouTube.Schema.VideoProcessingDetails | undefined; - projectDetails?: YouTube.Schema.VideoProjectDetails | undefined; - recordingDetails?: YouTube.Schema.VideoRecordingDetails | undefined; - snippet?: YouTube.Schema.VideoSnippet | undefined; - statistics?: YouTube.Schema.VideoStatistics | undefined; - status?: YouTube.Schema.VideoStatus | undefined; - suggestions?: YouTube.Schema.VideoSuggestions | undefined; - topicDetails?: YouTube.Schema.VideoTopicDetails | undefined; - } - interface VideoAbuseReport { - comments?: string | undefined; - language?: string | undefined; - reasonId?: string | undefined; - secondaryReasonId?: string | undefined; - videoId?: string | undefined; - } - interface VideoAbuseReportReason { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.VideoAbuseReportReasonSnippet | undefined; - } - interface VideoAbuseReportReasonListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.VideoAbuseReportReason[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface VideoAbuseReportReasonSnippet { - label?: string | undefined; - secondaryReasons?: YouTube.Schema.VideoAbuseReportSecondaryReason[] | undefined; - } - interface VideoAbuseReportSecondaryReason { - id?: string | undefined; - label?: string | undefined; - } - interface VideoAgeGating { - alcoholContent?: boolean | undefined; - restricted?: boolean | undefined; - videoGameRating?: string | undefined; - } - interface VideoCategory { - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTube.Schema.VideoCategorySnippet | undefined; - } - interface VideoCategoryListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.VideoCategory[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface VideoCategorySnippet { - assignable?: boolean | undefined; - channelId?: string | undefined; - title?: string | undefined; - } - interface VideoContentDetails { - caption?: string | undefined; - contentRating?: YouTube.Schema.ContentRating | undefined; - countryRestriction?: YouTube.Schema.AccessPolicy | undefined; - definition?: string | undefined; - dimension?: string | undefined; - duration?: string | undefined; - hasCustomThumbnail?: boolean | undefined; - licensedContent?: boolean | undefined; - projection?: string | undefined; - regionRestriction?: YouTube.Schema.VideoContentDetailsRegionRestriction | undefined; - } - interface VideoContentDetailsRegionRestriction { - allowed?: string[] | undefined; - blocked?: string[] | undefined; - } - interface VideoFileDetails { - audioStreams?: YouTube.Schema.VideoFileDetailsAudioStream[] | undefined; - bitrateBps?: string | undefined; - container?: string | undefined; - creationTime?: string | undefined; - durationMs?: string | undefined; - fileName?: string | undefined; - fileSize?: string | undefined; - fileType?: string | undefined; - videoStreams?: YouTube.Schema.VideoFileDetailsVideoStream[] | undefined; - } - interface VideoFileDetailsAudioStream { - bitrateBps?: string | undefined; - channelCount?: number | undefined; - codec?: string | undefined; - vendor?: string | undefined; - } - interface VideoFileDetailsVideoStream { - aspectRatio?: number | undefined; - bitrateBps?: string | undefined; - codec?: string | undefined; - frameRateFps?: number | undefined; - heightPixels?: number | undefined; - rotation?: string | undefined; - vendor?: string | undefined; - widthPixels?: number | undefined; - } - interface VideoGetRatingResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.VideoRating[] | undefined; - kind?: string | undefined; - visitorId?: string | undefined; - } - interface VideoListResponse { - etag?: string | undefined; - eventId?: string | undefined; - items?: YouTube.Schema.Video[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YouTube.Schema.PageInfo | undefined; - prevPageToken?: string | undefined; - tokenPagination?: any; // Schema.TokenPagination - visitorId?: string | undefined; - } - interface VideoLiveStreamingDetails { - activeLiveChatId?: string | undefined; - actualEndTime?: string | undefined; - actualStartTime?: string | undefined; - concurrentViewers?: string | undefined; - scheduledEndTime?: string | undefined; - scheduledStartTime?: string | undefined; - } - interface VideoLocalization { - description?: string | undefined; - title?: string | undefined; - } - interface VideoMonetizationDetails { - access?: YouTube.Schema.AccessPolicy | undefined; - } - interface VideoPlayer { - embedHeight?: string | undefined; - embedHtml?: string | undefined; - embedWidth?: string | undefined; - } - interface VideoProcessingDetails { - editorSuggestionsAvailability?: string | undefined; - fileDetailsAvailability?: string | undefined; - processingFailureReason?: string | undefined; - processingIssuesAvailability?: string | undefined; - processingProgress?: YouTube.Schema.VideoProcessingDetailsProcessingProgress | undefined; - processingStatus?: string | undefined; - tagSuggestionsAvailability?: string | undefined; - thumbnailsAvailability?: string | undefined; - } - interface VideoProcessingDetailsProcessingProgress { - partsProcessed?: string | undefined; - partsTotal?: string | undefined; - timeLeftMs?: string | undefined; - } - interface VideoProjectDetails { - tags?: string[] | undefined; - } - interface VideoRating { - rating?: string | undefined; - videoId?: string | undefined; - } - interface VideoRecordingDetails { - location?: YouTube.Schema.GeoPoint | undefined; - locationDescription?: string | undefined; - recordingDate?: string | undefined; - } - interface VideoSnippet { - categoryId?: string | undefined; - channelId?: string | undefined; - channelTitle?: string | undefined; - defaultAudioLanguage?: string | undefined; - defaultLanguage?: string | undefined; - description?: string | undefined; - liveBroadcastContent?: string | undefined; - localized?: YouTube.Schema.VideoLocalization | undefined; - publishedAt?: string | undefined; - tags?: string[] | undefined; - thumbnails?: YouTube.Schema.ThumbnailDetails | undefined; - title?: string | undefined; - } - interface VideoStatistics { - commentCount?: string | undefined; - dislikeCount?: string | undefined; - favoriteCount?: string | undefined; - likeCount?: string | undefined; - viewCount?: string | undefined; - } - interface VideoStatus { - embeddable?: boolean | undefined; - failureReason?: string | undefined; - license?: string | undefined; - privacyStatus?: string | undefined; - publicStatsViewable?: boolean | undefined; - publishAt?: string | undefined; - rejectionReason?: string | undefined; - uploadStatus?: string | undefined; - } - interface VideoSuggestions { - editorSuggestions?: string[] | undefined; - processingErrors?: string[] | undefined; - processingHints?: string[] | undefined; - processingWarnings?: string[] | undefined; - tagSuggestions?: YouTube.Schema.VideoSuggestionsTagSuggestion[] | undefined; - } - interface VideoSuggestionsTagSuggestion { - categoryRestricts?: string[] | undefined; - tag?: string | undefined; - } - interface VideoTopicDetails { - relevantTopicIds?: string[] | undefined; - topicCategories?: string[] | undefined; - topicIds?: string[] | undefined; - } - interface WatchSettings { - backgroundColor?: string | undefined; - featuredPlaylistId?: string | undefined; - textColor?: string | undefined; - } - } - } - interface YouTube { - Activities?: YouTube.Collection.ActivitiesCollection | undefined; - Captions?: YouTube.Collection.CaptionsCollection | undefined; - ChannelBanners?: YouTube.Collection.ChannelBannersCollection | undefined; - ChannelSections?: YouTube.Collection.ChannelSectionsCollection | undefined; - Channels?: YouTube.Collection.ChannelsCollection | undefined; - CommentThreads?: YouTube.Collection.CommentThreadsCollection | undefined; - Comments?: YouTube.Collection.CommentsCollection | undefined; - GuideCategories?: YouTube.Collection.GuideCategoriesCollection | undefined; - I18nLanguages?: YouTube.Collection.I18nLanguagesCollection | undefined; - I18nRegions?: YouTube.Collection.I18nRegionsCollection | undefined; - LiveBroadcasts?: YouTube.Collection.LiveBroadcastsCollection | undefined; - LiveChatBans?: YouTube.Collection.LiveChatBansCollection | undefined; - LiveChatMessages?: YouTube.Collection.LiveChatMessagesCollection | undefined; - LiveChatModerators?: YouTube.Collection.LiveChatModeratorsCollection | undefined; - LiveStreams?: YouTube.Collection.LiveStreamsCollection | undefined; - PlaylistItems?: YouTube.Collection.PlaylistItemsCollection | undefined; - Playlists?: YouTube.Collection.PlaylistsCollection | undefined; - Search?: YouTube.Collection.SearchCollection | undefined; - Sponsors?: YouTube.Collection.SponsorsCollection | undefined; - Subscriptions?: YouTube.Collection.SubscriptionsCollection | undefined; - SuperChatEvents?: YouTube.Collection.SuperChatEventsCollection | undefined; - Thumbnails?: YouTube.Collection.ThumbnailsCollection | undefined; - VideoAbuseReportReasons?: YouTube.Collection.VideoAbuseReportReasonsCollection | undefined; - VideoCategories?: YouTube.Collection.VideoCategoriesCollection | undefined; - Videos?: YouTube.Collection.VideosCollection | undefined; - Watermarks?: YouTube.Collection.WatermarksCollection | undefined; - // Create a new instance of AccessPolicy - newAccessPolicy(): YouTube.Schema.AccessPolicy; - // Create a new instance of Activity - newActivity(): YouTube.Schema.Activity; - // Create a new instance of ActivityContentDetails - newActivityContentDetails(): YouTube.Schema.ActivityContentDetails; - // Create a new instance of ActivityContentDetailsBulletin - newActivityContentDetailsBulletin(): YouTube.Schema.ActivityContentDetailsBulletin; - // Create a new instance of ActivityContentDetailsChannelItem - newActivityContentDetailsChannelItem(): YouTube.Schema.ActivityContentDetailsChannelItem; - // Create a new instance of ActivityContentDetailsComment - newActivityContentDetailsComment(): YouTube.Schema.ActivityContentDetailsComment; - // Create a new instance of ActivityContentDetailsFavorite - newActivityContentDetailsFavorite(): YouTube.Schema.ActivityContentDetailsFavorite; - // Create a new instance of ActivityContentDetailsLike - newActivityContentDetailsLike(): YouTube.Schema.ActivityContentDetailsLike; - // Create a new instance of ActivityContentDetailsPlaylistItem - newActivityContentDetailsPlaylistItem(): YouTube.Schema.ActivityContentDetailsPlaylistItem; - // Create a new instance of ActivityContentDetailsPromotedItem - newActivityContentDetailsPromotedItem(): YouTube.Schema.ActivityContentDetailsPromotedItem; - // Create a new instance of ActivityContentDetailsRecommendation - newActivityContentDetailsRecommendation(): YouTube.Schema.ActivityContentDetailsRecommendation; - // Create a new instance of ActivityContentDetailsSocial - newActivityContentDetailsSocial(): YouTube.Schema.ActivityContentDetailsSocial; - // Create a new instance of ActivityContentDetailsSubscription - newActivityContentDetailsSubscription(): YouTube.Schema.ActivityContentDetailsSubscription; - // Create a new instance of ActivityContentDetailsUpload - newActivityContentDetailsUpload(): YouTube.Schema.ActivityContentDetailsUpload; - // Create a new instance of ActivitySnippet - newActivitySnippet(): YouTube.Schema.ActivitySnippet; - // Create a new instance of Caption - newCaption(): YouTube.Schema.Caption; - // Create a new instance of CaptionSnippet - newCaptionSnippet(): YouTube.Schema.CaptionSnippet; - // Create a new instance of CdnSettings - newCdnSettings(): YouTube.Schema.CdnSettings; - // Create a new instance of Channel - newChannel(): YouTube.Schema.Channel; - // Create a new instance of ChannelAuditDetails - newChannelAuditDetails(): YouTube.Schema.ChannelAuditDetails; - // Create a new instance of ChannelBannerResource - newChannelBannerResource(): YouTube.Schema.ChannelBannerResource; - // Create a new instance of ChannelBrandingSettings - newChannelBrandingSettings(): YouTube.Schema.ChannelBrandingSettings; - // Create a new instance of ChannelContentDetails - newChannelContentDetails(): YouTube.Schema.ChannelContentDetails; - // Create a new instance of ChannelContentDetailsRelatedPlaylists - newChannelContentDetailsRelatedPlaylists(): YouTube.Schema.ChannelContentDetailsRelatedPlaylists; - // Create a new instance of ChannelContentOwnerDetails - newChannelContentOwnerDetails(): YouTube.Schema.ChannelContentOwnerDetails; - // Create a new instance of ChannelConversionPing - newChannelConversionPing(): YouTube.Schema.ChannelConversionPing; - // Create a new instance of ChannelConversionPings - newChannelConversionPings(): YouTube.Schema.ChannelConversionPings; - // Create a new instance of ChannelLocalization - newChannelLocalization(): YouTube.Schema.ChannelLocalization; - // Create a new instance of ChannelProfileDetails - newChannelProfileDetails(): YouTube.Schema.ChannelProfileDetails; - // Create a new instance of ChannelSection - newChannelSection(): YouTube.Schema.ChannelSection; - // Create a new instance of ChannelSectionContentDetails - newChannelSectionContentDetails(): YouTube.Schema.ChannelSectionContentDetails; - // Create a new instance of ChannelSectionLocalization - newChannelSectionLocalization(): YouTube.Schema.ChannelSectionLocalization; - // Create a new instance of ChannelSectionSnippet - newChannelSectionSnippet(): YouTube.Schema.ChannelSectionSnippet; - // Create a new instance of ChannelSectionTargeting - newChannelSectionTargeting(): YouTube.Schema.ChannelSectionTargeting; - // Create a new instance of ChannelSettings - newChannelSettings(): YouTube.Schema.ChannelSettings; - // Create a new instance of ChannelSnippet - newChannelSnippet(): YouTube.Schema.ChannelSnippet; - // Create a new instance of ChannelStatistics - newChannelStatistics(): YouTube.Schema.ChannelStatistics; - // Create a new instance of ChannelStatus - newChannelStatus(): YouTube.Schema.ChannelStatus; - // Create a new instance of ChannelTopicDetails - newChannelTopicDetails(): YouTube.Schema.ChannelTopicDetails; - // Create a new instance of Comment - newComment(): YouTube.Schema.Comment; - // Create a new instance of CommentSnippet - newCommentSnippet(): YouTube.Schema.CommentSnippet; - // Create a new instance of CommentThread - newCommentThread(): YouTube.Schema.CommentThread; - // Create a new instance of CommentThreadReplies - newCommentThreadReplies(): YouTube.Schema.CommentThreadReplies; - // Create a new instance of CommentThreadSnippet - newCommentThreadSnippet(): YouTube.Schema.CommentThreadSnippet; - // Create a new instance of ContentRating - newContentRating(): YouTube.Schema.ContentRating; - // Create a new instance of GeoPoint - newGeoPoint(): YouTube.Schema.GeoPoint; - // Create a new instance of ImageSettings - newImageSettings(): YouTube.Schema.ImageSettings; - // Create a new instance of IngestionInfo - newIngestionInfo(): YouTube.Schema.IngestionInfo; - // Create a new instance of InvideoBranding - newInvideoBranding(): YouTube.Schema.InvideoBranding; - // Create a new instance of InvideoPosition - newInvideoPosition(): YouTube.Schema.InvideoPosition; - // Create a new instance of InvideoPromotion - newInvideoPromotion(): YouTube.Schema.InvideoPromotion; - // Create a new instance of InvideoTiming - newInvideoTiming(): YouTube.Schema.InvideoTiming; - // Create a new instance of LanguageTag - newLanguageTag(): YouTube.Schema.LanguageTag; - // Create a new instance of LiveBroadcast - newLiveBroadcast(): YouTube.Schema.LiveBroadcast; - // Create a new instance of LiveBroadcastContentDetails - newLiveBroadcastContentDetails(): YouTube.Schema.LiveBroadcastContentDetails; - // Create a new instance of LiveBroadcastSnippet - newLiveBroadcastSnippet(): YouTube.Schema.LiveBroadcastSnippet; - // Create a new instance of LiveBroadcastStatistics - newLiveBroadcastStatistics(): YouTube.Schema.LiveBroadcastStatistics; - // Create a new instance of LiveBroadcastStatus - newLiveBroadcastStatus(): YouTube.Schema.LiveBroadcastStatus; - // Create a new instance of LiveChatBan - newLiveChatBan(): YouTube.Schema.LiveChatBan; - // Create a new instance of LiveChatBanSnippet - newLiveChatBanSnippet(): YouTube.Schema.LiveChatBanSnippet; - // Create a new instance of LiveChatFanFundingEventDetails - newLiveChatFanFundingEventDetails(): YouTube.Schema.LiveChatFanFundingEventDetails; - // Create a new instance of LiveChatMessage - newLiveChatMessage(): YouTube.Schema.LiveChatMessage; - // Create a new instance of LiveChatMessageAuthorDetails - newLiveChatMessageAuthorDetails(): YouTube.Schema.LiveChatMessageAuthorDetails; - // Create a new instance of LiveChatMessageDeletedDetails - newLiveChatMessageDeletedDetails(): YouTube.Schema.LiveChatMessageDeletedDetails; - // Create a new instance of LiveChatMessageRetractedDetails - newLiveChatMessageRetractedDetails(): YouTube.Schema.LiveChatMessageRetractedDetails; - // Create a new instance of LiveChatMessageSnippet - newLiveChatMessageSnippet(): YouTube.Schema.LiveChatMessageSnippet; - // Create a new instance of LiveChatModerator - newLiveChatModerator(): YouTube.Schema.LiveChatModerator; - // Create a new instance of LiveChatModeratorSnippet - newLiveChatModeratorSnippet(): YouTube.Schema.LiveChatModeratorSnippet; - // Create a new instance of LiveChatPollClosedDetails - newLiveChatPollClosedDetails(): YouTube.Schema.LiveChatPollClosedDetails; - // Create a new instance of LiveChatPollEditedDetails - newLiveChatPollEditedDetails(): YouTube.Schema.LiveChatPollEditedDetails; - // Create a new instance of LiveChatPollItem - newLiveChatPollItem(): YouTube.Schema.LiveChatPollItem; - // Create a new instance of LiveChatPollOpenedDetails - newLiveChatPollOpenedDetails(): YouTube.Schema.LiveChatPollOpenedDetails; - // Create a new instance of LiveChatPollVotedDetails - newLiveChatPollVotedDetails(): YouTube.Schema.LiveChatPollVotedDetails; - // Create a new instance of LiveChatSuperChatDetails - newLiveChatSuperChatDetails(): YouTube.Schema.LiveChatSuperChatDetails; - // Create a new instance of LiveChatSuperStickerDetails - newLiveChatSuperStickerDetails(): YouTube.Schema.LiveChatSuperStickerDetails; - // Create a new instance of LiveChatTextMessageDetails - newLiveChatTextMessageDetails(): YouTube.Schema.LiveChatTextMessageDetails; - // Create a new instance of LiveChatUserBannedMessageDetails - newLiveChatUserBannedMessageDetails(): YouTube.Schema.LiveChatUserBannedMessageDetails; - // Create a new instance of LiveStream - newLiveStream(): YouTube.Schema.LiveStream; - // Create a new instance of LiveStreamConfigurationIssue - newLiveStreamConfigurationIssue(): YouTube.Schema.LiveStreamConfigurationIssue; - // Create a new instance of LiveStreamContentDetails - newLiveStreamContentDetails(): YouTube.Schema.LiveStreamContentDetails; - // Create a new instance of LiveStreamHealthStatus - newLiveStreamHealthStatus(): YouTube.Schema.LiveStreamHealthStatus; - // Create a new instance of LiveStreamSnippet - newLiveStreamSnippet(): YouTube.Schema.LiveStreamSnippet; - // Create a new instance of LiveStreamStatus - newLiveStreamStatus(): YouTube.Schema.LiveStreamStatus; - // Create a new instance of LocalizedProperty - newLocalizedProperty(): YouTube.Schema.LocalizedProperty; - // Create a new instance of LocalizedString - newLocalizedString(): YouTube.Schema.LocalizedString; - // Create a new instance of MonitorStreamInfo - newMonitorStreamInfo(): YouTube.Schema.MonitorStreamInfo; - // Create a new instance of Playlist - newPlaylist(): YouTube.Schema.Playlist; - // Create a new instance of PlaylistContentDetails - newPlaylistContentDetails(): YouTube.Schema.PlaylistContentDetails; - // Create a new instance of PlaylistItem - newPlaylistItem(): YouTube.Schema.PlaylistItem; - // Create a new instance of PlaylistItemContentDetails - newPlaylistItemContentDetails(): YouTube.Schema.PlaylistItemContentDetails; - // Create a new instance of PlaylistItemSnippet - newPlaylistItemSnippet(): YouTube.Schema.PlaylistItemSnippet; - // Create a new instance of PlaylistItemStatus - newPlaylistItemStatus(): YouTube.Schema.PlaylistItemStatus; - // Create a new instance of PlaylistLocalization - newPlaylistLocalization(): YouTube.Schema.PlaylistLocalization; - // Create a new instance of PlaylistPlayer - newPlaylistPlayer(): YouTube.Schema.PlaylistPlayer; - // Create a new instance of PlaylistSnippet - newPlaylistSnippet(): YouTube.Schema.PlaylistSnippet; - // Create a new instance of PlaylistStatus - newPlaylistStatus(): YouTube.Schema.PlaylistStatus; - // Create a new instance of PromotedItem - newPromotedItem(): YouTube.Schema.PromotedItem; - // Create a new instance of PromotedItemId - newPromotedItemId(): YouTube.Schema.PromotedItemId; - // Create a new instance of PropertyValue - newPropertyValue(): YouTube.Schema.PropertyValue; - // Create a new instance of ResourceId - newResourceId(): YouTube.Schema.ResourceId; - // Create a new instance of Subscription - newSubscription(): YouTube.Schema.Subscription; - // Create a new instance of SubscriptionContentDetails - newSubscriptionContentDetails(): YouTube.Schema.SubscriptionContentDetails; - // Create a new instance of SubscriptionSnippet - newSubscriptionSnippet(): YouTube.Schema.SubscriptionSnippet; - // Create a new instance of SubscriptionSubscriberSnippet - newSubscriptionSubscriberSnippet(): YouTube.Schema.SubscriptionSubscriberSnippet; - // Create a new instance of SuperStickerMetadata - newSuperStickerMetadata(): YouTube.Schema.SuperStickerMetadata; - // Create a new instance of Thumbnail - newThumbnail(): YouTube.Schema.Thumbnail; - // Create a new instance of ThumbnailDetails - newThumbnailDetails(): YouTube.Schema.ThumbnailDetails; - // Create a new instance of Video - newVideo(): YouTube.Schema.Video; - // Create a new instance of VideoAbuseReport - newVideoAbuseReport(): YouTube.Schema.VideoAbuseReport; - // Create a new instance of VideoAgeGating - newVideoAgeGating(): YouTube.Schema.VideoAgeGating; - // Create a new instance of VideoContentDetails - newVideoContentDetails(): YouTube.Schema.VideoContentDetails; - // Create a new instance of VideoContentDetailsRegionRestriction - newVideoContentDetailsRegionRestriction(): YouTube.Schema.VideoContentDetailsRegionRestriction; - // Create a new instance of VideoFileDetails - newVideoFileDetails(): YouTube.Schema.VideoFileDetails; - // Create a new instance of VideoFileDetailsAudioStream - newVideoFileDetailsAudioStream(): YouTube.Schema.VideoFileDetailsAudioStream; - // Create a new instance of VideoFileDetailsVideoStream - newVideoFileDetailsVideoStream(): YouTube.Schema.VideoFileDetailsVideoStream; - // Create a new instance of VideoLiveStreamingDetails - newVideoLiveStreamingDetails(): YouTube.Schema.VideoLiveStreamingDetails; - // Create a new instance of VideoLocalization - newVideoLocalization(): YouTube.Schema.VideoLocalization; - // Create a new instance of VideoMonetizationDetails - newVideoMonetizationDetails(): YouTube.Schema.VideoMonetizationDetails; - // Create a new instance of VideoPlayer - newVideoPlayer(): YouTube.Schema.VideoPlayer; - // Create a new instance of VideoProcessingDetails - newVideoProcessingDetails(): YouTube.Schema.VideoProcessingDetails; - // Create a new instance of VideoProcessingDetailsProcessingProgress - newVideoProcessingDetailsProcessingProgress(): YouTube.Schema.VideoProcessingDetailsProcessingProgress; - // Create a new instance of VideoProjectDetails - newVideoProjectDetails(): YouTube.Schema.VideoProjectDetails; - // Create a new instance of VideoRecordingDetails - newVideoRecordingDetails(): YouTube.Schema.VideoRecordingDetails; - // Create a new instance of VideoSnippet - newVideoSnippet(): YouTube.Schema.VideoSnippet; - // Create a new instance of VideoStatistics - newVideoStatistics(): YouTube.Schema.VideoStatistics; - // Create a new instance of VideoStatus - newVideoStatus(): YouTube.Schema.VideoStatus; - // Create a new instance of VideoSuggestions - newVideoSuggestions(): YouTube.Schema.VideoSuggestions; - // Create a new instance of VideoSuggestionsTagSuggestion - newVideoSuggestionsTagSuggestion(): YouTube.Schema.VideoSuggestionsTagSuggestion; - // Create a new instance of VideoTopicDetails - newVideoTopicDetails(): YouTube.Schema.VideoTopicDetails; - // Create a new instance of WatchSettings - newWatchSettings(): YouTube.Schema.WatchSettings; - } -} - -declare var YouTube: GoogleAppsScript.YouTube; diff --git a/node_modules/@types/google-apps-script/apis/youtubeanalytics_v2.d.ts b/node_modules/@types/google-apps-script/apis/youtubeanalytics_v2.d.ts deleted file mode 100644 index 63d2523..0000000 --- a/node_modules/@types/google-apps-script/apis/youtubeanalytics_v2.d.ts +++ /dev/null @@ -1,140 +0,0 @@ -declare namespace GoogleAppsScript { - namespace YouTubeAnalytics { - namespace Collection { - interface GroupItemsCollection { - // Creates a group item. - insert(resource: Schema.GroupItem): YouTubeAnalytics.Schema.GroupItem; - // Creates a group item. - insert(resource: Schema.GroupItem, optionalArgs: object): YouTubeAnalytics.Schema.GroupItem; - // Returns a collection of group items that match the API request parameters. - list(): YouTubeAnalytics.Schema.ListGroupItemsResponse; - // Returns a collection of group items that match the API request parameters. - list(optionalArgs: object): YouTubeAnalytics.Schema.ListGroupItemsResponse; - // Removes an item from a group. - remove(): YouTubeAnalytics.Schema.EmptyResponse; - // Removes an item from a group. - remove(optionalArgs: object): YouTubeAnalytics.Schema.EmptyResponse; - } - interface GroupsCollection { - // Creates a group. - insert(resource: Schema.Group): YouTubeAnalytics.Schema.Group; - // Creates a group. - insert(resource: Schema.Group, optionalArgs: object): YouTubeAnalytics.Schema.Group; - // Returns a collection of groups that match the API request parameters. For - // example, you can retrieve all groups that the authenticated user owns, - // or you can retrieve one or more groups by their unique IDs. - list(): YouTubeAnalytics.Schema.ListGroupsResponse; - // Returns a collection of groups that match the API request parameters. For - // example, you can retrieve all groups that the authenticated user owns, - // or you can retrieve one or more groups by their unique IDs. - list(optionalArgs: object): YouTubeAnalytics.Schema.ListGroupsResponse; - // Deletes a group. - remove(): YouTubeAnalytics.Schema.EmptyResponse; - // Deletes a group. - remove(optionalArgs: object): YouTubeAnalytics.Schema.EmptyResponse; - // Modifies a group. For example, you could change a group's title. - update(resource: Schema.Group): YouTubeAnalytics.Schema.Group; - // Modifies a group. For example, you could change a group's title. - update(resource: Schema.Group, optionalArgs: object): YouTubeAnalytics.Schema.Group; - } - interface ReportsCollection { - // Retrieve your YouTube Analytics reports. - query(): YouTubeAnalytics.Schema.QueryResponse; - // Retrieve your YouTube Analytics reports. - query(optionalArgs: object): YouTubeAnalytics.Schema.QueryResponse; - } - } - namespace Schema { - interface EmptyResponse { - errors?: YouTubeAnalytics.Schema.Errors | undefined; - } - interface ErrorProto { - argument?: string[] | undefined; - code?: string | undefined; - debugInfo?: string | undefined; - domain?: string | undefined; - externalErrorMessage?: string | undefined; - location?: string | undefined; - locationType?: string | undefined; - } - interface Errors { - code?: string | undefined; - error?: YouTubeAnalytics.Schema.ErrorProto[] | undefined; - requestId?: string | undefined; - } - interface Group { - contentDetails?: YouTubeAnalytics.Schema.GroupContentDetails | undefined; - errors?: YouTubeAnalytics.Schema.Errors | undefined; - etag?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - snippet?: YouTubeAnalytics.Schema.GroupSnippet | undefined; - } - interface GroupContentDetails { - itemCount?: string | undefined; - itemType?: string | undefined; - } - interface GroupItem { - errors?: YouTubeAnalytics.Schema.Errors | undefined; - etag?: string | undefined; - groupId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - resource?: YouTubeAnalytics.Schema.GroupItemResource | undefined; - } - interface GroupItemResource { - id?: string | undefined; - kind?: string | undefined; - } - interface GroupSnippet { - publishedAt?: string | undefined; - title?: string | undefined; - } - interface ListGroupItemsResponse { - errors?: YouTubeAnalytics.Schema.Errors | undefined; - etag?: string | undefined; - items?: YouTubeAnalytics.Schema.GroupItem[] | undefined; - kind?: string | undefined; - } - interface ListGroupsResponse { - errors?: YouTubeAnalytics.Schema.Errors | undefined; - etag?: string | undefined; - items?: YouTubeAnalytics.Schema.Group[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - } - interface QueryResponse { - columnHeaders?: YouTubeAnalytics.Schema.ResultTableColumnHeader[] | undefined; - errors?: YouTubeAnalytics.Schema.Errors | undefined; - kind?: string | undefined; - rows?: any[][] | undefined; - } - interface ResultTableColumnHeader { - columnType?: string | undefined; - dataType?: string | undefined; - name?: string | undefined; - } - } - } - interface YouTubeAnalytics { - GroupItems?: YouTubeAnalytics.Collection.GroupItemsCollection | undefined; - Groups?: YouTubeAnalytics.Collection.GroupsCollection | undefined; - Reports?: YouTubeAnalytics.Collection.ReportsCollection | undefined; - // Create a new instance of ErrorProto - newErrorProto(): YouTubeAnalytics.Schema.ErrorProto; - // Create a new instance of Errors - newErrors(): YouTubeAnalytics.Schema.Errors; - // Create a new instance of Group - newGroup(): YouTubeAnalytics.Schema.Group; - // Create a new instance of GroupContentDetails - newGroupContentDetails(): YouTubeAnalytics.Schema.GroupContentDetails; - // Create a new instance of GroupItem - newGroupItem(): YouTubeAnalytics.Schema.GroupItem; - // Create a new instance of GroupItemResource - newGroupItemResource(): YouTubeAnalytics.Schema.GroupItemResource; - // Create a new instance of GroupSnippet - newGroupSnippet(): YouTubeAnalytics.Schema.GroupSnippet; - } -} - -declare var YouTubeAnalytics: GoogleAppsScript.YouTubeAnalytics; diff --git a/node_modules/@types/google-apps-script/apis/youtubepartner_v1.d.ts b/node_modules/@types/google-apps-script/apis/youtubepartner_v1.d.ts deleted file mode 100644 index 0e439ae..0000000 --- a/node_modules/@types/google-apps-script/apis/youtubepartner_v1.d.ts +++ /dev/null @@ -1,1217 +0,0 @@ -declare namespace GoogleAppsScript { - namespace YoutubePartner { - namespace Collection { - interface AssetLabelsCollection { - // Insert an asset label for an owner. - insert(resource: Schema.AssetLabel): YoutubePartner.Schema.AssetLabel; - // Insert an asset label for an owner. - insert(resource: Schema.AssetLabel, optionalArgs: object): YoutubePartner.Schema.AssetLabel; - // Retrieves a list of all asset labels for an owner. - list(): YoutubePartner.Schema.AssetLabelListResponse; - // Retrieves a list of all asset labels for an owner. - list(optionalArgs: object): YoutubePartner.Schema.AssetLabelListResponse; - } - interface AssetMatchPolicyCollection { - // Retrieves the match policy assigned to the specified asset by the content owner associated with the authenticated user. This information is only accessible to an owner of the asset. - get(assetId: string): YoutubePartner.Schema.AssetMatchPolicy; - // Retrieves the match policy assigned to the specified asset by the content owner associated with the authenticated user. This information is only accessible to an owner of the asset. - get(assetId: string, optionalArgs: object): YoutubePartner.Schema.AssetMatchPolicy; - // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. This method supports patch semantics. - patch(resource: Schema.AssetMatchPolicy, assetId: string): YoutubePartner.Schema.AssetMatchPolicy; - // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. This method supports patch semantics. - patch( - resource: Schema.AssetMatchPolicy, - assetId: string, - optionalArgs: object, - ): YoutubePartner.Schema.AssetMatchPolicy; - // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. - update(resource: Schema.AssetMatchPolicy, assetId: string): YoutubePartner.Schema.AssetMatchPolicy; - // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. - update( - resource: Schema.AssetMatchPolicy, - assetId: string, - optionalArgs: object, - ): YoutubePartner.Schema.AssetMatchPolicy; - } - interface AssetRelationshipsCollection { - // Creates a relationship that links two assets. - insert(resource: Schema.AssetRelationship): YoutubePartner.Schema.AssetRelationship; - // Creates a relationship that links two assets. - insert( - resource: Schema.AssetRelationship, - optionalArgs: object, - ): YoutubePartner.Schema.AssetRelationship; - // Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship. - list(assetId: string): YoutubePartner.Schema.AssetRelationshipListResponse; - // Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship. - list(assetId: string, optionalArgs: object): YoutubePartner.Schema.AssetRelationshipListResponse; - // Deletes a relationship between two assets. - remove(assetRelationshipId: string): void; - // Deletes a relationship between two assets. - remove(assetRelationshipId: string, optionalArgs: object): void; - } - interface AssetSearchCollection { - // Searches for assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. This method mimics the functionality of the advanced search feature on the Assets page in CMS. - list(): YoutubePartner.Schema.AssetSearchResponse; - // Searches for assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. This method mimics the functionality of the advanced search feature on the Assets page in CMS. - list(optionalArgs: object): YoutubePartner.Schema.AssetSearchResponse; - } - interface AssetSharesCollection { - // This method either retrieves a list of asset shares the partner owns and that map to a specified asset view ID or it retrieves a list of asset views associated with a specified asset share ID owned by the partner. - list(assetId: string): YoutubePartner.Schema.AssetShareListResponse; - // This method either retrieves a list of asset shares the partner owns and that map to a specified asset view ID or it retrieves a list of asset views associated with a specified asset share ID owned by the partner. - list(assetId: string, optionalArgs: object): YoutubePartner.Schema.AssetShareListResponse; - } - interface AssetsCollection { - // Retrieves the metadata for the specified asset. Note that if the request identifies an asset that has been merged with another asset, meaning that YouTube identified the requested asset as a duplicate, then the request retrieves the merged, or synthesized, asset. - get(assetId: string): YoutubePartner.Schema.Asset; - // Retrieves the metadata for the specified asset. Note that if the request identifies an asset that has been merged with another asset, meaning that YouTube identified the requested asset as a duplicate, then the request retrieves the merged, or synthesized, asset. - get(assetId: string, optionalArgs: object): YoutubePartner.Schema.Asset; - // Inserts an asset with the specified metadata. After inserting an asset, you can set its ownership data and match policy. - insert(resource: Schema.Asset): YoutubePartner.Schema.Asset; - // Inserts an asset with the specified metadata. After inserting an asset, you can set its ownership data and match policy. - insert(resource: Schema.Asset, optionalArgs: object): YoutubePartner.Schema.Asset; - // Retrieves a list of assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. - // Note that in cases where duplicate assets have been merged, the API response only contains the synthesized asset. (It does not contain the constituent assets that were merged into the synthesized asset.) - list(id: string): YoutubePartner.Schema.AssetListResponse; - // Retrieves a list of assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. - // Note that in cases where duplicate assets have been merged, the API response only contains the synthesized asset. (It does not contain the constituent assets that were merged into the synthesized asset.) - list(id: string, optionalArgs: object): YoutubePartner.Schema.AssetListResponse; - // Updates the metadata for the specified asset. This method supports patch semantics. - patch(resource: Schema.Asset, assetId: string): YoutubePartner.Schema.Asset; - // Updates the metadata for the specified asset. This method supports patch semantics. - patch(resource: Schema.Asset, assetId: string, optionalArgs: object): YoutubePartner.Schema.Asset; - // Updates the metadata for the specified asset. - update(resource: Schema.Asset, assetId: string): YoutubePartner.Schema.Asset; - // Updates the metadata for the specified asset. - update(resource: Schema.Asset, assetId: string, optionalArgs: object): YoutubePartner.Schema.Asset; - } - interface CampaignsCollection { - // Retrieves a particular campaign for an owner. - get(campaignId: string): YoutubePartner.Schema.Campaign; - // Retrieves a particular campaign for an owner. - get(campaignId: string, optionalArgs: object): YoutubePartner.Schema.Campaign; - // Insert a new campaign for an owner using the specified campaign data. - insert(resource: Schema.Campaign): YoutubePartner.Schema.Campaign; - // Insert a new campaign for an owner using the specified campaign data. - insert(resource: Schema.Campaign, optionalArgs: object): YoutubePartner.Schema.Campaign; - // Retrieves a list of campaigns for an owner. - list(): YoutubePartner.Schema.CampaignList; - // Retrieves a list of campaigns for an owner. - list(optionalArgs: object): YoutubePartner.Schema.CampaignList; - // Update the data for a specific campaign. This method supports patch semantics. - patch(resource: Schema.Campaign, campaignId: string): YoutubePartner.Schema.Campaign; - // Update the data for a specific campaign. This method supports patch semantics. - patch( - resource: Schema.Campaign, - campaignId: string, - optionalArgs: object, - ): YoutubePartner.Schema.Campaign; - // Deletes a specified campaign for an owner. - remove(campaignId: string): void; - // Deletes a specified campaign for an owner. - remove(campaignId: string, optionalArgs: object): void; - // Update the data for a specific campaign. - update(resource: Schema.Campaign, campaignId: string): YoutubePartner.Schema.Campaign; - // Update the data for a specific campaign. - update( - resource: Schema.Campaign, - campaignId: string, - optionalArgs: object, - ): YoutubePartner.Schema.Campaign; - } - interface ClaimHistoryCollection { - // Retrieves the claim history for a specified claim. - get(claimId: string): YoutubePartner.Schema.ClaimHistory; - // Retrieves the claim history for a specified claim. - get(claimId: string, optionalArgs: object): YoutubePartner.Schema.ClaimHistory; - } - interface ClaimSearchCollection { - // Retrieves a list of claims that match the search criteria. You can search for claims that are associated with a specific asset or video or that match a specified query string. - list(): YoutubePartner.Schema.ClaimSearchResponse; - // Retrieves a list of claims that match the search criteria. You can search for claims that are associated with a specific asset or video or that match a specified query string. - list(optionalArgs: object): YoutubePartner.Schema.ClaimSearchResponse; - } - interface ClaimsCollection { - // Retrieves a specific claim by ID. - get(claimId: string): YoutubePartner.Schema.Claim; - // Retrieves a specific claim by ID. - get(claimId: string, optionalArgs: object): YoutubePartner.Schema.Claim; - // Creates a claim. The video being claimed must have been uploaded to a channel associated with the same content owner as the API user sending the request. You can set the claim's policy in any of the following ways: - // - Use the claim resource's policy property to identify a saved policy by its unique ID. - // - Use the claim resource's policy property to specify a custom set of rules. - insert(resource: Schema.Claim): YoutubePartner.Schema.Claim; - // Creates a claim. The video being claimed must have been uploaded to a channel associated with the same content owner as the API user sending the request. You can set the claim's policy in any of the following ways: - // - Use the claim resource's policy property to identify a saved policy by its unique ID. - // - Use the claim resource's policy property to specify a custom set of rules. - insert(resource: Schema.Claim, optionalArgs: object): YoutubePartner.Schema.Claim; - // Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time. - list(): YoutubePartner.Schema.ClaimListResponse; - // Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time. - list(optionalArgs: object): YoutubePartner.Schema.ClaimListResponse; - // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. This method supports patch semantics. - patch(resource: Schema.Claim, claimId: string): YoutubePartner.Schema.Claim; - // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. This method supports patch semantics. - patch(resource: Schema.Claim, claimId: string, optionalArgs: object): YoutubePartner.Schema.Claim; - // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. - update(resource: Schema.Claim, claimId: string): YoutubePartner.Schema.Claim; - // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. - update(resource: Schema.Claim, claimId: string, optionalArgs: object): YoutubePartner.Schema.Claim; - } - interface ContentOwnerAdvertisingOptionsCollection { - // Retrieves advertising options for the content owner associated with the authenticated user. - get(): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Retrieves advertising options for the content owner associated with the authenticated user. - get(optionalArgs: object): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Updates advertising options for the content owner associated with the authenticated API user. This method supports patch semantics. - patch( - resource: Schema.ContentOwnerAdvertisingOption, - ): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Updates advertising options for the content owner associated with the authenticated API user. This method supports patch semantics. - patch( - resource: Schema.ContentOwnerAdvertisingOption, - optionalArgs: object, - ): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Updates advertising options for the content owner associated with the authenticated API user. - update( - resource: Schema.ContentOwnerAdvertisingOption, - ): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Updates advertising options for the content owner associated with the authenticated API user. - update( - resource: Schema.ContentOwnerAdvertisingOption, - optionalArgs: object, - ): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - } - interface ContentOwnersCollection { - // Retrieves information about the specified content owner. - get(contentOwnerId: string): YoutubePartner.Schema.ContentOwner; - // Retrieves information about the specified content owner. - get(contentOwnerId: string, optionalArgs: object): YoutubePartner.Schema.ContentOwner; - // Retrieves a list of content owners that match the request criteria. - list(): YoutubePartner.Schema.ContentOwnerListResponse; - // Retrieves a list of content owners that match the request criteria. - list(optionalArgs: object): YoutubePartner.Schema.ContentOwnerListResponse; - } - interface LiveCuepointsCollection { - // Inserts a cuepoint into a live broadcast. - insert(resource: Schema.LiveCuepoint, channelId: string): YoutubePartner.Schema.LiveCuepoint; - // Inserts a cuepoint into a live broadcast. - insert( - resource: Schema.LiveCuepoint, - channelId: string, - optionalArgs: object, - ): YoutubePartner.Schema.LiveCuepoint; - } - interface MetadataHistoryCollection { - // Retrieves a list of all metadata provided for an asset, regardless of which content owner provided the data. - list(assetId: string): YoutubePartner.Schema.MetadataHistoryListResponse; - // Retrieves a list of all metadata provided for an asset, regardless of which content owner provided the data. - list(assetId: string, optionalArgs: object): YoutubePartner.Schema.MetadataHistoryListResponse; - } - interface OrdersCollection { - // Retrieve the details of an existing order. - get(orderId: string): YoutubePartner.Schema.Order; - // Retrieve the details of an existing order. - get(orderId: string, optionalArgs: object): YoutubePartner.Schema.Order; - // Creates a new basic order entry in the YouTube premium asset order management system. You must supply at least a country and channel in the new order. - insert(resource: Schema.Order): YoutubePartner.Schema.Order; - // Creates a new basic order entry in the YouTube premium asset order management system. You must supply at least a country and channel in the new order. - insert(resource: Schema.Order, optionalArgs: object): YoutubePartner.Schema.Order; - // Return a list of orders, filtered by the parameters below, may return more than a single page of results. - list(): YoutubePartner.Schema.OrderListResponse; - // Return a list of orders, filtered by the parameters below, may return more than a single page of results. - list(optionalArgs: object): YoutubePartner.Schema.OrderListResponse; - // Update the values in an existing order. This method supports patch semantics. - patch(resource: Schema.Order, orderId: string): YoutubePartner.Schema.Order; - // Update the values in an existing order. This method supports patch semantics. - patch(resource: Schema.Order, orderId: string, optionalArgs: object): YoutubePartner.Schema.Order; - // Delete an order, which moves orders to inactive state and removes any associated video. - remove(orderId: string): void; - // Delete an order, which moves orders to inactive state and removes any associated video. - remove(orderId: string, optionalArgs: object): void; - // Update the values in an existing order. - update(resource: Schema.Order, orderId: string): YoutubePartner.Schema.Order; - // Update the values in an existing order. - update(resource: Schema.Order, orderId: string, optionalArgs: object): YoutubePartner.Schema.Order; - } - interface OwnershipCollection { - // Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user. - get(assetId: string): YoutubePartner.Schema.RightsOwnership; - // Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user. - get(assetId: string, optionalArgs: object): YoutubePartner.Schema.RightsOwnership; - // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. This method supports patch semantics. - patch(resource: Schema.RightsOwnership, assetId: string): YoutubePartner.Schema.RightsOwnership; - // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. This method supports patch semantics. - patch( - resource: Schema.RightsOwnership, - assetId: string, - optionalArgs: object, - ): YoutubePartner.Schema.RightsOwnership; - // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. - update(resource: Schema.RightsOwnership, assetId: string): YoutubePartner.Schema.RightsOwnership; - // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. - update( - resource: Schema.RightsOwnership, - assetId: string, - optionalArgs: object, - ): YoutubePartner.Schema.RightsOwnership; - } - interface OwnershipHistoryCollection { - // Retrieves a list of the ownership data for an asset, regardless of which content owner provided the data. The list only includes the most recent ownership data for each content owner. However, if the content owner has submitted ownership data through multiple data sources (API, content feeds, etc.), the list will contain the most recent data for each content owner and data source. - list(assetId: string): YoutubePartner.Schema.OwnershipHistoryListResponse; - // Retrieves a list of the ownership data for an asset, regardless of which content owner provided the data. The list only includes the most recent ownership data for each content owner. However, if the content owner has submitted ownership data through multiple data sources (API, content feeds, etc.), the list will contain the most recent data for each content owner and data source. - list(assetId: string, optionalArgs: object): YoutubePartner.Schema.OwnershipHistoryListResponse; - } - interface PackageCollection { - // Retrieves information for the specified package. - get(packageId: string): YoutubePartner.Schema.Package; - // Retrieves information for the specified package. - get(packageId: string, optionalArgs: object): YoutubePartner.Schema.Package; - // Inserts a metadata-only package. - insert(resource: Schema.Package): YoutubePartner.Schema.PackageInsertResponse; - // Inserts a metadata-only package. - insert(resource: Schema.Package, optionalArgs: object): YoutubePartner.Schema.PackageInsertResponse; - } - interface PoliciesCollection { - // Retrieves the specified saved policy. - get(policyId: string): YoutubePartner.Schema.Policy; - // Retrieves the specified saved policy. - get(policyId: string, optionalArgs: object): YoutubePartner.Schema.Policy; - // Creates a saved policy. - insert(resource: Schema.Policy): YoutubePartner.Schema.Policy; - // Creates a saved policy. - insert(resource: Schema.Policy, optionalArgs: object): YoutubePartner.Schema.Policy; - // Retrieves a list of the content owner's saved policies. - list(): YoutubePartner.Schema.PolicyList; - // Retrieves a list of the content owner's saved policies. - list(optionalArgs: object): YoutubePartner.Schema.PolicyList; - // Updates the specified saved policy. This method supports patch semantics. - patch(resource: Schema.Policy, policyId: string): YoutubePartner.Schema.Policy; - // Updates the specified saved policy. This method supports patch semantics. - patch(resource: Schema.Policy, policyId: string, optionalArgs: object): YoutubePartner.Schema.Policy; - // Updates the specified saved policy. - update(resource: Schema.Policy, policyId: string): YoutubePartner.Schema.Policy; - // Updates the specified saved policy. - update(resource: Schema.Policy, policyId: string, optionalArgs: object): YoutubePartner.Schema.Policy; - } - interface PublishersCollection { - // Retrieves information about the specified publisher. - get(publisherId: string): YoutubePartner.Schema.Publisher; - // Retrieves information about the specified publisher. - get(publisherId: string, optionalArgs: object): YoutubePartner.Schema.Publisher; - // Retrieves a list of publishers that match the request criteria. This method is analogous to a publisher search function. - list(): YoutubePartner.Schema.PublisherList; - // Retrieves a list of publishers that match the request criteria. This method is analogous to a publisher search function. - list(optionalArgs: object): YoutubePartner.Schema.PublisherList; - } - interface ReferenceConflictsCollection { - // Retrieves information about the specified reference conflict. - get(referenceConflictId: string): YoutubePartner.Schema.ReferenceConflict; - // Retrieves information about the specified reference conflict. - get(referenceConflictId: string, optionalArgs: object): YoutubePartner.Schema.ReferenceConflict; - // Retrieves a list of unresolved reference conflicts. - list(): YoutubePartner.Schema.ReferenceConflictListResponse; - // Retrieves a list of unresolved reference conflicts. - list(optionalArgs: object): YoutubePartner.Schema.ReferenceConflictListResponse; - } - interface ReferencesCollection { - // Retrieves information about the specified reference. - get(referenceId: string): YoutubePartner.Schema.Reference; - // Retrieves information about the specified reference. - get(referenceId: string, optionalArgs: object): YoutubePartner.Schema.Reference; - // Creates a reference in one of the following ways: - // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. - // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. - insert(resource: Schema.Reference): YoutubePartner.Schema.Reference; - // Creates a reference in one of the following ways: - // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. - // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. - insert(resource: Schema.Reference, mediaData: any): YoutubePartner.Schema.Reference; - // Creates a reference in one of the following ways: - // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. - // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. - insert( - resource: Schema.Reference, - mediaData: any, - optionalArgs: object, - ): YoutubePartner.Schema.Reference; - // Retrieves a list of references by ID or the list of references for the specified asset. - list(): YoutubePartner.Schema.ReferenceListResponse; - // Retrieves a list of references by ID or the list of references for the specified asset. - list(optionalArgs: object): YoutubePartner.Schema.ReferenceListResponse; - // Updates a reference. This method supports patch semantics. - patch(resource: Schema.Reference, referenceId: string): YoutubePartner.Schema.Reference; - // Updates a reference. This method supports patch semantics. - patch( - resource: Schema.Reference, - referenceId: string, - optionalArgs: object, - ): YoutubePartner.Schema.Reference; - // Updates a reference. - update(resource: Schema.Reference, referenceId: string): YoutubePartner.Schema.Reference; - // Updates a reference. - update( - resource: Schema.Reference, - referenceId: string, - optionalArgs: object, - ): YoutubePartner.Schema.Reference; - } - interface SpreadsheetTemplateCollection { - // Retrieves a list of spreadsheet templates for a content owner. - list(): YoutubePartner.Schema.SpreadsheetTemplateListResponse; - // Retrieves a list of spreadsheet templates for a content owner. - list(optionalArgs: object): YoutubePartner.Schema.SpreadsheetTemplateListResponse; - } - interface UploaderCollection { - // Retrieves a list of uploaders for a content owner. - list(): YoutubePartner.Schema.UploaderListResponse; - // Retrieves a list of uploaders for a content owner. - list(optionalArgs: object): YoutubePartner.Schema.UploaderListResponse; - } - interface ValidatorCollection { - // Validate a metadata file. - validate(resource: Schema.ValidateRequest): YoutubePartner.Schema.ValidateResponse; - // Validate a metadata file. - validate( - resource: Schema.ValidateRequest, - optionalArgs: object, - ): YoutubePartner.Schema.ValidateResponse; - // Validate a metadata file asynchronously. - validateAsync(resource: Schema.ValidateAsyncRequest): YoutubePartner.Schema.ValidateAsyncResponse; - // Validate a metadata file asynchronously. - validateAsync( - resource: Schema.ValidateAsyncRequest, - optionalArgs: object, - ): YoutubePartner.Schema.ValidateAsyncResponse; - // Get the asynchronous validation status. - validateAsyncStatus( - resource: Schema.ValidateStatusRequest, - ): YoutubePartner.Schema.ValidateStatusResponse; - // Get the asynchronous validation status. - validateAsyncStatus( - resource: Schema.ValidateStatusRequest, - optionalArgs: object, - ): YoutubePartner.Schema.ValidateStatusResponse; - } - interface VideoAdvertisingOptionsCollection { - // Retrieves advertising settings for the specified video. - get(videoId: string): YoutubePartner.Schema.VideoAdvertisingOption; - // Retrieves advertising settings for the specified video. - get(videoId: string, optionalArgs: object): YoutubePartner.Schema.VideoAdvertisingOption; - // Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video. - getEnabledAds(videoId: string): YoutubePartner.Schema.VideoAdvertisingOptionGetEnabledAdsResponse; - // Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video. - getEnabledAds( - videoId: string, - optionalArgs: object, - ): YoutubePartner.Schema.VideoAdvertisingOptionGetEnabledAdsResponse; - // Updates the advertising settings for the specified video. This method supports patch semantics. - patch( - resource: Schema.VideoAdvertisingOption, - videoId: string, - ): YoutubePartner.Schema.VideoAdvertisingOption; - // Updates the advertising settings for the specified video. This method supports patch semantics. - patch( - resource: Schema.VideoAdvertisingOption, - videoId: string, - optionalArgs: object, - ): YoutubePartner.Schema.VideoAdvertisingOption; - // Updates the advertising settings for the specified video. - update( - resource: Schema.VideoAdvertisingOption, - videoId: string, - ): YoutubePartner.Schema.VideoAdvertisingOption; - // Updates the advertising settings for the specified video. - update( - resource: Schema.VideoAdvertisingOption, - videoId: string, - optionalArgs: object, - ): YoutubePartner.Schema.VideoAdvertisingOption; - } - interface WhitelistsCollection { - // Retrieves a specific whitelisted channel by ID. - get(id: string): YoutubePartner.Schema.Whitelist; - // Retrieves a specific whitelisted channel by ID. - get(id: string, optionalArgs: object): YoutubePartner.Schema.Whitelist; - // Whitelist a YouTube channel for your content owner. Whitelisted channels are channels that are not owned or managed by you, but you would like to whitelist so that no claims from your assets are placed on videos uploaded to these channels. - insert(resource: Schema.Whitelist): YoutubePartner.Schema.Whitelist; - // Whitelist a YouTube channel for your content owner. Whitelisted channels are channels that are not owned or managed by you, but you would like to whitelist so that no claims from your assets are placed on videos uploaded to these channels. - insert(resource: Schema.Whitelist, optionalArgs: object): YoutubePartner.Schema.Whitelist; - // Retrieves a list of whitelisted channels for a content owner. - list(): YoutubePartner.Schema.WhitelistListResponse; - // Retrieves a list of whitelisted channels for a content owner. - list(optionalArgs: object): YoutubePartner.Schema.WhitelistListResponse; - // Removes a whitelisted channel for a content owner. - remove(id: string): void; - // Removes a whitelisted channel for a content owner. - remove(id: string, optionalArgs: object): void; - } - } - namespace Schema { - interface AdBreak { - midrollSeconds?: number | undefined; - position?: string | undefined; - slot?: YoutubePartner.Schema.AdSlot[] | undefined; - } - interface AdSlot { - id?: string | undefined; - type?: string | undefined; - } - interface AllowedAdvertisingOptions { - adsOnEmbeds?: boolean | undefined; - kind?: string | undefined; - licAdFormats?: string[] | undefined; - ugcAdFormats?: string[] | undefined; - } - interface Asset { - aliasId?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - label?: string[] | undefined; - matchPolicy?: YoutubePartner.Schema.AssetMatchPolicy | undefined; - matchPolicyEffective?: YoutubePartner.Schema.AssetMatchPolicy | undefined; - matchPolicyMine?: YoutubePartner.Schema.AssetMatchPolicy | undefined; - metadata?: YoutubePartner.Schema.Metadata | undefined; - metadataEffective?: YoutubePartner.Schema.Metadata | undefined; - metadataMine?: YoutubePartner.Schema.Metadata | undefined; - ownership?: YoutubePartner.Schema.RightsOwnership | undefined; - ownershipConflicts?: YoutubePartner.Schema.OwnershipConflicts | undefined; - ownershipEffective?: YoutubePartner.Schema.RightsOwnership | undefined; - ownershipMine?: YoutubePartner.Schema.RightsOwnership | undefined; - status?: string | undefined; - timeCreated?: string | undefined; - type?: string | undefined; - } - interface AssetLabel { - kind?: string | undefined; - labelName?: string | undefined; - } - interface AssetLabelListResponse { - items?: YoutubePartner.Schema.AssetLabel[] | undefined; - kind?: string | undefined; - } - interface AssetListResponse { - items?: YoutubePartner.Schema.Asset[] | undefined; - kind?: string | undefined; - } - interface AssetMatchPolicy { - kind?: string | undefined; - policyId?: string | undefined; - rules?: YoutubePartner.Schema.PolicyRule[] | undefined; - } - interface AssetRelationship { - childAssetId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - parentAssetId?: string | undefined; - } - interface AssetRelationshipListResponse { - items?: YoutubePartner.Schema.AssetRelationship[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface AssetSearchResponse { - items?: YoutubePartner.Schema.AssetSnippet[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface AssetShare { - kind?: string | undefined; - shareId?: string | undefined; - viewId?: string | undefined; - } - interface AssetShareListResponse { - items?: YoutubePartner.Schema.AssetShare[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface AssetSnippet { - customId?: string | undefined; - id?: string | undefined; - isrc?: string | undefined; - iswc?: string | undefined; - kind?: string | undefined; - timeCreated?: string | undefined; - title?: string | undefined; - type?: string | undefined; - } - interface Campaign { - campaignData?: YoutubePartner.Schema.CampaignData | undefined; - id?: string | undefined; - kind?: string | undefined; - status?: string | undefined; - timeCreated?: string | undefined; - timeLastModified?: string | undefined; - } - interface CampaignData { - campaignSource?: YoutubePartner.Schema.CampaignSource | undefined; - expireTime?: string | undefined; - name?: string | undefined; - promotedContent?: YoutubePartner.Schema.PromotedContent[] | undefined; - startTime?: string | undefined; - } - interface CampaignList { - items?: YoutubePartner.Schema.Campaign[] | undefined; - kind?: string | undefined; - } - interface CampaignSource { - sourceType?: string | undefined; - sourceValue?: string[] | undefined; - } - interface CampaignTargetLink { - targetId?: string | undefined; - targetType?: string | undefined; - } - interface Claim { - appliedPolicy?: YoutubePartner.Schema.Policy | undefined; - assetId?: string | undefined; - blockOutsideOwnership?: boolean | undefined; - contentType?: string | undefined; - id?: string | undefined; - isPartnerUploaded?: boolean | undefined; - kind?: string | undefined; - matchInfo?: YoutubePartner.Schema.ClaimMatchInfo | undefined; - origin?: YoutubePartner.Schema.ClaimOrigin | undefined; - policy?: YoutubePartner.Schema.Policy | undefined; - status?: string | undefined; - timeCreated?: string | undefined; - videoId?: string | undefined; - } - interface ClaimEvent { - kind?: string | undefined; - reason?: string | undefined; - source?: YoutubePartner.Schema.ClaimEventSource | undefined; - time?: string | undefined; - type?: string | undefined; - typeDetails?: YoutubePartner.Schema.ClaimEventTypeDetails | undefined; - } - interface ClaimEventSource { - contentOwnerId?: string | undefined; - type?: string | undefined; - userEmail?: string | undefined; - } - interface ClaimEventTypeDetails { - appealExplanation?: string | undefined; - disputeNotes?: string | undefined; - disputeReason?: string | undefined; - updateStatus?: string | undefined; - } - interface ClaimHistory { - event?: YoutubePartner.Schema.ClaimEvent[] | undefined; - id?: string | undefined; - kind?: string | undefined; - uploaderChannelId?: string | undefined; - } - interface ClaimListResponse { - items?: YoutubePartner.Schema.Claim[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - previousPageToken?: string | undefined; - } - interface ClaimMatchInfo { - longestMatch?: YoutubePartner.Schema.ClaimMatchInfoLongestMatch | undefined; - matchSegments?: YoutubePartner.Schema.MatchSegment[] | undefined; - referenceId?: string | undefined; - totalMatch?: YoutubePartner.Schema.ClaimMatchInfoTotalMatch | undefined; - } - interface ClaimMatchInfoLongestMatch { - durationSecs?: string | undefined; - referenceOffset?: string | undefined; - userVideoOffset?: string | undefined; - } - interface ClaimMatchInfoTotalMatch { - referenceDurationSecs?: string | undefined; - userVideoDurationSecs?: string | undefined; - } - interface ClaimOrigin { - source?: string | undefined; - } - interface ClaimSearchResponse { - items?: YoutubePartner.Schema.ClaimSnippet[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - previousPageToken?: string | undefined; - } - interface ClaimSnippet { - assetId?: string | undefined; - contentType?: string | undefined; - id?: string | undefined; - isPartnerUploaded?: boolean | undefined; - kind?: string | undefined; - origin?: YoutubePartner.Schema.ClaimSnippetOrigin | undefined; - status?: string | undefined; - thirdPartyClaim?: boolean | undefined; - timeCreated?: string | undefined; - timeStatusLastModified?: string | undefined; - videoId?: string | undefined; - videoTitle?: string | undefined; - videoViews?: string | undefined; - } - interface ClaimSnippetOrigin { - source?: string | undefined; - } - interface ClaimedVideoDefaults { - autoGeneratedBreaks?: boolean | undefined; - channelOverride?: boolean | undefined; - kind?: string | undefined; - newVideoDefaults?: string[] | undefined; - } - interface Conditions { - contentMatchType?: string[] | undefined; - matchDuration?: YoutubePartner.Schema.IntervalCondition[] | undefined; - matchPercent?: YoutubePartner.Schema.IntervalCondition[] | undefined; - referenceDuration?: YoutubePartner.Schema.IntervalCondition[] | undefined; - referencePercent?: YoutubePartner.Schema.IntervalCondition[] | undefined; - requiredTerritories?: YoutubePartner.Schema.TerritoryCondition | undefined; - } - interface ConflictingOwnership { - owner?: string | undefined; - ratio?: number | undefined; - } - interface ContentOwner { - conflictNotificationEmail?: string | undefined; - displayName?: string | undefined; - disputeNotificationEmails?: string[] | undefined; - fingerprintReportNotificationEmails?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - primaryNotificationEmails?: string[] | undefined; - } - interface ContentOwnerAdvertisingOption { - allowedOptions?: YoutubePartner.Schema.AllowedAdvertisingOptions | undefined; - claimedVideoOptions?: YoutubePartner.Schema.ClaimedVideoDefaults | undefined; - id?: string | undefined; - kind?: string | undefined; - } - interface ContentOwnerListResponse { - items?: YoutubePartner.Schema.ContentOwner[] | undefined; - kind?: string | undefined; - } - interface CountriesRestriction { - adFormats?: string[] | undefined; - territories?: string[] | undefined; - } - interface CuepointSettings { - cueType?: string | undefined; - durationSecs?: number | undefined; - offsetTimeMs?: string | undefined; - walltime?: string | undefined; - } - interface Date { - day?: number | undefined; - month?: number | undefined; - year?: number | undefined; - } - interface DateRange { - end?: YoutubePartner.Schema.Date | undefined; - kind?: string | undefined; - start?: YoutubePartner.Schema.Date | undefined; - } - interface ExcludedInterval { - high?: number | undefined; - low?: number | undefined; - origin?: string | undefined; - timeCreated?: string | undefined; - } - interface IntervalCondition { - high?: number | undefined; - low?: number | undefined; - } - interface LiveCuepoint { - broadcastId?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - settings?: YoutubePartner.Schema.CuepointSettings | undefined; - } - interface MatchSegment { - channel?: string | undefined; - reference_segment?: YoutubePartner.Schema.Segment | undefined; - video_segment?: YoutubePartner.Schema.Segment | undefined; - } - interface Metadata { - actor?: string[] | undefined; - album?: string | undefined; - artist?: string[] | undefined; - broadcaster?: string[] | undefined; - category?: string | undefined; - contentType?: string | undefined; - copyrightDate?: YoutubePartner.Schema.Date | undefined; - customId?: string | undefined; - description?: string | undefined; - director?: string[] | undefined; - eidr?: string | undefined; - endYear?: number | undefined; - episodeNumber?: string | undefined; - episodesAreUntitled?: boolean | undefined; - genre?: string[] | undefined; - grid?: string | undefined; - hfa?: string | undefined; - infoUrl?: string | undefined; - isan?: string | undefined; - isrc?: string | undefined; - iswc?: string | undefined; - keyword?: string[] | undefined; - label?: string | undefined; - notes?: string | undefined; - originalReleaseMedium?: string | undefined; - producer?: string[] | undefined; - ratings?: YoutubePartner.Schema.Rating[] | undefined; - releaseDate?: YoutubePartner.Schema.Date | undefined; - seasonNumber?: string | undefined; - showCustomId?: string | undefined; - showTitle?: string | undefined; - spokenLanguage?: string | undefined; - startYear?: number | undefined; - subtitledLanguage?: string[] | undefined; - title?: string | undefined; - tmsId?: string | undefined; - totalEpisodesExpected?: number | undefined; - upc?: string | undefined; - writer?: string[] | undefined; - } - interface MetadataHistory { - kind?: string | undefined; - metadata?: YoutubePartner.Schema.Metadata | undefined; - origination?: YoutubePartner.Schema.Origination | undefined; - timeProvided?: string | undefined; - } - interface MetadataHistoryListResponse { - items?: YoutubePartner.Schema.MetadataHistory[] | undefined; - kind?: string | undefined; - } - interface Order { - availGroupId?: string | undefined; - channelId?: string | undefined; - contentType?: string | undefined; - country?: string | undefined; - customId?: string | undefined; - dvdReleaseDate?: YoutubePartner.Schema.Date | undefined; - estDates?: YoutubePartner.Schema.DateRange | undefined; - events?: YoutubePartner.Schema.StateCompleted[] | undefined; - id?: string | undefined; - kind?: string | undefined; - movie?: string | undefined; - originalReleaseDate?: YoutubePartner.Schema.Date | undefined; - priority?: string | undefined; - productionHouse?: string | undefined; - purchaseOrder?: string | undefined; - requirements?: YoutubePartner.Schema.Requirements | undefined; - show?: YoutubePartner.Schema.ShowDetails | undefined; - status?: string | undefined; - videoId?: string | undefined; - vodDates?: YoutubePartner.Schema.DateRange | undefined; - } - interface OrderListResponse { - items?: YoutubePartner.Schema.Order[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - previousPageToken?: string | undefined; - } - interface Origination { - owner?: string | undefined; - source?: string | undefined; - } - interface OwnershipConflicts { - general?: YoutubePartner.Schema.TerritoryConflicts[] | undefined; - kind?: string | undefined; - mechanical?: YoutubePartner.Schema.TerritoryConflicts[] | undefined; - performance?: YoutubePartner.Schema.TerritoryConflicts[] | undefined; - synchronization?: YoutubePartner.Schema.TerritoryConflicts[] | undefined; - } - interface OwnershipHistoryListResponse { - items?: YoutubePartner.Schema.RightsOwnershipHistory[] | undefined; - kind?: string | undefined; - } - interface Package { - content?: string | undefined; - customIds?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - locale?: string | undefined; - name?: string | undefined; - status?: string | undefined; - statusReports?: YoutubePartner.Schema.StatusReport[] | undefined; - timeCreated?: string | undefined; - type?: string | undefined; - uploaderName?: string | undefined; - } - interface PackageInsertResponse { - errors?: YoutubePartner.Schema.ValidateError[] | undefined; - kind?: string | undefined; - resource?: YoutubePartner.Schema.Package | undefined; - status?: string | undefined; - } - interface PageInfo { - resultsPerPage?: number | undefined; - startIndex?: number | undefined; - totalResults?: number | undefined; - } - interface Policy { - description?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - rules?: YoutubePartner.Schema.PolicyRule[] | undefined; - timeUpdated?: string | undefined; - } - interface PolicyList { - items?: YoutubePartner.Schema.Policy[] | undefined; - kind?: string | undefined; - } - interface PolicyRule { - action?: string | undefined; - conditions?: YoutubePartner.Schema.Conditions | undefined; - subaction?: string[] | undefined; - } - interface PromotedContent { - link?: YoutubePartner.Schema.CampaignTargetLink[] | undefined; - } - interface Publisher { - caeNumber?: string | undefined; - id?: string | undefined; - ipiNumber?: string | undefined; - kind?: string | undefined; - name?: string | undefined; - } - interface PublisherList { - items?: YoutubePartner.Schema.Publisher[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface Rating { - rating?: string | undefined; - ratingSystem?: string | undefined; - } - interface Reference { - assetId?: string | undefined; - audioswapEnabled?: boolean | undefined; - claimId?: string | undefined; - contentType?: string | undefined; - duplicateLeader?: string | undefined; - excludedIntervals?: YoutubePartner.Schema.ExcludedInterval[] | undefined; - fpDirect?: boolean | undefined; - hashCode?: string | undefined; - id?: string | undefined; - ignoreFpMatch?: boolean | undefined; - kind?: string | undefined; - length?: number | undefined; - origination?: YoutubePartner.Schema.Origination | undefined; - status?: string | undefined; - statusReason?: string | undefined; - urgent?: boolean | undefined; - videoId?: string | undefined; - } - interface ReferenceConflict { - conflictingReferenceId?: string | undefined; - expiryTime?: string | undefined; - id?: string | undefined; - kind?: string | undefined; - matches?: YoutubePartner.Schema.ReferenceConflictMatch[] | undefined; - originalReferenceId?: string | undefined; - status?: string | undefined; - } - interface ReferenceConflictListResponse { - items?: YoutubePartner.Schema.ReferenceConflict[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface ReferenceConflictMatch { - conflicting_reference_offset_ms?: string | undefined; - length_ms?: string | undefined; - original_reference_offset_ms?: string | undefined; - type?: string | undefined; - } - interface ReferenceListResponse { - items?: YoutubePartner.Schema.Reference[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - interface Requirements { - caption?: boolean | undefined; - hdTranscode?: boolean | undefined; - posterArt?: boolean | undefined; - spotlightArt?: boolean | undefined; - spotlightReview?: boolean | undefined; - trailer?: boolean | undefined; - } - interface RightsOwnership { - general?: YoutubePartner.Schema.TerritoryOwners[] | undefined; - kind?: string | undefined; - mechanical?: YoutubePartner.Schema.TerritoryOwners[] | undefined; - performance?: YoutubePartner.Schema.TerritoryOwners[] | undefined; - synchronization?: YoutubePartner.Schema.TerritoryOwners[] | undefined; - } - interface RightsOwnershipHistory { - kind?: string | undefined; - origination?: YoutubePartner.Schema.Origination | undefined; - ownership?: YoutubePartner.Schema.RightsOwnership | undefined; - timeProvided?: string | undefined; - } - interface Segment { - duration?: string | undefined; - kind?: string | undefined; - start?: string | undefined; - } - interface ShowDetails { - episodeNumber?: string | undefined; - episodeTitle?: string | undefined; - seasonNumber?: string | undefined; - title?: string | undefined; - } - interface SpreadsheetTemplate { - kind?: string | undefined; - status?: string | undefined; - templateContent?: string | undefined; - templateName?: string | undefined; - templateType?: string | undefined; - } - interface SpreadsheetTemplateListResponse { - items?: YoutubePartner.Schema.SpreadsheetTemplate[] | undefined; - kind?: string | undefined; - status?: string | undefined; - } - interface StateCompleted { - state?: string | undefined; - timeCompleted?: string | undefined; - } - interface StatusReport { - statusContent?: string | undefined; - statusFileName?: string | undefined; - } - interface TerritoryCondition { - territories?: string[] | undefined; - type?: string | undefined; - } - interface TerritoryConflicts { - conflictingOwnership?: YoutubePartner.Schema.ConflictingOwnership[] | undefined; - territory?: string | undefined; - } - interface TerritoryOwners { - owner?: string | undefined; - publisher?: string | undefined; - ratio?: number | undefined; - territories?: string[] | undefined; - type?: string | undefined; - } - interface Uploader { - kind?: string | undefined; - uploaderName?: string | undefined; - } - interface UploaderListResponse { - items?: YoutubePartner.Schema.Uploader[] | undefined; - kind?: string | undefined; - } - interface ValidateAsyncRequest { - content?: string | undefined; - kind?: string | undefined; - uploaderName?: string | undefined; - } - interface ValidateAsyncResponse { - kind?: string | undefined; - status?: string | undefined; - validationId?: string | undefined; - } - interface ValidateError { - columnName?: string | undefined; - columnNumber?: number | undefined; - lineNumber?: number | undefined; - message?: string | undefined; - messageCode?: number | undefined; - severity?: string | undefined; - } - interface ValidateRequest { - content?: string | undefined; - kind?: string | undefined; - locale?: string | undefined; - uploaderName?: string | undefined; - } - interface ValidateResponse { - errors?: YoutubePartner.Schema.ValidateError[] | undefined; - kind?: string | undefined; - status?: string | undefined; - } - interface ValidateStatusRequest { - kind?: string | undefined; - locale?: string | undefined; - validationId?: string | undefined; - } - interface ValidateStatusResponse { - errors?: YoutubePartner.Schema.ValidateError[] | undefined; - isMetadataOnly?: boolean | undefined; - kind?: string | undefined; - status?: string | undefined; - } - interface VideoAdvertisingOption { - adBreaks?: YoutubePartner.Schema.AdBreak[] | undefined; - adFormats?: string[] | undefined; - autoGeneratedBreaks?: boolean | undefined; - breakPosition?: string[] | undefined; - id?: string | undefined; - kind?: string | undefined; - tpAdServerVideoId?: string | undefined; - tpTargetingUrl?: string | undefined; - tpUrlParameters?: string | undefined; - } - interface VideoAdvertisingOptionGetEnabledAdsResponse { - adBreaks?: YoutubePartner.Schema.AdBreak[] | undefined; - adsOnEmbeds?: boolean | undefined; - countriesRestriction?: YoutubePartner.Schema.CountriesRestriction[] | undefined; - id?: string | undefined; - kind?: string | undefined; - } - interface Whitelist { - id?: string | undefined; - kind?: string | undefined; - title?: string | undefined; - } - interface WhitelistListResponse { - items?: YoutubePartner.Schema.Whitelist[] | undefined; - kind?: string | undefined; - nextPageToken?: string | undefined; - pageInfo?: YoutubePartner.Schema.PageInfo | undefined; - } - } - } - interface YoutubePartner { - AssetLabels?: YoutubePartner.Collection.AssetLabelsCollection | undefined; - AssetMatchPolicy?: YoutubePartner.Collection.AssetMatchPolicyCollection | undefined; - AssetRelationships?: YoutubePartner.Collection.AssetRelationshipsCollection | undefined; - AssetSearch?: YoutubePartner.Collection.AssetSearchCollection | undefined; - AssetShares?: YoutubePartner.Collection.AssetSharesCollection | undefined; - Assets?: YoutubePartner.Collection.AssetsCollection | undefined; - Campaigns?: YoutubePartner.Collection.CampaignsCollection | undefined; - ClaimHistory?: YoutubePartner.Collection.ClaimHistoryCollection | undefined; - ClaimSearch?: YoutubePartner.Collection.ClaimSearchCollection | undefined; - Claims?: YoutubePartner.Collection.ClaimsCollection | undefined; - ContentOwnerAdvertisingOptions?: YoutubePartner.Collection.ContentOwnerAdvertisingOptionsCollection | undefined; - ContentOwners?: YoutubePartner.Collection.ContentOwnersCollection | undefined; - LiveCuepoints?: YoutubePartner.Collection.LiveCuepointsCollection | undefined; - MetadataHistory?: YoutubePartner.Collection.MetadataHistoryCollection | undefined; - Orders?: YoutubePartner.Collection.OrdersCollection | undefined; - Ownership?: YoutubePartner.Collection.OwnershipCollection | undefined; - OwnershipHistory?: YoutubePartner.Collection.OwnershipHistoryCollection | undefined; - Package?: YoutubePartner.Collection.PackageCollection | undefined; - Policies?: YoutubePartner.Collection.PoliciesCollection | undefined; - Publishers?: YoutubePartner.Collection.PublishersCollection | undefined; - ReferenceConflicts?: YoutubePartner.Collection.ReferenceConflictsCollection | undefined; - References?: YoutubePartner.Collection.ReferencesCollection | undefined; - SpreadsheetTemplate?: YoutubePartner.Collection.SpreadsheetTemplateCollection | undefined; - Uploader?: YoutubePartner.Collection.UploaderCollection | undefined; - Validator?: YoutubePartner.Collection.ValidatorCollection | undefined; - VideoAdvertisingOptions?: YoutubePartner.Collection.VideoAdvertisingOptionsCollection | undefined; - Whitelists?: YoutubePartner.Collection.WhitelistsCollection | undefined; - // Create a new instance of AdBreak - newAdBreak(): YoutubePartner.Schema.AdBreak; - // Create a new instance of AdSlot - newAdSlot(): YoutubePartner.Schema.AdSlot; - // Create a new instance of AllowedAdvertisingOptions - newAllowedAdvertisingOptions(): YoutubePartner.Schema.AllowedAdvertisingOptions; - // Create a new instance of Asset - newAsset(): YoutubePartner.Schema.Asset; - // Create a new instance of AssetLabel - newAssetLabel(): YoutubePartner.Schema.AssetLabel; - // Create a new instance of AssetMatchPolicy - newAssetMatchPolicy(): YoutubePartner.Schema.AssetMatchPolicy; - // Create a new instance of AssetRelationship - newAssetRelationship(): YoutubePartner.Schema.AssetRelationship; - // Create a new instance of Campaign - newCampaign(): YoutubePartner.Schema.Campaign; - // Create a new instance of CampaignData - newCampaignData(): YoutubePartner.Schema.CampaignData; - // Create a new instance of CampaignSource - newCampaignSource(): YoutubePartner.Schema.CampaignSource; - // Create a new instance of CampaignTargetLink - newCampaignTargetLink(): YoutubePartner.Schema.CampaignTargetLink; - // Create a new instance of Claim - newClaim(): YoutubePartner.Schema.Claim; - // Create a new instance of ClaimMatchInfo - newClaimMatchInfo(): YoutubePartner.Schema.ClaimMatchInfo; - // Create a new instance of ClaimMatchInfoLongestMatch - newClaimMatchInfoLongestMatch(): YoutubePartner.Schema.ClaimMatchInfoLongestMatch; - // Create a new instance of ClaimMatchInfoTotalMatch - newClaimMatchInfoTotalMatch(): YoutubePartner.Schema.ClaimMatchInfoTotalMatch; - // Create a new instance of ClaimOrigin - newClaimOrigin(): YoutubePartner.Schema.ClaimOrigin; - // Create a new instance of ClaimedVideoDefaults - newClaimedVideoDefaults(): YoutubePartner.Schema.ClaimedVideoDefaults; - // Create a new instance of Conditions - newConditions(): YoutubePartner.Schema.Conditions; - // Create a new instance of ConflictingOwnership - newConflictingOwnership(): YoutubePartner.Schema.ConflictingOwnership; - // Create a new instance of ContentOwnerAdvertisingOption - newContentOwnerAdvertisingOption(): YoutubePartner.Schema.ContentOwnerAdvertisingOption; - // Create a new instance of CuepointSettings - newCuepointSettings(): YoutubePartner.Schema.CuepointSettings; - // Create a new instance of Date - newDate(): YoutubePartner.Schema.Date; - // Create a new instance of DateRange - newDateRange(): YoutubePartner.Schema.DateRange; - // Create a new instance of ExcludedInterval - newExcludedInterval(): YoutubePartner.Schema.ExcludedInterval; - // Create a new instance of IntervalCondition - newIntervalCondition(): YoutubePartner.Schema.IntervalCondition; - // Create a new instance of LiveCuepoint - newLiveCuepoint(): YoutubePartner.Schema.LiveCuepoint; - // Create a new instance of MatchSegment - newMatchSegment(): YoutubePartner.Schema.MatchSegment; - // Create a new instance of Metadata - newMetadata(): YoutubePartner.Schema.Metadata; - // Create a new instance of Order - newOrder(): YoutubePartner.Schema.Order; - // Create a new instance of Origination - newOrigination(): YoutubePartner.Schema.Origination; - // Create a new instance of OwnershipConflicts - newOwnershipConflicts(): YoutubePartner.Schema.OwnershipConflicts; - // Create a new instance of Package - newPackage(): YoutubePartner.Schema.Package; - // Create a new instance of Policy - newPolicy(): YoutubePartner.Schema.Policy; - // Create a new instance of PolicyRule - newPolicyRule(): YoutubePartner.Schema.PolicyRule; - // Create a new instance of PromotedContent - newPromotedContent(): YoutubePartner.Schema.PromotedContent; - // Create a new instance of Rating - newRating(): YoutubePartner.Schema.Rating; - // Create a new instance of Reference - newReference(): YoutubePartner.Schema.Reference; - // Create a new instance of Requirements - newRequirements(): YoutubePartner.Schema.Requirements; - // Create a new instance of RightsOwnership - newRightsOwnership(): YoutubePartner.Schema.RightsOwnership; - // Create a new instance of Segment - newSegment(): YoutubePartner.Schema.Segment; - // Create a new instance of ShowDetails - newShowDetails(): YoutubePartner.Schema.ShowDetails; - // Create a new instance of StateCompleted - newStateCompleted(): YoutubePartner.Schema.StateCompleted; - // Create a new instance of StatusReport - newStatusReport(): YoutubePartner.Schema.StatusReport; - // Create a new instance of TerritoryCondition - newTerritoryCondition(): YoutubePartner.Schema.TerritoryCondition; - // Create a new instance of TerritoryConflicts - newTerritoryConflicts(): YoutubePartner.Schema.TerritoryConflicts; - // Create a new instance of TerritoryOwners - newTerritoryOwners(): YoutubePartner.Schema.TerritoryOwners; - // Create a new instance of ValidateAsyncRequest - newValidateAsyncRequest(): YoutubePartner.Schema.ValidateAsyncRequest; - // Create a new instance of ValidateRequest - newValidateRequest(): YoutubePartner.Schema.ValidateRequest; - // Create a new instance of ValidateStatusRequest - newValidateStatusRequest(): YoutubePartner.Schema.ValidateStatusRequest; - // Create a new instance of VideoAdvertisingOption - newVideoAdvertisingOption(): YoutubePartner.Schema.VideoAdvertisingOption; - // Create a new instance of Whitelist - newWhitelist(): YoutubePartner.Schema.Whitelist; - } -} - -declare var YoutubePartner: GoogleAppsScript.YoutubePartner; diff --git a/node_modules/@types/google-apps-script/google-apps-script-events.d.ts b/node_modules/@types/google-apps-script/google-apps-script-events.d.ts deleted file mode 100644 index a9445fd..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script-events.d.ts +++ /dev/null @@ -1,115 +0,0 @@ -/// -/// -/// - -declare namespace GoogleAppsScript { - /** - * Google Apps Script Events - * @see https://developers.google.com/apps-script/guides/triggers/events - */ - namespace Events { - // Internal interfaces - interface AppsScriptEvent { - authMode: Script.AuthMode; - triggerUid: string; - user: Base.User; - } - - interface AppsScriptHttpRequestEvent { - parameter: { [key: string]: string }; - pathInfo: string; - contextPath: string; - contentLength: number; - queryString: string; - parameters: { [key: string]: string[] }; - } - - interface AppsScriptHttpRequestEventPostData { - length: number; - type: string; - contents: string; - name: string; - } - - // External interfaces - interface SheetsOnOpen extends AppsScriptEvent { - source: Spreadsheet.Spreadsheet; - } - - type SheetsOnChangeChangeType = - | "EDIT" - | "INSERT_ROW" - | "INSERT_COLUMN" - | "REMOVE_ROW" - | "REMOVE_COLUMN" - | "INSERT_GRID" - | "REMOVE_GRID" - | "FORMAT" - | "OTHER"; - interface SheetsOnChange extends AppsScriptEvent { - changeType: SheetsOnChangeChangeType; - source: Spreadsheet.Spreadsheet; - } - - interface SheetsOnEdit extends AppsScriptEvent { - oldValue: string; - range: Spreadsheet.Range; - source: Spreadsheet.Spreadsheet; - value: string; - } - - interface SheetsOnFormSubmit extends AppsScriptEvent { - namedValues: { [key: string]: string[] }; - range: Spreadsheet.Range; - values: string[]; - } - - interface FormsOnFormSubmit extends AppsScriptEvent { - response: Forms.FormResponse; - source: Forms.Form; - } - - interface DocsOnOpen extends AppsScriptEvent { - source: Document.Document; - } - - interface SlidesOnOpen extends AppsScriptEvent { - source: Slides.Presentation; - } - - interface FormsOnOpen extends AppsScriptEvent { - source: Forms.Form; - } - - // TODO: Is there a `user` attribute? - interface CalendarEventUpdated extends AppsScriptEvent { - calendarId: string; - } - - interface AddonOnInstall { - authMode: Script.AuthMode; - } - - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface DoGet extends AppsScriptHttpRequestEvent { - } - - interface DoPost extends AppsScriptHttpRequestEvent { - postData: AppsScriptHttpRequestEventPostData; - } - - interface TimeDriven { - authMode: Script.AuthMode; - year: number; - month: number; - "week-of-year": number; - "day-of-month": number; - "day-of-week": number; - hour: number; - minute: number; - second: number; - timezone: string; - triggerUid: string; - } - } -} diff --git a/node_modules/@types/google-apps-script/google-apps-script.base.d.ts b/node_modules/@types/google-apps-script/google-apps-script.base.d.ts deleted file mode 100644 index dc26eaf..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.base.d.ts +++ /dev/null @@ -1,599 +0,0 @@ -/// - -interface Console { - error(): void; - error(formatOrObject: object | string, ...values: any[]): void; - info(): void; - info(formatOrObject: object | string, ...values: any[]): void; - log(): void; - log(formatOrObject: object | string, ...values: any[]): void; - time(label: string): void; - timeEnd(label: string): void; - warn(): void; - warn(formatOrObject: object | string, ...values: any[]): void; -} - -declare namespace GoogleAppsScript { - namespace Base { - /** - * A data interchange object for Apps Script services. - */ - interface Blob extends BlobSource { - copyBlob(): Blob; - getAs(contentType: string): Blob; - getBytes(): Byte[]; - getContentType(): string | null; - getDataAsString(): string; - getDataAsString(charset: string): string; - getName(): string | null; - isGoogleType(): boolean; - setBytes(data: Byte[]): Blob; - setContentType(contentType: string | null): Blob; - setContentTypeFromExtension(): Blob; - setDataFromString(string: string): Blob; - setDataFromString(string: string, charset: string): Blob; - setName(name: string): Blob; - /** @deprecated DO NOT USE */ getAllBlobs(): Blob[]; - } - /** - * Interface for objects that can export their data as a Blob. - * Implementing classes - * - * NameBrief description - * - * AttachmentA Sites Attachment such as a file attached to a page. - * - * BlobA data interchange object for Apps Script services. - * - * ChartA Chart object, which can be converted to a static image. - * - * DocumentA document, containing rich text and elements such as tables and lists. - * - * EmbeddedChartRepresents a chart that has been embedded into a spreadsheet. - * - * FileA file in Google Drive. - * - * GmailAttachmentAn attachment from Gmail. - * - * HTTPResponseThis class allows users to access specific information on HTTP responses. - * - * HtmlOutputAn HtmlOutput object that can be served from a script. - * - * ImageA PageElement representing an image. - * - * InlineImageAn element representing an embedded image. - * - * JdbcBlobA JDBC Blob. - * - * JdbcClobA JDBC Clob. - * - * PictureFillA fill that renders an image that's stretched to the dimensions of its container. - * - * PositionedImageFixed position image anchored to a Paragraph. - * - * SpreadsheetAccess and modify Google Sheets files. - * - * StaticMapAllows for the creation and decoration of static map images. - */ - interface BlobSource { - getAs(contentType: string): Blob; - getBlob(): Blob; - } - /** - * This class provides access to dialog boxes specific to Google Sheets. - * - * The methods in this class are only available for use in the context of a Google Spreadsheet. - * Please use G Suite dialogs instead. - * See also - * - * ButtonSet - */ - interface Browser { - Buttons: typeof ButtonSet; - inputBox(prompt: string): string; - inputBox(prompt: string, buttons: ButtonSet): string; - inputBox(title: string, prompt: string, buttons: ButtonSet): string; - msgBox(prompt: string): string; - msgBox(prompt: string, buttons: ButtonSet): string; - msgBox(title: string, prompt: string, buttons: ButtonSet): string; - } - /** - * An enum representing predetermined, localized dialog buttons returned by an alert or PromptResponse.getSelectedButton() to indicate - * which button in a dialog the user clicked. These values cannot be set; to add buttons to an - * alert or prompt, use ButtonSet instead. - * - * // Display a dialog box with a message and "Yes" and "No" buttons. - * var ui = DocumentApp.getUi(); - * var response = ui.alert('Are you sure you want to continue?', ui.ButtonSet.YES_NO); - * - * // Process the user's response. - * if (response == ui.Button.YES) { - * Logger.log('The user clicked "Yes."'); - * } else { - * Logger.log('The user clicked "No" or the dialog\'s close button.'); - * } - */ - enum Button { - CLOSE, - OK, - CANCEL, - YES, - NO, - } - /** - * An enum representing predetermined, localized sets of one or more dialog buttons that can be - * added to an alert or a prompt. To determine which button the user clicked, - * use Button. - * - * // Display a dialog box with a message and "Yes" and "No" buttons. - * var ui = DocumentApp.getUi(); - * var response = ui.alert('Are you sure you want to continue?', ui.ButtonSet.YES_NO); - * - * // Process the user's response. - * if (response == ui.Button.YES) { - * Logger.log('The user clicked "Yes."'); - * } else { - * Logger.log('The user clicked "No" or the dialog\'s close button.'); - * } - */ - enum ButtonSet { - OK, - OK_CANCEL, - YES_NO, - YES_NO_CANCEL, - } - /** - * The types of Colors - */ - enum ColorType { - UNSUPPORTED, - RGB, - THEME, - } - /** - * This class allows the developer to write out text to the debugging logs. - */ - interface Logger { - clear(): void; - getLog(): string; - log(data: any): Logger; - log(format: string, ...values: any[]): Logger; - } - /** - * A custom menu in an instance of the user interface for a Google App. A script can only interact - * with the UI for the current instance of an open document or form, and only if the script is container-bound to the document or form. For more - * information, see the guide to menus. - * - * // Add a custom menu to the active spreadsheet, including a separator and a sub-menu. - * function onOpen(e) { - * SpreadsheetApp.getUi() - * .createMenu('My Menu') - * .addItem('My Menu Item', 'myFunction') - * .addSeparator() - * .addSubMenu(SpreadsheetApp.getUi().createMenu('My Submenu') - * .addItem('One Submenu Item', 'mySecondFunction') - * .addItem('Another Submenu Item', 'myThirdFunction')) - * .addToUi(); - * } - */ - interface Menu { - addItem(caption: string, functionName: string): Menu; - addSeparator(): Menu; - addSubMenu(menu: Menu): Menu; - addToUi(): void; - } - /** - * An enumeration that provides access to MIME-type declarations without typing the strings - * explicitly. Methods that expect a MIME type rendered as a string (for example, - * 'image/png') also accept any of the values below, so long as the method supports the - * underlying MIME type. - * - * // Use MimeType enum to log the name of every Google Doc in the user's Drive. - * var docs = DriveApp.getFilesByType(MimeType.GOOGLE_DOCS); - * while (docs.hasNext()) { - * var doc = docs.next(); - * Logger.log(doc.getName()) - * } - * - * // Use plain string to log the size of every PNG in the user's Drive. - * var pngs = DriveApp.getFilesByType('image/png'); - * while (pngs.hasNext()) { - * var png = pngs.next(); - * Logger.log(png.getSize()); - * } - */ - interface MimeType { - GOOGLE_APPS_SCRIPT: string; - GOOGLE_DRAWINGS: string; - GOOGLE_DOCS: string; - GOOGLE_FORMS: string; - GOOGLE_SHEETS: string; - GOOGLE_SITES: string; - GOOGLE_SLIDES: string; - FOLDER: string; - SHORTCUT: string; - BMP: string; - GIF: string; - JPEG: string; - PNG: string; - SVG: string; - PDF: string; - CSS: string; - CSV: string; - HTML: string; - JAVASCRIPT: string; - PLAIN_TEXT: string; - RTF: string; - OPENDOCUMENT_GRAPHICS: string; - OPENDOCUMENT_PRESENTATION: string; - OPENDOCUMENT_SPREADSHEET: string; - OPENDOCUMENT_TEXT: string; - MICROSOFT_EXCEL: string; - MICROSOFT_EXCEL_LEGACY: string; - MICROSOFT_POWERPOINT: string; - MICROSOFT_POWERPOINT_LEGACY: string; - MICROSOFT_WORD: string; - MICROSOFT_WORD_LEGACY: string; - ZIP: string; - } - /** - * An enum representing the months of the year. - */ - enum Month { - JANUARY, - FEBRUARY, - MARCH, - APRIL, - MAY, - JUNE, - JULY, - AUGUST, - SEPTEMBER, - OCTOBER, - NOVEMBER, - DECEMBER, - } - /** - * A response to a prompt dialog displayed in the - * user-interface environment for a Google App. The response contains any text the user entered in - * the dialog's input field and indicates which button the user clicked to dismiss the dialog. - * - * // Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The - * // user can also close the dialog by clicking the close button in its title bar. - * var ui = DocumentApp.getUi(); - * var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO); - * - * // Process the user's response. - * if (response.getSelectedButton() == ui.Button.YES) { - * Logger.log('The user\'s name is %s.', response.getResponseText()); - * } else if (response.getSelectedButton() == ui.Button.NO) { - * Logger.log('The user didn\'t want to provide a name.'); - * } else { - * Logger.log('The user clicked the close button in the dialog\'s title bar.'); - * } - */ - interface PromptResponse { - getResponseText(): string; - getSelectedButton(): Button; - } - /** - * A color defined by red, green, blue color channels. - */ - interface RgbColor { - asHexString(): string; - getBlue(): Integer; - getColorType(): ColorType; - getGreen(): Integer; - getRed(): Integer; - } - /** - * The Session class provides access to session information, such as the user's email address (in - * some circumstances) and language setting. - */ - interface Session { - getActiveUser(): User; - getActiveUserLocale(): string; - getEffectiveUser(): User; - getScriptTimeZone(): string; - getTemporaryActiveUserKey(): string; - /** @deprecated DO NOT USE */ getTimeZone(): string; - /** @deprecated DO NOT USE */ getUser(): User; - } - /** - * An instance of the user-interface environment for a Google App that allows the script to add - * features like menus, dialogs, and sidebars. A script can only interact with the UI for the - * current instance of an open editor, and only if the script is container-bound to the editor. - * - * // Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The - * // user can also close the dialog by clicking the close button in its title bar. - * var ui = SpreadsheetApp.getUi(); - * var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO); - * - * // Process the user's response. - * if (response.getSelectedButton() == ui.Button.YES) { - * Logger.log('The user\'s name is %s.', response.getResponseText()); - * } else if (response.getSelectedButton() == ui.Button.NO) { - * Logger.log('The user didn\'t want to provide a name.'); - * } else { - * Logger.log('The user clicked the close button in the dialog\'s title bar.'); - * } - */ - interface Ui { - Button: typeof Button; - ButtonSet: typeof ButtonSet; - alert(prompt: string): Button; - alert(prompt: string, buttons: ButtonSet): Button; - alert(title: string, prompt: string, buttons: ButtonSet): Button; - createAddonMenu(): Menu; - createMenu(caption: string): Menu; - prompt(prompt: string): PromptResponse; - prompt(prompt: string, buttons: ButtonSet): PromptResponse; - prompt(title: string, prompt: string, buttons: ButtonSet): PromptResponse; - showModalDialog(userInterface: HTML.HtmlOutput, title: string): void; - showModelessDialog(userInterface: HTML.HtmlOutput, title: string): void; - showSidebar(userInterface: HTML.HtmlOutput): void; - /** @deprecated DO NOT USE */ showDialog(userInterface: HTML.HtmlOutput): void; - } - /** - * Representation of a user, suitable for scripting. - */ - interface User { - getEmail(): string; - /** @deprecated DO NOT USE */ getUserLoginId(): string; - } - /** - * An enum representing the days of the week. - */ - enum Weekday { - SUNDAY, - MONDAY, - TUESDAY, - WEDNESDAY, - THURSDAY, - FRIDAY, - SATURDAY, - } - /** - * This class allows the developer to write logs to the Google Cloud Platform's Stackdriver Logging service. The following - * shows some logging examples: - * - * function measuringExecutionTime() { - * // A simple INFO log message, using sprintf() formatting. - * console.info('Timing the %s function (%d arguments)', 'myFunction', 1); - * - * // Log a JSON object at a DEBUG level. If the object contains a property called "message", - * // that is used as the summary in the log viewer, otherwise a stringified version of - * // the object is used as the summary. - * var parameters = { - * isValid: true, - * content: 'some string', - * timestamp: new Date() - * }; - * console.log(parameters); - * - * var label = 'myFunction() time'; // Labels the timing log entry. - * console.time(label); // Starts the timer. - * try { - * myFunction(parameters); // Function to time. - * } catch (e) { - * // Logs an ERROR message. - * console.error('myFunction() yielded an error: ' + e); - * } - * console.timeEnd(label); // Stops the timer, logs execution duration. - * } - */ - - /** - * Apps Script has a non-standard Date Class - * - * @see https://github.com/microsoft/TypeScript/blob/master/lib/lib.es5.d.ts - * Enables basic storage and retrieval of dates and times. - */ - interface Date { - /** Returns a string representation of a date. The format of the string depends on the locale. */ - toString(): string; - /** Returns a date as a string value. */ - toDateString(): string; - /** Returns a time as a string value. */ - toTimeString(): string; - /** Returns a value as a string value appropriate to the host environment's current locale. */ - toLocaleString(): string; - /** Returns a date as a string value appropriate to the host environment's current locale. */ - toLocaleDateString(): string; - /** Returns a time as a string value appropriate to the host environment's current locale. */ - toLocaleTimeString(): string; - /** Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC. */ - valueOf(): number; - /** Gets the time value in milliseconds. */ - getTime(): number; - /** Gets the year, using local time. */ - getFullYear(): number; - /** Gets the year using Universal Coordinated Time (UTC). */ - getUTCFullYear(): number; - /** Gets the month, using local time. */ - getMonth(): number; - /** Gets the month of a Date object using Universal Coordinated Time (UTC). */ - getUTCMonth(): number; - /** Gets the day-of-the-month, using local time. */ - getDate(): number; - /** Gets the day-of-the-month, using Universal Coordinated Time (UTC). */ - getUTCDate(): number; - /** Gets the day of the week, using local time. */ - getDay(): number; - /** Gets the day of the week using Universal Coordinated Time (UTC). */ - getUTCDay(): number; - /** Gets the hours in a date, using local time. */ - getHours(): number; - /** Gets the hours value in a Date object using Universal Coordinated Time (UTC). */ - getUTCHours(): number; - /** Gets the minutes of a Date object, using local time. */ - getMinutes(): number; - /** Gets the minutes of a Date object using Universal Coordinated Time (UTC). */ - getUTCMinutes(): number; - /** Gets the seconds of a Date object, using local time. */ - getSeconds(): number; - /** Gets the seconds of a Date object using Universal Coordinated Time (UTC). */ - getUTCSeconds(): number; - /** Gets the milliseconds of a Date, using local time. */ - getMilliseconds(): number; - /** Gets the milliseconds of a Date object using Universal Coordinated Time (UTC). */ - getUTCMilliseconds(): number; - /** Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC). */ - getTimezoneOffset(): number; - /** - * Sets the date and time value in the Date object. - * @param time A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT. - */ - setTime(time: number): number; - /** - * Sets the milliseconds value in the Date object using local time. - * @param ms A numeric value equal to the millisecond value. - */ - setMilliseconds(ms: number): number; - /** - * Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC). - * @param ms A numeric value equal to the millisecond value. - */ - setUTCMilliseconds(ms: number): number; - /** - * Sets the seconds value in the Date object using local time. - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setSeconds(sec: number, ms?: number): number; - /** - * Sets the seconds value in the Date object using Universal Coordinated Time (UTC). - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setUTCSeconds(sec: number, ms?: number): number; - /** - * Sets the minutes value in the Date object using local time. - * @param min A numeric value equal to the minutes value. - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setMinutes(min: number, sec?: number, ms?: number): number; - /** - * Sets the minutes value in the Date object using Universal Coordinated Time (UTC). - * @param min A numeric value equal to the minutes value. - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setUTCMinutes(min: number, sec?: number, ms?: number): number; - /** - * Sets the hour value in the Date object using local time. - * @param hours A numeric value equal to the hours value. - * @param min A numeric value equal to the minutes value. - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setHours(hours: number, min?: number, sec?: number, ms?: number): number; - /** - * Sets the hours value in the Date object using Universal Coordinated Time (UTC). - * @param hours A numeric value equal to the hours value. - * @param min A numeric value equal to the minutes value. - * @param sec A numeric value equal to the seconds value. - * @param ms A numeric value equal to the milliseconds value. - */ - setUTCHours(hours: number, min?: number, sec?: number, ms?: number): number; - /** - * Sets the numeric day-of-the-month value of the Date object using local time. - * @param date A numeric value equal to the day of the month. - */ - setDate(date: number): number; - /** - * Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC). - * @param date A numeric value equal to the day of the month. - */ - setUTCDate(date: number): number; - /** - * Sets the month value in the Date object using local time. - * @param month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. - * @param date A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used. - */ - setMonth(month: number, date?: number): number; - /** - * Sets the month value in the Date object using Universal Coordinated Time (UTC). - * @param month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. - * @param date A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used. - */ - setUTCMonth(month: number, date?: number): number; - /** - * Sets the year of the Date object using local time. - * @param year A numeric value for the year. - * @param month A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified. - * @param date A numeric value equal for the day of the month. - */ - setFullYear(year: number, month?: number, date?: number): number; - /** - * Sets the year value in the Date object using Universal Coordinated Time (UTC). - * @param year A numeric value equal to the year. - * @param month A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied. - * @param date A numeric value equal to the day of the month. - */ - setUTCFullYear(year: number, month?: number, date?: number): number; - /** Returns a date converted to a string using Universal Coordinated Time (UTC). */ - toUTCString(): string; - /** Returns a date as a string value in ISO format. */ - toISOString(): string; - /** Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization. */ - toJSON(key?: any): string; - } - - interface DateConstructor { - new(): Date; - new(value: number | string): Date; - new( - year: number, - month: number, - date?: number, - hours?: number, - minutes?: number, - seconds?: number, - ms?: number, - ): Date; - (): string; - readonly prototype: Date; - /** - * Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970. - * @param s A date string - */ - parse(s: string): number; - /** - * Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date. - * @param year The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year. - * @param month The month as an number between 0 and 11 (January to December). - * @param date The date as an number between 1 and 31. - * @param hours Must be supplied if minutes is supplied. An number from 0 to 23 (midnight to 11pm) that specifies the hour. - * @param minutes Must be supplied if seconds is supplied. An number from 0 to 59 that specifies the minutes. - * @param seconds Must be supplied if milliseconds is supplied. An number from 0 to 59 that specifies the seconds. - * @param ms An number from 0 to 999 that specifies the milliseconds. - */ - UTC( - year: number, - month: number, - date?: number, - hours?: number, - minutes?: number, - seconds?: number, - ms?: number, - ): number; - now(): number; - } - const Date: DateConstructor; - } -} - -declare var Browser: GoogleAppsScript.Base.Browser; -declare var Logger: GoogleAppsScript.Base.Logger; -declare var MimeType: GoogleAppsScript.Base.MimeType; -declare var Session: GoogleAppsScript.Base.Session; -declare var console: Console; - -// The name `Date` conflicts with lib.es5.d.ts. -// - We cannot include lib.es5.d.ts with Apps Script though because Apps Script is ES3 -// and doesn't include all ES5+ features. -// Thus developers using the Date class must alias the type in their own TS projects. -// - We cannot use lib.es3.d.ts because it is no longer by dtslint. -declare var Date2: GoogleAppsScript.Base.DateConstructor; diff --git a/node_modules/@types/google-apps-script/google-apps-script.cache.d.ts b/node_modules/@types/google-apps-script/google-apps-script.cache.d.ts deleted file mode 100644 index 8d29d9f..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.cache.d.ts +++ /dev/null @@ -1,53 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Cache { - /** - * A reference to a particular cache. - * - * This class allows you to insert, retrieve, and remove items from a cache. This can be - * particularly useful when you want frequent access to an expensive or slow resource. For example, - * say you have an RSS feed at example.com that takes 20 seconds to fetch, but you want to speed up - * access on an average request. - * - * function getRssFeed() { - * var cache = CacheService.getScriptCache(); - * var cached = cache.get("rss-feed-contents"); - * if (cached != null) { - * return cached; - * } - * var result = UrlFetchApp.fetch("http://example.com/my-slow-rss-feed.xml"); // takes 20 seconds - * var contents = result.getContentText(); - * cache.put("rss-feed-contents", contents, 1500); // cache for 25 minutes - * return contents; - * } - */ - interface Cache { - get(key: string): string | null; - getAll(keys: string[]): { [key: string]: any }; - put(key: string, value: string): void; - put(key: string, value: string, expirationInSeconds: Integer): void; - putAll(values: { [key: string]: any }): void; - putAll(values: { [key: string]: any }, expirationInSeconds: Integer): void; - remove(key: string): void; - removeAll(keys: string[]): void; - } - /** - * CacheService allows you to access a cache for short term storage of data. - * - * This class lets you get a specific cache instance. Public caches are for things that are not - * dependent on which user is accessing your script. Private caches are for things which are - * user-specific, like settings or recent activity. - * - * The data you write to the cache is not guaranteed to persist until its expiration time. You - * must be prepared to get back null from all reads. - */ - interface CacheService { - getDocumentCache(): Cache | null; - getScriptCache(): Cache; - getUserCache(): Cache; - } - } -} - -declare var CacheService: GoogleAppsScript.Cache.CacheService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.calendar.d.ts b/node_modules/@types/google-apps-script/google-apps-script.calendar.d.ts deleted file mode 100644 index ff6bc1d..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.calendar.d.ts +++ /dev/null @@ -1,400 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Calendar { - /** - * Represents a calendar that the user owns or is subscribed to. - */ - interface Calendar { - createAllDayEvent(title: string, date: Base.Date): CalendarEvent; - createAllDayEvent(title: string, startDate: Base.Date, endDate: Base.Date): CalendarEvent; - createAllDayEvent( - title: string, - startDate: Base.Date, - endDate: Base.Date, - options: { [key: string]: any }, - ): CalendarEvent; - createAllDayEvent(title: string, date: Base.Date, options: { [key: string]: any }): CalendarEvent; - createAllDayEventSeries( - title: string, - startDate: Base.Date, - recurrence: EventRecurrence, - ): CalendarEventSeries; - createAllDayEventSeries( - title: string, - startDate: Base.Date, - recurrence: EventRecurrence, - options: { [key: string]: any }, - ): CalendarEventSeries; - createEvent(title: string, startTime: Base.Date, endTime: Base.Date): CalendarEvent; - createEvent( - title: string, - startTime: Base.Date, - endTime: Base.Date, - options: { [key: string]: any }, - ): CalendarEvent; - createEventFromDescription(description: string): CalendarEvent; - createEventSeries( - title: string, - startTime: Base.Date, - endTime: Base.Date, - recurrence: EventRecurrence, - ): CalendarEventSeries; - createEventSeries( - title: string, - startTime: Base.Date, - endTime: Base.Date, - recurrence: EventRecurrence, - options: { [key: string]: any }, - ): CalendarEventSeries; - deleteCalendar(): void; - getColor(): string; - getDescription(): string; - getEventById(iCalId: string): CalendarEvent; - getEventSeriesById(iCalId: string): CalendarEventSeries; - getEvents(startTime: Base.Date, endTime: Base.Date): CalendarEvent[]; - getEvents(startTime: Base.Date, endTime: Base.Date, options: { [key: string]: any }): CalendarEvent[]; - getEventsForDay(date: Base.Date): CalendarEvent[]; - getEventsForDay(date: Base.Date, options: { [key: string]: any }): CalendarEvent[]; - getId(): string; - getName(): string; - getTimeZone(): string; - isHidden(): boolean; - isMyPrimaryCalendar(): boolean; - isOwnedByMe(): boolean; - isSelected(): boolean; - setColor(color: string): Calendar; - setDescription(description: string): Calendar; - setHidden(hidden: boolean): Calendar; - setName(name: string): Calendar; - setSelected(selected: boolean): Calendar; - setTimeZone(timeZone: string): Calendar; - unsubscribeFromCalendar(): void; - } - /** - * Allows a script to read and update the user's Google Calendar. This class provides direct access - * to the user's default calendar, as well as the ability to retrieve additional calendars that the - * user owns or is subscribed to. - */ - interface CalendarApp { - Color: typeof Color; - EventColor: typeof EventColor; - GuestStatus: typeof GuestStatus; - Month: typeof Base.Month; - Visibility: typeof Visibility; - Weekday: typeof Base.Weekday; - createAllDayEvent(title: string, date: Base.Date): CalendarEvent; - createAllDayEvent(title: string, startDate: Base.Date, endDate: Base.Date): CalendarEvent; - createAllDayEvent( - title: string, - startDate: Base.Date, - endDate: Base.Date, - options: { [key: string]: any }, - ): CalendarEvent; - createAllDayEvent(title: string, date: Base.Date, options: { [key: string]: any }): CalendarEvent; - createAllDayEventSeries( - title: string, - startDate: Base.Date, - recurrence: EventRecurrence, - ): CalendarEventSeries; - createAllDayEventSeries( - title: string, - startDate: Base.Date, - recurrence: EventRecurrence, - options: { [key: string]: any }, - ): CalendarEventSeries; - createCalendar(name: string): Calendar; - createCalendar(name: string, options: { [key: string]: any }): Calendar; - createEvent(title: string, startTime: Base.Date, endTime: Base.Date): CalendarEvent; - createEvent( - title: string, - startTime: Base.Date, - endTime: Base.Date, - options: { [key: string]: any }, - ): CalendarEvent; - createEventFromDescription(description: string): CalendarEvent; - createEventSeries( - title: string, - startTime: Base.Date, - endTime: Base.Date, - recurrence: EventRecurrence, - ): CalendarEventSeries; - createEventSeries( - title: string, - startTime: Base.Date, - endTime: Base.Date, - recurrence: EventRecurrence, - options: { [key: string]: any }, - ): CalendarEventSeries; - getAllCalendars(): Calendar[]; - getAllOwnedCalendars(): Calendar[]; - getCalendarById(id: string): Calendar; - getCalendarsByName(name: string): Calendar[]; - getColor(): string; - getDefaultCalendar(): Calendar; - getDescription(): string; - getEventById(iCalId: string): CalendarEvent; - getEventSeriesById(iCalId: string): CalendarEventSeries; - getEvents(startTime: Base.Date, endTime: Base.Date): CalendarEvent[]; - getEvents(startTime: Base.Date, endTime: Base.Date, options: { [key: string]: any }): CalendarEvent[]; - getEventsForDay(date: Base.Date): CalendarEvent[]; - getEventsForDay(date: Base.Date, options: { [key: string]: any }): CalendarEvent[]; - getId(): string; - getName(): string; - getOwnedCalendarById(id: string): Calendar; - getOwnedCalendarsByName(name: string): Calendar[]; - getTimeZone(): string; - isHidden(): boolean; - isMyPrimaryCalendar(): boolean; - isOwnedByMe(): boolean; - isSelected(): boolean; - newRecurrence(): EventRecurrence; - setColor(color: string): Calendar; - setDescription(description: string): Calendar; - setHidden(hidden: boolean): Calendar; - setName(name: string): Calendar; - setSelected(selected: boolean): Calendar; - setTimeZone(timeZone: string): Calendar; - subscribeToCalendar(id: string): Calendar; - subscribeToCalendar(id: string, options: { [key: string]: any }): Calendar; - } - /** - * Represents a single calendar event. - */ - interface CalendarEvent { - addEmailReminder(minutesBefore: Integer): CalendarEvent; - addGuest(email: string): CalendarEvent; - addPopupReminder(minutesBefore: Integer): CalendarEvent; - addSmsReminder(minutesBefore: Integer): CalendarEvent; - anyoneCanAddSelf(): boolean; - deleteEvent(): void; - deleteTag(key: string): CalendarEvent; - getAllDayEndDate(): Base.Date; - getAllDayStartDate(): Base.Date; - getAllTagKeys(): string[]; - getColor(): string; - getCreators(): string[]; - getDateCreated(): Base.Date; - getDescription(): string; - getEmailReminders(): Integer[]; - getEndTime(): Base.Date; - getEventSeries(): CalendarEventSeries; - getGuestByEmail(email: string): EventGuest; - getGuestList(): EventGuest[]; - getGuestList(includeOwner: boolean): EventGuest[]; - getId(): string; - getLastUpdated(): Base.Date; - getLocation(): string; - getMyStatus(): GuestStatus; - getOriginalCalendarId(): string; - getPopupReminders(): Integer[]; - getSmsReminders(): Integer[]; - getStartTime(): Base.Date; - getTag(key: string): string; - getTitle(): string; - getVisibility(): Visibility; - guestsCanInviteOthers(): boolean; - guestsCanModify(): boolean; - guestsCanSeeGuests(): boolean; - isAllDayEvent(): boolean; - isOwnedByMe(): boolean; - isRecurringEvent(): boolean; - removeAllReminders(): CalendarEvent; - removeGuest(email: string): CalendarEvent; - resetRemindersToDefault(): CalendarEvent; - setAllDayDate(date: Base.Date): CalendarEvent; - setAllDayDates(startDate: Base.Date, endDate: Base.Date): CalendarEvent; - setAnyoneCanAddSelf(anyoneCanAddSelf: boolean): CalendarEvent; - setColor(color: string): CalendarEvent; - setDescription(description: string): CalendarEvent; - setGuestsCanInviteOthers(guestsCanInviteOthers: boolean): CalendarEvent; - setGuestsCanModify(guestsCanModify: boolean): CalendarEvent; - setGuestsCanSeeGuests(guestsCanSeeGuests: boolean): CalendarEvent; - setLocation(location: string): CalendarEvent; - setMyStatus(status: GuestStatus): CalendarEvent; - setTag(key: string, value: string): CalendarEvent; - setTime(startTime: Base.Date, endTime: Base.Date): CalendarEvent; - setTitle(title: string): CalendarEvent; - setVisibility(visibility: Visibility): CalendarEvent; - } - /** - * Represents a series of events (a recurring event). - */ - interface CalendarEventSeries { - addEmailReminder(minutesBefore: Integer): CalendarEventSeries; - addGuest(email: string): CalendarEventSeries; - addPopupReminder(minutesBefore: Integer): CalendarEventSeries; - addSmsReminder(minutesBefore: Integer): CalendarEventSeries; - anyoneCanAddSelf(): boolean; - deleteEventSeries(): void; - deleteTag(key: string): CalendarEventSeries; - getAllTagKeys(): string[]; - getColor(): string; - getCreators(): string[]; - getDateCreated(): Base.Date; - getDescription(): string; - getEmailReminders(): Integer[]; - getGuestByEmail(email: string): EventGuest; - getGuestList(): EventGuest[]; - getGuestList(includeOwner: boolean): EventGuest[]; - getId(): string; - getLastUpdated(): Base.Date; - getLocation(): string; - getMyStatus(): GuestStatus; - getOriginalCalendarId(): string; - getPopupReminders(): Integer[]; - getSmsReminders(): Integer[]; - getTag(key: string): string; - getTitle(): string; - getVisibility(): Visibility; - guestsCanInviteOthers(): boolean; - guestsCanModify(): boolean; - guestsCanSeeGuests(): boolean; - isOwnedByMe(): boolean; - removeAllReminders(): CalendarEventSeries; - removeGuest(email: string): CalendarEventSeries; - resetRemindersToDefault(): CalendarEventSeries; - setAnyoneCanAddSelf(anyoneCanAddSelf: boolean): CalendarEventSeries; - setColor(color: string): CalendarEventSeries; - setDescription(description: string): CalendarEventSeries; - setGuestsCanInviteOthers(guestsCanInviteOthers: boolean): CalendarEventSeries; - setGuestsCanModify(guestsCanModify: boolean): CalendarEventSeries; - setGuestsCanSeeGuests(guestsCanSeeGuests: boolean): CalendarEventSeries; - setLocation(location: string): CalendarEventSeries; - setMyStatus(status: GuestStatus): CalendarEventSeries; - setRecurrence(recurrence: EventRecurrence, startDate: Base.Date): CalendarEventSeries; - setRecurrence(recurrence: EventRecurrence, startTime: Base.Date, endTime: Base.Date): CalendarEventSeries; - setTag(key: string, value: string): CalendarEventSeries; - setTitle(title: string): CalendarEventSeries; - setVisibility(visibility: Visibility): CalendarEventSeries; - } - /** - * An enum representing the named colors available in the Calendar service. - */ - enum Color { - BLUE, - BROWN, - CHARCOAL, - CHESTNUT, - GRAY, - GREEN, - INDIGO, - LIME, - MUSTARD, - OLIVE, - ORANGE, - PINK, - PLUM, - PURPLE, - RED, - RED_ORANGE, - SEA_BLUE, - SLATE, - TEAL, - TURQOISE, - YELLOW, - } - /** - * An enum representing the named event colors available in the Calendar service. - */ - enum EventColor { - PALE_BLUE, - PALE_GREEN, - MAUVE, - PALE_RED, - YELLOW, - ORANGE, - CYAN, - GRAY, - BLUE, - GREEN, - RED, - } - /** - * Represents a guest of an event. - */ - interface EventGuest { - getAdditionalGuests(): Integer; - getEmail(): string; - getGuestStatus(): GuestStatus; - getName(): string; - /** @deprecated DO NOT USE */ getStatus(): string; - } - /** - * Represents the recurrence settings for an event series. - */ - interface EventRecurrence { - addDailyExclusion(): RecurrenceRule; - addDailyRule(): RecurrenceRule; - addDate(date: Base.Date): EventRecurrence; - addDateExclusion(date: Base.Date): EventRecurrence; - addMonthlyExclusion(): RecurrenceRule; - addMonthlyRule(): RecurrenceRule; - addWeeklyExclusion(): RecurrenceRule; - addWeeklyRule(): RecurrenceRule; - addYearlyExclusion(): RecurrenceRule; - addYearlyRule(): RecurrenceRule; - setTimeZone(timeZone: string): EventRecurrence; - } - /** - * An enum representing the statuses a guest can have for an event. - */ - enum GuestStatus { - INVITED, - MAYBE, - NO, - OWNER, - YES, - } - /** - * Represents a recurrence rule for an event series. - * - * Note that this class also behaves like the EventRecurrence that it belongs to, - * allowing you to chain rule creation together like so: - * - * recurrence.addDailyRule().times(3).interval(2).addWeeklyExclusion().times(2); - * - * times(times) - * interval(interval) - */ - interface RecurrenceRule { - addDailyExclusion(): RecurrenceRule; - addDailyRule(): RecurrenceRule; - addDate(date: Base.Date): EventRecurrence; - addDateExclusion(date: Base.Date): EventRecurrence; - addMonthlyExclusion(): RecurrenceRule; - addMonthlyRule(): RecurrenceRule; - addWeeklyExclusion(): RecurrenceRule; - addWeeklyRule(): RecurrenceRule; - addYearlyExclusion(): RecurrenceRule; - addYearlyRule(): RecurrenceRule; - interval(interval: Integer): RecurrenceRule; - onlyInMonth(month: Base.Month): RecurrenceRule; - onlyInMonths(months: Base.Month[]): RecurrenceRule; - onlyOnMonthDay(day: Integer): RecurrenceRule; - onlyOnMonthDays(days: Integer[]): RecurrenceRule; - onlyOnWeek(week: Integer): RecurrenceRule; - onlyOnWeekday(day: Base.Weekday): RecurrenceRule; - onlyOnWeekdays(days: Base.Weekday[]): RecurrenceRule; - onlyOnWeeks(weeks: Integer[]): RecurrenceRule; - onlyOnYearDay(day: Integer): RecurrenceRule; - onlyOnYearDays(days: Integer[]): RecurrenceRule; - setTimeZone(timeZone: string): EventRecurrence; - times(times: Integer): RecurrenceRule; - until(endDate: Base.Date): RecurrenceRule; - weekStartsOn(day: Base.Weekday): RecurrenceRule; - } - /** - * An enum representing the visibility of an event. - */ - enum Visibility { - CONFIDENTIAL, - DEFAULT, - PRIVATE, - PUBLIC, - } - } -} - -declare var CalendarApp: GoogleAppsScript.Calendar.CalendarApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.card-service.d.ts b/node_modules/@types/google-apps-script/google-apps-script.card-service.d.ts deleted file mode 100644 index 560e91c..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.card-service.d.ts +++ /dev/null @@ -1,1222 +0,0 @@ -/// -/// -/// - -declare namespace GoogleAppsScript { - namespace Card_Service { - /** - * An action that enables interactivity within UI elements. The action does not happen directly on - * the client but rather invokes an Apps Script callback function with optional parameters. - * - * var image = CardService.newImage() - * .setOnClickAction(CardService.newAction() - * .setFunctionName("handleImageClick") - * .setParameters({imageSrc: 'carImage'})); - */ - interface Action { - setFunctionName(functionName: string): Action; - setLoadIndicator(loadIndicator: LoadIndicator): Action; - setParameters(parameters: { [key: string]: string }): Action; - /** @deprecated DO NOT USE */ setMethodName(functionName: string): Action; - setPersistValues(persistValues: boolean): Action; - } - /** - * The response object that may be returned from a callback function (e.g., a form response handler) - * to perform one or more actions on the client. Some combinations of actions are not supported. - * - * // An action that opens a link - * var actionResponse = CardService.newActionResponseBuilder() - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://www.google.com")) - * .build(); - * - * // An action that shows a notification. - * var actionResponse = CardService.newActionResponseBuilder() - * .setNotification(CardService.newNotification() - * .setText("Some info to display to user")) - * .build(); - * - * // An action that shows an additional card. It also sets a flag to indicate that the original - * // state data has changed. - * - * var cardBuilder = CardService.newCardBuilder(); - * // Build card ... - * var actionResponse = CardService.newActionResponseBuilder() - * .setNavigation(CardService.newNavigation() - * .pushCard(cardBuilder.build())) - * .setStateChanged(true) - * .build(); - */ - interface ActionResponse { - printJson(): string; - } - /** - * A builder for ActionResponse objects. - */ - interface ActionResponseBuilder { - build(): ActionResponse; - setNavigation(navigation: Navigation): ActionResponseBuilder; - setNotification(notification: Notification): ActionResponseBuilder; - setOpenLink(openLink: OpenLink): ActionResponseBuilder; - setStateChanged(stateChanged: boolean): ActionResponseBuilder; - } - /** - * Represents an attachment created by an add-on. This can be used within the context of different - * Google extensibility products to generate new attachments, such as for Calendar events. - */ - interface Attachment { - setIconUrl(iconUrl: string): Attachment; - setMimeType(mimeType: string): Attachment; - setResourceUrl(resourceUrl: string): Attachment; - setTitle(title: string): Attachment; - } - /** - * An authorization action that will send the user to the AuthorizationUrl when clicked. - * - * CardService.newAuthorizationAction() - * .setAuthorizationUrl("http://google.com/"); - */ - interface AuthorizationAction { - setAuthorizationUrl(authorizationUrl: string): AuthorizationAction; - } - /** - * An error that can be returned to trigger an authorization card to be shown to the user. - * - * CardService.newAuthorizationException() - * .setAuthorizationUrl("http://auth.com/") - * .setResourceDisplayName("Example Resource") - * .throwException(); - */ - interface AuthorizationException { - printJson(): string; - setAuthorizationUrl(authUrl: string): AuthorizationException; - setCustomUiCallback(callback: string): AuthorizationException; - setResourceDisplayName(name: string): AuthorizationException; - throwException(): void; - } - /** - * A base class for all buttons. - */ - interface Button { - setAuthorizationAction(action: AuthorizationAction): Button; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): Button; - setOnClickAction(action: Action): Button; - setOnClickOpenLinkAction(action: Action): Button; - setOpenLink(openLink: OpenLink): Button; - } - /** - * Holds a set of Button objects that are displayed in a row. - * - * var textButton = CardService.newTextButton(); - * // Finish building the text button... - * - * var imageButton = CardService.newImageButton(); - * // Finish building the image button... - * - * var buttonSet = CardService.newButtonSet() - * .addButton(textButton) - * .addButton(imageButton); - */ - interface ButtonSet { - addButton(button: Button): ButtonSet; - } - /** - * A context card that represents a single view in the - * UI. - * - * var cardSection = CardService.newCardSection(); - * // Finish building the card section ... - * - * var card = CardService.newCardBuilder() - * .setName("Card name") - * .setHeader(CardService.newCardHeader().setTitle("Card title")) - * .addSection(cardSection) - * .build(); - */ - interface Card { - printJson(): string; - } - /** - * A clickable menu item that is added to the card header menu. - * - * var action = CardService.newAction(); - * // Finish building the action... - * - * var cardAction = CardService.newCardAction() - * .setText("Card action") - * .setOnClickAction(action); - */ - interface CardAction { - setAuthorizationAction(action: AuthorizationAction): CardAction; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): CardAction; - setOnClickAction(action: Action): CardAction; - setOnClickOpenLinkAction(action: Action): CardAction; - setOpenLink(openLink: OpenLink): CardAction; - setText(text: string): CardAction; - } - /** - * An enum that defines the display style of card. - */ - enum DisplayStyle { - PEEK, - REPLACE, - } - /** - * A builder for Card objects. - */ - interface CardBuilder { - addCardAction(cardAction: CardAction): CardBuilder; - addSection(section: CardSection): CardBuilder; - build(): Card; - setHeader(cardHeader: CardHeader): CardBuilder; - setName(name: string): CardBuilder; - setFixedFooter(fixedFooter: FixedFooter): CardBuilder; - setDisplayStyle(displayStyle: DisplayStyle): CardBuilder; - setPeekCardHeader(peekCardHeader: CardHeader): CardBuilder; - } - /** - * The header of a Card. - * - * var cardHeader = CardService.newCardHeader() - * .setTitle("Card header title") - * .setSubtitle("Card header subtitle") - * .setImageStyle(CardService.ImageStyle.CIRCLE) - * .setImageUrl("https://image.png"); - */ - interface CardHeader { - setImageAltText(imageAltText: string): CardHeader; - setImageStyle(imageStyle: ImageStyle): CardHeader; - setImageUrl(imageUrl: string): CardHeader; - setSubtitle(subtitle: string): CardHeader; - setTitle(title: string): CardHeader; - } - /** - * A card section holds groups of widgets and provides visual separation between them. - * - * var image = CardService.newImage(); - * // Build image ... - * var textParagraph = CardService.newTextParagraph(); - * // Build text paragraph ... - * - * var cardSection = CardService.newCardSection() - * .setHeader("Section header") - * .addWidget(image) - * .addWidget(textParagraph); - */ - interface CardSection { - addWidget(widget: Widget): CardSection; - setCollapsible(collapsible: boolean): CardSection; - setHeader(header: string): CardSection; - setNumUncollapsibleWidgets(numUncollapsibleWidgets: Integer): CardSection; - } - /** - * CardService provides the ability to create generic cards used across different Google - * extensibility products, such as Gmail add-ons. - * - * Currently you can only use this service to construct Gmail add-ons. - * - * return CardService.newCardBuilder() - * .setHeader(CardService.newCardHeader().setTitle("CardTitle")) - * .build(); - * - * Or you can return multiple Cards like so: - * - * return [ - * CardService.newCardBuilder().build(), - * CardService.newCardBuilder().build(), - * CardService.newCardBuilder().build() - * ] - * - * The following shows how you could define a card with a header, text, an image and a menu item: - * - * function createWidgetDemoCard() { - * return CardService - * .newCardBuilder() - * .setHeader( - * CardService.newCardHeader() - * .setTitle('Widget demonstration') - * .setSubtitle('Check out these widgets') - * .setImageStyle(CardService.ImageStyle.SQUARE) - * .setImageUrl( - * 'https://www.example.com/images/headerImage.png')) - * .addSection( - * CardService.newCardSection() - * .setHeader('Simple widgets') // optional - * .addWidget(CardService.newTextParagraph().setText( - * 'These widgets are display-only. ' + - * 'A text paragraph can have multiple lines and ' + - * 'formatting.')) - * .addWidget(CardService.newImage().setImageUrl( - * 'https://www.example.com/images/mapsImage.png'))) - * .addCardAction(CardService.newCardAction().setText('Gmail').setOpenLink( - * CardService.newOpenLink().setUrl('https://mail.google.com/mail'))) - * .build(); - * } - */ - interface CardService { - BorderType: typeof BorderType; - ComposedEmailType: typeof ComposedEmailType; - ContentType: typeof ContentType; - DisplayStyle: typeof DisplayStyle; - GridItemLayout: typeof GridItemLayout; - HorizontalAlignment: typeof HorizontalAlignment; - Icon: typeof Icon; - ImageCropType: typeof ImageCropType; - ImageStyle: typeof ImageStyle; - LoadIndicator: typeof LoadIndicator; - OnClose: typeof OnClose; - OpenAs: typeof OpenAs; - SelectionInputType: typeof SelectionInputType; - SwitchControlType: typeof SwitchControlType; - TextButtonStyle: typeof TextButtonStyle; - UpdateDraftBodyType: typeof UpdateDraftBodyType; - newAction(): Action; - newActionResponseBuilder(): ActionResponseBuilder; - newAttachment(): Attachment; - newAuthorizationAction(): AuthorizationAction; - newAuthorizationException(): AuthorizationException; - /** - * Creates a new BorderStyle. - */ - newBorderStyle(): BorderStyle; - newButtonSet(): ButtonSet; - newCalendarEventActionResponseBuilder(): CalendarEventActionResponseBuilder; - newCardAction(): CardAction; - newCardBuilder(): CardBuilder; - newCardHeader(): CardHeader; - newCardSection(): CardSection; - newComposeActionResponseBuilder(): ComposeActionResponseBuilder; - newDatePicker(): DatePicker; - newDateTimePicker(): DateTimePicker; - newDecoratedText(): DecoratedText; - newDivider(): Divider; - newDriveItemsSelectedActionResponseBuilder(): DriveItemsSelectedActionResponseBuilder; - /** - * Creates a new EditorFileScopeActionResponseBuilder. - */ - newEditorFileScopeActionResponseBuilder(): EditorFileScopeActionResponseBuilder; - newFixedFooter(): FixedFooter; - newIconImage(): IconImage; - /** - * Creates a new Grid - */ - newGrid(): Grid; - /** - * Creates a new GridItem. - */ - newGridItem(): GridItem; - newImage(): Image; - newImageButton(): ImageButton; - /** - * Creates a new ImageComponent. - */ - newImageComponent(): ImageComponent; - /** - * Creates a new ImageCropStyle. - */ - newImageCropStyle(): ImageCropStyle; - newKeyValue(): KeyValue; - newLinkPreview(): LinkPreview; - newNavigation(): Navigation; - newNotification(): Notification; - newOpenLink(): OpenLink; - newSelectionInput(): SelectionInput; - newSuggestions(): Suggestions; - newSuggestionsResponseBuilder(): SuggestionsResponseBuilder; - newSwitch(): Switch; - newTextButton(): TextButton; - newTextInput(): TextInput; - newTextParagraph(): TextParagraph; - newTimePicker(): TimePicker; - newUniversalActionResponseBuilder(): UniversalActionResponseBuilder; - newUpdateDraftActionResponseBuilder(): UpdateDraftActionResponseBuilder; - newUpdateDraftBccRecipientsAction(): UpdateDraftBccRecipientsAction; - newUpdateDraftBodyAction(): UpdateDraftBodyAction; - newUpdateDraftCcRecipientsAction(): UpdateDraftCcRecipientsAction; - newUpdateDraftSubjectAction(): UpdateDraftSubjectAction; - newUpdateDraftToRecipientsAction(): UpdateDraftToRecipientsAction; - } - /** - * The response object that may be returned from a callback method for compose action in a Gmail add-on. - * - * Note: This object isn't related to compose actions that are - * used to extend the compose UI. Rather, - * this object is a response to an Action that composes draft messages when a specific UI element is - * selected. - * - * var composeActionResponse = CardService.newComposeActionResponseBuilder() - * .setGmailDraft(GmailApp.createDraft("recipient", "subject", "body")) - * .build(); - */ - interface ComposeActionResponse { - printJson(): string; - } - /** - * A builder for ComposeActionResponse objects. - * - * Note: This object isn't related to compose actions that are - * used to extend the compose UI. Rather, - * this builder creates responses to an Action that composes draft messages when a specific - * UI element is selected. - */ - interface ComposeActionResponseBuilder { - build(): ComposeActionResponse; - setGmailDraft(draft: Gmail.GmailDraft): ComposeActionResponseBuilder; - } - /** - * An enum value that specifies whether the composed email is a standalone or reply draft. - */ - enum ComposedEmailType { - REPLY_AS_DRAFT, - STANDALONE_DRAFT, - } - /** - * An enum value that specifies the content type of the content generated by a UpdateDraftActionResponse. - */ - enum ContentType { - TEXT, - MUTABLE_HTML, - IMMUTABLE_HTML, - } - /** - * Predefined icons that can be used in various UI objects, such as ImageButton or KeyValue widgets. - */ - enum Icon { - NONE, - AIRPLANE, - BOOKMARK, - BUS, - CAR, - CLOCK, - CONFIRMATION_NUMBER_ICON, - DOLLAR, - DESCRIPTION, - EMAIL, - EVENT_PERFORMER, - EVENT_SEAT, - FLIGHT_ARRIVAL, - FLIGHT_DEPARTURE, - HOTEL, - HOTEL_ROOM_TYPE, - INVITE, - MAP_PIN, - MEMBERSHIP, - MULTIPLE_PEOPLE, - OFFER, - PERSON, - PHONE, - RESTAURANT_ICON, - SHOPPING_CART, - STAR, - STORE, - TICKET, - TRAIN, - VIDEO_CAMERA, - VIDEO_PLAY, - } - /** - * A widget that shows an icon image. - * - * var icon = CardService.newIconImage().setAltText("A nice icon").setIconUrl("https://example.com/icon.png"); - */ - interface IconImage { - setAltText(altText: string): IconImage; - setIcon(icon: Icon): IconImage; - setIconUrl(url: string): IconImage; - setImageCropType(imageCropType: ImageCropType): IconImage; - } - /** - * A widget that shows a single image. - * - * var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png"); - */ - interface Image { - setAltText(altText: string): Image; - setAuthorizationAction(action: AuthorizationAction): Image; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): Image; - setImageUrl(url: string): Image; - setOnClickAction(action: Action): Image; - setOnClickOpenLinkAction(action: Action): Image; - setOpenLink(openLink: OpenLink): Image; - } - /** - * A ImageButton with an image displayed on it. - * - * var imageButton = CardService.newImageButton() - * .setAltText("An image button with an airplane icon.") - * .setIcon(CardService.Icon.AIRPLANE) - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://airplane.com")); - */ - interface ImageButton { - setAltText(altText: string): ImageButton; - setAuthorizationAction(action: AuthorizationAction): ImageButton; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): ImageButton; - setIcon(icon: Icon): ImageButton; - setIconUrl(url: string): ImageButton; - setOnClickAction(action: Action): ImageButton; - setOnClickOpenLinkAction(action: Action): ImageButton; - setOpenLink(openLink: OpenLink): ImageButton; - } - /** - * An enum that defines an image cropping style. - */ - enum ImageStyle { - SQUARE, - CIRCLE, - } - /** - * A widget that displays one or more "keys" around a text "value". The possible keys include an - * icon, a label above and a label below. Setting the text content and one of the keys is required - * using setContent(text) and one of setIcon(icon), setIconUrl(url), setTopLabel(text), - * or setBottomLabel(text). - * - * var imageKeyValue = CardService.newKeyValue() - * .setIconUrl("https://icon.png") - * .setContent("KeyValue widget with an image on the left and text on the right"); - * - * var textKeyValue = CardService.newKeyValue() - * .setTopLabel("Text key") - * .setContent("KeyValue widget with text key on top and cotent below"); - * - * var multilineKeyValue = CardService.newKeyValue() - * .setTopLabel("Top label - single line)") - * .setContent("Content can be multiple lines") - * .setMultiline(true) - * .setBottomLabel("Bottom label - single line"); - */ - interface KeyValue { - setAuthorizationAction(action: AuthorizationAction): KeyValue; - setBottomLabel(text: string): KeyValue; - setButton(button: Button): KeyValue; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): KeyValue; - setContent(text: string): KeyValue; - setIcon(icon: Icon): KeyValue; - setIconAltText(altText: string): KeyValue; - setIconUrl(url: string): KeyValue; - setMultiline(multiline: boolean): KeyValue; - setOnClickAction(action: Action): KeyValue; - setOnClickOpenLinkAction(action: Action): KeyValue; - setOpenLink(openLink: OpenLink): KeyValue; - setSwitch(switchToSet: Switch): KeyValue; - setTopLabel(text: string): KeyValue; - } - - /** - * Card action that displays a link preview card and smart chip in the host app. - * - * const decoratedText = CardService.newDecoratedText() - * .setTopLabel('Hello') - * .setText('Hi!'); - * - * const cardSection = CardService.newCardSection() - * .addWidget(decoratedText); - * - * const card = CardService.newCardBuilder() - * .addSection(cardSection) - * .build(); - * - * const linkPreview = CardService.newLinkPreview() - * .setPreviewCard(card) - * .setTitle('Smart chip title'); - */ - - interface LinkPreview { - printJson(): string; - setLinkPreviewTitle(title: string): LinkPreview; - setPreviewCard(previewCard: Card): LinkPreview; - setTitle(title: string): LinkPreview; - } - /** - * An enum type that specifies the type of loading or progress indicator to display while an Action is being processed. - */ - enum LoadIndicator { - SPINNER, - NONE, - } - /** - * A helper object that controls card navigation. See the card navigation guide for more details. - */ - interface Navigation { - popCard(): Navigation; - popToNamedCard(cardName: string): Navigation; - popToRoot(): Navigation; - printJson(): string; - pushCard(card: Card): Navigation; - updateCard(card: Card): Navigation; - } - /** - * A notification shown to the user as a response to interacting with a UI element. - * - * var action = CardService.newAction().setFunctionName("notificationCallback"); - * CardService.newTextButton().setText('Save').setOnClickAction(action); - * - * // ... - * - * function notificationCallback() { - * return CardService.newActionResponseBuilder() - * .setNotification(CardService.newNotification() - * .setText("Some info to display to user")) - * .build(); - * } - */ - interface Notification { - setText(text: string): Notification; - } - /** - * An enum that specifies what to do when a URL opened through an OpenLink is closed. - * - * When a link is opened, the client either forgets about it or waits until the window is closed. - * The implementation depends on the client platform capabilities. OnClose may cause OpenAs to be ignored; if the client platform cannot support both selected values together, - * OnClose takes precedence. - */ - enum OnClose { - NOTHING, - RELOAD, - RELOAD_ADD_ON, - } - /** - * An enum that specifies how to open a URL. - * - * The client can open a URL as either a full size window (if that is the frame used by the - * client), or an overlay (such as a pop-up). The implementation depends on the client platform - * capabilities, and the value selected may be ignored if the client does not support it. FULL_SIZE is supported by all clients. - * - * Using OnClose may cause OpenAs to be ignored; if the client platform cannot - * support both selected values together, OnClose takes precedence. - */ - enum OpenAs { - FULL_SIZE, - OVERLAY, - } - /** - * Represents an action to open a link with some options. - * - * // A button that opens as a link in an overlay and - * // requires a reload when closed. - * var button = CardService.newTextButton() - * .setText("This button opens a link in an overlay window") - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://www.google.com") - * .setOpenAs(CardService.OpenAs.OVERLAY) - * .setOnClose(CardService.OnClose.RELOAD_ADD_ON)); - * - * // An action response that opens a link in full screen and - * // requires no action when closed. - * var actionResponse = CardService.newActionResponseBuilder() - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://www.google.com") - * .setOpenAs(CardService.OpenAs.FULL_SIZE) - * .setOnClose(CardService.OnClose.NOTHING)); - * .build(); - */ - interface OpenLink { - setOnClose(onClose: OnClose): OpenLink; - setOpenAs(openAs: OpenAs): OpenLink; - setUrl(url: string): OpenLink; - } - /** - * An input field that allows choosing between a set of predefined options. - * - * var checkboxGroup = CardService.newSelectionInput() - * .setType(CardService.SelectionInputType.CHECK_BOX) - * .setTitle("A group of checkboxes. Multiple selections are allowed.") - * .setFieldName("checkbox_field") - * .addItem("checkbox one title", "checkbox_one_value", false) - * .addItem("checkbox two title", "checkbox_two_value", true) - * .addItem("checkbox three title", "checkbox_three_value", false) - * .setOnChangeAction(CardService.newAction() - * .setFunctionName("handleCheckboxChange")); - * - * var radioGroup = CardService.newSelectionInput() - * .setType(CardService.SelectionInputType.RADIO_BUTTON) - * .setTitle("A group of radio buttons. Only a single selection is allowed.") - * .setFieldName("checkbox_field") - * .addItem("radio button one title", "radio_one_value", true) - * .addItem("radio button two title", "radio_two_value", true) - * .addItem("radio button three title", "radio_three_value", false); - */ - interface SelectionInput { - addItem(text: any, value: any, selected: boolean): SelectionInput; - setFieldName(fieldName: string): SelectionInput; - setOnChangeAction(action: Action): SelectionInput; - setTitle(title: string): SelectionInput; - setType(type: SelectionInputType): SelectionInput; - } - /** - * Type of selection input. - */ - enum SelectionInputType { - CHECK_BOX, - RADIO_BUTTON, - DROPDOWN, - } - /** - * Autocomplete suggestions to supplement a TextInput widget. - * - * var textInput = CardService.newTextInput() - * .setSuggestions(CardService.newSuggestions() - * .addSuggestion("First suggestion") - * .addSuggestion("Second suggestion")) - */ - interface Suggestions { - addSuggestion(suggestion: string): Suggestions; - addSuggestions(suggestions: string[]): Suggestions; - } - /** - * A response object that can be returned from a suggestions callback function. This is used with - * TextInput widgets that implement autocomplete. - * - * var suggestionsResponse = CardService.newSuggestionsResponseBuilder() - * .setSuggestions(CardService.newSuggestions() - * .addSuggestion("First suggestion") - * .addSuggestion("Second suggestion")) - * .build(); - */ - interface SuggestionsResponse { - printJson(): string; - } - /** - * A builder for SuggestionsResponse objects. - */ - interface SuggestionsResponseBuilder { - build(): SuggestionsResponse; - setSuggestions(suggestions: Suggestions): SuggestionsResponseBuilder; - } - /** - * A UI element that supports being toggled on or off. This can only be used within a KeyValue widget. - * - * var switchKeyValue = CardService.newKeyValue() - * .setTopLabel("Switch key value widget label") - * .setContent("This is a key value widget with a switch on the right") - * .setSwitch(CardService.newSwitch() - * .setFieldName("form_input_switch_key") - * .setValue("form_input_switch_value") - * .setControlType(CardService.SwitchControlType.SWITCH) - * .setOnChangeAction(CardService.newAction() - * .setFunctionName("handleSwitchChange"))); - */ - interface Switch { - setFieldName(fieldName: string): Switch; - setOnChangeAction(action: Action): Switch; - setSelected(selected: boolean): Switch; - setValue(value: string): Switch; - setControlType(type: SwitchControlType): Switch; - } - /** - * Type of switch. - */ - enum SwitchControlType { - SWITCH, - CHECK_BOX, - } - /** - * A TextButton with a text label. You can set the background color and disable the button when - * needed. - * - * var textButton = CardService.newTextButton() - * .setText("Open Link") - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://www.google.com")); - */ - interface TextButton { - setAltText(altText: string): TextButton; - setAuthorizationAction(action: AuthorizationAction): TextButton; - setBackgroundColor(backgroundColor: string): TextButton; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): TextButton; - setDisabled(disabled: boolean): TextButton; - setOnClickAction(action: Action): TextButton; - setOnClickOpenLinkAction(action: Action): TextButton; - setOpenLink(openLink: OpenLink): TextButton; - setText(text: string): TextButton; - setTextButtonStyle(textButtonStyle: TextButtonStyle): TextButton; - } - /** - * An enum that specifies the style for TextButton. - * - * TEXT is the default; it renders a simple text button with clear background. - * FILLED buttons have a background color you can set with - * TextButton.setBackgroundColor(backgroundColor). - */ - enum TextButtonStyle { - TEXT, - FILLED, - } - /** - * A input field widget that accepts text input. - * - * var textInput = CardService.newTextInput() - * .setFieldName("text_input_form_input_key") - * .setTitle("Text input title") - * .setHint("Text input hint"); - */ - interface TextInput { - setFieldName(fieldName: string): TextInput; - setHint(hint: string): TextInput; - setMultiline(multiline: boolean): TextInput; - setOnChangeAction(action: Action): TextInput; - setSuggestions(suggestions: Suggestions): TextInput; - setSuggestionsAction(suggestionsAction: Action): TextInput; - setTitle(title: string): TextInput; - setValue(value: string): TextInput; - } - /** - * A widget that displays text and supports basic HTML formatting. - * - * var textParagraph = CardService.newTextParagraph() - * .setText("This is a text paragraph widget. Multiple lines are allowed if needed."); - */ - interface TextParagraph { - setText(text: string): TextParagraph; - } - /** - * The response object that may be returned from a method that creates universal action. - * - * // A universal action that opens a link. - * var openLinkUniversalAction = CardService.newUniversalActionResponseBuilder() - * .setOpenLink(CardService.newOpenLink() - * .setUrl("https://www.google.com")) - * .build(); - * - * var cardBuilder1 = CardService.newCardBuilder(); - * var cardBuilder2 = CardService.newCardBuilder(); - * // Finish building the cards ... - * - * // A universal action that shows two static cards. - * var cardsUniversalAction = CardService.newUniversalActionResponseBuilder() - * .displayAddOnCards([ - * cardBuilder1.build(); - * cardBuilder2.build(); - * ]).build(); - */ - interface UniversalActionResponse { - printJson(): string; - } - /** - * An input field that allows users to input a time. - * - * // A time picker with default value of 3:30 PM. - * var dateTimePicker = CardService.newTimePicker() - * .setTitle("Enter the time.") - * .setFieldName("time_field") - * .setHours(15) - * .setMinutes(30) - * .setOnChangeAction(CardService.newAction() - * .setFunctionName("handleTimeChange")); - */ - interface TimePicker { - setFieldName(fieldName: string): TimePicker; - setHours(hours: number): TimePicker; - setMinutes(hours: number): TimePicker; - setOnChangeAction(action: Action): TimePicker; - setTitle(title: string): TimePicker; - } - /** - * A builder for the UniversalActionResponse objects. - */ - interface UniversalActionResponseBuilder { - build(): UniversalActionResponse; - displayAddOnCards(cardObjects: Card[]): UniversalActionResponseBuilder; - setOpenLink(openLink: OpenLink): UniversalActionResponseBuilder; - } - /** - * Represents an action that updates the email draft that the user is currently editing. - * - * // A UpdateDraftActionResponse that inserts non-editable content (a link in this case) into an - * // email draft. - * var updateDraftActionResponse = CardService.newUpdateDraftActionResponseBuilder() - * .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction() - * .addUpdateContent( - * "Google", - * ContentType.IMMUTABLE_HTML) - * .setUpdateType(UpdateDraftBodyType.IN_PLACE_INSERT)) - * .build(); - * - * // A UpdateDraftActionResponse that inserts a link into an email draft. The added content can be - * // edited further. - * var updateDraftActionResponse = CardService.newUpdateDraftActionResponseBuilder() - * .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction() - * .addUpdateContent( - * "Google", - * ContentType.MUTABLE_HTML) - * .setUpdateType(UpdateDraftBodyType.IN_PLACE_INSERT)) - * .build(); - * - * // A UpdateDraftActionResponse that inserts multiple values of different types. - * // The example action response inserts two lines next to each other in the email - * // draft, at the cursor position. Each line contains the content added by - * // {@link UpdateDraftActionResponseBuilder#addUpdateContent}. - * var updateDraftActionResponse = CardService.newUpdateDraftActionResponseBuilder() - * .setUpdateDraftBodyAction(CardService.newUpdateDraftBodyAction() - * .addUpdateContent( - * "Google", - * ContentType.MUTABLE_HTML) - * .addUpdateContent("Above is a google link.", ContentType.PLAIN_TEXT) - * .setUpdateType(UpdateDraftBodyType.IN_PLACE_INSERT)) - * .build(); - */ - interface UpdateDraftActionResponse { - printJson(): string; - } - /** - * A builder for UpdateDraftActionResponse objects. - */ - interface UpdateDraftActionResponseBuilder { - build(): UpdateDraftActionResponse; - setUpdateDraftBccRecipientsAction( - updateDraftBccRecipientsAction: UpdateDraftBccRecipientsAction, - ): UpdateDraftActionResponseBuilder; - setUpdateDraftBodyAction(updateDraftBodyAction: UpdateDraftBodyAction): UpdateDraftActionResponseBuilder; - setUpdateDraftCcRecipientsAction( - updateDraftCcRecipientsAction: UpdateDraftCcRecipientsAction, - ): UpdateDraftActionResponseBuilder; - setUpdateDraftSubjectAction( - updateDraftSubjectAction: UpdateDraftSubjectAction, - ): UpdateDraftActionResponseBuilder; - setUpdateDraftToRecipientsAction( - updateDraftToRecipientsAction: UpdateDraftToRecipientsAction, - ): UpdateDraftActionResponseBuilder; - } - /** - * Represents an action that updates the email draft body. - */ - interface UpdateDraftBodyAction { - addUpdateContent(content: string, contentType: ContentType): UpdateDraftBodyAction; - setUpdateType(updateType: UpdateDraftBodyType): UpdateDraftBodyAction; - } - - /** - * Sets an action that updates the email Bcc recipients of a draft. - */ - interface UpdateDraftBccRecipientsAction { - addUpdateBccRecipients(bccRecipientEmails: string[]): UpdateDraftBccRecipientsAction; - } - - /** - * Sets an action that updates the Cc recipients of a draft. - */ - interface UpdateDraftCcRecipientsAction { - addUpdateCcRecipients(ccRecipientEmails: string[]): UpdateDraftCcRecipientsAction; - } - - /** - * Updates the subject line of an email draft. - */ - interface UpdateDraftSubjectAction { - addUpdateSubject(subject: string): UpdateDraftSubjectAction; - } - - /** - * Updates the To recipients of an email draft. - */ - interface UpdateDraftToRecipientsAction { - addUpdateToRecipients(toRecipientEmails: string[]): UpdateDraftToRecipientsAction; - } - /** - * The fixed footer shown at the bottom of an add-on Card. - */ - interface FixedFooter { - setPrimaryButton(button: TextButton): FixedFooter; - setSecondaryButton(button: TextButton): FixedFooter; - } - - /** - * Represents a response that makes changes to the calendar event that the user is currently editing in reaction to an action taken in the UI, such as a button click. - */ - interface CalendarEventActionResponse { - printJson(): string; - } - - /** - * A builder for CalendarEventActionResponse objects. - */ - interface CalendarEventActionResponseBuilder { - addAttachments(attachments: Attachment[]): CalendarEventActionResponseBuilder; - addAttendees(emails: string[]): CalendarEventActionResponseBuilder; - build(): CalendarEventActionResponse; - setConferenceData(conferenceData: Conference_Data.ConferenceData): CalendarEventActionResponseBuilder; - } - - /** - * An input field that allows inputing a date. - */ - interface DatePicker { - setFieldName(fieldName: string): DatePicker; - setOnChangeAction(action: Action): DatePicker; - setTitle(title: string): DatePicker; - setValueInMsSinceEpoch(valueMsEpoch: number): DatePicker; - setValueInMsSinceEpoch(valueMsEpoch: string): DatePicker; - } - - /** - * An input field that allows inputing a date. - */ - interface DateTimePicker { - setFieldName(fieldName: string): DateTimePicker; - setOnChangeAction(action: Action): DateTimePicker; - setTimeZoneOffsetInMins(timeZoneOffsetMins: Integer): DateTimePicker; - setTitle(title: string): DateTimePicker; - setValueInMsSinceEpoch(valueMsEpoch: number): DateTimePicker; - setValueInMsSinceEpoch(valueMsEpoch: string): DateTimePicker; - } - - /** - * A widget that displays text with optional decorations. Possible keys include an icon, a label - * above and a label below. Setting the text content and one of the keys is required using setText(text) - * and one of setIcon(icon), setIconUrl(url), setTopLabel(text), or setBottomLabel(text). - * This class is intended to replace KeyValue. - */ - interface DecoratedText { - setAuthorizationAction(action: AuthorizationAction): DecoratedText; - setBottomLabel(text: string): DecoratedText; - setButton(button: Button): DecoratedText; - setComposeAction(action: Action, composedEmailType: ComposedEmailType): DecoratedText; - setEndIcon(endIcon: IconImage): DecoratedText; - setIcon(icon: Icon): DecoratedText; - setIconAltText(altText: string): DecoratedText; - setIconUrl(url: string): DecoratedText; - setOnClickAction(action: Action): DecoratedText; - setOnClickOpenLinkAction(action: Action): DecoratedText; - setOpenLink(openLink: OpenLink): DecoratedText; - setStartIcon(startIcon: IconImage): DecoratedText; - setSwitchControl(switchToSet: Switch): DecoratedText; - setText(text: string): DecoratedText; - setTopLabel(text: string): DecoratedText; - setWrapText(wrapText: boolean): DecoratedText; - } - - /** - * A horizontal divider. - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface Divider { - } - - /** - * An enum that represents the border types that can be applied to widgets. - */ - enum BorderType { - /** No border style. */ - NO_BORDER, - /** Stroke border style. */ - STROKE, - } - - /** - * An enum that defines the image and text style of a GridItem. - */ - enum GridItemLayout { - /** The title and subtitle are shown below the grid item's image. */ - TEXT_BELOW, - /** The title and subtitle are shown above the grid item's image. */ - TEXT_ABOVE, - } - - /** - * An enum that specifies the horizontal alignment of a widget. - */ - enum HorizontalAlignment { - /** Align the widget to the start of the sentence side. */ - START, - /** Align the widget to the center. */ - CENTER, - /** Align the widget to the end of the sentence side. */ - END, - } - - /** - * An enum that represents the crop styles applied to image components. - * If you want to apply a crop style to an IconImage, you can only use SQUARE or CIRCLE. - */ - enum ImageCropType { - /** Square shape crop style. */ - SQUARE, - /** Circle shape crop style. */ - CIRCLE, - /** Rectangle shape crop style with custom ratio. */ - RECTANGLE_CUSTOM, - /** Rectangle shape crop style with 4:3 ratio. */ - RECTANGLE_4_3, - } - - /** - * A class that represents a complete border style that can be applied to widgets. - */ - interface BorderStyle { - /** - * Sets the corner radius of the border, for example 8. - */ - setCornerRadius(radius: number): BorderStyle; - /** - * The color in #RGB format to be applied to the border. - */ - setStrokeColor(color: string): BorderStyle; - /** - * Sets the type of the border. - */ - setType(type: BorderType): BorderStyle; - } - - /** - * A class that represents a crop style that can be applied to image components. - */ - interface ImageCropStyle { - /** - * Sets the aspect ratio to use if the crop type is RECTANGLE_CUSTOM. The ratio must be a positive value. - */ - setAspectRatio(ratio: number): ImageCropStyle; - /** - * Sets the crop type for the image. - */ - setImageCropType(type: ImageCropType): ImageCropStyle; - } - - /** - * An image component that can be added to grid items. - */ - interface ImageComponent { - /** - * Sets the alternative text of the image. - */ - setAltText(altText: string): ImageComponent; - /** - * Sets the border style applied to the image. - */ - setBorderStyle(borderStyle: BorderStyle): ImageComponent; - /** - * Sets the crop style for the image. - */ - setCropStyle(imageCropStyle: ImageCropStyle): ImageComponent; - /** - * Sets the URL of the image. - */ - setImageUrl(url: string): ImageComponent; - } - - /** - * The items users interact with within a grid widget. - */ - interface GridItem { - /** - * Sets the identifier for the grid item. When a user clicks this grid item, - * this ID is returned in the parent grid's on_click call back parameters. - */ - setIdentifier(id: string): GridItem; - /** - * Sets the image for this grid item. - */ - setImage(image: ImageComponent): GridItem; - /** - * Sets the layout of text and image for the grid item. Default is TEXT_BELOW - */ - setLayout(layout: GridItemLayout): GridItem; - /** - * Sets the subtitle of the grid item. - */ - setSubtitle(subtitle: string): GridItem; - /** - * Sets the horizontal alignment of the grid item. Default is START. - */ - setTextAlignment(alignment: HorizontalAlignment): GridItem; - /** - * Sets the title text of the grid item. - */ - setTitle(title: string): GridItem; - } - - /** - * An organized grid to display a collection of grid items. - */ - interface Grid { - /** - * Adds a new grid item to the grid. - */ - addItem(gridItem: GridItem): Grid; - /** - * Sets an authorization action that opens a URL to the authorization flow when the object is clicked. - */ - setAuthorizationAction(action: AuthorizationAction): Grid; - /** - * Sets the border style applied to each grid item. - */ - setBorderStyle(borderStyle: BorderStyle): Grid; - /** - * Sets an action that composes a draft email when the object is clicked. - */ - setComposeAction(action: Action, composedEmailType: ComposedEmailType): Grid; - /** - * The number of columns to display in the grid. - */ - setNumColumns(numColumns: number): Grid; - /** - * Sets an action that executes when the object is clicked. - */ - setOnClickAction(action: Action): Grid; - /** - * Sets an action that opens a URL in a tab when the object is clicked. - */ - setOnClickOpenLinkAction(action: Action): Grid; - /** - * Sets a URL to be opened when the object is clicked. - */ - setOpenLink(openLink: OpenLink): Grid; - /** - * Sets the title text of the grid. - */ - setTitle(title: string): Grid; - } - - /** - * A builder for DriveItemsSelectedActionResponse objects. - */ - interface DriveItemsSelectedActionResponseBuilder { - build(): DriveItemsSelectedActionResponse; - requestFileScope(itemId: string): DriveItemsSelectedActionResponseBuilder; - } - - /** - * Represents a response that makes changes to Drive while Drive items are selected and in reaction to an action taken in the UI, such as a button click. - */ - interface DriveItemsSelectedActionResponse { - printJson(): string; - } - - /** - * Makes changes to an Editor, such as Google Docs, Sheets, or Slides in reaction to an action taken in the UI. - */ - interface EditorFileScopeActionResponse { - /** - * Prints the JSON representation of this object. - */ - printJson(): string; - } - /** - * A builder for EditorFileScopeActionResponse objects. - */ - interface EditorFileScopeActionResponseBuilder { - /** - * Builds the current Editor action response. - */ - build(): EditorFileScopeActionResponse; - /** - * Requests the drive.file scope for the current active Editor document. - */ - requestFileScopeForActiveDocument(): EditorFileScopeActionResponseBuilder; - } - - /** - * An enum value that specifies the type of an UpdateDraftBodyAction. - */ - enum UpdateDraftBodyType { - IN_PLACE_INSERT, - } - /** - * Base class for all widgets that can be added to a Card. - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface Widget { - } - } -} - -declare var CardService: GoogleAppsScript.Card_Service.CardService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.charts.d.ts b/node_modules/@types/google-apps-script/google-apps-script.charts.d.ts deleted file mode 100644 index 439c639..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.charts.d.ts +++ /dev/null @@ -1,697 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Charts { - /** - * Builder for area charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build an area chart. - * - * // Create a data table with some sample data. - * var sampleData = Charts.newDataTable() - * .addColumn(Charts.ColumnType.STRING, "Month") - * .addColumn(Charts.ColumnType.NUMBER, "Dining") - * .addColumn(Charts.ColumnType.NUMBER, "Total") - * .addRow(["Jan", 60, 520]) - * .addRow(["Feb", 50, 430]) - * .addRow(["Mar", 53, 440]) - * .addRow(["Apr", 70, 410]) - * .addRow(["May", 80, 390]) - * .addRow(["Jun", 60, 500]) - * .addRow(["Jul", 100, 450]) - * .addRow(["Aug", 140, 431]) - * .addRow(["Sep", 75, 488]) - * .addRow(["Oct", 70, 521]) - * .addRow(["Nov", 58, 388]) - * .addRow(["Dec", 63, 400]) - * .build(); - * - * var chart = Charts.newAreaChart() - * .setTitle('Yearly Spending') - * .setXAxisTitle('Month') - * .setYAxisTitle('Spending (USD)') - * .setDimensions(600, 500) - * .setStacked() - * .setColors(['red', 'green']) - * .setDataTable(sampleData) - * .build(); - */ - interface AreaChartBuilder { - build(): Chart; - reverseCategories(): AreaChartBuilder; - setBackgroundColor(cssValue: string): AreaChartBuilder; - setColors(cssValues: string[]): AreaChartBuilder; - setDataSourceUrl(url: string): AreaChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): AreaChartBuilder; - setDataTable(table: DataTableSource): AreaChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): AreaChartBuilder; - setDimensions(width: Integer, height: Integer): AreaChartBuilder; - setLegendPosition(position: Position): AreaChartBuilder; - setLegendTextStyle(textStyle: TextStyle): AreaChartBuilder; - setOption(option: string, value: any): AreaChartBuilder; - setPointStyle(style: PointStyle): AreaChartBuilder; - setRange(start: number, end: number): AreaChartBuilder; - setStacked(): AreaChartBuilder; - setTitle(chartTitle: string): AreaChartBuilder; - setTitleTextStyle(textStyle: TextStyle): AreaChartBuilder; - setXAxisTextStyle(textStyle: TextStyle): AreaChartBuilder; - setXAxisTitle(title: string): AreaChartBuilder; - setXAxisTitleTextStyle(textStyle: TextStyle): AreaChartBuilder; - setYAxisTextStyle(textStyle: TextStyle): AreaChartBuilder; - setYAxisTitle(title: string): AreaChartBuilder; - setYAxisTitleTextStyle(textStyle: TextStyle): AreaChartBuilder; - useLogScale(): AreaChartBuilder; - } - /** - * Builder for bar charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build a bar chart. The data is imported from a - * Google spreadsheet. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=B1%3AC11' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=0&headers=-1'; - * - * var chartBuilder = Charts.newBarChart() - * .setTitle('Top Grossing Films in US and Canada') - * .setXAxisTitle('USD') - * .setYAxisTitle('Film') - * .setDimensions(600, 500) - * .setLegendPosition(Charts.Position.BOTTOM) - * .setDataSourceUrl(dataSourceUrl); - * - * var chart = chartBuilder.build(); - */ - interface BarChartBuilder { - build(): Chart; - reverseCategories(): BarChartBuilder; - reverseDirection(): BarChartBuilder; - setBackgroundColor(cssValue: string): BarChartBuilder; - setColors(cssValues: string[]): BarChartBuilder; - setDataSourceUrl(url: string): BarChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): BarChartBuilder; - setDataTable(table: DataTableSource): BarChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): BarChartBuilder; - setDimensions(width: Integer, height: Integer): BarChartBuilder; - setLegendPosition(position: Position): BarChartBuilder; - setLegendTextStyle(textStyle: TextStyle): BarChartBuilder; - setOption(option: string, value: any): BarChartBuilder; - setRange(start: number, end: number): BarChartBuilder; - setStacked(): BarChartBuilder; - setTitle(chartTitle: string): BarChartBuilder; - setTitleTextStyle(textStyle: TextStyle): BarChartBuilder; - setXAxisTextStyle(textStyle: TextStyle): BarChartBuilder; - setXAxisTitle(title: string): BarChartBuilder; - setXAxisTitleTextStyle(textStyle: TextStyle): BarChartBuilder; - setYAxisTextStyle(textStyle: TextStyle): BarChartBuilder; - setYAxisTitle(title: string): BarChartBuilder; - setYAxisTitleTextStyle(textStyle: TextStyle): BarChartBuilder; - useLogScale(): BarChartBuilder; - } - /** - * A Chart object, which can be converted to a static image. For charts embedded in spreadsheets, - * see EmbeddedChart. - */ - interface Chart { - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getOptions(): ChartOptions; - } - /** - * An enumeration of how hidden dimensions in a source are expressed in a chart. - */ - enum ChartHiddenDimensionStrategy { - IGNORE_BOTH, - IGNORE_ROWS, - IGNORE_COLUMNS, - SHOW_BOTH, - } - /** - * An enumeration of how multiple ranges in the source are expressed in a chart. - */ - enum ChartMergeStrategy { - MERGE_COLUMNS, - MERGE_ROWS, - } - /** - * Exposes options currently configured for a Chart, such as height, color, etc. - * - * Please see the visualization - * reference documentation for information on what options are available. Specific options for - * each chart can be found by clicking on the specific chart in the chart gallery. - * - * These options are immutable. - */ - interface ChartOptions { - get(option: string): any; - } - /** - * Chart types supported by the Charts service. - */ - enum ChartType { - TIMELINE, - AREA, - BAR, - BUBBLE, - CANDLESTICK, - COLUMN, - COMBO, - GAUGE, - GEO, - HISTOGRAM, - RADAR, - LINE, - ORG, - PIE, - SCATTER, - SPARKLINE, - STEPPED_AREA, - TABLE, - TREEMAP, - WATERFALL, - } - /** - * Entry point for creating Charts in scripts. - * - * This example creates a basic data table, populates an area chart with the data, and adds it - * into a web page as an image: - * - * function doGet() { - * var data = Charts.newDataTable() - * .addColumn(Charts.ColumnType.STRING, "Month") - * .addColumn(Charts.ColumnType.NUMBER, "In Store") - * .addColumn(Charts.ColumnType.NUMBER, "Online") - * .addRow(["January", 10, 1]) - * .addRow(["February", 12, 1]) - * .addRow(["March", 20, 2]) - * .addRow(["April", 25, 3]) - * .addRow(["May", 30, 4]) - * .build(); - * - * var chart = Charts.newAreaChart() - * .setDataTable(data) - * .setStacked() - * .setRange(0, 40) - * .setTitle("Sales per Month") - * .build(); - * - * var htmlOutput = HtmlService.createHtmlOutput().setTitle('My Chart'); - * var imageData = Utilities.base64Encode(chart.getAs('image/png').getBytes()); - * var imageUrl = "data:image/png;base64," + encodeURI(imageData); - * htmlOutput.append("Render chart server side:
"); - * htmlOutput.append(""); - * return htmlOutput; - * } - */ - interface Charts { - ChartHiddenDimensionStrategy: typeof ChartHiddenDimensionStrategy; - ChartMergeStrategy: typeof ChartMergeStrategy; - ChartType: typeof ChartType; - ColumnType: typeof ColumnType; - CurveStyle: typeof CurveStyle; - PointStyle: typeof PointStyle; - Position: typeof Position; - newAreaChart(): AreaChartBuilder; - newBarChart(): BarChartBuilder; - newColumnChart(): ColumnChartBuilder; - newDataTable(): DataTableBuilder; - newDataViewDefinition(): DataViewDefinitionBuilder; - newLineChart(): LineChartBuilder; - newPieChart(): PieChartBuilder; - newScatterChart(): ScatterChartBuilder; - newTableChart(): TableChartBuilder; - newTextStyle(): TextStyleBuilder; - } - /** - * Builder for column charts. For more details, see the Google Charts documentation. - * - * This example shows how to create a column chart with data from a data table. - * - * var sampleData = Charts.newDataTable() - * .addColumn(Charts.ColumnType.STRING, "Year") - * .addColumn(Charts.ColumnType.NUMBER, "Sales") - * .addColumn(Charts.ColumnType.NUMBER, "Expenses") - * .addRow(["2004", 1000, 400]) - * .addRow(["2005", 1170, 460]) - * .addRow(["2006", 660, 1120]) - * .addRow(["2007", 1030, 540]) - * .addRow(["2008", 800, 600]) - * .addRow(["2009", 943, 678]) - * .addRow(["2010", 1020, 550]) - * .addRow(["2011", 910, 700]) - * .addRow(["2012", 1230, 840]) - * .build(); - * - * var chart = Charts.newColumnChart() - * .setTitle('Sales & Expenses') - * .setXAxisTitle('Year') - * .setYAxisTitle('Amount (USD)') - * .setDimensions(600, 500) - * .setDataTable(sampleData) - * .build(); - */ - interface ColumnChartBuilder { - build(): Chart; - reverseCategories(): ColumnChartBuilder; - setBackgroundColor(cssValue: string): ColumnChartBuilder; - setColors(cssValues: string[]): ColumnChartBuilder; - setDataSourceUrl(url: string): ColumnChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): ColumnChartBuilder; - setDataTable(table: DataTableSource): ColumnChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): ColumnChartBuilder; - setDimensions(width: Integer, height: Integer): ColumnChartBuilder; - setLegendPosition(position: Position): ColumnChartBuilder; - setLegendTextStyle(textStyle: TextStyle): ColumnChartBuilder; - setOption(option: string, value: any): ColumnChartBuilder; - setRange(start: number, end: number): ColumnChartBuilder; - setStacked(): ColumnChartBuilder; - setTitle(chartTitle: string): ColumnChartBuilder; - setTitleTextStyle(textStyle: TextStyle): ColumnChartBuilder; - setXAxisTextStyle(textStyle: TextStyle): ColumnChartBuilder; - setXAxisTitle(title: string): ColumnChartBuilder; - setXAxisTitleTextStyle(textStyle: TextStyle): ColumnChartBuilder; - setYAxisTextStyle(textStyle: TextStyle): ColumnChartBuilder; - setYAxisTitle(title: string): ColumnChartBuilder; - setYAxisTitleTextStyle(textStyle: TextStyle): ColumnChartBuilder; - useLogScale(): ColumnChartBuilder; - } - /** - * An enumeration of the valid data types for columns in a DataTable. - */ - enum ColumnType { - DATE, - NUMBER, - STRING, - } - /** - * An enumeration of the styles for curves in a chart. - */ - enum CurveStyle { - NORMAL, - SMOOTH, - } - /** - * A Data Table to be used in charts. A DataTable can come from sources such as Google - * Sheets or specified data-table URLs, or can be filled in by hand. This class intentionally has no - * methods: a DataTable can be passed around, but not manipulated directly. - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface DataTable { - } - /** - * Builder of DataTable objects. Building a data table consists of first specifying its columns, and - * then adding its rows, one at a time. Example: - * - * var data = Charts.newDataTable() - * .addColumn(Charts.ColumnType.STRING, "Month") - * .addColumn(Charts.ColumnType.NUMBER, "In Store") - * .addColumn(Charts.ColumnType.NUMBER, "Online") - * .addRow(["January", 10, 1]) - * .addRow(["February", 12, 1]) - * .addRow(["March", 20, 2]) - * .addRow(["April", 25, 3]) - * .addRow(["May", 30, 4]) - * .build(); - */ - interface DataTableBuilder { - addColumn(type: ColumnType, label: string): DataTableBuilder; - addRow(values: any[]): DataTableBuilder; - build(): DataTable; - setValue(row: Integer, column: Integer, value: any): DataTableBuilder; - } - /** - * Interface for objects that can represent their data as a DataTable. - * Implementing classes - * - * NameBrief description - * - * DataTableA Data Table to be used in charts. - * - * RangeAccess and modify spreadsheet ranges. - */ - interface DataTableSource { - getDataTable(): DataTable; - } - /** - * A data view definition for visualizing chart data. - * - * Data view definition can be set for charts to visualize a view derived from the given data - * table and not the data table itself. For example if the view definition of a chart states that - * the view columns are [0, 3], only the first and the third columns of the data table is taken into - * consideration when drawing the chart. See DataViewDefinitionBuilder for an example on how - * to define and use a DataViewDefinition. - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface DataViewDefinition { - } - /** - * Builder for DataViewDefinition objects. - * - * Here's an example of using the builder. The data is imported - * from a Google spreadsheet. - * - * function doGet() { - * // This example creates two table charts side by side. One uses a data view definition to - * // restrict the number of displayed columns. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AF' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1'; - * - * // Create a chart to display all of the data. - * var originalChart = Charts.newTableChart() - * .setDimensions(600, 500) - * .setDataSourceUrl(dataSourceUrl) - * .build(); - * - * // Create another chart to display a subset of the data (only columns 1 and 4). - * var dataViewDefinition = Charts.newDataViewDefinition().setColumns([0, 3]); - * var limitedChart = Charts.newTableChart() - * .setDimensions(200, 500) - * .setDataSourceUrl(dataSourceUrl) - * .setDataViewDefinition(dataViewDefinition) - * .build(); - * - * var htmlOutput = HtmlService.createHtmlOutput(); - * var originalChartData = Utilities.base64Encode(originalChart.getAs('image/png').getBytes()); - * var originalChartUrl = "data:image/png;base64," + encodeURI(originalChartData); - * var limitedChartData = Utilities.base64Encode(limitedChart.getAs('image/png').getBytes()); - * var limitedChartUrl = "data:image/png;base64," + encodeURI(limitedChartData); - * htmlOutput.append("
"); - * htmlOutput.append(""); - * htmlOutput.append(""); - * htmlOutput.append(""); - * htmlOutput.append("
"); - * return htmlOutput; - * } - */ - interface DataViewDefinitionBuilder { - build(): DataViewDefinition; - setColumns(columns: any[]): DataViewDefinitionBuilder; - } - /** - * Builder for line charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build a line chart. The data is imported from a Google spreadsheet. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AG5' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=2&headers=-1'; - * - * var chartBuilder = Charts.newLineChart() - * .setTitle('Yearly Rainfall') - * .setXAxisTitle('Month') - * .setYAxisTitle('Rainfall (in)') - * .setDimensions(600, 500) - * .setCurveStyle(Charts.CurveStyle.SMOOTH) - * .setPointStyle(Charts.PointStyle.MEDIUM) - * .setDataSourceUrl(dataSourceUrl); - * - * var chart = chartBuilder.build(); - */ - interface LineChartBuilder { - build(): Chart; - reverseCategories(): LineChartBuilder; - setBackgroundColor(cssValue: string): LineChartBuilder; - setColors(cssValues: string[]): LineChartBuilder; - setCurveStyle(style: CurveStyle): LineChartBuilder; - setDataSourceUrl(url: string): LineChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): LineChartBuilder; - setDataTable(table: DataTableSource): LineChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): LineChartBuilder; - setDimensions(width: Integer, height: Integer): LineChartBuilder; - setLegendPosition(position: Position): LineChartBuilder; - setLegendTextStyle(textStyle: TextStyle): LineChartBuilder; - setOption(option: string, value: any): LineChartBuilder; - setPointStyle(style: PointStyle): LineChartBuilder; - setRange(start: number, end: number): LineChartBuilder; - setTitle(chartTitle: string): LineChartBuilder; - setTitleTextStyle(textStyle: TextStyle): LineChartBuilder; - setXAxisTextStyle(textStyle: TextStyle): LineChartBuilder; - setXAxisTitle(title: string): LineChartBuilder; - setXAxisTitleTextStyle(textStyle: TextStyle): LineChartBuilder; - setYAxisTextStyle(textStyle: TextStyle): LineChartBuilder; - setYAxisTitle(title: string): LineChartBuilder; - setYAxisTitleTextStyle(textStyle: TextStyle): LineChartBuilder; - useLogScale(): LineChartBuilder; - } - /** - * An enumeration of how a string value should be matched. Matching a string is a boolean operation. - * Given a string, a match term (string), and a match type, the operation outputs true in - * the following cases: - * - * If the match type equals EXACT and the match term equals the string. - * - * If the match type equals PREFIX and the match term is a prefix of the string. - * - * If the match type equals ANY and the match term is a substring of the string. - * - * This enumeration can be used in by a string filter control to decide which rows to filter out - * of the data table. Given a column to filter on, leave only the rows that match the value entered - * in the filter input box, using one of the above matching types. - */ - enum MatchType { - EXACT, - PREFIX, - ANY, - } - /** - * A builder for number range filter controls. - * - * A number range filter is a slider with two thumbs that lets the user select ranges of numeric - * values. Given a column of type number and matching options, this control filters out the rows - * that don't match the range that was selected. - * - * For more details, see the Gviz - * documentation. - */ - interface NumberRangeFilterBuilder { - setMaxValue(maxValue: Integer): NumberRangeFilterBuilder; - setMinValue(minValue: Integer): NumberRangeFilterBuilder; - setOrientation(orientation: Orientation): NumberRangeFilterBuilder; - setShowRangeValues(showRangeValues: boolean): NumberRangeFilterBuilder; - setTicks(ticks: Integer): NumberRangeFilterBuilder; - } - /** - * An enumeration of the orientation of an object. - */ - enum Orientation { - HORIZONTAL, - VERTICAL, - } - /** - * An enumeration of how to display selected values in picker widget. - */ - enum PickerValuesLayout { - ASIDE, - BELOW, - BELOW_WRAPPING, - BELOW_STACKED, - } - /** - * A builder for pie charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build a pie chart. The data is imported from a Google spreadsheet. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AB8' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=3&headers=-1'; - * - * var chartBuilder = Charts.newPieChart() - * .setTitle('World Population by Continent') - * .setDimensions(600, 500) - * .set3D() - * .setDataSourceUrl(dataSourceUrl); - * - * var chart = chartBuilder.build(); - */ - interface PieChartBuilder { - build(): Chart; - reverseCategories(): PieChartBuilder; - set3D(): PieChartBuilder; - setBackgroundColor(cssValue: string): PieChartBuilder; - setColors(cssValues: string[]): PieChartBuilder; - setDataSourceUrl(url: string): PieChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): PieChartBuilder; - setDataTable(table: DataTableSource): PieChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): PieChartBuilder; - setDimensions(width: Integer, height: Integer): PieChartBuilder; - setLegendPosition(position: Position): PieChartBuilder; - setLegendTextStyle(textStyle: TextStyle): PieChartBuilder; - setOption(option: string, value: any): PieChartBuilder; - setTitle(chartTitle: string): PieChartBuilder; - setTitleTextStyle(textStyle: TextStyle): PieChartBuilder; - } - /** - * An enumeration of the styles of points in a line. - */ - enum PointStyle { - NONE, - TINY, - MEDIUM, - LARGE, - HUGE, - } - /** - * An enumeration of legend positions within a chart. - */ - enum Position { - TOP, - RIGHT, - BOTTOM, - NONE, - } - /** - * Builder for scatter charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build a scatter chart. The data is imported from a Google spreadsheet. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=C1%3AD' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1'; - * - * var chartBuilder = Charts.newScatterChart() - * .setTitle('Adjusted GDP & U.S. Population') - * .setXAxisTitle('U.S. Population (millions)') - * .setYAxisTitle('Adjusted GDP ($ billions)') - * .setDimensions(600, 500) - * .setLegendPosition(Charts.Position.NONE) - * .setDataSourceUrl(dataSourceUrl); - * - * var chart = chartBuilder.build(); - */ - interface ScatterChartBuilder { - build(): Chart; - setBackgroundColor(cssValue: string): ScatterChartBuilder; - setColors(cssValues: string[]): ScatterChartBuilder; - setDataSourceUrl(url: string): ScatterChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): ScatterChartBuilder; - setDataTable(table: DataTableSource): ScatterChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): ScatterChartBuilder; - setDimensions(width: Integer, height: Integer): ScatterChartBuilder; - setLegendPosition(position: Position): ScatterChartBuilder; - setLegendTextStyle(textStyle: TextStyle): ScatterChartBuilder; - setOption(option: string, value: any): ScatterChartBuilder; - setPointStyle(style: PointStyle): ScatterChartBuilder; - setTitle(chartTitle: string): ScatterChartBuilder; - setTitleTextStyle(textStyle: TextStyle): ScatterChartBuilder; - setXAxisLogScale(): ScatterChartBuilder; - setXAxisRange(start: number, end: number): ScatterChartBuilder; - setXAxisTextStyle(textStyle: TextStyle): ScatterChartBuilder; - setXAxisTitle(title: string): ScatterChartBuilder; - setXAxisTitleTextStyle(textStyle: TextStyle): ScatterChartBuilder; - setYAxisLogScale(): ScatterChartBuilder; - setYAxisRange(start: number, end: number): ScatterChartBuilder; - setYAxisTextStyle(textStyle: TextStyle): ScatterChartBuilder; - setYAxisTitle(title: string): ScatterChartBuilder; - setYAxisTitleTextStyle(textStyle: TextStyle): ScatterChartBuilder; - } - /** - * A builder for string filter controls. - * - * A string filter is a simple text input field that lets the user filter data via string - * matching. Given a column of type string and matching options, this control filters out the rows - * that don't match the term that's in the input field. - * - * For more details, see the Gviz - * documentation. - */ - interface StringFilterBuilder { - setCaseSensitive(caseSensitive: boolean): StringFilterBuilder; - setMatchType(matchType: MatchType): StringFilterBuilder; - setRealtimeTrigger(realtimeTrigger: boolean): StringFilterBuilder; - } - /** - * A builder for table charts. For more details, see the Google Charts documentation. - * - * Here is an example that shows how to build a table chart. The data is imported from a Google spreadsheet. - * - * // Get sample data from a spreadsheet. - * var dataSourceUrl = 'https://docs.google.com/spreadsheet/tq?range=A1%3AF' + - * '&key=0Aq4s9w_HxMs7dHpfX05JdmVSb1FpT21sbXd4NVE3UEE&gid=4&headers=-1'; - * - * var chartBuilder = Charts.newTableChart() - * .setDimensions(600, 500) - * .enablePaging(20) - * .setDataSourceUrl(dataSourceUrl); - * - * var chart = chartBuilder.build(); - */ - interface TableChartBuilder { - build(): Chart; - enablePaging(enablePaging: boolean): TableChartBuilder; - enablePaging(pageSize: Integer): TableChartBuilder; - enablePaging(pageSize: Integer, startPage: Integer): TableChartBuilder; - enableRtlTable(rtlEnabled: boolean): TableChartBuilder; - enableSorting(enableSorting: boolean): TableChartBuilder; - setDataSourceUrl(url: string): TableChartBuilder; - setDataTable(tableBuilder: DataTableBuilder): TableChartBuilder; - setDataTable(table: DataTableSource): TableChartBuilder; - setDataViewDefinition(dataViewDefinition: DataViewDefinition): TableChartBuilder; - setDimensions(width: Integer, height: Integer): TableChartBuilder; - setFirstRowNumber(number: Integer): TableChartBuilder; - setInitialSortingAscending(column: Integer): TableChartBuilder; - setInitialSortingDescending(column: Integer): TableChartBuilder; - setOption(option: string, value: any): TableChartBuilder; - showRowNumberColumn(showRowNumber: boolean): TableChartBuilder; - useAlternatingRowStyle(alternate: boolean): TableChartBuilder; - } - /** - * A text style configuration object. Used in charts options to configure text style for elements - * that accepts it, such as title, horizontal axis, vertical axis, legend and tooltip. - * - * // This example creates a chart specifying different text styles for the title and axes. - * var sampleData = Charts.newDataTable() - * .addColumn(Charts.ColumnType.STRING, "Seasons") - * .addColumn(Charts.ColumnType.NUMBER, "Rainy Days") - * .addRow(["Winter", 5]) - * .addRow(["Spring", 12]) - * .addRow(["Summer", 8]) - * .addRow(["Fall", 8]) - * .build(); - * - * var titleTextStyleBuilder = Charts.newTextStyle() - * .setColor('#0000FF').setFontSize(26).setFontName('Ariel'); - * var axisTextStyleBuilder = Charts.newTextStyle() - * .setColor('#3A3A3A').setFontSize(20).setFontName('Ariel'); - * var titleTextStyle = titleTextStyleBuilder.build(); - * var axisTextStyle = axisTextStyleBuilder.build(); - * - * var chart = Charts.newLineChart() - * .setTitleTextStyle(titleTextStyle) - * .setXAxisTitleTextStyle(axisTextStyle) - * .setYAxisTitleTextStyle(axisTextStyle) - * .setTitle('Rainy Days Per Season') - * .setXAxisTitle('Season') - * .setYAxisTitle('Number of Rainy Days') - * .setDataTable(sampleData) - * .build(); - */ - interface TextStyle { - getColor(): string; - getFontName(): string; - getFontSize(): number; - } - /** - * A builder used to create TextStyle objects. It allows configuration of the text's - * properties such as name, color, and size. - * - * The following example shows how to create a text style using the builder. For a more complete - * example, refer to the documentation for TextStyle. - * - * // Creates a new text style that uses 26-point, blue, Ariel font. - * var textStyleBuilder = Charts.newTextStyle() - * .setColor('#0000FF').setFontName('Ariel').setFontSize(26); - * var style = textStyleBuilder.build(); - */ - interface TextStyleBuilder { - build(): TextStyle; - setColor(cssValue: string): TextStyleBuilder; - setFontName(fontName: string): TextStyleBuilder; - setFontSize(fontSize: number): TextStyleBuilder; - } - } -} - -declare var Charts: GoogleAppsScript.Charts.Charts; diff --git a/node_modules/@types/google-apps-script/google-apps-script.conference-data.d.ts b/node_modules/@types/google-apps-script/google-apps-script.conference-data.d.ts deleted file mode 100644 index 929f17e..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.conference-data.d.ts +++ /dev/null @@ -1,306 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Conference_Data { - /** - * Container for all conference-related information. - * - * var conferenceId; - * // Set the conference ID, that is, the identifier your system creates for the meeting. - * - * var entryPoint = ConferenceDataService.newEntryPoint(); - * // Finish building the entry point ... - * - * var conferenceParameter = ConferenceDataService.newConferenceParameter(); - * // Finish building the parameter ... - * - * var conferenceData = ConferenceDataService.newConferenceDataBuilder() - * .setConferenceId(conferenceId); - * .addEntryPoint(entryPoint) - * .addConferenceParameter(conferenceParameter) - * .build(); - */ - interface ConferenceData { - /** - * Prints the JSON representation of this object. This is for debugging only. - * https://developers.google.com/apps-script/reference/conference-data/conference-data#printJson() - */ - printJson(): string; - } - /** - * Builder for creating for ConferenceData objects. - */ - interface ConferenceDataBuilder { - /** - * Adds a ConferenceParameter to this ConferenceData. The maximum number of - * parameters per ConferenceData is 300. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#addConferenceParameter(ConferenceParameter) - * @param conferenceParameter The parameter to add. - */ - addConferenceParameter(conferenceParameter: ConferenceParameter): ConferenceDataBuilder; - - /** - * Adds an EntryPoint to this ConferenceData. The maximum number of entry points - * per ConferenceData is 300. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#addEntryPoint(EntryPoint) - * @param entryPoint The entry point to add. - */ - addEntryPoint(entryPoint: EntryPoint): ConferenceDataBuilder; - - /** - * Builds and validates the ConferenceData. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#build() - */ - build(): ConferenceData; - - /** - * Sets the conference ID of this ConferenceData. The maximum length for this field is 512 - * characters. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setConferenceId(String) - * @param conferenceId The ID to set. - */ - setConferenceId(conferenceId: string): ConferenceDataBuilder; - - /** - * Sets the conference solution ID defined in the addon's manifest. The value must be specified - * and populates conference's name and iconUrl values. - * - * Note that the field is required for GSuite add-ons whereas it's ignored for Conferencing - * add-ons - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setConferenceSolutionId(String) - * @param conferenceSolutionId The ID matching the manifest. - */ - setConferenceSolutionId(conferenceSolutionId: string): ConferenceDataBuilder; - - /** - * Sets the ConferenceError of this ConferenceData, indicating that the conference - * was not successfully created. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setError(ConferenceError) - * @param conferenceError The error to set. - */ - setError(conferenceError: ConferenceError): ConferenceDataBuilder; - - /** - * Sets the additional notes of this ConferenceData, such as instructions from the - * administrator or legal notices. Can contain HTML. The maximum length for this field is 2048 - * characters. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-builder#setNotes(String) - * @param notes The additional notes to set. - */ - setNotes(notes: string): ConferenceDataBuilder; - } - /** - * Service that scripts can use to create conferencing information. - */ - interface ConferenceDataService { - ConferenceErrorType: typeof ConferenceErrorType; - EntryPointFeature: typeof EntryPointFeature; - EntryPointType: typeof EntryPointType; - - /** - * Returns a new, empty ConferenceDataBuilder. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceDataBuilder() - */ - newConferenceDataBuilder(): ConferenceDataBuilder; - - /** - * Returns a new, empty ConferenceError. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceError() - */ - newConferenceError(): ConferenceError; - - /** - * Returns a new, empty ConferenceParameter. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newConferenceParameter() - */ - newConferenceParameter(): ConferenceParameter; - - /** - * Returns a new, empty EntryPoint. - * https://developers.google.com/apps-script/reference/conference-data/conference-data-service#newEntryPoint() - */ - newEntryPoint(): EntryPoint; - } - /** - * Error that occurred in a conferencing add-on. Example usage: - * - * var conferenceError = ConferenceDataService.newConferenceError() - * .setConferenceErrorType(ConferenceErrorType.PERMANENT); - * - * var state = ScriptApp.newStateToken() - * .withMethod('myLoginCallbackFunction'); - * .withTimeout(3600) - * .createToken(); - * - * var authenticationUrl = 'https://script.google.com/a/google.com/d/' - * + ScriptApp.getScriptId() - * + '/usercallback?state=' - * + state; - * - * var conferenceError = ConferenceDataService.newConferenceError() - * .setConferenceErrorType(ConferenceErrorType.UNAUTHENTICATED) - * .setAuthenticationUrl(authenticationUrl); - */ - interface ConferenceError { - /** - * If the error type is AUTHENTICATION, the add-on must - * provide a URL calling back into the add-on to allow users to log in. The maximum length for - * this field is 1800 characters. - * https://developers.google.com/apps-script/reference/conference-data/conference-error#setAuthenticationUrl(String) - * @param authenticationUrl The authentication URL to set. - */ - setAuthenticationUrl(authenticationUrl: string): ConferenceError; - - /** - * Sets the error type of this ConferenceError. - * https://developers.google.com/apps-script/reference/conference-data/conference-error#setConferenceErrorType(ConferenceErrorType) - * @param conferenceErrorType The type of error to set. - */ - setConferenceErrorType(conferenceErrorType: ConferenceErrorType): ConferenceError; - } - /** - * Enum that defines the types of errors that you can specify in a ConferenceError. - */ - enum ConferenceErrorType { - AUTHENTICATION, - CONFERENCE_SOLUTION_FORBIDDEN, - PERMANENT, - PERMISSION_DENIED, - TEMPORARY, - UNKNOWN, - } - /** - * Solution-specific parameter available fo the add-on's use. This parameter is persisted with the - * conference data and, if an update or delete is needed, is passed to the add-on. Example usage: - * - * var conferenceParameter = ConferenceDataService.newConferenceParameter() - * .setKey('meetingId') - * .setValue('123456'); - */ - interface ConferenceParameter { - /** - * Sets the key of this ConferenceParameter. The maximum length for this field is 50 - * characters. Required. - * https://developers.google.com/apps-script/reference/conference-data/conference-parameter#setKey(String) - * @param key The key to set. - */ - setKey(key: string): ConferenceParameter; - - /** - * Sets the value of this ConferenceParameter. The maximum length for this field is 1024 - * characters. Required. - * https://developers.google.com/apps-script/reference/conference-data/conference-parameter#setValue(String) - * @param value The value to set. - */ - setValue(value: string): ConferenceParameter; - } - /** - * Definition of a specific way to join a conference. Example usage: - * - * var videoEntryPoint = ConferenceDataService.newEntryPoint() - * .setEntryPointType(ConferenceDataService.EntryPointType.VIDEO) - * .setUri('https://example.com/myroom'); - * .setPasscode('12345'); - * - * var phoneEntryPoint = ConferenceDataService.newEntryPoint() - * .setEntryPointType(ConferenceDataService.EntryPointType.PHONE) - * .setUri('tel:+11234567890,,,112233445;9687') - * .addFeature(ConferenceDataService.EntryPointFeature.TOLL) - * setPin('9687'); - * - * var sipEntryPoint = ConferenceDataService.newEntryPoint() - * .setEntryPointType(ConferenceDataService.EntryPointType.SIP) - * .setUri('sip:joe@example.com') - * .setAccessCode('1234567'); - * - * var moreEntryPoint = ConferenceDataService.newEntryPoint() - * .setEntryPointType(ConferenceDataService.EntryPointType.MORE) - * .setUri('https://example.com/moreJoiningInfo'); - */ - interface EntryPoint { - /** - * Adds the feature of the entry point, such as being toll or toll-free. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#addFeature(EntryPointFeature) - * @param feature The feature to set. - */ - addFeature(feature: EntryPointFeature): EntryPoint; - - /** - * An access code for accessing the conference. Maximum length 128 characters. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setAccessCode(String) - * @param accessCode The access code to set. - */ - setAccessCode(accessCode: string): EntryPoint; - - /** - * Sets the type of this entry point. Required. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setEntryPointType(EntryPointType) - * @param entryPointType The entry point type to set. - */ - setEntryPointType(entryPointType: EntryPointType): EntryPoint; - - /** - * A meeting code for accessing the conference. Maximum length 128 characters. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setMeetingCode(String) - * @param meetingCode The meeting code to set. - */ - setMeetingCode(meetingCode: string): EntryPoint; - - /** - * A passcode for accessing the conference. Maximum length 128 characters. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setPasscode(String) - * @param passcode The passcode to set. - */ - setPasscode(passcode: string): EntryPoint; - - /** - * A password code for accessing the conference. Maximum length 128 characters. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setPassword(String) - * @param password The password to set. - */ - setPassword(password: string): EntryPoint; - - /** - * A PIN code for accessing the conference. Maximum length 128 characters. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setPin(String) - * @param pin The PIN code to set. - */ - setPin(pin: string): EntryPoint; - - /** - * The CLDR/ISO 3166 region code for the country associated with this entry point. Applicable only - * to phone entry point types. Optional. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setRegionCode(String) - * @param regionCode The regionCode to set. - */ - setRegionCode(regionCode: string): EntryPoint; - - /** - * Sets the URI for joining the conference through this entry point. For PHONE entry points, the prefix tel: is required. For SIP entry points, the prefix sip: is required. For VIDEO and MORE entry points, the prefixes - * http: or https: are required. Maximum length 1300 characters. Required. - * https://developers.google.com/apps-script/reference/conference-data/entry-point#setUri(String) - * @param uri The URI to set. - */ - setUri(uri: string): EntryPoint; - } - /** - * Enum that defines the features of the entry point that can be created by a conferencing add-on. - */ - enum EntryPointFeature { - UNKNOWN_FEATURE, - TOLL, - TOLL_FREE, - } - /** - * Enum that defines the types of entry points that can be created by a conferencing add-on. - */ - enum EntryPointType { - VIDEO, - PHONE, - MORE, - SIP, - } - } -} - -declare var ConferenceDataService: GoogleAppsScript.Conference_Data.ConferenceDataService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.contacts.d.ts b/node_modules/@types/google-apps-script/google-apps-script.contacts.d.ts deleted file mode 100644 index 9361732..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.contacts.d.ts +++ /dev/null @@ -1,356 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Contacts { - /** - * Address field in a contact. - */ - interface AddressField { - deleteAddressField(): void; - getAddress(): string; - getLabel(): Field | ExtendedField | string; - isPrimary(): boolean; - setAddress(address: string): AddressField; - setAsPrimary(): AddressField; - setLabel(field: Field): AddressField; - setLabel(label: string): AddressField; - } - /** - * Company field in a Contact. - */ - interface CompanyField { - deleteCompanyField(): void; - getCompanyName(): string; - getJobTitle(): string; - isPrimary(): boolean; - setAsPrimary(): CompanyField; - setCompanyName(company: string): CompanyField; - setJobTitle(title: string): CompanyField; - } - /** - * A Contact contains the name, address, and various contact details of a contact. - */ - interface Contact { - addAddress(label: typeof ContactsApp.Field | string, address: string): AddressField; - addCompany(company: string, title: string): CompanyField; - addCustomField(label: typeof ContactsApp.ExtendedField | string, content: any): CustomField; - addDate( - label: typeof ContactsApp.Field | string, - month: Base.Month, - day: Integer, - year: Integer, - ): DateField; - addEmail(label: typeof ContactsApp.Field | string, address: string): EmailField; - addIM(label: typeof ContactsApp.Field | string, address: string): IMField; - addPhone(label: typeof ContactsApp.Field | string, number: string): PhoneField; - addToGroup(group: ContactGroup): Contact; - addUrl(label: typeof ContactsApp.Field | string, url: string): UrlField; - deleteContact(): void; - getAddresses(): AddressField[]; - getAddresses(label: typeof ContactsApp.Field | string): AddressField[]; - getCompanies(): CompanyField[]; - getContactGroups(): ContactGroup[]; - getCustomFields(): CustomField[]; - getCustomFields(label: typeof ContactsApp.ExtendedField | string): CustomField[]; - getDates(): DateField[]; - getDates(label: typeof ContactsApp.Field | string): DateField[]; - getEmails(): EmailField[]; - getEmails(label: typeof ContactsApp.Field | string): EmailField[]; - getFamilyName(): string; - getFullName(): string; - getGivenName(): string; - getIMs(): IMField[]; - getIMs(label: typeof ContactsApp.Field | string): IMField[]; - getId(): string; - getInitials(): string; - getLastUpdated(): Base.Date; - getMaidenName(): string; - getMiddleName(): string; - getNickname(): string; - getNotes(): string; - getPhones(): PhoneField[]; - getPhones(label: typeof ContactsApp.Field | string): PhoneField[]; - getPrefix(): string; - getPrimaryEmail(): string; - getShortName(): string; - getSuffix(): string; - getUrls(): UrlField[]; - getUrls(label: typeof ContactsApp.Field | string): UrlField[]; - removeFromGroup(group: ContactGroup): Contact; - setFamilyName(familyName: string): Contact; - setFullName(fullName: string): Contact; - setGivenName(givenName: string): Contact; - setInitials(initials: string): Contact; - setMaidenName(maidenName: string): Contact; - setMiddleName(middleName: string): Contact; - setNickname(nickname: string): Contact; - setNotes(notes: string): Contact; - setPrefix(prefix: string): Contact; - setShortName(shortName: string): Contact; - setSuffix(suffix: string): Contact; - /** @deprecated DO NOT USE */ getEmailAddresses(): string[]; - /** @deprecated DO NOT USE */ getHomeAddress(): string; - /** @deprecated DO NOT USE */ getHomeFax(): string; - /** @deprecated DO NOT USE */ getHomePhone(): string; - /** @deprecated DO NOT USE */ getMobilePhone(): string; - /** @deprecated DO NOT USE */ getPager(): string; - /** @deprecated DO NOT USE */ getUserDefinedField(key: string): string; - /** @deprecated DO NOT USE */ getUserDefinedFields(): object; - /** @deprecated DO NOT USE */ getWorkAddress(): string; - /** @deprecated DO NOT USE */ getWorkFax(): string; - /** @deprecated DO NOT USE */ getWorkPhone(): string; - /** @deprecated DO NOT USE */ setHomeAddress(addr: string): void; - /** @deprecated DO NOT USE */ setHomeFax(phone: string): void; - /** @deprecated DO NOT USE */ setHomePhone(phone: string): void; - /** @deprecated DO NOT USE */ setMobilePhone(phone: string): void; - /** @deprecated DO NOT USE */ setPager(phone: string): void; - /** @deprecated DO NOT USE */ setPrimaryEmail(primaryEmail: string): void; - /** @deprecated DO NOT USE */ setUserDefinedField(key: string, value: string): void; - /** @deprecated DO NOT USE */ setUserDefinedFields(o: object): void; - /** @deprecated DO NOT USE */ setWorkAddress(addr: string): void; - /** @deprecated DO NOT USE */ setWorkFax(phone: string): void; - /** @deprecated DO NOT USE */ setWorkPhone(phone: string): void; - } - /** - * A ContactGroup is is a group of contacts. - */ - interface ContactGroup { - addContact(contact: Contact): ContactGroup; - deleteGroup(): void; - getContacts(): Contact[]; - getId(): string; - getName(): string; - isSystemGroup(): boolean; - removeContact(contact: Contact): ContactGroup; - setName(name: string): ContactGroup; - /** @deprecated DO NOT USE */ getGroupName(): string; - /** @deprecated DO NOT USE */ setGroupName(name: string): void; - } - /** - * This class allows users to access their own Google Contacts and create, remove, and update - * contacts listed therein. - */ - interface ContactsApp { - ExtendedField: typeof ExtendedField; - Field: typeof Field; - Gender: typeof Gender; - Month: typeof Base.Month; - Priority: typeof Priority; - Sensitivity: typeof Sensitivity; - createContact(givenName: string, familyName: string, email: string): Contact; - createContactGroup(name: string): ContactGroup; - deleteContact(contact: Contact): void; - deleteContactGroup(group: ContactGroup): void; - getContact(emailAddress: string): Contact; - getContactById(id: string): Contact; - getContactGroup(name: string): ContactGroup; - getContactGroupById(id: string): ContactGroup; - getContactGroups(): ContactGroup[]; - getContacts(): Contact[]; - getContactsByAddress(query: string): Contact[]; - getContactsByAddress(query: string, label: Field): Contact[]; - getContactsByAddress(query: string, label: string): Contact[]; - getContactsByCompany(query: string): Contact[]; - getContactsByCustomField(query: typeof ContactsApp.ExtendedField | string, label: ExtendedField): Contact[]; - getContactsByDate(month: Base.Month, day: Integer, label: Field): Contact[]; - getContactsByDate(month: Base.Month, day: Integer, year: Integer, label: Field): Contact[]; - getContactsByDate(month: Base.Month, day: Integer, year: Integer, label: string): Contact[]; - getContactsByDate(month: Base.Month, day: Integer, label: string): Contact[]; - getContactsByEmailAddress(query: string): Contact[]; - getContactsByEmailAddress(query: string, label: Field): Contact[]; - getContactsByEmailAddress(query: string, label: string): Contact[]; - getContactsByGroup(group: ContactGroup): Contact[]; - getContactsByIM(query: string): Contact[]; - getContactsByIM(query: string, label: Field): Contact[]; - getContactsByIM(query: string, label: string): Contact[]; - getContactsByJobTitle(query: string): Contact[]; - getContactsByName(query: string): Contact[]; - getContactsByName(query: string, label: Field): Contact[]; - getContactsByNotes(query: string): Contact[]; - getContactsByPhone(query: string): Contact[]; - getContactsByPhone(query: string, label: Field): Contact[]; - getContactsByPhone(query: string, label: string): Contact[]; - getContactsByUrl(query: string): Contact[]; - getContactsByUrl(query: string, label: Field): Contact[]; - getContactsByUrl(query: string, label: string): Contact[]; - /** @deprecated DO NOT USE */ findByEmailAddress(email: string): Contact; - /** @deprecated DO NOT USE */ findContactGroup(name: string): ContactGroup; - /** @deprecated DO NOT USE */ getAllContacts(): Contact[]; - } - /** - * A custom field in a Contact. - */ - interface CustomField { - deleteCustomField(): void; - getLabel(): Field | ExtendedField | string; - getValue(): any; - setLabel(field: ExtendedField): CustomField; - setLabel(label: string): CustomField; - setValue(value: any): CustomField; - } - /** - * A date field in a Contact. - * - * This class is only used by the Contacts service, and dates used elsewhere in App Script use - * JavaScript's standard - * Date object. - */ - interface DateField { - deleteDateField(): void; - getDay(): Integer; - getLabel(): Field | ExtendedField | string; - getMonth(): Base.Month; - getYear(): Integer; - setDate(month: Base.Month, day: Integer): DateField; - setDate(month: Base.Month, day: Integer, year: Integer): DateField; - setLabel(label: Field): DateField; - setLabel(label: string): DateField; - } - /** - * An email field in a Contact. - */ - interface EmailField { - deleteEmailField(): void; - getAddress(): string; - getDisplayName(): string; - getLabel(): Field | ExtendedField | string; - isPrimary(): boolean; - setAddress(address: string): EmailField; - setAsPrimary(): EmailField; - setDisplayName(name: string): EmailField; - setLabel(field: Field): EmailField; - setLabel(label: string): EmailField; - } - /** - * An enum for extended contacts fields. - */ - enum ExtendedField { - HOBBY, - MILEAGE, - LANGUAGE, - GENDER, - BILLING_INFORMATION, - DIRECTORY_SERVER, - SENSITIVITY, - PRIORITY, - HOME, - WORK, - USER, - OTHER, - } - /** - * An enum for contacts fields. - */ - enum Field { - FULL_NAME, - GIVEN_NAME, - MIDDLE_NAME, - FAMILY_NAME, - MAIDEN_NAME, - NICKNAME, - SHORT_NAME, - INITIALS, - PREFIX, - SUFFIX, - HOME_EMAIL, - WORK_EMAIL, - BIRTHDAY, - ANNIVERSARY, - HOME_ADDRESS, - WORK_ADDRESS, - ASSISTANT_PHONE, - CALLBACK_PHONE, - MAIN_PHONE, - PAGER, - HOME_FAX, - WORK_FAX, - HOME_PHONE, - WORK_PHONE, - MOBILE_PHONE, - GOOGLE_VOICE, - NOTES, - GOOGLE_TALK, - AIM, - YAHOO, - SKYPE, - QQ, - MSN, - ICQ, - JABBER, - BLOG, - FTP, - PROFILE, - HOME_PAGE, - WORK_WEBSITE, - HOME_WEBSITE, - JOB_TITLE, - COMPANY, - } - /** - * An enum for contact gender. - */ - enum Gender { - MALE, - FEMALE, - } - /** - * An instant messaging field in a Contact. - */ - interface IMField { - deleteIMField(): void; - getAddress(): string; - getLabel(): Field | ExtendedField | string; - isPrimary(): boolean; - setAddress(address: string): IMField; - setAsPrimary(): IMField; - setLabel(field: Field): IMField; - setLabel(label: string): IMField; - } - /** - * A phone number field in a Contact. - */ - interface PhoneField { - deletePhoneField(): void; - getLabel(): Field | ExtendedField | string; - getPhoneNumber(): string; - isPrimary(): boolean; - setAsPrimary(): PhoneField; - setLabel(field: Field): PhoneField; - setLabel(label: string): PhoneField; - setPhoneNumber(number: string): PhoneField; - } - /** - * An enum for contact priority. - */ - enum Priority { - HIGH, - LOW, - NORMAL, - } - /** - * An enum for contact sensitivity. - */ - enum Sensitivity { - CONFIDENTIAL, - NORMAL, - PERSONAL, - PRIVATE, - } - /** - * A URL field in a Contact. - */ - interface UrlField { - deleteUrlField(): void; - getAddress(): string; - getLabel(): Field | ExtendedField | string; - isPrimary(): boolean; - setAddress(address: string): UrlField; - setAsPrimary(): UrlField; - setLabel(field: Field): UrlField; - setLabel(label: string): UrlField; - } - } -} - -declare var ContactsApp: GoogleAppsScript.Contacts.ContactsApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.content.d.ts b/node_modules/@types/google-apps-script/google-apps-script.content.d.ts deleted file mode 100644 index 0f6f626..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.content.d.ts +++ /dev/null @@ -1,61 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Content { - /** - * Service for returning text content from a script. - * - * You can serve up text in various forms. For example, publish this script as a web app. - * - * function doGet() { - * return ContentService.createTextOutput("Hello World"); - * } - */ - interface ContentService { - MimeType: typeof MimeType; - createTextOutput(): TextOutput; - createTextOutput(content: string): TextOutput; - } - /** - * An enum for mime types that can be served from a script. - */ - enum MimeType { - ATOM, - CSV, - ICAL, - JAVASCRIPT, - JSON, - RSS, - TEXT, - VCARD, - XML, - } - /** - * A TextOutput object that can be served from a script. - * - * Due to security considerations, scripts cannot directly return text content to a browser. - * Instead, the browser is redirected to googleusercontent.com, which will display it without any - * further sanitization or manipulation. - * - * You can return text content like this: - * - * function doGet() { - * return ContentService.createTextOutput("hello world!"); - * } - * - * ContentService - */ - interface TextOutput { - append(addedContent: string): TextOutput; - clear(): TextOutput; - downloadAsFile(filename: string): TextOutput; - getContent(): string; - getFileName(): string; - getMimeType(): MimeType; - setContent(content: string): TextOutput; - setMimeType(mimeType: MimeType): TextOutput; - } - } -} - -declare var ContentService: GoogleAppsScript.Content.ContentService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.data-studio.d.ts b/node_modules/@types/google-apps-script/google-apps-script.data-studio.d.ts deleted file mode 100644 index a3eb881..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.data-studio.d.ts +++ /dev/null @@ -1,628 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Data_Studio { - /** - * An enum that defines the aggregation types that can be set for a Field. - */ - enum AggregationType { - AVG, - COUNT, - COUNT_DISTINCT, - MAX, - MIN, - SUM, - AUTO, - NO_AGGREGATION, - } - /** - * An enum that defines the authentication types that can be set for a connector. - */ - enum AuthType { - NONE, - OAUTH2, - USER_PASS, - KEY, - USER_TOKEN, - } - /** - * A configuration object for a native BigQuery connector. Return this object from getData() - * for Data Studio to query BigQuery for the connector. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var types = cc.BigQueryParameterType; - * - * var bqConfig = cc.newBigQueryConfig() - * .setBillingProjectId('billingProjectId') - * .setQuery('queryString') - * .setUseStandardSql(true) - * .setAccessToken('accessToken') - * .addQueryParameter('dob', types.STRING, '01011990') - * .build(); - */ - interface BigQueryConfig { - addQueryParameter(name: string, type: BigQueryParameterType, value: string): BigQueryConfig; - build(): Config; - printJson(): string; - setAccessToken(accessToken: string): BigQueryConfig; - setBillingProjectId(billingProjectId: string): BigQueryConfig; - setQuery(query: string): BigQueryConfig; - setUseStandardSql(useStandardSql: boolean): BigQueryConfig; - } - /** - * An enum that defines the BigQuery parameter types that you can set. - */ - enum BigQueryParameterType { - STRING, - INT64, - BOOL, - FLOAT64, - } - /** - * Contains checkbox information for the config. Its properties determine how the checkbox is - * displayed in Data Studio. - * - * var checkbox = config.newCheckbox() - * .setId("use_https") - * .setName("Use Https?") - * .setHelpText("Whether or not https should be used.") - * .setAllowOverride(true); - */ - interface Checkbox { - setAllowOverride(allowOverride: boolean): Checkbox; - setHelpText(helpText: string): Checkbox; - setId(id: string): Checkbox; - setIsDynamic(isDynamic: boolean): Checkbox; - setName(name: string): Checkbox; - } - /** - * CommunityConnector enables scripts to access builders and utilities to help with development of - * Community Connectors for Data Studio. Use this class to get a reference to the Fields - * object and the FieldType and AggregationType enums so they can be used in the - * construction of Fields. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var fieldType = cc.FieldType; - * var aggregationType = cc.AggregationType; - * - * var fields = cc.getFields(); - * - * fields.newMetric() - * .setAggregation(aggregationType.AVG) - * .setType(fieldType.CURRENCY_USD); - */ - interface CommunityConnector { - AggregationType: typeof AggregationType; - AuthType: typeof AuthType; - BigQueryParameterType: typeof BigQueryParameterType; - FieldType: typeof FieldType; - getConfig(): Config; - getFields(): Fields; - newAuthTypeResponse(): GetAuthTypeResponse; - newBigQueryConfig(): BigQueryConfig; - newDebugError(): DebugError; - newGetDataResponse(): GetDataResponse; - newGetSchemaResponse(): GetSchemaResponse; - newSetCredentialsResponse(): SetCredentialsResponse; - newUserError(): UserError; - } - /** - * Contains the configuration entries for a connector. These configuration entries define what - * questions are asked when adding a new connector. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var config = cc.getConfig(); - * - * var info_entry = config.newInfo() - * .setId("info_id") - * .setHelpText("This connector can connect to multiple data endpoints."); - */ - interface Config { - build(): Config; - newCheckbox(): Checkbox; - newInfo(): Info; - newOptionBuilder(): OptionBuilder; - newSelectMultiple(): SelectMultiple; - newSelectSingle(): SelectSingle; - newTextArea(): TextArea; - newTextInput(): TextInput; - printJson(): string; - setDateRangeRequired(dateRangeRequired: boolean): Config; - setIsSteppedConfig(isSteppedConfig: boolean): Config; - } - /** - * DataStudioApp allows scripts to interact with developer-oriented features for Data Studio. - */ - interface DataStudioApp { - createCommunityConnector(): CommunityConnector; - } - /** - * An error that is only visible to admins of the connector. - * - * var cc = DataStudioApp.createCommunityConnector(); - * - * cc.newDebugError() - * .setText("This is the debug error text.") - * .throwException(); - */ - interface DebugError { - printJson(): string; - setText(text: string): DebugError; - throwException(): never; - } - /** - * Contains field-related data. Its properties determine how the field is used in Data Studio. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var fields = cc.getFields(); - * var types = cc.FieldType; - * - * var field1 = fields.newDimension() - * .setId('field1_id') - * .setName('Field 1 ID') - * .setDescription('The first field.') - * .setType(types.YEAR_MONTH) - * .setGroup('DATETIME'); - */ - interface Field { - getAggregation(): AggregationType | null; - getDescription(): string | null; - getFormula(): string | null; - getGroup(): string | null; - getId(): string | null; - getIsReaggregatable(): boolean | null; - getName(): string | null; - getType(): FieldType | null; - isDefault(): boolean; - isDimension(): boolean; - isHidden(): boolean; - isMetric(): boolean; - setAggregation(aggregation: AggregationType): Field; - setDescription(description: string): Field; - setFormula(formula: string): Field; - setGroup(group: string): Field; - setId(id: string): Field; - setIsHidden(isHidden: boolean): Field; - setIsReaggregatable(isReaggregatable: boolean): Field; - setName(name: string): Field; - setType(type: FieldType): Field; - } - /** - * An enum that defines the types that can be set for a Field. - */ - enum FieldType { - YEAR, - YEAR_QUARTER, - YEAR_MONTH, - YEAR_WEEK, - YEAR_MONTH_DAY, - YEAR_MONTH_DAY_HOUR, - YEAR_MONTH_DAY_SECOND, - QUARTER, - MONTH, - WEEK, - MONTH_DAY, - DAY_OF_WEEK, - DAY, - HOUR, - MINUTE, - DURATION, - COUNTRY, - COUNTRY_CODE, - CONTINENT, - CONTINENT_CODE, - SUB_CONTINENT, - SUB_CONTINENT_CODE, - REGION, - REGION_CODE, - CITY, - CITY_CODE, - METRO, - METRO_CODE, - LATITUDE_LONGITUDE, - NUMBER, - PERCENT, - TEXT, - BOOLEAN, - URL, - HYPERLINK, - IMAGE, - IMAGE_LINK, - CURRENCY_AED, - CURRENCY_ALL, - CURRENCY_ARS, - CURRENCY_AUD, - CURRENCY_BDT, - CURRENCY_BGN, - CURRENCY_BOB, - CURRENCY_BRL, - CURRENCY_CAD, - CURRENCY_CDF, - CURRENCY_CHF, - CURRENCY_CLP, - CURRENCY_CNY, - CURRENCY_COP, - CURRENCY_CRC, - CURRENCY_CZK, - CURRENCY_DKK, - CURRENCY_DOP, - CURRENCY_EGP, - CURRENCY_ETB, - CURRENCY_EUR, - CURRENCY_GBP, - CURRENCY_HKD, - CURRENCY_HRK, - CURRENCY_HUF, - CURRENCY_IDR, - CURRENCY_ILS, - CURRENCY_INR, - CURRENCY_IRR, - CURRENCY_ISK, - CURRENCY_JMD, - CURRENCY_JPY, - CURRENCY_KRW, - CURRENCY_LKR, - CURRENCY_LTL, - CURRENCY_MNT, - CURRENCY_MVR, - CURRENCY_MXN, - CURRENCY_MYR, - CURRENCY_NOK, - CURRENCY_NZD, - CURRENCY_PAB, - CURRENCY_PEN, - CURRENCY_PHP, - CURRENCY_PKR, - CURRENCY_PLN, - CURRENCY_RON, - CURRENCY_RSD, - CURRENCY_RUB, - CURRENCY_SAR, - CURRENCY_SEK, - CURRENCY_SGD, - CURRENCY_THB, - CURRENCY_TRY, - CURRENCY_TWD, - CURRENCY_TZS, - CURRENCY_UAH, - CURRENCY_USD, - CURRENCY_UYU, - CURRENCY_VEF, - CURRENCY_VND, - CURRENCY_YER, - CURRENCY_ZAR, - } - /** - * Contains a set of Fields for a community connector. This set of fields define which - * dimensions and metrics can be used in Data Studio. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var fields = cc.getFields(); - * var types = cc.FieldType; - * - * var field1 = fields.newDimension() - * // Set other properties as needed. - * .setId('field1_id'); - */ - interface Fields { - asArray(): Field[]; - build(): any[]; - forIds(ids: string[]): Fields; - getDefaultDimension(): Field | null; - getDefaultMetric(): Field | null; - getFieldById(fieldId: string): Field | null; - newDimension(): Field; - newMetric(): Field; - setDefaultDimension(fieldId: string): void; - setDefaultMetric(fieldId: string): void; - } - /** - * Builder to create a getAuthType() response for your script project. - * - * function getAuthType() { - * var cc = DataStudioApp.createCommunityConnector(); - * var authTypes = cc.AuthType; - * - * return cc.newGetAuthTypeResponse() - * .setAuthType(authTypes.USER_PASS) - * .setHelpUrl("https://www.example.org/connector-auth-help") - * .build(); - * } - */ - interface GetAuthTypeResponse { - build(): GetAuthTypeResponse; - printJson(): string; - setAuthType(authType: AuthType): GetAuthTypeResponse; - setHelpUrl(helpUrl: string): GetAuthTypeResponse; - } - /** - * Builder to create a getData() response for your script project. - * - * function getFields() {...} - * function getData() { - * var cc = DataStudioApp.createCommunityConnector(); - * - * return cc.newGetDataResponse() - * .setFields(getFields()) - * .addRow(['3', 'Foobar.com']) - * .addRow(['4', 'Foobaz.com']) - * .addRows([ - * ['5', 'Fizzbuz.com'], - * ['6', 'Fizzbaz.com'] - * ]) - * .build(); - * } - */ - interface GetDataResponse { - addAllRows(rows: string[][]): GetDataResponse; - addRow(row: string[]): GetDataResponse; - build(): any; - setFields(fields: Fields): GetDataResponse; - setFiltersApplied(filtersApplied: boolean): GetDataResponse; - } - /** - * Builder to create a getSchema() response for your script project. - * - * function getSchema() { - * var cc = DataStudioApp.createCommunityConnector(); - * var fields = cc.getFields(); - * var types = cc.FieldType; - * - * fields.newDimension() - * .setId('Created') - * .setName('Date Created') - * .setDescription('The date that this was created') - * .setType(types.YEAR_MONTH_DAY); - * - * fields.newMetric() - * .setId('Amount') - * .setName('Amount (USD)') - * .setDescription('The cost in US dollars') - * .setType(types.CURRENCY_USD); - * - * return cc.newGetSchemaResponse() - * .setFields(fields) - * .build(); - * } - */ - interface GetSchemaResponse { - build(): any; - printJson(): string; - setFields(fields: Fields): GetSchemaResponse; - } - /** - * Contains info data for the config. Its properties determine how the info is displayed in Data - * Studio. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var config = cc.getConfig(); - * - * var info1 = config.newInfo() - * .setId("info1") - * .setText("This text gives some context on the configuration."); - */ - interface Info { - setId(id: string): Info; - setText(text: string): Info; - } - /** - * A builder for creating options for SelectSingles and SelectMultiples. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var config = cc.getConfig(); - * - * var option1 = config.newOptionBuilder() - * .setLabel("option label") - * .setValue("option_value"); - * - * var option2 = config.newOptionBuilder() - * .setLabel("second option label") - * .setValue("option_value_2"); - * - * var info1 = config.newSelectSingle() - * .setId("api_endpoint") - * .setName("Data Type") - * .setHelpText("Select the data type you're interested in.") - * .addOption(option1) - * .addOption(option2); - */ - interface OptionBuilder { - setLabel(label: string): OptionBuilder; - setValue(value: string): OptionBuilder; - } - /** - * Contains select multiple information for the config. Its properties determine how the select - * multiple is displayed in Data Studio. - * - * Usage: - * - * var option1 = config.newOptionBuilder() - * .setLabel("option label") - * .setValue("option_value"); - * - * var option2 = config.newOptionBuilder() - * .setLabel("second option label") - * .setValue("option_value_2"); - * - * var info1 = config.newSelectMultiple() - * .setId("api_endpoint") - * .setName("Data Type") - * .setHelpText("Select the data type you're interested in.") - * .setAllowOverride(true) - * .addOption(option1) - * .addOption(option2); - */ - interface SelectMultiple { - addOption(optionBuilder: OptionBuilder): SelectMultiple; - setAllowOverride(allowOverride: boolean): SelectMultiple; - setHelpText(helpText: string): SelectMultiple; - setId(id: string): SelectMultiple; - setIsDynamic(isDynamic: boolean): SelectMultiple; - setName(name: string): SelectMultiple; - } - /** - * Contains select single information for the config. Its properties determine how the select single - * is displayed in Data Studio. - * - * var option1 = config.newOptionBuilder() - * .setLabel("option label") - * .setValue("option_value"); - * - * var option2 = config.newOptionBuilder() - * .setLabel("second option label") - * .setValue("option_value_2"); - * - * var info1 = config.newSelectSingle() - * .setId("api_endpoint") - * .setName("Data Type") - * .setHelpText("Select the data type you're interested in.") - * .setAllowOverride(true) - * .addOption(option1) - * .addOption(option2); - */ - interface SelectSingle { - addOption(optionBuilder: OptionBuilder): SelectSingle; - setAllowOverride(allowOverride: boolean): SelectSingle; - setHelpText(helpText: string): SelectSingle; - setId(id: string): SelectSingle; - setIsDynamic(isDynamic: boolean): SelectSingle; - setName(name: string): SelectSingle; - } - /** - * Builder to create a setCredentials() response for your script project. - * - * function setCredentials(request) { - * var isValid = checkForValidCreds(request); - * - * if (isValid) { - * // store the creds somewhere. - * } - * - * return cc.newSetCredentialsResponse() - * .setIsValid(isValid) - * .build(); - * } - */ - interface SetCredentialsResponse { - build(): any; - printJson(): string; - setIsValid(isValid: boolean): SetCredentialsResponse; - } - /** - * Contains text area information for the config. Its properties determine how the text input is - * displayed in Data Studio. - * - * Usage: - * - * var cc = DataStudioApp.createCommunityConnector(); - * var config = cc.getConfig(); - * - * var textArea1 = config.newTextArea() - * .setId("textArea1") - * .setName("Search") - * .setHelpText("for example, Coldplay") - * .setAllowOverride(true) - * .setPlaceholder("Search for an artist for all songs."); - */ - interface TextArea { - setAllowOverride(allowOverride: boolean): TextArea; - setHelpText(helpText: string): TextArea; - setId(id: string): TextArea; - setIsDynamic(isDynamic: boolean): TextArea; - setName(name: string): TextArea; - setPlaceholder(placeholder: string): TextArea; - } - /** - * Contains text input information for the config. Its properties determine how the text input is - * displayed in Data Studio. - * - * var cc = DataStudioApp.createCommunityConnector(); - * var config = cc.getConfig(); - * - * var info1 = config.newTextInput() - * .setId("info1") - * .setName("Search") - * .setHelpText("for example, Coldplay") - * .setAllowOverride(true) - * .setPlaceholder("Search for an artist for all songs."); - */ - interface TextInput { - setAllowOverride(allowOverride: boolean): TextInput; - setHelpText(helpText: string): TextInput; - setId(id: string): TextInput; - setIsDynamic(isDynamic: boolean): TextInput; - setName(name: string): TextInput; - setPlaceholder(placeholder: string): TextInput; - } - /** - * An error that is shown to users of the connector. - * - * var cc = DataStudioApp.createCommunityConnector(); - * - * cc.newUserError() - * .setText("This is the debug error text.") - * .setDebugText("This text is only shown to admins.") - * .throwException(); - */ - interface UserError { - printJson(): string; - setDebugText(text: string): UserError; - setText(text: string): UserError; - throwException(): never; - } - /** - * function getData(request: GoogleAppsScript.Data_Studio.Request) - * - * See https://developers.google.com/datastudio/connector/reference#getdata - */ - interface Request { - /** An object containing the user provided values for the config parameters defined by the connector. */ - configParams: T; - /** An object containing information relevant to connector execution. */ - scriptParams: ScriptParams; - /** - * By default, the date range provided will be the last 28 days excluding today. - * If a user applies a date range filter for a report, then the date range provided will reflect the user selection. - * When sampleExtraction is set to true, the date two days earlier than today is given as both the start and end date. - */ - dateRange: DateRange; - /** The names of the requested fields. */ - fields: Array<{ name: string }>; - /** - * A nested array of the user selected filters. - * The innermost arrays should be ORed together, the outermost arrays should be ANDed together. - */ - dimensionsFilters: DimensionsFilters[][]; - } - interface DateRange { - /** The start date for filtering the data. Applies only if dateRangeRequired is set to true. It will be in YYYY-MM-DD format. */ - startDate: string; - /** The end date for filtering the data. Applies only dateRangeRequired is set to true. It will be in YYYY-MM-DD format. */ - endDate: string; - } - interface ScriptParams { - /** If true, the getData() request is for automatic semantic type detection. */ - sampleExtraction?: boolean | undefined; - /** A timestamp that marks the most recent request for a refresh of data. */ - lastRefresh: string; - } - type RegexpOperator = "REGEXP_PARTIAL_MATCH" | "REGEXP_EXACT_MATCH"; - type NumericOperator = - | "NUMERIC_GREATER_THAN" - | "NUMERIC_GREATER_THAN_OR_EQUAL" - | "NUMERIC_LESS_THAN" - | "NUMERIC_LESS_THAN_OR_EQUAL"; - interface DimensionsFilters { - /** The name of the field to be filtered */ - fieldName: string; - /** An array of values to use for the operator. */ - values: string[]; - /** Whether data matching this filter should be included or excluded from the getData() response. */ - type: "INCLUDE" | "EXCLUDE"; - /** The operator to apply. */ - operator: "EQUALS" | "CONTAINS" | RegexpOperator | "IN_LIST" | "IS_NULL" | "BETWEEN" | NumericOperator; - } - } -} - -declare var DataStudioApp: GoogleAppsScript.Data_Studio.DataStudioApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.document.d.ts b/node_modules/@types/google-apps-script/google-apps-script.document.d.ts deleted file mode 100644 index be35fa3..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.document.d.ts +++ /dev/null @@ -1,1661 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Document { - /** - * An enumeration of the element attributes. - * - * Use attributes to compose custom styles. For example: - * - * // Define a style with yellow background. - * var highlightStyle = {}; - * highlightStyle[DocumentApp.Attribute.BACKGROUND_COLOR] = '#FFFF00'; - * highlightStyle[DocumentApp.Attribute.BOLD] = true; - * - * // Insert "Hello", highlighted. - * DocumentApp.getActiveDocument().editAsText() - * .insertText(0, 'Hello\n') - * .setAttributes(0, 4, highlightStyle); - */ - enum Attribute { - BACKGROUND_COLOR, - BOLD, - BORDER_COLOR, - BORDER_WIDTH, - CODE, - FONT_FAMILY, - FONT_SIZE, - FOREGROUND_COLOR, - HEADING, - HEIGHT, - HORIZONTAL_ALIGNMENT, - INDENT_END, - INDENT_FIRST_LINE, - INDENT_START, - ITALIC, - GLYPH_TYPE, - LEFT_TO_RIGHT, - LINE_SPACING, - LINK_URL, - LIST_ID, - MARGIN_BOTTOM, - MARGIN_LEFT, - MARGIN_RIGHT, - MARGIN_TOP, - NESTING_LEVEL, - MINIMUM_HEIGHT, - PADDING_BOTTOM, - PADDING_LEFT, - PADDING_RIGHT, - PADDING_TOP, - PAGE_HEIGHT, - PAGE_WIDTH, - SPACING_AFTER, - SPACING_BEFORE, - STRIKETHROUGH, - UNDERLINE, - VERTICAL_ALIGNMENT, - WIDTH, - } - /** - * An element representing a document body. The Body may contain ListItem, Paragraph, Table, and TableOfContents elements. For more information on document - * structure, see the guide to extending - * Google Docs. - * - * The Body typically contains the full document contents except for the HeaderSection, FooterSection, and any FootnoteSection elements. - * - * var doc = DocumentApp.getActiveDocument(); - * var body = doc.getBody(); - * - * // Append a paragraph and a page break to the document body section directly. - * body.appendParagraph("A paragraph."); - * body.appendPageBreak(); - */ - interface Body extends Element { - appendHorizontalRule(): HorizontalRule; - appendImage(image: Base.BlobSource): InlineImage; - appendImage(image: InlineImage): InlineImage; - appendListItem(listItem: ListItem): ListItem; - appendListItem(text: string): ListItem; - appendPageBreak(): PageBreak; - appendPageBreak(pageBreak: PageBreak): PageBreak; - appendParagraph(paragraph: Paragraph): Paragraph; - appendParagraph(text: string): Paragraph; - appendTable(): Table; - appendTable(cells: string[][]): Table; - appendTable(table: Table): Table; - clear(): Body; - copy(): Body; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getHeadingAttributes(paragraphHeading: ParagraphHeading): any; - getImages(): InlineImage[]; - getListItems(): ListItem[]; - getMarginBottom(): number; - getMarginLeft(): number; - getMarginRight(): number; - getMarginTop(): number; - getNumChildren(): Integer; - getPageHeight(): number; - getPageWidth(): number; - getParagraphs(): Paragraph[]; - getParent(): ContainerElement; - getTables(): Table[]; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertImage(childIndex: Integer, image: InlineImage): InlineImage; - insertListItem(childIndex: Integer, listItem: ListItem): ListItem; - insertListItem(childIndex: Integer, text: string): ListItem; - insertPageBreak(childIndex: Integer): PageBreak; - insertPageBreak(childIndex: Integer, pageBreak: PageBreak): PageBreak; - insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; - insertParagraph(childIndex: Integer, text: string): Paragraph; - insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: string[][]): Table; - insertTable(childIndex: Integer, table: Table): Table; - removeChild(child: Element): Body; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): Body; - setHeadingAttributes(paragraphHeading: ParagraphHeading, attributes: any): Body; - setMarginBottom(marginBottom: number): Body; - setMarginLeft(marginLeft: number): Body; - setMarginRight(marginRight: number): Body; - setMarginTop(marginTop: number): Body; - setPageHeight(pageHeight: number): Body; - setPageWidth(pageWidth: number): Body; - setText(text: string): Body; - setTextAlignment(textAlignment: TextAlignment): Body; - /** @deprecated DO NOT USE */ getFootnotes(): Footnote[]; - /** @deprecated DO NOT USE */ getLinkUrl(): string; - /** @deprecated DO NOT USE */ getNextSibling(): Element; - /** @deprecated DO NOT USE */ getPreviousSibling(): Element; - /** @deprecated DO NOT USE */ isAtDocumentEnd(): boolean; - /** @deprecated DO NOT USE */ setLinkUrl(url: string): Body; - } - /** - * An object representing a bookmark. - * - * // Insert a bookmark at the cursor position and log its ID. - * var doc = DocumentApp.getActiveDocument(); - * var cursor = doc.getCursor(); - * var bookmark = doc.addBookmark(cursor); - * Logger.log(bookmark.getId()); - */ - interface Bookmark { - getId(): string; - getPosition(): Position; - remove(): void; - } - /** - * A generic element that may contain other elements. All elements that may contain child elements, - * such as Paragraph, inherit from ContainerElement. - */ - interface ContainerElement extends Element { - asBody(): Body; - asEquation(): Equation; - asFooterSection(): FooterSection; - asFootnoteSection(): FootnoteSection; - asHeaderSection(): HeaderSection; - asListItem(): ListItem; - asParagraph(): Paragraph; - asTable(): Table; - asTableCell(): TableCell; - asTableOfContents(): TableOfContents; - asTableRow(): TableRow; - clear(): ContainerElement; - copy(): ContainerElement; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): ContainerElement; - removeFromParent(): ContainerElement; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): ContainerElement; - setLinkUrl(url: string): ContainerElement; - setTextAlignment(textAlignment: TextAlignment): ContainerElement; - } - /** - * An element representing a formatted date. - */ - interface Date extends Element { - copy(): Date; - getAttributes(): any; - getDisplayText(): string; - getLocale(): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getTimestamp(): Date; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): Date; - removeFromParent(): Date; - setAttributes(attributes: any): Date; - } - /** - * A document, containing rich text and elements such as tables and lists. - * - * Documents may be opened or created using DocumentApp. - * - * // Open a document by ID. - * var doc = DocumentApp.openById(""); - * - * // Create and open a document. - * doc = DocumentApp.create("Document Title"); - */ - interface Document { - addBookmark(position: Position): Bookmark; - addEditor(emailAddress: string): Document; - addEditor(user: Base.User): Document; - addEditors(emailAddresses: string[]): Document; - addFooter(): FooterSection; - addHeader(): HeaderSection; - addNamedRange(name: string, range: Range): NamedRange; - addViewer(emailAddress: string): Document; - addViewer(user: Base.User): Document; - addViewers(emailAddresses: string[]): Document; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getBody(): Body; - getBookmark(id: string): Bookmark; - getBookmarks(): Bookmark[]; - getCursor(): Position | null; - getEditors(): Base.User[]; - getFooter(): FooterSection; - getFootnotes(): Footnote[]; - getHeader(): HeaderSection; - getId(): string; - getLanguage(): string; - getName(): string; - getNamedRangeById(id: string): NamedRange; - getNamedRanges(): NamedRange[]; - getNamedRanges(name: string): NamedRange[]; - getSelection(): Range; - getSupportedLanguageCodes(): string[]; - getUrl(): string; - getViewers(): Base.User[]; - newPosition(element: Element, offset: Integer): Position; - newRange(): RangeBuilder; - removeEditor(emailAddress: string): Document; - removeEditor(user: Base.User): Document; - removeViewer(emailAddress: string): Document; - removeViewer(user: Base.User): Document; - saveAndClose(): void; - setCursor(position: Position): Document; - setLanguage(languageCode: string): Document; - setName(name: string): Document; - setSelection(range: Range): Document; - } - /** - * The document service creates and opens Documents that can be edited. - * - * // Open a document by ID. - * var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE'); - * - * // Create and open a document. - * doc = DocumentApp.create('Document Name'); - */ - interface DocumentApp { - Attribute: typeof Attribute; - ElementType: typeof ElementType; - GlyphType: typeof GlyphType; - HorizontalAlignment: typeof HorizontalAlignment; - ParagraphHeading: typeof ParagraphHeading; - PositionedLayout: typeof PositionedLayout; - TextAlignment: typeof TextAlignment; - VerticalAlignment: typeof VerticalAlignment; - create(name: string): Document; - getActiveDocument(): Document; - getUi(): Base.Ui; - openById(id: string): Document; - openByUrl(url: string): Document; - /** @deprecated DO NOT USE */ FontFamily: typeof FontFamily; - } - /** - * A generic element. Document contents are - * represented as elements. For example, ListItem, Paragraph, and Table are - * elements and inherit all of the methods defined by Element, such as getType(). - * Implementing classes - * - * NameBrief description - * - * BodyAn element representing a document body. - * - * ContainerElementA generic element that may contain other elements. - * - * EquationAn element representing a mathematical expression. - * - * EquationFunctionAn element representing a function in a mathematical Equation. - * - * EquationFunctionArgumentSeparatorAn element representing a function separator in a mathematical Equation. - * - * EquationSymbolAn element representing a symbol in a mathematical Equation. - * - * FooterSectionAn element representing a footer section. - * - * FootnoteAn element representing a footnote. - * - * FootnoteSectionAn element representing a footnote section. - * - * HeaderSectionAn element representing a header section. - * - * HorizontalRuleAn element representing an horizontal rule. - * - * InlineDrawingAn element representing an embedded drawing. - * - * InlineImageAn element representing an embedded image. - * - * ListItemAn element representing a list item. - * - * PageBreakAn element representing a page break. - * - * ParagraphAn element representing a paragraph. - * - * TableAn element representing a table. - * - * TableCellAn element representing a table cell. - * - * TableOfContentsAn element containing a table of contents. - * - * TableRowAn element representing a table row. - * - * TextAn element representing a rich text region. - * - * UnsupportedElementAn element representing a region that is unknown or cannot be affected by a script, such as a - * page number. - */ - interface Element { - asBody(): Body; - asDate(): Date; - asEquation(): Equation; - asEquationFunction(): EquationFunction; - asEquationFunctionArgumentSeparator(): EquationFunctionArgumentSeparator; - asEquationSymbol(): EquationSymbol; - asFooterSection(): FooterSection; - asFootnote(): Footnote; - asFootnoteSection(): FootnoteSection; - asHeaderSection(): HeaderSection; - asHorizontalRule(): HorizontalRule; - asInlineDrawing(): InlineDrawing; - asInlineImage(): InlineImage; - asListItem(): ListItem; - asPageBreak(): PageBreak; - asParagraph(): Paragraph; - asPerson(): Person; - asRichLink(): RichLink; - asTable(): Table; - asTableCell(): TableCell; - asTableOfContents(): TableOfContents; - asTableRow(): TableRow; - asText(): Text; - copy(): Element; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): Element; - removeFromParent(): Element; - setAttributes(attributes: any): Element; - } - /** - * An enumeration of all the element types. - * - * Use the ElementType enumeration to check the type of a given element, for instance: - * - * var firstChild = DocumentApp.getActiveDocument().getBody().getChild(0); - * if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { - * // It's a paragraph, apply a paragraph heading. - * firstChild.asParagraph().setHeading(DocumentApp.ParagraphHeading.HEADING1); - * } - */ - enum ElementType { - BODY_SECTION, - COMMENT_SECTION, - DATE, - DOCUMENT, - EQUATION, - EQUATION_FUNCTION, - EQUATION_FUNCTION_ARGUMENT_SEPARATOR, - EQUATION_SYMBOL, - FOOTER_SECTION, - FOOTNOTE, - FOOTNOTE_SECTION, - HEADER_SECTION, - HORIZONTAL_RULE, - INLINE_DRAWING, - INLINE_IMAGE, - LIST_ITEM, - PAGE_BREAK, - PARAGRAPH, - PERSON, - RICH_LINK, - TABLE, - TABLE_CELL, - TABLE_OF_CONTENTS, - TABLE_ROW, - TEXT, - UNSUPPORTED, - } - /** - * An element representing a mathematical expression. An Equation may contain EquationFunction, EquationSymbol, and Text elements. For more information on - * document structure, see the guide to - * extending Google Docs. - */ - interface Equation extends Element { - clear(): Equation; - copy(): Equation; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): Equation; - removeFromParent(): Equation; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): Equation; - setLinkUrl(url: string): Equation; - setTextAlignment(textAlignment: TextAlignment): Equation; - } - /** - * An element representing a function in a mathematical Equation. An EquationFunction may contain EquationFunction, EquationFunctionArgumentSeparator, EquationSymbol, and Text elements. For more - * information on document structure, see the guide to extending Google Docs. - */ - interface EquationFunction extends Element { - clear(): EquationFunction; - copy(): EquationFunction; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getCode(): string; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): EquationFunction; - removeFromParent(): EquationFunction; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): EquationFunction; - setLinkUrl(url: string): EquationFunction; - setTextAlignment(textAlignment: TextAlignment): EquationFunction; - } - /** - * An element representing a function separator in a mathematical Equation. An EquationFunctionArgumentSeparator cannot contain any other element. For more information on - * document structure, see the guide to - * extending Google Docs. - */ - interface EquationFunctionArgumentSeparator extends Element { - copy(): EquationFunctionArgumentSeparator; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): EquationFunctionArgumentSeparator; - removeFromParent(): EquationFunctionArgumentSeparator; - setAttributes(attributes: any): EquationFunctionArgumentSeparator; - } - /** - * An element representing a symbol in a mathematical Equation. An EquationSymbol - * cannot contain any other element. For more information on document structure, see the guide to extending Google Docs. - */ - interface EquationSymbol extends Element { - copy(): EquationSymbol; - getAttributes(): any; - getCode(): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): EquationSymbol; - removeFromParent(): EquationSymbol; - setAttributes(attributes: any): EquationSymbol; - } - /** - * Deprecated. The methods getFontFamily() and setFontFamily(String) now use string - * names for fonts instead of this enum. Although this enum is deprecated, it will remain - * available for compatibility with older scripts. - * An enumeration of the supported fonts. - * - * Use the FontFamily enumeration to set the font for a range of text, element or - * document. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Insert a paragraph at the start of the document. - * body.insertParagraph(0, "Hello, Apps Script!"); - * - * // Set the document font to Calibri. - * body.editAsText().setFontFamily(DocumentApp.FontFamily.CALIBRI); - * - * // Set the first paragraph font to Arial. - * body.getParagraphs()[0].setFontFamily(DocumentApp.FontFamily.ARIAL); - * - * // Set "Apps Script" to Comic Sans MS. - * var text = 'Apps Script'; - * var a = body.getText().indexOf(text); - * var b = a + text.length - 1; - * body.editAsText().setFontFamily(a, b, DocumentApp.FontFamily.COMIC_SANS_MS); - */ - enum FontFamily { - AMARANTH, - ARIAL, - ARIAL_BLACK, - ARIAL_NARROW, - ARVO, - CALIBRI, - CAMBRIA, - COMIC_SANS_MS, - CONSOLAS, - CORSIVA, - COURIER_NEW, - DANCING_SCRIPT, - DROID_SANS, - DROID_SERIF, - GARAMOND, - GEORGIA, - GLORIA_HALLELUJAH, - GREAT_VIBES, - LOBSTER, - MERRIWEATHER, - PACIFICO, - PHILOSOPHER, - POIRET_ONE, - QUATTROCENTO, - ROBOTO, - SHADOWS_INTO_LIGHT, - SYNCOPATE, - TAHOMA, - TIMES_NEW_ROMAN, - TREBUCHET_MS, - UBUNTU, - VERDANA, - } - /** - * An element representing a footer section. A Document typically contains at most one FooterSection. The FooterSection may contain ListItem, Paragraph, and - * Table elements. For more information on document structure, see the guide to extending Google Docs. - */ - interface FooterSection extends Element { - appendHorizontalRule(): HorizontalRule; - appendImage(image: Base.BlobSource): InlineImage; - appendImage(image: InlineImage): InlineImage; - appendListItem(listItem: ListItem): ListItem; - appendListItem(text: string): ListItem; - appendParagraph(paragraph: Paragraph): Paragraph; - appendParagraph(text: string): Paragraph; - appendTable(): Table; - appendTable(cells: string[][]): Table; - appendTable(table: Table): Table; - clear(): FooterSection; - copy(): FooterSection; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getImages(): InlineImage[]; - getListItems(): ListItem[]; - getNumChildren(): Integer; - getParagraphs(): Paragraph[]; - getParent(): ContainerElement; - getTables(): Table[]; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertImage(childIndex: Integer, image: InlineImage): InlineImage; - insertListItem(childIndex: Integer, listItem: ListItem): ListItem; - insertListItem(childIndex: Integer, text: string): ListItem; - insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; - insertParagraph(childIndex: Integer, text: string): Paragraph; - insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: string[][]): Table; - insertTable(childIndex: Integer, table: Table): Table; - removeChild(child: Element): FooterSection; - removeFromParent(): FooterSection; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): FooterSection; - setText(text: string): FooterSection; - setTextAlignment(textAlignment: TextAlignment): FooterSection; - /** @deprecated DO NOT USE */ getFootnotes(): Footnote[]; - /** @deprecated DO NOT USE */ getLinkUrl(): string; - /** @deprecated DO NOT USE */ getNextSibling(): Element; - /** @deprecated DO NOT USE */ getPreviousSibling(): Element; - /** @deprecated DO NOT USE */ isAtDocumentEnd(): boolean; - /** @deprecated DO NOT USE */ setLinkUrl(url: string): FooterSection; - } - /** - * An element representing a footnote. Each Footnote is contained within a ListItem - * or Paragraph and has a corresponding FootnoteSection element for the footnote's - * contents. The Footnote itself cannot contain any other element. For more information on - * document structure, see the guide to - * extending Google Docs. - */ - interface Footnote extends Element { - copy(): Footnote; - getAttributes(): any; - getFootnoteContents(): FootnoteSection; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - removeFromParent(): Footnote; - setAttributes(attributes: any): Footnote; - } - /** - * An element representing a footnote section. A FootnoteSection contains the text that - * corresponds to a Footnote. The FootnoteSection may contain ListItem or - * Paragraph elements. For more information on document structure, see the guide to extending Google Docs. - */ - interface FootnoteSection extends Element { - appendParagraph(paragraph: Paragraph): Paragraph; - appendParagraph(text: string): Paragraph; - clear(): FootnoteSection; - copy(): FootnoteSection; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getNextSibling(): Element; - getNumChildren(): Integer; - getParagraphs(): Paragraph[]; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; - insertParagraph(childIndex: Integer, text: string): Paragraph; - removeChild(child: Element): FootnoteSection; - removeFromParent(): FootnoteSection; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): FootnoteSection; - setText(text: string): FootnoteSection; - setTextAlignment(textAlignment: TextAlignment): FootnoteSection; - /** @deprecated DO NOT USE */ getFootnotes(): Footnote[]; - /** @deprecated DO NOT USE */ getLinkUrl(): string; - /** @deprecated DO NOT USE */ isAtDocumentEnd(): boolean; - /** @deprecated DO NOT USE */ setLinkUrl(url: string): FootnoteSection; - } - /** - * An enumeration of the supported glyph types. - * - * Use the GlyphType enumeration to set the bullet type for list items. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Insert at list item, with the default nesting level of zero. - * body.appendListItem("Item 1"); - * - * // Append a second list item, with a nesting level of one, indented one inch. - * // The two items will have different bullet glyphs. - * body.appendListItem("Item 2").setNestingLevel(1).setIndentStart(72) - * .setGlyphType(DocumentApp.GlyphType.SQUARE_BULLET); - */ - enum GlyphType { - BULLET, - HOLLOW_BULLET, - SQUARE_BULLET, - NUMBER, - LATIN_UPPER, - LATIN_LOWER, - ROMAN_UPPER, - ROMAN_LOWER, - } - /** - * An element representing a header section. A Document typically contains at most one HeaderSection. The HeaderSection may contain ListItem, Paragraph, and - * Table elements. For more information on document structure, see the guide to extending Google Docs. - */ - interface HeaderSection extends Element { - appendHorizontalRule(): HorizontalRule; - appendImage(image: Base.BlobSource): InlineImage; - appendImage(image: InlineImage): InlineImage; - appendListItem(listItem: ListItem): ListItem; - appendListItem(text: string): ListItem; - appendParagraph(paragraph: Paragraph): Paragraph; - appendParagraph(text: string): Paragraph; - appendTable(): Table; - appendTable(cells: string[][]): Table; - appendTable(table: Table): Table; - clear(): HeaderSection; - copy(): HeaderSection; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getImages(): InlineImage[]; - getListItems(): ListItem[]; - getNumChildren(): Integer; - getParagraphs(): Paragraph[]; - getParent(): ContainerElement; - getTables(): Table[]; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertImage(childIndex: Integer, image: InlineImage): InlineImage; - insertListItem(childIndex: Integer, listItem: ListItem): ListItem; - insertListItem(childIndex: Integer, text: string): ListItem; - insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; - insertParagraph(childIndex: Integer, text: string): Paragraph; - insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: string[][]): Table; - insertTable(childIndex: Integer, table: Table): Table; - removeChild(child: Element): HeaderSection; - removeFromParent(): HeaderSection; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): HeaderSection; - setText(text: string): HeaderSection; - setTextAlignment(textAlignment: TextAlignment): HeaderSection; - /** @deprecated DO NOT USE */ getFootnotes(): Footnote[]; - /** @deprecated DO NOT USE */ getLinkUrl(): string; - /** @deprecated DO NOT USE */ getNextSibling(): Element; - /** @deprecated DO NOT USE */ getPreviousSibling(): Element; - /** @deprecated DO NOT USE */ isAtDocumentEnd(): boolean; - /** @deprecated DO NOT USE */ setLinkUrl(url: string): HeaderSection; - } - /** - * An enumeration of the supported horizontal alignment types. - * - * Use the HorizontalAlignment enumeration to manipulate the alignment of Paragraph contents. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Insert a paragraph and a table at the start of document. - * var par1 = body.insertParagraph(0, "Center"); - * var table = body.insertTable(1, [['Left', 'Right']]); - * var par2 = table.getCell(0, 0).getChild(0).asParagraph(); - * var par3 = table.getCell(0, 0).getChild(0).asParagraph(); - * - * // Center align the first paragraph. - * par1.setAlignment(DocumentApp.HorizontalAlignment.CENTER); - * - * // Left align the first cell. - * par2.setAlignment(DocumentApp.HorizontalAlignment.LEFT); - * - * // Right align the second cell. - * par3.setAlignment(DocumentApp.HorizontalAlignment.RIGHT); - */ - enum HorizontalAlignment { - LEFT, - CENTER, - RIGHT, - JUSTIFY, - } - /** - * An element representing an horizontal rule. A HorizontalRule can be contained within a - * ListItem or Paragraph, but cannot itself contain any other element. For more - * information on document structure, see the guide to extending Google Docs. - */ - interface HorizontalRule extends Element { - copy(): HorizontalRule; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - removeFromParent(): HorizontalRule; - setAttributes(attributes: any): HorizontalRule; - } - /** - * An element representing an embedded drawing. An InlineDrawing can be contained within a - * ListItem or Paragraph, unless the ListItem or Paragraph is within - * a FootnoteSection. An InlineDrawing cannot itself contain any other element. For - * more information on document structure, see the guide to extending Google Docs. - */ - interface InlineDrawing extends Element { - copy(): InlineDrawing; - getAltDescription(): string; - getAltTitle(): string; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): InlineDrawing; - removeFromParent(): InlineDrawing; - setAltDescription(description: string): InlineDrawing; - setAltTitle(title: string): InlineDrawing; - setAttributes(attributes: any): InlineDrawing; - } - /** - * An element representing an embedded image. An InlineImage can be contained within a - * ListItem or Paragraph, unless the ListItem or Paragraph is within - * a FootnoteSection. An InlineImage cannot itself contain any other element. For - * more information on document structure, see the guide to extending Google Docs. - */ - interface InlineImage extends Element { - copy(): InlineImage; - getAltDescription(): string; - getAltTitle(): string; - getAs(contentType: string): Base.Blob; - getAttributes(): any; - getBlob(): Base.Blob; - getHeight(): Integer; - getLinkUrl(): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - getWidth(): Integer; - isAtDocumentEnd(): boolean; - merge(): InlineImage; - removeFromParent(): InlineImage; - setAltDescription(description: string): InlineImage; - setAltTitle(title: string): InlineImage; - setAttributes(attributes: any): InlineImage; - setHeight(height: Integer): InlineImage; - setLinkUrl(url: string): InlineImage; - setWidth(width: Integer): InlineImage; - } - /** - * An element representing a list item. A ListItem is a Paragraph that is associated - * with a list ID. A ListItem may contain Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, and Text - * elements. For more information on document structure, see the guide to extending Google Docs. - * - * ListItems may not contain new-line characters. New-line characters ("\n") are - * converted to line-break characters ("\r"). - * - * ListItems with the same list ID belong to the same list and are numbered accordingly. - * The ListItems for a given list are not required to be adjacent in the document or even - * have the same parent element. Two items belonging to the same list may exist anywhere in the - * document while maintaining consecutive numbering, as the following example illustrates: - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Append a new list item to the body. - * var item1 = body.appendListItem('Item 1'); - * - * // Log the new list item's list ID. - * Logger.log(item1.getListId()); - * - * // Append a table after the list item. - * body.appendTable([ - * ['Cell 1', 'Cell 2'] - * ]); - * - * // Append a second list item with the same list ID. The two items are treated as the same list, - * // despite not being consecutive. - * var item2 = body.appendListItem('Item 2'); - * item2.setListId(item1); - */ - interface ListItem extends Element { - addPositionedImage(image: Base.BlobSource): PositionedImage; - appendHorizontalRule(): HorizontalRule; - appendInlineImage(image: Base.BlobSource): InlineImage; - appendInlineImage(image: InlineImage): InlineImage; - appendPageBreak(): PageBreak; - appendPageBreak(pageBreak: PageBreak): PageBreak; - appendText(text: string): Text; - appendText(text: Text): Text; - clear(): ListItem; - copy(): ListItem; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAlignment(): HorizontalAlignment; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getGlyphType(): GlyphType; - getHeading(): ParagraphHeading; - getIndentEnd(): number; - getIndentFirstLine(): number; - getIndentStart(): number; - getLineSpacing(): number; - getLinkUrl(): string; - getListId(): string; - getNestingLevel(): Integer; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPositionedImage(id: string): PositionedImage; - getPositionedImages(): PositionedImage[]; - getPreviousSibling(): Element; - getSpacingAfter(): number; - getSpacingBefore(): number; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertInlineImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertInlineImage(childIndex: Integer, image: InlineImage): InlineImage; - insertPageBreak(childIndex: Integer): PageBreak; - insertPageBreak(childIndex: Integer, pageBreak: PageBreak): PageBreak; - insertText(childIndex: Integer, text: string): Text; - insertText(childIndex: Integer, text: Text): Text; - isAtDocumentEnd(): boolean; - isLeftToRight(): boolean; - merge(): ListItem; - removeChild(child: Element): ListItem; - removeFromParent(): ListItem; - removePositionedImage(id: string): boolean; - replaceText(searchPattern: string, replacement: string): Element; - setAlignment(alignment: HorizontalAlignment): ListItem; - setAttributes(attributes: any): ListItem; - setGlyphType(glyphType: GlyphType): ListItem; - setHeading(heading: ParagraphHeading): ListItem; - setIndentEnd(indentEnd: number): ListItem; - setIndentFirstLine(indentFirstLine: number): ListItem; - setIndentStart(indentStart: number): ListItem; - setLeftToRight(leftToRight: boolean): ListItem; - setLineSpacing(multiplier: number): ListItem; - setLinkUrl(url: string): ListItem; - setListId(listItem: ListItem): ListItem; - setNestingLevel(nestingLevel: Integer): ListItem; - setSpacingAfter(spacingAfter: number): ListItem; - setSpacingBefore(spacingBefore: number): ListItem; - setText(text: string): void; - setTextAlignment(textAlignment: TextAlignment): ListItem; - } - /** - * A Range that has a name and ID to allow later retrieval. Names are not - * necessarily unique; several different ranges in the same document may share the same name, much - * like a class in HTML. By contrast, IDs are unique within the document, like an ID in HTML. Once a - * NamedRange has been added to a document, it cannot be modified, only removed. - * - * A NamedRange can be accessed by any script that accesses the document. To avoid - * unintended conflicts between scripts, consider prefixing range names with a unique string. - * - * // Create a named range that includes every table in the document. - * var doc = DocumentApp.getActiveDocument(); - * var rangeBuilder = doc.newRange(); - * var tables = doc.getBody().getTables(); - * for (var i = 0; i < tables.length; i++) { - * rangeBuilder.addElement(tables[i]); - * } - * doc.addNamedRange('myUniquePrefix-tables', rangeBuilder.build()); - */ - interface NamedRange { - getId(): string; - getName(): string; - getRange(): Range; - remove(): void; - } - /** - * An element representing a page break. A PageBreak can be contained within a ListItem or Paragraph, unless the ListItem or Paragraph is within a - * Table, HeaderSection, FooterSection, or FootnoteSection. A PageBreak cannot itself contain any other element. For more information on document structure, - * see the guide to extending Google - * Docs. - */ - interface PageBreak extends Element { - copy(): PageBreak; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - removeFromParent(): PageBreak; - setAttributes(attributes: any): PageBreak; - } - /** - * An element representing a paragraph. A Paragraph may contain Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak, - * and Text elements. For more information on document structure, see the guide to extending Google Docs. - * - * Paragraphs may not contain new-line characters. New-line characters ("\n") are - * converted to line-break characters ("\r"). - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Append a document header paragraph. - * var header = body.appendParagraph("A Document"); - * header.setHeading(DocumentApp.ParagraphHeading.HEADING1); - * - * // Append a section header paragraph. - * var section = body.appendParagraph("Section 1"); - * section.setHeading(DocumentApp.ParagraphHeading.HEADING2); - * - * // Append a regular paragraph. - * body.appendParagraph("This is a typical paragraph."); - */ - interface Paragraph extends Element { - addPositionedImage(image: Base.BlobSource): PositionedImage; - appendHorizontalRule(): HorizontalRule; - appendInlineImage(image: Base.BlobSource): InlineImage; - appendInlineImage(image: InlineImage): InlineImage; - appendPageBreak(): PageBreak; - appendPageBreak(pageBreak: PageBreak): PageBreak; - appendText(text: string): Text; - appendText(text: Text): Text; - clear(): Paragraph; - copy(): Paragraph; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAlignment(): HorizontalAlignment; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getHeading(): ParagraphHeading; - getIndentEnd(): number; - getIndentFirstLine(): number; - getIndentStart(): number; - getLineSpacing(): number; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPositionedImage(id: string): PositionedImage; - getPositionedImages(): PositionedImage[]; - getPreviousSibling(): Element; - getSpacingAfter(): number; - getSpacingBefore(): number; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertInlineImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertInlineImage(childIndex: Integer, image: InlineImage): InlineImage; - insertPageBreak(childIndex: Integer): PageBreak; - insertPageBreak(childIndex: Integer, pageBreak: PageBreak): PageBreak; - insertText(childIndex: Integer, text: string): Text; - insertText(childIndex: Integer, text: Text): Text; - isAtDocumentEnd(): boolean; - isLeftToRight(): boolean; - merge(): Paragraph; - removeChild(child: Element): Paragraph; - removeFromParent(): Paragraph; - removePositionedImage(id: string): boolean; - replaceText(searchPattern: string, replacement: string): Element; - setAlignment(alignment: HorizontalAlignment): Paragraph; - setAttributes(attributes: any): Paragraph; - setHeading(heading: ParagraphHeading): Paragraph; - setIndentEnd(indentEnd: number): Paragraph; - setIndentFirstLine(indentFirstLine: number): Paragraph; - setIndentStart(indentStart: number): Paragraph; - setLeftToRight(leftToRight: boolean): Paragraph; - setLineSpacing(multiplier: number): Paragraph; - setLinkUrl(url: string): Paragraph; - setSpacingAfter(spacingAfter: number): Paragraph; - setSpacingBefore(spacingBefore: number): Paragraph; - setText(text: string): void; - setTextAlignment(textAlignment: TextAlignment): Paragraph; - } - /** - * An enumeration of the standard paragraph headings. - * - * Use the ParagraphHeading enumeration to configure the heading style for ParagraphElement. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Append a paragraph, with heading 1. - * var par1 = body.appendParagraph("Title"); - * par1.setHeading(DocumentApp.ParagraphHeading.HEADING1); - * - * // Append a paragraph, with heading 2. - * var par2 = body.appendParagraph("SubTitle"); - * par2.setHeading(DocumentApp.ParagraphHeading.HEADING2); - * - * // Append a paragraph, with normal heading. - * var par3 = body.appendParagraph("Text"); - * par3.setHeading(DocumentApp.ParagraphHeading.NORMAL); - */ - enum ParagraphHeading { - NORMAL, - HEADING1, - HEADING2, - HEADING3, - HEADING4, - HEADING5, - HEADING6, - TITLE, - SUBTITLE, - } - /** - * An element representing a link to a person. A person link refers to an email address and might - * optionally have a name associated with the address. If the name is set, the name is what is - * displayed in the document body. - */ - interface Person extends Element { - copy(): Person; - getAttributes(): any; - getEmail(): string; - getName(): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): Person; - removeFromParent(): Person; - setAttributes(attributes: any): Person; - } - /** - * A reference to a location in the document, relative to a specific element. The user's cursor is - * represented as a Position, among other uses. Scripts can only access the cursor of the - * user who is running the script, and only if the script is bound to the document. - * - * // Insert some text at the cursor position and make it bold. - * var cursor = DocumentApp.getActiveDocument().getCursor(); - * if (cursor) { - * // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's - * // containing element doesn't allow insertions, so show the user an error message. - * var element = cursor.insertText('ಠ‿ಠ'); - * if (element) { - * element.setBold(true); - * } else { - * DocumentApp.getUi().alert('Cannot insert text here.'); - * } - * } else { - * DocumentApp.getUi().alert('Cannot find a cursor.'); - * } - */ - interface Position { - getElement(): Element; - getOffset(): Integer; - getSurroundingText(): Text; - getSurroundingTextOffset(): Integer; - insertBookmark(): Bookmark; - insertInlineImage(image: Base.BlobSource): InlineImage; - insertText(text: string): Text; - } - /** - * Fixed position image anchored to a Paragraph. Unlike an InlineImage, a PositionedImage is - * not an Element. It does not have a - * parent or sibling Element. Instead, - * it is anchored to a Paragraph or ListItem, and is placed via offsets from - * that anchor. A PositionedImage has an ID that can be used to reference it. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Append a new paragraph. - * var paragraph = body.appendParagraph("New paragraph to anchor the image to."); - * * - * // Get an image in Drive from its ID. - * var image = DriveApp.getFileById('ENTER_IMAGE_FILE_ID_HERE').getBlob(); - * - * // Add the PositionedImage with offsets (in points). - * var posImage = paragraph.addPositionedImage(image) - * .setTopOffset(60) - * .setLeftOffset(40); - */ - interface PositionedImage { - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getHeight(): Integer; - getId(): string; - getLayout(): PositionedLayout; - getLeftOffset(): number; - getParagraph(): Paragraph; - getTopOffset(): number; - getWidth(): Integer; - setHeight(height: Integer): PositionedImage; - setLayout(layout: PositionedLayout): PositionedImage; - setLeftOffset(offset: number): PositionedImage; - setTopOffset(offset: number): PositionedImage; - setWidth(width: Integer): PositionedImage; - } - /** - * An enumeration that specifies how to lay out a PositionedImage in relation to surrounding - * text. - */ - enum PositionedLayout { - ABOVE_TEXT, - BREAK_BOTH, - BREAK_LEFT, - BREAK_RIGHT, - WRAP_TEXT, - } - /** - * A range of elements in a document. The user's selection is represented as a Range, among - * other uses. Scripts can only access the selection of the user who is running the script, and only - * if the script is bound to the document. - * - * // Bold all selected text. - * var selection = DocumentApp.getActiveDocument().getSelection(); - * if (selection) { - * var elements = selection.getRangeElements(); - * for (var i = 0; i < elements.length; i++) { - * var element = elements[i]; - * - * // Only modify elements that can be edited as text; skip images and other non-text elements. - * if (element.getElement().editAsText) { - * var text = element.getElement().editAsText(); - * - * // Bold the selected part of the element, or the full element if it's completely selected. - * if (element.isPartial()) { - * text.setBold(element.getStartOffset(), element.getEndOffsetInclusive(), true); - * } else { - * text.setBold(true); - * } - * } - * } - * } - */ - interface Range { - getRangeElements(): RangeElement[]; - /** @deprecated DO NOT USE */ getSelectedElements(): RangeElement[]; - } - /** - * A builder used to construct Range objects from document elements. - * - * // Change the user's selection to a range that includes every table in the document. - * var doc = DocumentApp.getActiveDocument(); - * var rangeBuilder = doc.newRange(); - * var tables = doc.getBody().getTables(); - * for (var i = 0; i < tables.length; i++) { - * rangeBuilder.addElement(tables[i]); - * } - * doc.setSelection(rangeBuilder.build()); - */ - interface RangeBuilder { - addElement(element: Element): RangeBuilder; - addElement(textElement: Text, startOffset: Integer, endOffsetInclusive: Integer): RangeBuilder; - addElementsBetween(startElement: Element, endElementInclusive: Element): RangeBuilder; - addElementsBetween( - startTextElement: Text, - startOffset: Integer, - endTextElementInclusive: Text, - endOffsetInclusive: Integer, - ): RangeBuilder; - addRange(range: Range): RangeBuilder; - build(): Range; - getRangeElements(): RangeElement[]; - /** @deprecated DO NOT USE */ getSelectedElements(): RangeElement[]; - } - /** - * A wrapper around an Element with a possible start and end offset. These offsets allow a - * range of characters within a Text - * element to be represented in search results, document selections, and named ranges. - */ - interface RangeElement { - getElement(): Element; - getEndOffsetInclusive(): Integer; - getStartOffset(): Integer; - isPartial(): boolean; - } - /** - * An element representing a link to a Google resource, such as a Drive file or a YouTube video. - */ - interface RichLink extends Element { - copy(): RichLink; - getAttributes(): any; - getMimeType(): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getTitle(): string; - getType(): ElementType; - getUrl(): string; - isAtDocumentEnd(): boolean; - merge(): RichLink; - removeFromParent(): RichLink; - setAttributes(attributes: any): RichLink; - } - /** - * An element representing a table. A Table may only contain TableRow elements. For - * more information on document structure, see the guide to extending Google Docs. - * - * When creating a Table that contains a large number of rows or cells, consider building - * it from a string array, as shown in the following example. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Create a two-dimensional array containing the cell contents. - * var cells = [ - * ['Row 1, Cell 1', 'Row 1, Cell 2'], - * ['Row 2, Cell 1', 'Row 2, Cell 2'] - * ]; - * - * // Build a table from the array. - * body.appendTable(cells); - */ - interface Table extends Element { - appendTableRow(): TableRow; - appendTableRow(tableRow: TableRow): TableRow; - clear(): Table; - copy(): Table; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getBorderColor(): string; - getBorderWidth(): number; - getCell(rowIndex: Integer, cellIndex: Integer): TableCell; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getColumnWidth(columnIndex: Integer): number; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getNumRows(): Integer; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getRow(rowIndex: Integer): TableRow; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertTableRow(childIndex: Integer): TableRow; - insertTableRow(childIndex: Integer, tableRow: TableRow): TableRow; - isAtDocumentEnd(): boolean; - removeChild(child: Element): Table; - removeFromParent(): Table; - removeRow(rowIndex: Integer): TableRow; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): Table; - setBorderColor(color: string): Table; - setBorderWidth(width: number): Table; - setColumnWidth(columnIndex: Integer, width: number): Table; - setLinkUrl(url: string): Table; - setTextAlignment(textAlignment: TextAlignment): Table; - } - /** - * An element representing a table cell. A TableCell is always contained within a TableRow and may contain ListItem, Paragraph, or Table elements. For - * more information on document structure, see the guide to extending Google Docs. - */ - interface TableCell extends Element { - appendHorizontalRule(): HorizontalRule; - appendImage(image: Base.BlobSource): InlineImage; - appendImage(image: InlineImage): InlineImage; - appendListItem(listItem: ListItem): ListItem; - appendListItem(text: string): ListItem; - appendParagraph(paragraph: Paragraph): Paragraph; - appendParagraph(text: string): Paragraph; - appendTable(): Table; - appendTable(cells: string[][]): Table; - appendTable(table: Table): Table; - clear(): TableCell; - copy(): TableCell; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getBackgroundColor(): string; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getColSpan(): Integer; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getPaddingBottom(): number; - getPaddingLeft(): number; - getPaddingRight(): number; - getPaddingTop(): number; - getParent(): ContainerElement; - getParentRow(): TableRow; - getParentTable(): Table; - getPreviousSibling(): Element; - getRowSpan(): Integer; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - getVerticalAlignment(): VerticalAlignment; - getWidth(): number; - insertHorizontalRule(childIndex: Integer): HorizontalRule; - insertImage(childIndex: Integer, image: Base.BlobSource): InlineImage; - insertImage(childIndex: Integer, image: InlineImage): InlineImage; - insertListItem(childIndex: Integer, listItem: ListItem): ListItem; - insertListItem(childIndex: Integer, text: string): ListItem; - insertParagraph(childIndex: Integer, paragraph: Paragraph): Paragraph; - insertParagraph(childIndex: Integer, text: string): Paragraph; - insertTable(childIndex: Integer): Table; - insertTable(childIndex: Integer, cells: string[][]): Table; - insertTable(childIndex: Integer, table: Table): Table; - isAtDocumentEnd(): boolean; - merge(): TableCell; - removeChild(child: Element): TableCell; - removeFromParent(): TableCell; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): TableCell; - setBackgroundColor(color: string): TableCell; - setLinkUrl(url: string): TableCell; - setPaddingBottom(paddingBottom: number): TableCell; - setPaddingLeft(paddingLeft: number): TableCell; - setPaddingRight(paddingTop: number): TableCell; - setPaddingTop(paddingTop: number): TableCell; - setText(text: string): TableCell; - setTextAlignment(textAlignment: TextAlignment): TableCell; - setVerticalAlignment(alignment: VerticalAlignment): TableCell; - setWidth(width: number): TableCell; - } - /** - * An element containing a table of contents. A TableOfContents may contain ListItem, Paragraph, and Table elements, although the contents of a TableOfContents are usually generated automatically by Google Docs. For more information on - * document structure, see the guide to - * extending Google Docs. - */ - interface TableOfContents extends Element { - clear(): TableOfContents; - copy(): TableOfContents; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getLinkUrl(): string; - getNextSibling(): Element; - getNumChildren(): Integer; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - isAtDocumentEnd(): boolean; - removeFromParent(): TableOfContents; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): TableOfContents; - setLinkUrl(url: string): TableOfContents; - setTextAlignment(textAlignment: TextAlignment): TableOfContents; - } - /** - * An element representing a table row. A TableRow is always contained within a Table and may only contain TableCell elements. For more information on document - * structure, see the guide to extending - * Google Docs. - */ - interface TableRow extends Element { - appendTableCell(): TableCell; - appendTableCell(textContents: string): TableCell; - appendTableCell(tableCell: TableCell): TableCell; - clear(): TableRow; - copy(): TableRow; - editAsText(): Text; - findElement(elementType: ElementType): RangeElement; - findElement(elementType: ElementType, from: RangeElement): RangeElement; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getCell(cellIndex: Integer): TableCell; - getChild(childIndex: Integer): Element; - getChildIndex(child: Element): Integer; - getLinkUrl(): string; - getMinimumHeight(): number; - getNextSibling(): Element; - getNumCells(): Integer; - getNumChildren(): Integer; - getParent(): ContainerElement; - getParentTable(): Table; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getType(): ElementType; - insertTableCell(childIndex: Integer): TableCell; - insertTableCell(childIndex: Integer, textContents: string): TableCell; - insertTableCell(childIndex: Integer, tableCell: TableCell): TableCell; - isAtDocumentEnd(): boolean; - merge(): TableRow; - removeCell(cellIndex: Integer): TableCell; - removeChild(child: Element): TableRow; - removeFromParent(): TableRow; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(attributes: any): TableRow; - setLinkUrl(url: string): TableRow; - setMinimumHeight(minHeight: number): TableRow; - setTextAlignment(textAlignment: TextAlignment): TableRow; - } - /** - * An element representing a rich text region. All text in a Document is contained within Text elements. - * A Text element can be contained within an Equation, EquationFunction, - * ListItem, or Paragraph, but cannot itself contain any other element. For more - * information on document structure, see the guide to extending Google Docs. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Use editAsText to obtain a single text element containing - * // all the characters in the document. - * var text = body.editAsText(); - * - * // Insert text at the beginning of the document. - * text.insertText(0, 'Inserted text.\n'); - * - * // Insert text at the end of the document. - * text.appendText('\nAppended text.'); - * - * // Make the first half of the document blue. - * text.setForegroundColor(0, text.getText().length / 2, '#00FFFF'); - */ - interface Text extends Element { - appendText(text: string): Text; - copy(): Text; - deleteText(startOffset: Integer, endOffsetInclusive: Integer): Text; - editAsText(): Text; - findText(searchPattern: string): RangeElement; - findText(searchPattern: string, from: RangeElement): RangeElement; - getAttributes(): any; - getAttributes(offset: Integer): any; - getBackgroundColor(): string; - getBackgroundColor(offset: Integer): string; - getFontFamily(): string; - getFontFamily(offset: Integer): string; - getFontSize(): Integer; - getFontSize(offset: Integer): Integer; - getForegroundColor(): string; - getForegroundColor(offset: Integer): string; - getLinkUrl(): string; - getLinkUrl(offset: Integer): string; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getText(): string; - getTextAlignment(): TextAlignment; - getTextAlignment(offset: Integer): TextAlignment; - getTextAttributeIndices(): Integer[]; - getType(): ElementType; - insertText(offset: Integer, text: string): Text; - isAtDocumentEnd(): boolean; - isBold(): boolean; - isBold(offset: Integer): boolean; - isItalic(): boolean; - isItalic(offset: Integer): boolean; - isStrikethrough(): boolean; - isStrikethrough(offset: Integer): boolean; - isUnderline(): boolean; - isUnderline(offset: Integer): boolean; - merge(): Text; - removeFromParent(): Text; - replaceText(searchPattern: string, replacement: string): Element; - setAttributes(startOffset: Integer, endOffsetInclusive: Integer, attributes: any): Text; - setAttributes(attributes: any): Text; - setBackgroundColor(startOffset: Integer, endOffsetInclusive: Integer, color: string): Text; - setBackgroundColor(color: string): Text; - setBold(bold: boolean): Text; - setBold(startOffset: Integer, endOffsetInclusive: Integer, bold: boolean): Text; - setFontFamily(startOffset: Integer, endOffsetInclusive: Integer, fontFamilyName: string): Text; - setFontFamily(fontFamilyName: string): Text; - setFontSize(size: Integer): Text; - setFontSize(startOffset: Integer, endOffsetInclusive: Integer, size: Integer): Text; - setForegroundColor(startOffset: Integer, endOffsetInclusive: Integer, color: string): Text; - setForegroundColor(color: string): Text; - setItalic(italic: boolean): Text; - setItalic(startOffset: Integer, endOffsetInclusive: Integer, italic: boolean): Text; - setLinkUrl(startOffset: Integer, endOffsetInclusive: Integer, url: string): Text; - setLinkUrl(url: string): Text; - setStrikethrough(strikethrough: boolean): Text; - setStrikethrough(startOffset: Integer, endOffsetInclusive: Integer, strikethrough: boolean): Text; - setText(text: string): Text; - setTextAlignment(startOffset: Integer, endOffsetInclusive: Integer, textAlignment: TextAlignment): Text; - setTextAlignment(textAlignment: TextAlignment): Text; - setUnderline(underline: boolean): Text; - setUnderline(startOffset: Integer, endOffsetInclusive: Integer, underline: boolean): Text; - } - /** - * An enumeration of the type of text alignments. - * - * // Make the first character in the first paragraph be superscript. - * var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); - * text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT); - */ - enum TextAlignment { - NORMAL, - SUPERSCRIPT, - SUBSCRIPT, - } - /** - * An element representing a region that is unknown or cannot be affected by a script, such as a - * page number. - */ - interface UnsupportedElement extends Element { - copy(): UnsupportedElement; - getAttributes(): any; - getNextSibling(): Element; - getParent(): ContainerElement; - getPreviousSibling(): Element; - getType(): ElementType; - isAtDocumentEnd(): boolean; - merge(): UnsupportedElement; - removeFromParent(): UnsupportedElement; - setAttributes(attributes: any): UnsupportedElement; - } - /** - * An enumeration of the supported vertical alignment types. - * - * Use the VerticalAlignment enumeration to set the vertical alignment of table cells. - * - * var body = DocumentApp.getActiveDocument().getBody(); - * - * // Append table containing two cells. - * var table = body.appendTable([['Top', 'Center', 'Bottom']]); - * - * // Align the first cell's contents to the top. - * table.getCell(0, 0).setVerticalAlignment(DocumentApp.VerticalAlignment.TOP); - * - * // Align the second cell's contents to the center. - * table.getCell(0, 1).setVerticalAlignment(DocumentApp.VerticalAlignment.CENTER); - * - * // Align the third cell's contents to the bottom. - * table.getCell(0, 2).setVerticalAlignment(DocumentApp.VerticalAlignment.BOTTOM); - */ - enum VerticalAlignment { - BOTTOM, - CENTER, - TOP, - } - } -} - -declare var DocumentApp: GoogleAppsScript.Document.DocumentApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.drive.d.ts b/node_modules/@types/google-apps-script/google-apps-script.drive.d.ts deleted file mode 100644 index 6517b2f..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.drive.d.ts +++ /dev/null @@ -1,398 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Drive { - /** - * An enum representing classes of users who can access a file or folder, besides any individual - * users who have been explicitly given access. These properties can be accessed from DriveApp.Access. - * - * // Creates a folder that anyone on the Internet can read from and write to. (Domain - * // administrators can prohibit this setting for users of a G Suite domain.) - * var folder = DriveApp.createFolder('Shared Folder'); - * folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT); - */ - enum Access { - ANYONE, - ANYONE_WITH_LINK, - DOMAIN, - DOMAIN_WITH_LINK, - PRIVATE, - } - /** - * Allows scripts to create, find, and modify files and folders in Google Drive. - * - * // Log the name of every file in the user's Drive. - * var files = DriveApp.getFiles(); - * while (files.hasNext()) { - * var file = files.next(); - * Logger.log(file.getName()); - * } - */ - interface DriveApp { - Access: typeof Access; - Permission: typeof Permission; - /** - * Adds the given file to the root of the user's Drive. - * This method does not move the file out of its existing parent folder; - * a file can have more than one parent simultaneously. - */ - addFile(child: File): Folder; - /** - * Adds the given folder to the root of the user's Drive. - * This method does not move the folder out of its existing parent folder; - * a folder can have more than one parent simultaneously. - */ - addFolder(child: Folder): Folder; - /** - * Resumes a file iteration using a continuation token from a previous iterator. - * This method is useful if processing an iterator in one execution would exceed - * the maximum execution time. Continuation tokens are generally valid for one week. - */ - continueFileIterator(continuationToken: string): FileIterator; - /** - * Resumes a folder iteration using a continuation token from a previous iterator. - * This method is useful if processing an iterator in one execution would exceed - * the maximum execution time. Continuation tokens are generally valid for one week. - */ - continueFolderIterator(continuationToken: string): FolderIterator; - /** Creates a file in the root of the user's Drive from a given Blob of arbitrary data. */ - createFile(blob: Base.BlobSource): File; - /** - * Creates a text file in the root of the user's Drive with the given name - * and contents. Throws an exception if content is larger than 50 MB. - */ - createFile(name: string, content: string): File; - /** - * Creates a file in the root of the user's Drive with the given name, contents, and MIME type. - * Throws an exception if content is larger than 10MB. - */ - createFile(name: string, content: string, mimeType: string): File; - /** Creates a folder in the root of the user's Drive with the given name. */ - createFolder(name: string): Folder; - /** Creates a shortcut to the provided Drive item ID, and returns it. */ - createShortcut(targetId: string): File; - /** - * Creates a shortcut to the provided Drive item ID and resource key, and - * returns it. Resource keys are an additional parameter which need to be - * passed to access the target file or folder that has been shared using a - * link. - */ - createShortcutForTargetIdAndResourceKey(targetId: string, targetResourceKey: string): File; - /** - * Gets the file with the given ID. - * Throws a scripting exception if the file does not exist or - * the user does not have permission to access it. - */ - getFileById(id: string): File; - /** - * Gets the file with the given ID and resource key. Resource keys are an - * additional parameter which need to be passed to access files that have - * been shared using a link. - * - * Throws a scripting exception if the file doesn't exist or the user - * doesn't have permission to access it. - */ - getFileByIdAndResourceKey(id: string, resourceKey: string): File; - /** Gets a collection of all files in the user's Drive. */ - getFiles(): FileIterator; - /** Gets a collection of all files in the user's Drive that have the given name. */ - getFilesByName(name: string): FileIterator; - /** Gets a collection of all files in the user's Drive that have the given MIME type. */ - getFilesByType(mimeType: string): FileIterator; - /** - * Gets the folder with the given ID. Throws a scripting exception if the folder - * does not exist or the user does not have permission to access it. - */ - getFolderById(id: string): Folder; - /** - * Gets the folder with the given ID and resource key. Resource keys are - * an additional parameter which need to be passed to access folders that - * have been shared using a link. - * Throws a scripting exception if the folder doesn't exist or the user - * doesn't have permission to access it. - */ - getFolderByIdAndResourceKey(id: string, resourceKey: string): Folder; - /** Gets a collection of all folders in the user's Drive. */ - getFolders(): FolderIterator; - /** Gets a collection of all folders in the user's Drive that have the given name. */ - getFoldersByName(name: string): FolderIterator; - /** Gets the folder at the root of the user's Drive. */ - getRootFolder(): Folder; - /** Gets the number of bytes the user is allowed to store in Drive. */ - getStorageLimit(): Integer; - /** Gets the number of bytes the user is currently storing in Drive. */ - getStorageUsed(): Integer; - /** Gets a collection of all the files in the trash of the user's Drive. */ - getTrashedFiles(): FileIterator; - /** Gets a collection of all the folders in the trash of the user's Drive. */ - getTrashedFolders(): FolderIterator; - /** - * Removes the given file from the root of the user's Drive. - * This method does not delete the file, but if a file is removed from all - * of its parents, it cannot be seen in Drive except by searching for it - * or using the "All items" view. - */ - removeFile(child: File): Folder; - /** - * Removes the given folder from the root of the user's Drive. - * This method does not delete the folder or its contents, but if a folder - * is removed from all of its parents, it cannot be seen in Drive except - * by searching for it or using the "All items" view. - */ - removeFolder(child: Folder): Folder; - /** - * Gets a collection of all files in the user's Drive that match the given search criteria. - * The search criteria are detailed the Google Drive SDK documentation. - * Note that the params argument is a query string that may contain string values, - * so take care to escape quotation marks correctly - * (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"'). - */ - searchFiles(params: string): FileIterator; - /** - * Gets a collection of all folders in the user's Drive that match the given search criteria. - * The search criteria are detailed the Google Drive SDK documentation. - * Note that the params argument is a query string that may contain string values, - * so take care to escape quotation marks correctly - * (for example "title contains 'Gulliver\\'s Travels'" or 'title contains "Gulliver\'s Travels"'). - */ - searchFolders(params: string): FolderIterator; - } - /** - * A file in Google Drive. Files can be accessed or created from DriveApp. - * - * // Trash every untitled spreadsheet that hasn't been updated in a week. - * var files = DriveApp.getFilesByName('Untitled spreadsheet'); - * while (files.hasNext()) { - * var file = files.next(); - * if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { - * file.setTrashed(true); - * } - * } - */ - interface File { - addCommenter(emailAddress: string): File; - addCommenter(user: Base.User): File; - addCommenters(emailAddresses: string[]): File; - addEditor(emailAddress: string): File; - addEditor(user: Base.User): File; - addEditors(emailAddresses: string[]): File; - addViewer(emailAddress: string): File; - addViewer(user: Base.User): File; - addViewers(emailAddresses: string[]): File; - getAccess(email: string): Permission; - getAccess(user: Base.User): Permission; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getDateCreated(): Base.Date; - getDescription(): string | null; - getDownloadUrl(): string; - getEditors(): User[]; - getId(): string; - getLastUpdated(): Base.Date; - getMimeType(): string; - getName(): string; - getOwner(): User; - getParents(): FolderIterator; - getResourceKey(): string | null; - getSecurityUpdateEligible(): boolean; - getSecurityUpdateEnabled(): boolean; - getSharingAccess(): Access; - getSharingPermission(): Permission; - getSize(): Integer; - getTargetId(): string | null; - getTargetMimeType(): string | null; - getTargetResourceKey(): string | null; - getThumbnail(): Base.Blob; - getUrl(): string; - getViewers(): User[]; - isShareableByEditors(): boolean; - isStarred(): boolean; - isTrashed(): boolean; - makeCopy(): File; - makeCopy(destination: Folder): File; - makeCopy(name: string): File; - makeCopy(name: string, destination: Folder): File; - moveTo(destination: Folder): File; - removeCommenter(emailAddress: string): File; - removeCommenter(user: Base.User): File; - removeEditor(emailAddress: string): File; - removeEditor(user: Base.User): File; - removeViewer(emailAddress: string): File; - removeViewer(user: Base.User): File; - revokePermissions(user: string): File; - revokePermissions(user: Base.User): File; - setContent(content: string): File; - setDescription(description: string): File; - setName(name: string): File; - setOwner(emailAddress: string): File; - setOwner(user: Base.User): File; - setSecurityUpdateEnabled(enabled: boolean): File; - setShareableByEditors(shareable: boolean): File; - setSharing(accessType: Access, permissionType: Permission): File; - setStarred(starred: boolean): File; - setTrashed(trashed: boolean): File; - } - /** - * An iterator that allows scripts to iterate over a potentially large collection of files. File - * iterators can be acccessed from DriveApp or a Folder. - * - * // Log the name of every file in the user's Drive. - * var files = DriveApp.getFiles(); - * while (files.hasNext()) { - * var file = files.next(); - * Logger.log(file.getName()); - * } - */ - interface FileIterator { - /** - * Gets a token that can be used to resume this iteration at a later time. - * This method is useful if processing an iterator in one execution would - * exceed the maximum execution time. Continuation tokens are generally valid for one week. - */ - getContinuationToken(): string; - /** Determines whether calling next() will return an item. */ - hasNext(): boolean; - /** - * Gets the next item in the collection of files or folders. - * Throws an exception if no items remain. - */ - next(): File; - } - /** - * A folder in Google Drive. Folders can be accessed or created from DriveApp. - * - * // Log the name of every folder in the user's Drive. - * var folders = DriveApp.getFolders(); - * while (folders.hasNext()) { - * var folder = folders.next(); - * Logger.log(folder.getName()); - * } - */ - interface Folder { - addEditor(emailAddress: string): Folder; - addEditor(user: Base.User): Folder; - addEditors(emailAddresses: string[]): Folder; - addFile(child: File): Folder; - addFolder(child: Folder): Folder; - addViewer(emailAddress: string): Folder; - addViewer(user: Base.User): Folder; - addViewers(emailAddresses: string[]): Folder; - createFile(blob: Base.BlobSource): File; - createFile(name: string, content: string): File; - createFile(name: string, content: string, mimeType: string): File; - createFolder(name: string): Folder; - createShortcut(targetId: string): File; - createShortcutForTargetIdAndResourceKey(targetId: string, targetResourceKey: string): File; - getAccess(email: string): Permission; - getAccess(user: Base.User): Permission; - getDateCreated(): Base.Date; - getDescription(): string | null; - getEditors(): User[]; - getFiles(): FileIterator; - getFilesByName(name: string): FileIterator; - getFilesByType(mimeType: string): FileIterator; - getFolders(): FolderIterator; - getFoldersByName(name: string): FolderIterator; - getId(): string; - getLastUpdated(): Base.Date; - getName(): string; - getOwner(): User; - getParents(): FolderIterator; - getResourceKey(): string | null; - getSecurityUpdateEligible(): boolean; - getSecurityUpdateEnabled(): boolean; - getSharingAccess(): Access; - getSharingPermission(): Permission; - getSize(): Integer; - getUrl(): string; - getViewers(): User[]; - isShareableByEditors(): boolean; - isStarred(): boolean; - isTrashed(): boolean; - moveTo(destination: Folder): Folder; - removeEditor(emailAddress: string): Folder; - removeEditor(user: Base.User): Folder; - removeFile(child: File): Folder; - removeFolder(child: Folder): Folder; - removeViewer(emailAddress: string): Folder; - removeViewer(user: Base.User): Folder; - revokePermissions(user: string): Folder; - revokePermissions(user: Base.User): Folder; - searchFiles(params: string): FileIterator; - searchFolders(params: string): FolderIterator; - setDescription(description: string): Folder; - setName(name: string): Folder; - setOwner(emailAddress: string): Folder; - setOwner(user: Base.User): Folder; - setSecurityUpdateEnabled(enabled: boolean): Folder; - setShareableByEditors(shareable: boolean): Folder; - setSharing(accessType: Access, permissionType: Permission): Folder; - setStarred(starred: boolean): Folder; - setTrashed(trashed: boolean): Folder; - } - /** - * An object that allows scripts to iterate over a potentially large collection of folders. Folder - * iterators can be acccessed from DriveApp, a File, or a Folder. - * - * // Log the name of every folder in the user's Drive. - * var folders = DriveApp.getFolders(); - * while (folders.hasNext()) { - * var folder = folders.next(); - * Logger.log(folder.getName()); - * } - */ - interface FolderIterator { - getContinuationToken(): string; - hasNext(): boolean; - next(): Folder; - } - /** - * An enum representing the permissions granted to users who can access a file or folder, besides - * any individual users who have been explicitly given access. These properties can be accessed from - * DriveApp.Permission. - * - * // Creates a folder that anyone on the Internet can read from and write to. (Domain - * // administrators can prohibit this setting for G Suite users.) - * var folder = DriveApp.createFolder('Shared Folder'); - * folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT); - */ - enum Permission { - VIEW, - EDIT, - COMMENT, - OWNER, - ORGANIZER, - NONE, - } - /** - * A user associated with a file in Google Drive. Users can be accessed from File.getEditors(), Folder.getViewers(), and other methods. - * - * // Log the email address of all users who have edit access to a file. - * var file = DriveApp.getFileById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var editors = file.getEditors(); - * for (var i = 0; i < editors.length; i++) { - * Logger.log(editors[i].getEmail()); - * } - */ - interface User { - /** Gets the domain name associated with the user's account. */ - getDomain(): string; - /** - * Gets the user's email address. The user's email address is only available - * if the user has chosen to share the address from the Google+ account settings - * page, or if the user belongs to the same domain as the user running the script - * and the domain administrator has allowed all users within the domain to see - * other users' email addresses. - */ - getEmail(): string; - /** Gets the user's name. This method returns null if the user's name is not available. */ - getName(): string; - /** Gets the URL for the user's photo. This method returns null if the user's photo is not available. */ - getPhotoUrl(): string; - /** @deprecated DO NOT USE */ getUserLoginId(): string; - } - } -} - -declare var DriveApp: GoogleAppsScript.Drive.DriveApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.forms.d.ts b/node_modules/@types/google-apps-script/google-apps-script.forms.d.ts deleted file mode 100644 index e582997..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.forms.d.ts +++ /dev/null @@ -1,1119 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Forms { - /** - * An enum representing the supported types of image alignment. Alignment types can be accessed from - * FormApp.Alignment. - * - * // Open a form by ID and add a new image item with alignment - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var img = UrlFetchApp.fetch('https://www.google.com/images/srpr/logo4w.png'); - * form.addImageItem() - * .setImage(img) - * .setAlignment(FormApp.Alignment.CENTER); - */ - enum Alignment { - LEFT, - CENTER, - RIGHT, - } - /** - * A question item, presented as a grid of columns and rows, that allows the respondent to select - * multiple choices per row from a sequence of checkboxes. Items can be accessed or created from a - * Form. - * - * // Open a form by ID and add a new checkgox grid item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addCheckboxGridItem(); - * item.setTitle('Where did you celebrate New Years?') - * .setRows(['New York', 'San Francisco', 'London']) - * .setColumns(['2014', '2015', '2016', '2017']); - */ - interface CheckboxGridItem { - clearValidation(): CheckboxGridItem; - createResponse(responses: string[][]): ItemResponse; - duplicate(): CheckboxGridItem; - getColumns(): string[]; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getRows(): string[]; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setColumns(columns: string[]): CheckboxGridItem; - setHelpText(text: string): CheckboxGridItem; - setRequired(enabled: boolean): CheckboxGridItem; - setRows(rows: string[]): CheckboxGridItem; - setTitle(title: string): CheckboxGridItem; - setValidation(validation: CheckboxGridValidation): CheckboxGridItem; - } - /** - * A DataValidation for a CheckboxGridItem. - * - * // Add a checkbox grid item to a form and require one response per column. - * var checkboxGridItem = form.addCheckboxGridItem(); - * checkboxGridItem.setTitle('Where did you celebrate New Years?') - * .setRows(['New York', 'San Francisco', 'London']) - * .setColumns(['2014', '2015', '2016', '2017']); - * var checkboxGridValidation = FormApp.createCheckboxGridValidation() - * .setHelpText(“Select one item per column.”) - * .requireLimitOneResponsePerColumn() - * .build(); - * checkboxGridItem.setValidation(checkboxGridValidation); - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface CheckboxGridValidation { - } - /** - * A DataValidationBuilder for a CheckboxGridValidation. - * - * // Add a checkbox grid item to a form and restrict it to one response per column. - * var checkboxGridItem = form.addCheckboxGridItem(); - * checkboxGridItem.setTitle('Where did you celebrate New Years?') - * .setRows(['New York', 'San Francisco', 'London']) - * .setColumns(['2014', '2015', '2016', '2017']); - * var checkboxGridValidation = FormApp.createcheckboxGridValidation() - * .setHelpText(“Select one item per column.”) - * .requireLimitOneResponsePerColumn() - * .build(); - * checkboxGridItem.setValidation(checkboxGridValidation); - */ - interface CheckboxGridValidationBuilder { - requireLimitOneResponsePerColumn(): CheckboxGridValidationBuilder; - build(): CheckboxGridValidation; - setHelpText(text: string): CheckboxGridValidationBuilder; - } - /** - * A question item that allows the respondent to select one or more checkboxes, as well as an - * optional "other" field. Items can be accessed or created from a Form. When used in a - * quiz, these items are autograded. - * - * // Open a form by ID and add a new checkbox item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addCheckboxItem(); - * item.setTitle('What condiments would you like on your hot dog?') - * .setChoices([ - * item.createChoice('Ketchup'), - * item.createChoice('Mustard'), - * item.createChoice('Relish') - * ]) - * .showOtherOption(true); - */ - interface CheckboxItem { - clearValidation(): CheckboxItem; - createChoice(value: string): Choice; - createChoice(value: string, isCorrect: boolean): Choice; - createResponse(responses: string[]): ItemResponse; - duplicate(): CheckboxItem; - getChoices(): Choice[]; - getFeedbackForCorrect(): QuizFeedback; - getFeedbackForIncorrect(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - hasOtherOption(): boolean; - isRequired(): boolean; - setChoiceValues(values: string[]): CheckboxItem; - setChoices(choices: Choice[]): CheckboxItem; - setFeedbackForCorrect(feedback: QuizFeedback): CheckboxItem; - setFeedbackForIncorrect(feedback: QuizFeedback): CheckboxItem; - setHelpText(text: string): CheckboxItem; - setPoints(points: Integer): CheckboxItem; - setRequired(enabled: boolean): CheckboxItem; - setTitle(title: string): CheckboxItem; - setValidation(validation: CheckboxValidation): CheckboxItem; - showOtherOption(enabled: boolean): CheckboxItem; - } - /** - * A DataValidation for a CheckboxItem. - * - * // Add a checkBox item to a form and require exactly two selections. - * var checkBoxItem = form.addCheckboxItem(); - * checkBoxItem.setTitle('What two condiments would you like on your hot dog?'); - * checkBoxItem.setChoices([ - * checkBoxItem.createChoice('Ketchup'), - * checkBoxItem.createChoice('Mustard'), - * checkBoxItem.createChoice('Relish') - * ]); - * var checkBoxValidation = FormApp.createCheckboxValidation() - * .setHelpText(“Select two condiments.”) - * .requireSelectExactly(2) - * .build(); - * checkBoxItem.setValidation(checkBoxValidation); - */ - interface CheckboxValidation { - requireSelectAtLeast(number: Integer): CheckboxValidation; - requireSelectAtMost(number: Integer): CheckboxValidation; - requireSelectExactly(number: Integer): CheckboxValidation; - } - /** - * A DataValidationBuilder for a CheckboxValidation. - * - * // Add a checkBox item to a form and require exactly two selections. - * var checkBoxItem = form.addCheckboxItem(); - * checkBoxItem.setTitle('What two condiments would you like on your hot dog?'); - * checkBoxItem.setChoices([ - * checkBoxItem.createChoice('Ketchup'), - * checkBoxItem.createChoice('Mustard'), - * checkBoxItem.createChoice('Relish') - * ]); - * var checkBoxValidation = FormApp.createCheckboxValidation() - * .setHelpText(“Select two condiments.”) - * .requireSelectExactly(2) - * .build(); - * checkBoxItem.setValidation(checkBoxValidation); - */ - interface CheckboxValidationBuilder { - requireSelectAtLeast(number: Integer): CheckboxValidationBuilder; - requireSelectAtMost(number: Integer): CheckboxValidationBuilder; - requireSelectExactly(number: Integer): CheckboxValidationBuilder; - build(): CheckboxValidation; - setHelpText(text: string): CheckboxValidationBuilder; - } - /** - * A single choice associated with a type of Item that supports choices, like CheckboxItem, ListItem, or MultipleChoiceItem. - * - * // Create a new form and add a multiple-choice item. - * var form = FormApp.create('Form Name'); - * var item = form.addMultipleChoiceItem(); - * item.setTitle('Do you prefer cats or dogs?') - * .setChoices([ - * item.createChoice('Cats', FormApp.PageNavigationType.CONTINUE), - * item.createChoice('Dogs', FormApp.PageNavigationType.RESTART) - * ]); - * - * // Add another page because navigation has no effect on the last page. - * form.addPageBreakItem().setTitle('You chose well!'); - * - * // Log the navigation types that each choice results in. - * var choices = item.getChoices(); - * for (var i = 0; i < choices.length; i++) { - * Logger.log('If the respondent chooses "%s", the form will %s.', - * choices[i].getValue(), - * choices[i].getPageNavigationType()); - * } - */ - interface Choice { - getGotoPage(): PageBreakItem; - getPageNavigationType(): PageNavigationType; - getValue(): string; - isCorrectAnswer(): boolean; - } - /** - * A question item that allows the respondent to indicate a date. Items can be accessed or created - * from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new date item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addDateItem(); - * item.setTitle('When were you born?'); - */ - interface DateItem { - createResponse(response: Base.Date): ItemResponse; - duplicate(): DateItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - includesYear(): boolean; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): DateItem; - setHelpText(text: string): DateItem; - setIncludesYear(enableYear: boolean): DateItem; - setPoints(points: Integer): DateItem; - setRequired(enabled: boolean): DateItem; - setTitle(title: string): DateItem; - } - /** - * A question item that allows the respondent to indicate a date and time. Items can be accessed or - * created from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new date-time item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addDateTimeItem(); - * item.setTitle('When do you want to meet?'); - */ - interface DateTimeItem { - createResponse(response: Base.Date): ItemResponse; - duplicate(): DateTimeItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - includesYear(): boolean; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): DateTimeItem; - setHelpText(text: string): DateTimeItem; - setIncludesYear(enableYear: boolean): DateTimeItem; - setPoints(points: Integer): DateTimeItem; - setRequired(enabled: boolean): DateTimeItem; - setTitle(title: string): DateTimeItem; - } - /** - * An enum representing the supported types of form-response destinations. All forms, including - * those that do not have a destination set explicitly, save a copy of responses in the form's - * response store. Destination types can be accessed from FormApp.DestinationType. - * - * // Open a form by ID and create a new spreadsheet. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var ss = SpreadsheetApp.create('Spreadsheet Name'); - * - * // Update the form's response destination. - * form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId()); - */ - enum DestinationType { - SPREADSHEET, - } - /** - * A question item that allows the respondent to indicate a length of time. Items can be accessed or - * created from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new duration item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addDurationItem(); - * item.setTitle('How long can you hold your breath?'); - */ - interface DurationItem { - createResponse(hours: Integer, minutes: Integer, seconds: Integer): ItemResponse; - duplicate(): DurationItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): DurationItem; - setHelpText(text: string): DurationItem; - setPoints(points: Integer): DurationItem; - setRequired(enabled: boolean): DurationItem; - setTitle(title: string): DurationItem; - } - /** - * An enum representing the supported types of feedback. Feedback types can be accessed from FormApp.FeedbackType. - * - * // Open a form by ID and add a new list item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addListItem(); - * item.setTitle('Do you prefer cats or dogs?'); - * // Set "Dogs" as the correct answer to this question. - * item.setChoices([ - * item.createChoice('Dogs', true), - * item.createChoice('Cats', false)]); - * // Add feedback which will be shown for correct responses; ie "Dogs". - * item.setFeedbackForCorrect( - * FormApp.createFeedback().setDisplayText("Dogs rule, cats drool.").build()); - */ - enum FeedbackType { - CORRECT, - INCORRECT, - GENERAL, - } - /** - * A form that contains overall properties and items. Properties include title, settings, and where - * responses are stored. Items include question items like checkboxes or radio items, while layout - * items refer to things like page breaks. Forms can be accessed or created from FormApp. - * - * // Open a form by ID and create a new spreadsheet. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var ss = SpreadsheetApp.create('Spreadsheet Name'); - * - * // Update form properties via chaining. - * form.setTitle('Form Name') - * .setDescription('Description of form') - * .setConfirmationMessage('Thanks for responding!') - * .setAllowResponseEdits(true) - * .setAcceptingResponses(false); - * - * // Update the form's response destination. - * form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId()); - */ - interface Form { - addCheckboxGridItem(): CheckboxGridItem; - addCheckboxItem(): CheckboxItem; - addDateItem(): DateItem; - addDateTimeItem(): DateTimeItem; - addDurationItem(): DurationItem; - addEditor(emailAddress: string): Form; - addEditor(user: Base.User): Form; - addEditors(emailAddresses: string[]): Form; - addGridItem(): GridItem; - addImageItem(): ImageItem; - addListItem(): ListItem; - addMultipleChoiceItem(): MultipleChoiceItem; - addPageBreakItem(): PageBreakItem; - addParagraphTextItem(): ParagraphTextItem; - addScaleItem(): ScaleItem; - addSectionHeaderItem(): SectionHeaderItem; - addTextItem(): TextItem; - addTimeItem(): TimeItem; - addVideoItem(): VideoItem; - canEditResponse(): boolean; - collectsEmail(): boolean; - createResponse(): FormResponse; - deleteAllResponses(): Form; - deleteItem(index: Integer): void; - deleteItem(item: Item): void; - deleteResponse(responseId: string): Form; - getConfirmationMessage(): string; - getCustomClosedFormMessage(): string; - getDescription(): string; - getDestinationId(): string; - getDestinationType(): DestinationType; - getEditUrl(): string; - getEditors(): Base.User[]; - getId(): string; - getItemById(id: Integer): Item; - getItems(): Item[]; - getItems(itemType: ItemType): Item[]; - getPublishedUrl(): string; - getResponse(responseId: string): FormResponse; - getResponses(): FormResponse[]; - getResponses(timestamp: Base.Date): FormResponse[]; - getShuffleQuestions(): boolean; - getSummaryUrl(): string; - getTitle(): string; - hasLimitOneResponsePerUser(): boolean; - hasProgressBar(): boolean; - hasRespondAgainLink(): boolean; - isAcceptingResponses(): boolean; - isPublishingSummary(): boolean; - isQuiz(): boolean; - moveItem(from: Integer, to: Integer): Item; - moveItem(item: Item, toIndex: Integer): Item; - removeDestination(): Form; - removeEditor(emailAddress: string): Form; - removeEditor(user: Base.User): Form; - requiresLogin(): boolean; - setAcceptingResponses(enabled: boolean): Form; - setAllowResponseEdits(enabled: boolean): Form; - setCollectEmail(collect: boolean): Form; - setConfirmationMessage(message: string): Form; - setCustomClosedFormMessage(message: string): Form; - setDescription(description: string): Form; - setDestination(type: DestinationType, id: string): Form; - setIsQuiz(enabled: boolean): Form; - setLimitOneResponsePerUser(enabled: boolean): Form; - setProgressBar(enabled: boolean): Form; - setPublishingSummary(enabled: boolean): Form; - setRequireLogin(requireLogin: boolean): Form; - setShowLinkToRespondAgain(enabled: boolean): Form; - setShuffleQuestions(shuffle: boolean): Form; - setTitle(title: string): Form; - shortenFormUrl(url: string): string; - submitGrades(responses: FormResponse[]): Form; - } - /** - * Allows a script to open an existing Form or create a new one. - * - * // Open a form by ID. - * var existingForm = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * - * // Create and open a form. - * var newForm = FormApp.create('Form Name'); - */ - interface FormApp { - Alignment: typeof Alignment; - DestinationType: typeof DestinationType; - FeedbackType: typeof FeedbackType; - ItemType: typeof ItemType; - PageNavigationType: typeof PageNavigationType; - create(title: string): Form; - createCheckboxGridValidation(): CheckboxGridValidationBuilder; - createCheckboxValidation(): CheckboxValidationBuilder; - createFeedback(): QuizFeedbackBuilder; - createGridValidation(): GridValidationBuilder; - createParagraphTextValidation(): ParagraphTextValidationBuilder; - createTextValidation(): TextValidationBuilder; - getActiveForm(): Form; - getUi(): Base.Ui; - openById(id: string): Form; - openByUrl(url: string): Form; - } - /** - * A response to the form as a whole. A FormResponse can be used in three ways: to access - * the answers submitted by a respondent (see getItemResponses()), to programmatically - * submit a response to the form (see withItemResponse(response) and submit()), and to generate a URL for the form which pre-fills fields using the provided - * answers. FormResponses can be created or accessed from a Form. - * - * // Open a form by ID and log the responses to each question. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var formResponses = form.getResponses(); - * for (var i = 0; i < formResponses.length; i++) { - * var formResponse = formResponses[i]; - * var itemResponses = formResponse.getItemResponses(); - * for (var j = 0; j < itemResponses.length; j++) { - * var itemResponse = itemResponses[j]; - * Logger.log('Response #%s to the question "%s" was "%s"', - * (i + 1).toString(), - * itemResponse.getItem().getTitle(), - * itemResponse.getResponse()); - * } - * } - */ - interface FormResponse { - getEditResponseUrl(): string; - getGradableItemResponses(): ItemResponse[]; - getGradableResponseForItem(item: Item): ItemResponse; - getId(): string; - getItemResponses(): ItemResponse[]; - getRespondentEmail(): string; - getResponseForItem(item: Item): ItemResponse; - getTimestamp(): Base.Date; - submit(): FormResponse; - toPrefilledUrl(): string; - withItemGrade(gradedResponse: ItemResponse): FormResponse; - withItemResponse(response: ItemResponse): FormResponse; - } - /** - * A question item, presented as a grid of columns and rows, that allows the respondent to select - * one choice per row from a sequence of radio buttons. Items can be accessed or created from a - * Form. - * - * // Open a form by ID and add a new grid item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addGridItem(); - * item.setTitle('Rate your interests') - * .setRows(['Cars', 'Computers', 'Celebrities']) - * .setColumns(['Boring', 'So-so', 'Interesting']); - */ - interface GridItem { - clearValidation(): GridItem; - createResponse(responses: string[]): ItemResponse; - duplicate(): GridItem; - getColumns(): string[]; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getRows(): string[]; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setColumns(columns: string[]): GridItem; - setHelpText(text: string): GridItem; - setRequired(enabled: boolean): GridItem; - setRows(rows: string[]): GridItem; - setTitle(title: string): GridItem; - setValidation(validation: GridValidation): GridItem; - } - /** - * A DataValidation for a GridItem. - * - * // Add a grid item to a form and require one response per column. - * var gridItem = form.addGridItem(); - * gridItem.setTitle('Rate your interests') - * .setRows(['Cars', 'Computers', 'Celebrities']) - * .setColumns(['Boring', 'So-so', 'Interesting']); - * var gridValidation = FormApp.createGridValidation() - * .setHelpText(“Select one item per column.”) - * .requireLimitOneResponsePerColumn() - * .build(); - * gridItem.setValidation(gridValidation); - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface GridValidation { - } - /** - * A DataValidationBuilder for a GridValidation. - * - * // Add a grid item to a form and require one response per column. - * var gridItem = form.addGridItem(); - * gridItem.setTitle('Rate your interests') - * .setRows(['Cars', 'Computers', 'Celebrities']) - * .setColumns(['Boring', 'So-so', 'Interesting']); - * var gridValidation = FormApp.createGridValidation() - * .setHelpText(“Select one item per column.”) - * .requireLimitOneResponsePerColumn() - * .build(); - * gridItem.setValidation(gridValidation); - */ - interface GridValidationBuilder { - requireLimitOneResponsePerColumn(): GridValidationBuilder; - build(): GridValidation; - setHelpText(text: string): GridValidationBuilder; - } - /** - * A layout item that displays an image. Items can be accessed or created from a Form. - * - * // Open a form by ID and add a new image item - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var img = UrlFetchApp.fetch('https://www.google.com/images/srpr/logo4w.png'); - * form.addImageItem() - * .setTitle('Google') - * .setHelpText('Google Logo') // The help text is the image description - * .setImage(img); - */ - interface ImageItem { - duplicate(): ImageItem; - getAlignment(): Alignment; - getHelpText(): string; - getId(): Integer; - getImage(): Base.Blob; - getIndex(): Integer; - getTitle(): string; - getType(): ItemType; - getWidth(): Integer; - setAlignment(alignment: Alignment): ImageItem; - setHelpText(text: string): ImageItem; - setImage(image: Base.BlobSource): ImageItem; - setTitle(title: string): ImageItem; - setWidth(width: Integer): ImageItem; - } - /** - * A generic form item that contains properties common to all items, such as title and help text. - * Items can be accessed or created from a Form. - * - * To operate on type-specific properties, use getType() to check the item's ItemType, then cast the item to the - * appropriate class using a method like asCheckboxItem(). - * - * // Create a new form and add a text item. - * var form = FormApp.create('Form Name'); - * form.addTextItem(); - * - * // Access the text item as a generic item. - * var items = form.getItems(); - * var item = items[0]; - * - * // Cast the generic item to the text-item class. - * if (item.getType() == 'TEXT') { - * var textItem = item.asTextItem(); - * textItem.setRequired(false); - * } - * - * Implementing classes - * - * NameBrief description - */ - interface Item { - asCheckboxGridItem(): CheckboxGridItem; - asCheckboxItem(): CheckboxItem; - asDateItem(): DateItem; - asDateTimeItem(): DateTimeItem; - asDurationItem(): DurationItem; - asGridItem(): GridItem; - asImageItem(): ImageItem; - asListItem(): ListItem; - asMultipleChoiceItem(): MultipleChoiceItem; - asPageBreakItem(): PageBreakItem; - asParagraphTextItem(): ParagraphTextItem; - asScaleItem(): ScaleItem; - asSectionHeaderItem(): SectionHeaderItem; - asTextItem(): TextItem; - asTimeItem(): TimeItem; - asVideoItem(): VideoItem; - duplicate(): Item; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getTitle(): string; - getType(): ItemType; - setHelpText(text: string): Item; - setTitle(title: string): Item; - } - /** - * A response to one question item within a form. Item responses can be accessed from FormResponse and created from any Item that asks the respondent to answer a question. - * - * // Open a form by ID and log the responses to each question. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var formResponses = form.getResponses(); - * for (var i = 0; i < formResponses.length; i++) { - * var formResponse = formResponses[i]; - * var itemResponses = formResponse.getItemResponses(); - * for (var j = 0; j < itemResponses.length; j++) { - * var itemResponse = itemResponses[j]; - * Logger.log('Response #%s to the question "%s" was "%s"', - * (i + 1).toString(), - * itemResponse.getItem().getTitle(), - * itemResponse.getResponse()); - * } - * } - */ - interface ItemResponse { - getFeedback(): QuizFeedback; - getItem(): Item; - getResponse(): string[][] | string[] | string; - getScore(): number; - setFeedback(feedback: any): ItemResponse; - setScore(score: any): ItemResponse; - } - /** - * An enum representing the supported types of form items. Item types can be accessed from FormApp.ItemType. - * - * // Open a form by ID and add a new section header. - * var form = FormApp.create('Form Name'); - * var item = form.addSectionHeaderItem(); - * item.setTitle('Title of new section'); - * - * // Check the item type. - * if (item.getType() == FormApp.ItemType.SECTION_HEADER) { - * item.setHelpText('Description of new section.'); - * } - */ - enum ItemType { - CHECKBOX, - CHECKBOX_GRID, - DATE, - DATETIME, - DURATION, - GRID, - IMAGE, - LIST, - MULTIPLE_CHOICE, - PAGE_BREAK, - PARAGRAPH_TEXT, - SCALE, - SECTION_HEADER, - TEXT, - TIME, - VIDEO, - FILE_UPLOAD, - } - /** - * A question item that allows the respondent to select one choice from a drop-down list. Items can - * be accessed or created from a Form. - * - * // Open a form by ID and add a new list item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addListItem(); - * item.setTitle('Do you prefer cats or dogs?') - * .setChoices([ - * item.createChoice('Cats'), - * item.createChoice('Dogs') - * ]); - */ - interface ListItem { - createChoice(value: string): Choice; - createChoice(value: string, isCorrect: boolean): Choice; - createChoice(value: string, navigationItem: PageBreakItem): Choice; - createChoice(value: string, navigationType: PageNavigationType): Choice; - createResponse(response: string): ItemResponse; - duplicate(): ListItem; - getChoices(): Choice[]; - getFeedbackForCorrect(): QuizFeedback; - getFeedbackForIncorrect(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setChoiceValues(values: string[]): ListItem; - setChoices(choices: Choice[]): ListItem; - setFeedbackForCorrect(feedback: QuizFeedback): ListItem; - setFeedbackForIncorrect(feedback: QuizFeedback): ListItem; - setHelpText(text: string): ListItem; - setPoints(points: Integer): ListItem; - setRequired(enabled: boolean): ListItem; - setTitle(title: string): ListItem; - } - /** - * A question item that allows the respondent to select one choice from a list of radio buttons or - * an optional "other" field. Items can be accessed or created from a Form. When used in a - * quiz, these items are autograded. - * - * // Open a form by ID and add a new multiple choice item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addMultipleChoiceItem(); - * item.setTitle('Do you prefer cats or dogs?') - * .setChoices([ - * item.createChoice('Cats'), - * item.createChoice('Dogs') - * ]) - * .showOtherOption(true); - */ - interface MultipleChoiceItem { - createChoice(value: string): Choice; - createChoice(value: string, isCorrect: boolean): Choice; - createChoice(value: string, navigationItem: PageBreakItem): Choice; - createChoice(value: string, navigationType: PageNavigationType): Choice; - createResponse(response: string): ItemResponse; - duplicate(): MultipleChoiceItem; - getChoices(): Choice[]; - getFeedbackForCorrect(): QuizFeedback; - getFeedbackForIncorrect(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - hasOtherOption(): boolean; - isRequired(): boolean; - setChoiceValues(values: string[]): MultipleChoiceItem; - setChoices(choices: Choice[]): MultipleChoiceItem; - setFeedbackForCorrect(feedback: QuizFeedback): MultipleChoiceItem; - setFeedbackForIncorrect(feedback: QuizFeedback): MultipleChoiceItem; - setHelpText(text: string): MultipleChoiceItem; - setPoints(points: Integer): MultipleChoiceItem; - setRequired(enabled: boolean): MultipleChoiceItem; - setTitle(title: string): MultipleChoiceItem; - showOtherOption(enabled: boolean): MultipleChoiceItem; - } - /** - * A layout item that marks the start of a page. Items can be accessed or created from a Form. - * - * // Create a form and add three page-break items. - * var form = FormApp.create('Form Name'); - * var pageTwo = form.addPageBreakItem().setTitle('Page Two'); - * var pageThree = form.addPageBreakItem().setTitle('Page Three'); - * - * // Make the first two pages navigate elsewhere upon completion. - * pageTwo.setGoToPage(pageThree); // At end of page one (start of page two), jump to page three - * pageThree.setGoToPage(FormApp.PageNavigationType.RESTART); // At end of page two, restart form - */ - interface PageBreakItem { - duplicate(): PageBreakItem; - getGoToPage(): PageBreakItem; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPageNavigationType(): PageNavigationType; - getTitle(): string; - getType(): ItemType; - setGoToPage(goToPageItem: PageBreakItem): PageBreakItem; - setGoToPage(navigationType: PageNavigationType): PageBreakItem; - setHelpText(text: string): PageBreakItem; - setTitle(title: string): PageBreakItem; - } - /** - * An enum representing the supported types of page navigation. Page navigation types can be - * accessed from FormApp.PageNavigationType. - * - * The page navigation occurs after the respondent completes a page that contains the option, and - * only if the respondent chose that option. If the respondent chose multiple options with - * page-navigation instructions on the same page, only the last navigation option has any effect. - * Page navigation also has no effect on the last page of a form. - * - * Choices that use page navigation cannot be combined in the same item with choices that do not - * use page navigation. - * - * // Create a form and add a new multiple-choice item and a page-break item. - * var form = FormApp.create('Form Name'); - * var item = form.addMultipleChoiceItem(); - * var pageBreak = form.addPageBreakItem(); - * - * // Set some choices with go-to-page logic. - * var rightChoice = item.createChoice('Vanilla', FormApp.PageNavigationType.SUBMIT); - * var wrongChoice = item.createChoice('Chocolate', FormApp.PageNavigationType.RESTART); - * - * // For GO_TO_PAGE, just pass in the page break item. For CONTINUE (normally the default), pass in - * // CONTINUE explicitly because page navigation cannot be mixed with non-navigation choices. - * var iffyChoice = item.createChoice('Peanut', pageBreak); - * var otherChoice = item.createChoice('Strawberry', FormApp.PageNavigationType.CONTINUE); - * item.setChoices([rightChoice, wrongChoice, iffyChoice, otherChoice]); - */ - enum PageNavigationType { - CONTINUE, - GO_TO_PAGE, - RESTART, - SUBMIT, - } - /** - * A question item that allows the respondent to enter a block of text. Items can be accessed or - * created from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new paragraph text item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addParagraphTextItem(); - * item.setTitle('What is your address?'); - */ - interface ParagraphTextItem { - clearValidation(): ParagraphTextItem; - createResponse(response: string): ItemResponse; - duplicate(): ParagraphTextItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): ParagraphTextItem; - setHelpText(text: string): ParagraphTextItem; - setPoints(points: Integer): ParagraphTextItem; - setRequired(enabled: boolean): ParagraphTextItem; - setTitle(title: string): ParagraphTextItem; - setValidation(validation: ParagraphTextValidation): ParagraphTextItem; - } - /** - * A DataValidation for a ParagraphTextItem. - * - * // Add a paragraph text item to a form and require the answer to be at least 100 characters. - * var paragraphTextItem = form.addParagraphTextItem().setTitle('Describe yourself:'); - * var paragraphtextValidation = FormApp.createParagraphTextValidation() - * .setHelpText(“Answer must be more than 100 characters.”) - * .requireTextLengthGreatherThan(100); - * paragraphTextItem.setValidation(paragraphtextValidation); - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface ParagraphTextValidation { - } - /** - * A DataValidationBuilder for a ParagraphTextValidation. - * - * // Add a paragraph text item to a form and require the answer to be at least 100 characters. - * var paragraphTextItem = form.addParagraphTextItem().setTitle('Describe yourself:'); - * var paragraphtextValidation = FormApp.createParagraphTextValidation() - * .setHelpText(“Answer must be more than 100 characters.”) - * .requireTextLengthLessThanOrEqualTo(100) - * .build(); - * paragraphTextItem.setValidation(paragraphtextValidation); - */ - interface ParagraphTextValidationBuilder { - requireTextContainsPattern(pattern: string): ParagraphTextValidationBuilder; - requireTextDoesNotContainPattern(pattern: string): ParagraphTextValidationBuilder; - requireTextDoesNotMatchPattern(pattern: string): ParagraphTextValidationBuilder; - requireTextLengthGreaterThanOrEqualTo(number: Integer): ParagraphTextValidationBuilder; - requireTextLengthLessThanOrEqualTo(number: Integer): ParagraphTextValidationBuilder; - requireTextMatchesPattern(pattern: string): ParagraphTextValidationBuilder; - build(): ParagraphTextValidation; - setHelpText(text: string): ParagraphTextValidationBuilder; - } - /** - * The bean implementation of a Feedback, which contains properties common to all feedback, such as - * display text or links. - * - * Feedback can be added to gradeable Form items. - * - * // Setting feedback which should be automatically shown when a user responds to a question - * // incorrectly. - * var textItem = form.addTextItem().setTitle('Re-hydrating dried fruit is an example of what?'); - * var feedback = FormApp.createFeedback() - * .setDisplayText( - * “Good answer, but not quite right. Please review chapter 4 before next time.”) - * .addLink("http://wikipedia.com/osmosis"); - * textItem.setFeedbackForIncorrect(feedback); - */ - interface QuizFeedback { - getLinkUrls(): string[]; - getText(): string; - } - /** - * The base FeedbackBuilder that contains setters for properties common to all feedback, such as - * display text. Used to build Feedback objects. - * - * // Open a form by ID and add a new list item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addListItem(); - * item.setTitle('Do you prefer cats or dogs?'); - * item.setChoices([ - * item.createChoice('Dogs', true), - * item.createChoice('Cats', false)]); - * // Add feedback which will be shown for correct responses; ie "Dogs". - * item.setFeedbackForCorrect(FormApp.createFeedback().setText("Dogs rule, cats drool.").build()); - */ - interface QuizFeedbackBuilder { - addLink(url: string): QuizFeedbackBuilder; - addLink(url: string, displayText: string): QuizFeedbackBuilder; - build(): QuizFeedback; - copy(): QuizFeedbackBuilder; - setText(text: string): QuizFeedbackBuilder; - } - /** - * A question item that allows the respondent to choose one option from a numbered sequence of radio - * buttons. Items can be accessed or created from a Form. When used in a quiz, these items - * are graded. - * - * // Open a form by ID and add a new scale item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addScaleItem(); - * item.setTitle('Pick a number between 1 and 10') - * .setBounds(1, 10); - */ - interface ScaleItem { - createResponse(response: Integer): ItemResponse; - duplicate(): ScaleItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getLeftLabel(): string; - getLowerBound(): Integer; - getPoints(): Integer; - getRightLabel(): string; - getTitle(): string; - getType(): ItemType; - getUpperBound(): Integer; - isRequired(): boolean; - setBounds(lower: Integer, upper: Integer): ScaleItem; - setGeneralFeedback(feedback: QuizFeedback): ScaleItem; - setHelpText(text: string): ScaleItem; - setLabels(lower: string, upper: string): ScaleItem; - setPoints(points: Integer): ScaleItem; - setRequired(enabled: boolean): ScaleItem; - setTitle(title: string): ScaleItem; - } - /** - * A layout item that visually indicates the start of a section. Items can be accessed or created - * from a Form. - * - * // Open a form by ID and add a new section header. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addSectionHeaderItem(); - * item.setTitle('Title of new section'); - */ - interface SectionHeaderItem { - duplicate(): SectionHeaderItem; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getTitle(): string; - getType(): ItemType; - setHelpText(text: string): SectionHeaderItem; - setTitle(title: string): SectionHeaderItem; - } - /** - * A question item that allows the respondent to enter a single line of text. Items can be accessed - * or created from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new text item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addTextItem(); - * item.setTitle('What is your name?'); - */ - interface TextItem { - clearValidation(): TextItem; - createResponse(response: string): ItemResponse; - duplicate(): TextItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): TextItem; - setHelpText(text: string): TextItem; - setPoints(points: Integer): TextItem; - setRequired(enabled: boolean): TextItem; - setTitle(title: string): TextItem; - setValidation(validation: TextValidation): TextItem; - } - /** - * A DataValidation for a TextItem. - * - * // Add a text item to a form and require it to be a number within a range. - * var textItem = form.addTextItem().setTitle('Pick a number between 1 and 100?'); - * var textValidation = FormApp.createTextValidation() - * .setHelpText(“Input was not a number between 1 and 100.”) - * .requireNumberBetween(1, 100) - * .build(); - * textItem.setValidation(textValidation); - */ - // eslint-disable-next-line @typescript-eslint/no-empty-interface - interface TextValidation { - } - /** - * A DataValidationBuilder for a TextValidation. - * - * // Add a text item to a form and require it to be a number within a range. - * var textItem = form.addTextItem().setTitle('Pick a number between 1 and 100?'); - * var textValidation = FormApp.createTextValidation() - * .setHelpText(“Input was not a number between 1 and 100.”) - * .requireNumberBetween(1, 100); - * textItem.setValidation(textValidation); - */ - interface TextValidationBuilder { - requireNumber(): TextValidationBuilder; - requireNumberBetween(start: number, end: number): TextValidationBuilder; - requireNumberEqualTo(number: number): TextValidationBuilder; - requireNumberGreaterThan(number: number): TextValidationBuilder; - requireNumberGreaterThanOrEqualTo(number: number): TextValidationBuilder; - requireNumberLessThan(number: number): TextValidationBuilder; - requireNumberLessThanOrEqualTo(number: number): TextValidationBuilder; - requireNumberNotBetween(start: number, end: number): TextValidationBuilder; - requireNumberNotEqualTo(number: number): TextValidationBuilder; - requireTextContainsPattern(pattern: string): TextValidationBuilder; - requireTextDoesNotContainPattern(pattern: string): TextValidationBuilder; - requireTextDoesNotMatchPattern(pattern: string): TextValidationBuilder; - requireTextIsEmail(): TextValidationBuilder; - requireTextIsUrl(): TextValidationBuilder; - requireTextLengthGreaterThanOrEqualTo(number: Integer): TextValidationBuilder; - requireTextLengthLessThanOrEqualTo(number: Integer): TextValidationBuilder; - requireTextMatchesPattern(pattern: string): TextValidationBuilder; - requireWholeNumber(): TextValidationBuilder; - build(): TextValidation; - setHelpText(text: string): TextValidationBuilder; - } - /** - * A question item that allows the respondent to indicate a time of day. Items can be accessed or - * created from a Form. When used in a quiz, these items are graded. - * - * // Open a form by ID and add a new time item. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * var item = form.addTimeItem(); - * item.setTitle('What time do you usually wake up in the morning?'); - */ - interface TimeItem { - createResponse(hour: Integer, minute: Integer): ItemResponse; - duplicate(): TimeItem; - getGeneralFeedback(): QuizFeedback; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getPoints(): Integer; - getTitle(): string; - getType(): ItemType; - isRequired(): boolean; - setGeneralFeedback(feedback: QuizFeedback): TimeItem; - setHelpText(text: string): TimeItem; - setPoints(points: Integer): TimeItem; - setRequired(enabled: boolean): TimeItem; - setTitle(title: string): TimeItem; - } - /** - * A layout item that displays a video. Items can be accessed or created from a Form. - * - * // Open a form by ID and add three new video items, using a long URL, - * // a short URL, and a video ID. - * var form = FormApp.openById('1234567890abcdefghijklmnopqrstuvwxyz'); - * form.addVideoItem() - * .setTitle('Video Title') - * .setHelpText('Video Caption') - * .setVideoUrl('www.youtube.com/watch?v=1234abcdxyz'); - * - * form.addVideoItem() - * .setTitle('Video Title') - * .setHelpText('Video Caption') - * .setVideoUrl('youtu.be/1234abcdxyz'); - * - * form.addVideoItem() - * .setTitle('Video Title') - * .setHelpText('Video Caption') - * .setVideoUrl('1234abcdxyz'); - */ - interface VideoItem { - duplicate(): VideoItem; - getAlignment(): Alignment; - getHelpText(): string; - getId(): Integer; - getIndex(): Integer; - getTitle(): string; - getType(): ItemType; - getWidth(): Integer; - setAlignment(alignment: Alignment): VideoItem; - setHelpText(text: string): VideoItem; - setTitle(title: string): VideoItem; - setVideoUrl(youtubeUrl: string): VideoItem; - setWidth(width: Integer): VideoItem; - } - } -} - -declare var FormApp: GoogleAppsScript.Forms.FormApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.gmail.d.ts b/node_modules/@types/google-apps-script/google-apps-script.gmail.d.ts deleted file mode 100644 index 05b8818..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.gmail.d.ts +++ /dev/null @@ -1,303 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Gmail { - /** - * Provides access to Gmail threads, messages, and labels. - */ - interface GmailApp { - createDraft(recipient: string, subject: string, body: string): GmailDraft; - createDraft(recipient: string, subject: string, body: string, options: GmailAdvancedOptions): GmailDraft; - createLabel(name: string): GmailLabel; - deleteLabel(label: GmailLabel): GmailApp; - getAliases(): string[]; - getChatThreads(): GmailThread[]; - getChatThreads(start: Integer, max: Integer): GmailThread[]; - getDraft(draftId: string): GmailDraft; - getDraftMessages(): GmailMessage[]; - getDrafts(): GmailDraft[]; - getInboxThreads(): GmailThread[]; - getInboxThreads(start: Integer, max: Integer): GmailThread[]; - getInboxUnreadCount(): Integer; - getMessageById(id: string): GmailMessage; - getMessagesForThread(thread: GmailThread): GmailMessage[]; - getMessagesForThreads(threads: GmailThread[]): GmailMessage[][]; - getPriorityInboxThreads(): GmailThread[]; - getPriorityInboxThreads(start: Integer, max: Integer): GmailThread[]; - getPriorityInboxUnreadCount(): Integer; - getSpamThreads(): GmailThread[]; - getSpamThreads(start: Integer, max: Integer): GmailThread[]; - getSpamUnreadCount(): Integer; - getStarredThreads(): GmailThread[]; - getStarredThreads(start: Integer, max: Integer): GmailThread[]; - getStarredUnreadCount(): Integer; - getThreadById(id: string): GmailThread; - getTrashThreads(): GmailThread[]; - getTrashThreads(start: Integer, max: Integer): GmailThread[]; - getUserLabelByName(name: string): GmailLabel; - getUserLabels(): GmailLabel[]; - markMessageRead(message: GmailMessage): GmailApp; - markMessageUnread(message: GmailMessage): GmailApp; - markMessagesRead(messages: GmailMessage[]): GmailApp; - markMessagesUnread(messages: GmailMessage[]): GmailApp; - markThreadImportant(thread: GmailThread): GmailApp; - markThreadRead(thread: GmailThread): GmailApp; - markThreadUnimportant(thread: GmailThread): GmailApp; - markThreadUnread(thread: GmailThread): GmailApp; - markThreadsImportant(threads: GmailThread[]): GmailApp; - markThreadsRead(threads: GmailThread[]): GmailApp; - markThreadsUnimportant(threads: GmailThread[]): GmailApp; - markThreadsUnread(threads: GmailThread[]): GmailApp; - moveMessageToTrash(message: GmailMessage): GmailApp; - moveMessagesToTrash(messages: GmailMessage[]): GmailApp; - moveThreadToArchive(thread: GmailThread): GmailApp; - moveThreadToInbox(thread: GmailThread): GmailApp; - moveThreadToSpam(thread: GmailThread): GmailApp; - moveThreadToTrash(thread: GmailThread): GmailApp; - moveThreadsToArchive(threads: GmailThread[]): GmailApp; - moveThreadsToInbox(threads: GmailThread[]): GmailApp; - moveThreadsToSpam(threads: GmailThread[]): GmailApp; - moveThreadsToTrash(threads: GmailThread[]): GmailApp; - refreshMessage(message: GmailMessage): GmailApp; - refreshMessages(messages: GmailMessage[]): GmailApp; - refreshThread(thread: GmailThread): GmailApp; - refreshThreads(threads: GmailThread[]): GmailApp; - search(query: string): GmailThread[]; - search(query: string, start: Integer, max: Integer): GmailThread[]; - sendEmail(recipient: string, subject: string, body: string): GmailApp; - sendEmail(recipient: string, subject: string, body: string, options: GmailAdvancedOptions): GmailApp; - setCurrentMessageAccessToken(accessToken: string): void; - starMessage(message: GmailMessage): GmailApp; - starMessages(messages: GmailMessage[]): GmailApp; - unstarMessage(message: GmailMessage): GmailApp; - unstarMessages(messages: GmailMessage[]): GmailApp; - } - /** - * An attachment from Gmail. This is a regular Blob except that it has an extra getSize() method that is faster than calling - * getBytes().length and does not count against the Gmail read quota. - * - * // Logs information about any attachments in the first 100 inbox threads. - * var threads = GmailApp.getInboxThreads(0, 100); - * var msgs = GmailApp.getMessagesForThreads(threads); - * for (var i = 0 ; i < msgs.length; i++) { - * for (var j = 0; j < msgs[i].length; j++) { - * var attachments = msgs[i][j].getAttachments(); - * for (var k = 0; k < attachments.length; k++) { - * Logger.log('Message "%s" contains the attachment "%s" (%s bytes)', - * msgs[i][j].getSubject(), attachments[k].getName(), attachments[k].getSize()); - * } - * } - * } - */ - interface GmailAttachment { - copyBlob(): Base.Blob; - getAs(contentType: string): Base.Blob; - getBytes(): Byte[]; - getContentType(): string; - getDataAsString(): string; - getDataAsString(charset: string): string; - getHash(): string; - getName(): string; - getSize(): Integer; - isGoogleType(): boolean; - setBytes(data: Byte[]): Base.Blob; - setContentType(contentType: string): Base.Blob; - setContentTypeFromExtension(): Base.Blob; - setDataFromString(string: string): Base.Blob; - setDataFromString(string: string, charset: string): Base.Blob; - setName(name: string): Base.Blob; - /** @deprecated DO NOT USE */ getAllBlobs(): Base.Blob[]; - } - /** - * A user-created draft message in a user's Gmail account. - */ - interface GmailDraft { - /** - * Deletes this draft message. - */ - deleteDraft(): void; - /** - * Gets the ID of this draft message. - */ - getId(): string; - /** - * Returns a GmailMessage representing this draft. - */ - getMessage(): GmailMessage; - /** - * Returns the ID of the `GmailMessage` representing this draft. - */ - getMessageId(): string; - /** - * Sends this draft email message. - */ - send(): GmailMessage; - /** - * Replaces the contents of this draft message. - */ - update(recipient: string, subject: string, body: string): GmailDraft; - /** - * Replaces the contents of this draft message using optional arguments. - */ - update(recipient: string, subject: string, body: string, options: GmailAdvancedOptions): GmailDraft; - } - /** - * Options for a Gmail draft. - */ - interface GmailAdvancedOptions { - /** - * An array of files to send with the email. - */ - attachments?: Base.BlobSource[] | undefined; - /** - * A comma-separated list of email addresses to BCC. - */ - bcc?: string | undefined; - /** - * A comma-separated list of email addresses to CC. - */ - cc?: string | undefined; - /** - * The address that the email should be sent from, which must be one of the values returned by `GmailApp.getAliases()`. - */ - from?: string | undefined; - /** - * If set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional `inlineImages` field in HTML body if you have inlined images for your email. - */ - htmlBody?: string | undefined; - /** - * A JavaScript object containing a mapping from image key (`String`) to image data (`BlobSource`) ; this assumes that the `htmlBody` parameter is used and contains references to these images in the format ``. - */ - inlineImages?: { [imageKey: string]: Base.BlobSource } | undefined; - /** - * The name of the sender of the email (default: the user's name). - */ - name?: string | undefined; - /** - * True if the email should be sent from a generic no-reply email address to discourage recipients from responding to emails; this option is only possible for Google Workspace accounts, not Gmail users. - */ - noReply?: boolean | undefined; - /** - * An email address to use as the default reply-to address (default: the user's email address). - */ - replyTo?: string | undefined; - } - /** alias to GmailAdvancedOptions */ - type GmailDraftOptions = GmailAdvancedOptions; - /** - * Options for a Gmail Attachments. - */ - interface GmailAttachmentOptions { - /** - * If the returned array of Blob attachments should include inline images. - */ - includeInlineImages?: boolean | undefined; - /** - * If the returned array of Blob attachments should include regular (non-inline) attachments. - */ - includeAttachments?: boolean | undefined; - /** - * A comma-separated list of email addresses to BCC. - */ - } - /** - * A user-created label in a user's Gmail account. - */ - interface GmailLabel { - addToThread(thread: GmailThread): GmailLabel; - addToThreads(threads: GmailThread[]): GmailLabel; - deleteLabel(): void; - getName(): string; - getThreads(): GmailThread[]; - getThreads(start: Integer, max: Integer): GmailThread[]; - getUnreadCount(): Integer; - removeFromThread(thread: GmailThread): GmailLabel; - removeFromThreads(threads: GmailThread[]): GmailLabel; - } - /** - * A message in a user's Gmail account. - */ - interface GmailMessage { - createDraftReply(body: string): GmailDraft; - createDraftReply(body: string, options: GmailAdvancedOptions): GmailDraft; - createDraftReplyAll(body: string): GmailDraft; - createDraftReplyAll(body: string, options: GmailAdvancedOptions): GmailDraft; - forward(recipient: string): GmailMessage; - forward(recipient: string, options: GmailAdvancedOptions): GmailMessage; - getAttachments(): GmailAttachment[]; - getAttachments(options: GmailAttachmentOptions): GmailAttachment[]; - getBcc(): string; - getBody(): string; - getCc(): string; - getDate(): Base.Date; - getFrom(): string; - getHeader(name: string): string; - getId(): string; - getPlainBody(): string; - getRawContent(): string; - getReplyTo(): string; - getSubject(): string; - getThread(): GmailThread; - getTo(): string; - isDraft(): boolean; - isInChats(): boolean; - isInInbox(): boolean; - isInPriorityInbox(): boolean; - isInTrash(): boolean; - isStarred(): boolean; - isUnread(): boolean; - markRead(): GmailMessage; - markUnread(): GmailMessage; - moveToTrash(): GmailMessage; - refresh(): GmailMessage; - reply(body: string): GmailMessage; - reply(body: string, options: GmailAdvancedOptions): GmailMessage; - replyAll(body: string): GmailMessage; - replyAll(body: string, options: GmailAdvancedOptions): GmailMessage; - star(): GmailMessage; - unstar(): GmailMessage; - } - /** - * A thread in a user's Gmail account. - */ - interface GmailThread { - addLabel(label: GmailLabel): GmailThread; - createDraftReply(body: string): GmailDraft; - createDraftReply(body: string, options: GmailAdvancedOptions): GmailDraft; - createDraftReplyAll(body: string): GmailDraft; - createDraftReplyAll(body: string, options: GmailAdvancedOptions): GmailDraft; - getFirstMessageSubject(): string; - getId(): string; - getLabels(): GmailLabel[]; - getLastMessageDate(): Base.Date; - getMessageCount(): Integer; - getMessages(): GmailMessage[]; - getPermalink(): string; - hasStarredMessages(): boolean; - isImportant(): boolean; - isInChats(): boolean; - isInInbox(): boolean; - isInPriorityInbox(): boolean; - isInSpam(): boolean; - isInTrash(): boolean; - isUnread(): boolean; - markImportant(): GmailThread; - markRead(): GmailThread; - markUnimportant(): GmailThread; - markUnread(): GmailThread; - moveToArchive(): GmailThread; - moveToInbox(): GmailThread; - moveToSpam(): GmailThread; - moveToTrash(): GmailThread; - refresh(): GmailThread; - removeLabel(label: GmailLabel): GmailThread; - reply(body: string): GmailThread; - reply(body: string, options: GmailAdvancedOptions): GmailThread; - replyAll(body: string): GmailThread; - replyAll(body: string, options: GmailAdvancedOptions): GmailThread; - } - } -} - -declare var GmailApp: GoogleAppsScript.Gmail.GmailApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.groups.d.ts b/node_modules/@types/google-apps-script/google-apps-script.groups.d.ts deleted file mode 100644 index 7e0092f..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.groups.d.ts +++ /dev/null @@ -1,66 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Groups { - /** - * A group object whose members and those members' roles within the group can be queried. - * - * Here's an example which shows the members of a group. Before running it, replace the email - * address of the group with that of one on your domain. - * - * function listGroupMembers() { - * var group = GroupsApp.getGroupByEmail("example@googlegroups.com"); - * var str = group.getEmail() + ': '; - * var users = group.getUsers(); - * for (var i = 0; i < users.length; i++) { - * var user = users[i]; - * str = str + user.getEmail() + ", "; - * } - * Logger.log(str); - * } - */ - interface Group { - getEmail(): string; - getGroups(): Group[]; - getRole(email: string): Role; - getRole(user: Base.User): Role; - getRoles(users: Base.User[]): Role[]; - getUsers(): Base.User[]; - hasGroup(group: Group): boolean; - hasGroup(email: string): boolean; - hasUser(email: string): boolean; - hasUser(user: Base.User): boolean; - } - /** - * This class provides access to Google Groups information. It can be used to query information such - * as a group's email address, or the list of groups in which the user is a direct member. - * - * Here's an example that shows how many groups the current user is a member of: - * - * var groups = GroupsApp.getGroups(); - * Logger.log('You belong to ' + groups.length + ' groups.'); - */ - interface GroupsApp { - Role: typeof Role; - getGroupByEmail(email: string): Group; - getGroups(): Group[]; - } - /** - * Possible roles of a user within a group, such as owner or ordinary member. Users subscribed to a - * group have exactly one role within the context of that group. - * See also - * - * Group.getRole(email) - */ - enum Role { - OWNER, - MANAGER, - MEMBER, - INVITED, - PENDING, - } - } -} - -declare var GroupsApp: GoogleAppsScript.Groups.GroupsApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.html.d.ts b/node_modules/@types/google-apps-script/google-apps-script.html.d.ts deleted file mode 100644 index 2023fab..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.html.d.ts +++ /dev/null @@ -1,135 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace HTML { - /** - * An HtmlOutput object that can be served from a script. Due to security considerations, - * scripts cannot directly return HTML to a browser. Instead, they must sanitize it so that it - * cannot perform malicious actions. You can return sanitized HTML like this: - * - * function doGet() { - * return HtmlService.createHtmlOutput('Hello, world!'); - * } - * - * HtmlOutput - * iframe - * sandboxing - * guide to restrictions in HTML service - */ - interface HtmlOutput { - addMetaTag(name: string, content: string): HtmlOutput; - append(addedContent: string): HtmlOutput; - appendUntrusted(addedContent: string): HtmlOutput; - asTemplate(): HtmlTemplate; - clear(): HtmlOutput; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getContent(): string; - getFaviconUrl(): string; - getHeight(): Integer; - getMetaTags(): HtmlOutputMetaTag[]; - getTitle(): string; - getWidth(): Integer; - setContent(content: string): HtmlOutput; - setFaviconUrl(iconUrl: string): HtmlOutput; - setHeight(height: Integer): HtmlOutput; - setSandboxMode(mode: SandboxMode): HtmlOutput; - setTitle(title: string): HtmlOutput; - setWidth(width: Integer): HtmlOutput; - setXFrameOptionsMode(mode: XFrameOptionsMode): HtmlOutput; - } - /** - * An object that represents a meta tag added to the page by calling HtmlOutput.addMetaTag(name, content). - * - * var output = HtmlService.createHtmlOutput('Hello, world!'); - * output.addMetaTag('viewport', 'width=device-width, initial-scale=1'); - * - * var tags = output.getMetaTags(); - * Logger.log('', tags[0].getName(), tags[0].getContent()); - */ - interface HtmlOutputMetaTag { - getContent(): string; - getName(): string; - } - /** - * Service for returning HTML and other text content from a script. - * - * Due to security considerations, scripts cannot directly return content to a browser. Instead, - * they must sanitize the HTML so that it cannot perform malicious actions. See the description of - * HtmlOutput for what limitations this implies on what can be returned. - */ - interface HtmlService { - SandboxMode: typeof SandboxMode; - XFrameOptionsMode: typeof XFrameOptionsMode; - createHtmlOutput(): HtmlOutput; - createHtmlOutput(blob: Base.BlobSource): HtmlOutput; - createHtmlOutput(html: string): HtmlOutput; - createHtmlOutputFromFile(filename: string): HtmlOutput; - createTemplate(blob: Base.BlobSource): HtmlTemplate; - createTemplate(html: string): HtmlTemplate; - createTemplateFromFile(filename: string): HtmlTemplate; - getUserAgent(): string; - } - /** - * A template object for dynamically constructing HTML. For more information, see the guide to templates. - */ - interface HtmlTemplate { - evaluate(): HtmlOutput; - getCode(): string; - getCodeWithComments(): string; - getRawContent(): string; - [propName: string]: any; - } - /** - * An enum representing the sandbox modes that can be used for client-side HtmlService - * scripts. These values can be accessed from HtmlService.SandboxMode, and set by calling - * HtmlOutput.setSandboxMode(mode). - * - * The NATIVE and EMULATED modes were deprecated on October 13, 2015 and both are now sunset. Only - * IFRAME mode is now supported. - * - * To protect users from being served malicious HTML or JavaScript, client-side code served from - * HTML service executes in a security sandbox that imposes restrictions on the code. The method - * HtmlOutput.setSandboxMode(mode) previously allowed script authors to choose - * between different versions of the sandbox, but now has no effect. For more information, see the - * guide to restrictions in HTML service. - * - * The IFRAME mode imposes many fewer restrictions than the other sandbox modes and runs - * fastest, but does not work at all in certain older browsers, including Internet Explorer 9. The - * sandbox mode can also be read in a client-side script by inspecting google.script.sandbox.mode. Note that this property returns the actual mode on the client, which - * may differ from the mode requested on the server if the requested mode is not supported in the - * user's browser. - * - * - * - */ - enum SandboxMode { - EMULATED, - IFRAME, - NATIVE, - } - /** - * An enum representing the X-Frame-Options modes that can be used for client-side HtmlService scripts. These values can be accessed from HtmlService.XFrameOptionsMode, - * and set by calling HtmlOutput.setXFrameOptionsMode(mode). - * - * Setting XFrameOptionsMode.ALLOWALL will let any site iframe the page, so the developer - * should implement their own protection against clickjacking. - * - * If a script does not set an X-Frame-Options mode, Apps Script uses DEFAULT - * mode as the default. - * - * // Serve HTML with no X-Frame-Options header (in Apps Script server-side code). - * var output = HtmlService.createHtmlOutput('Hello, world!'); - * output.setXFrameOptionsMode(HtmlService.XFrameOptionsMode.ALLOWALL); - */ - enum XFrameOptionsMode { - ALLOWALL, - DEFAULT, - } - } -} - -declare var HtmlService: GoogleAppsScript.HTML.HtmlService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.jdbc.d.ts b/node_modules/@types/google-apps-script/google-apps-script.jdbc.d.ts deleted file mode 100644 index 3cdc602..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.jdbc.d.ts +++ /dev/null @@ -1,973 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace JDBC { - /** JdbcAdvancedParameters */ - interface CloudSqlAdvancedParameters { - /** connection timeout in seconds */ - connectTimeoutSeconds?: Integer | undefined; - /** the database to connect to */ - database?: string | undefined; - /** the name of a Google SQL Service instance */ - instance?: string | undefined; - /** the user's password */ - password?: string | undefined; - /** query timeout in seconds */ - queryTimeoutSeconds?: Integer | undefined; - /** the username to pass to the database */ - user?: string | undefined; - } - /** JdbcAdvancedParameters */ - interface ConnectionAdvancedParameters { - /** the database to connect to */ - databaseName?: string | undefined; - /** the user's password */ - password?: string | undefined; - /** whether or not the connection should comply with JDBC rules when converting time zones. The default is false. */ - useJDBCCompliantTimeZoneShift?: boolean | undefined; - /** the username to pass to the database */ - user?: string | undefined; - /** the server's SSL certificate */ - _serverSslCertificate?: string | undefined; - /** the client's SSL certificate */ - _clientSslCertificate?: string | undefined; - /** the client's SSL key */ - _clientSslKey?: string | undefined; - } - /** - * The JDBC service allows scripts to connect to Google Cloud SQL, MySQL, - * Microsoft SQL Server, and Oracle databases. For more information, see the guide to JDBC. - */ - interface Jdbc { - getCloudSqlConnection(url: string): JdbcConnection; - getCloudSqlConnection(url: string, info: CloudSqlAdvancedParameters): JdbcConnection; - getCloudSqlConnection(url: string, userName: string, password: string): JdbcConnection; - getConnection(url: string): JdbcConnection; - getConnection(url: string, info: ConnectionAdvancedParameters): JdbcConnection; - getConnection(url: string, userName: string, password: string): JdbcConnection; - newDate(milliseconds: Integer): JdbcDate; - newTime(milliseconds: Integer): JdbcTime; - newTimestamp(milliseconds: Integer): JdbcTimestamp; - parseDate(date: string): JdbcDate; - parseTime(time: string): JdbcTime; - parseTimestamp(timestamp: string): JdbcTimestamp; - } - /** - * A JDBC Array. For documentation of this class, see java.sql.Array - * . - */ - interface JdbcArray { - free(): void; - getArray(): any; - getArray(index: Integer, count: Integer): any; - getBaseType(): Integer; - getBaseTypeName(): string; - getResultSet(): JdbcResultSet; - getResultSet(index: Integer, count: Integer): JdbcResultSet; - } - /** - * A JDBC Blob. For documentation of this class, see java.sql.Blob - * . - */ - interface JdbcBlob { - free(): void; - getAppsScriptBlob(): Base.Blob; - getAs(contentType: string): Base.Blob; - getBytes(position: Integer, length: Integer): Byte[]; - length(): Integer; - position(pattern: Byte[], start: Integer): Integer; - position(pattern: JdbcBlob, start: Integer): Integer; - setBytes(position: Integer, blobSource: Base.BlobSource): Integer; - setBytes(position: Integer, blobSource: Base.BlobSource, offset: Integer, length: Integer): Integer; - setBytes(position: Integer, bytes: Byte[]): Integer; - setBytes(position: Integer, bytes: Byte[], offset: Integer, length: Integer): Integer; - truncate(length: Integer): void; - } - /** - * A JDBC CallableStatement. For documentation of this class, see - * java.sql.CallableStatement. - */ - interface JdbcCallableStatement { - addBatch(): void; - addBatch(sql: string): void; - cancel(): void; - clearBatch(): void; - clearParameters(): void; - clearWarnings(): void; - close(): void; - execute(): boolean; - execute(sql: string): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: string[]): boolean; - executeBatch(): Integer[]; - executeQuery(): JdbcResultSet; - executeQuery(sql: string): JdbcResultSet; - executeUpdate(): Integer; - executeUpdate(sql: string): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: string[]): Integer; - getArray(parameterIndex: Integer): JdbcArray; - getArray(parameterName: string): JdbcArray; - getBigDecimal(parameterIndex: Integer): BigNumber; - getBigDecimal(parameterName: string): BigNumber; - getBlob(parameterIndex: Integer): JdbcBlob; - getBlob(parameterName: string): JdbcBlob; - getBoolean(parameterIndex: Integer): boolean; - getBoolean(parameterName: string): boolean; - getByte(parameterIndex: Integer): Byte; - getByte(parameterName: string): Byte; - getBytes(parameterIndex: Integer): Byte[]; - getBytes(parameterName: string): Byte[]; - getClob(parameterIndex: Integer): JdbcClob; - getClob(parameterName: string): JdbcClob; - getConnection(): JdbcConnection; - getDate(parameterIndex: Integer): JdbcDate; - getDate(parameterIndex: Integer, timeZone: string): JdbcDate; - getDate(parameterName: string): JdbcDate; - getDate(parameterName: string, timeZone: string): JdbcDate; - getDouble(parameterIndex: Integer): number; - getDouble(parameterName: string): number; - getFetchDirection(): Integer; - getFetchSize(): Integer; - getFloat(parameterIndex: Integer): number; - getFloat(parameterName: string): number; - getGeneratedKeys(): JdbcResultSet; - getInt(parameterIndex: Integer): Integer; - getInt(parameterName: string): Integer; - getLong(parameterIndex: Integer): Integer; - getLong(parameterName: string): Integer; - getMaxFieldSize(): Integer; - getMaxRows(): Integer; - getMetaData(): JdbcResultSetMetaData; - getMoreResults(): boolean; - getMoreResults(current: Integer): boolean; - getNClob(parameterIndex: Integer): JdbcClob; - getNClob(parameterName: string): JdbcClob; - getNString(parameterIndex: Integer): string; - getNString(parameterName: string): string; - getObject(parameterIndex: Integer): any; - getObject(parameterName: string): any; - getParameterMetaData(): JdbcParameterMetaData; - getQueryTimeout(): Integer; - getRef(parameterIndex: Integer): JdbcRef; - getRef(parameterName: string): JdbcRef; - getResultSet(): JdbcResultSet; - getResultSetConcurrency(): Integer; - getResultSetHoldability(): Integer; - getResultSetType(): Integer; - getRowId(parameterIndex: Integer): JdbcRowId; - getRowId(parameterName: string): JdbcRowId; - getSQLXML(parameterIndex: Integer): JdbcSQLXML; - getSQLXML(parameterName: string): JdbcSQLXML; - getShort(parameterIndex: Integer): Integer; - getShort(parameterName: string): Integer; - getString(parameterIndex: Integer): string; - getString(parameterName: string): string; - getTime(parameterIndex: Integer): JdbcTime; - getTime(parameterIndex: Integer, timeZone: string): JdbcTime; - getTime(parameterName: string): JdbcTime; - getTime(parameterName: string, timeZone: string): JdbcTime; - getTimestamp(parameterIndex: Integer): JdbcTimestamp; - getTimestamp(parameterIndex: Integer, timeZone: string): JdbcTimestamp; - getTimestamp(parameterName: string): JdbcTimestamp; - getTimestamp(parameterName: string, timeZone: string): JdbcTimestamp; - getURL(parameterIndex: Integer): string; - getURL(parameterName: string): string; - getUpdateCount(): Integer; - getWarnings(): string[]; - isClosed(): boolean; - isPoolable(): boolean; - registerOutParameter(parameterIndex: Integer, sqlType: Integer): void; - registerOutParameter(parameterIndex: Integer, sqlType: Integer, scale: Integer): void; - registerOutParameter(parameterIndex: Integer, sqlType: Integer, typeName: string): void; - registerOutParameter(parameterName: string, sqlType: Integer): void; - registerOutParameter(parameterName: string, sqlType: Integer, scale: Integer): void; - registerOutParameter(parameterName: string, sqlType: Integer, typeName: string): void; - setArray(parameterIndex: Integer, x: JdbcArray): void; - setBigDecimal(parameterIndex: Integer, x: BigNumber): void; - setBigDecimal(parameterName: string, x: BigNumber): void; - setBlob(parameterIndex: Integer, x: JdbcBlob): void; - setBlob(parameterName: string, x: JdbcBlob): void; - setBoolean(parameterIndex: Integer, x: boolean): void; - setBoolean(parameterName: string, x: boolean): void; - setByte(parameterIndex: Integer, x: Byte): void; - setByte(parameterName: string, x: Byte): void; - setBytes(parameterIndex: Integer, x: Byte[]): void; - setBytes(parameterName: string, x: Byte[]): void; - setClob(parameterIndex: Integer, x: JdbcClob): void; - setClob(parameterName: string, x: JdbcClob): void; - setCursorName(name: string): void; - setDate(parameterIndex: Integer, x: JdbcDate): void; - setDate(parameterIndex: Integer, x: JdbcDate, timeZone: string): void; - setDate(parameterName: string, x: JdbcDate): void; - setDate(parameterName: string, x: JdbcDate, timeZone: string): void; - setDouble(parameterIndex: Integer, x: number): void; - setDouble(parameterName: string, x: number): void; - setEscapeProcessing(enable: boolean): void; - setFetchDirection(direction: Integer): void; - setFetchSize(rows: Integer): void; - setFloat(parameterIndex: Integer, x: number): void; - setFloat(parameterName: string, x: number): void; - setInt(parameterIndex: Integer, x: Integer): void; - setInt(parameterName: string, x: Integer): void; - setLong(parameterIndex: Integer, x: Integer): void; - setLong(parameterName: string, x: Integer): void; - setMaxFieldSize(max: Integer): void; - setMaxRows(max: Integer): void; - setNClob(parameterIndex: Integer, x: JdbcClob): void; - setNClob(parameterName: string, value: JdbcClob): void; - setNString(parameterIndex: Integer, x: string): void; - setNString(parameterName: string, value: string): void; - setNull(parameterIndex: Integer, sqlType: Integer): void; - setNull(parameterIndex: Integer, sqlType: Integer, typeName: string): void; - setNull(parameterName: string, sqlType: Integer): void; - setNull(parameterName: string, sqlType: Integer, typeName: string): void; - setObject(index: Integer, x: any): void; - setObject(parameterIndex: Integer, x: any, targetSqlType: Integer): void; - setObject(parameterIndex: Integer, x: any, targetSqlType: Integer, scaleOrLength: Integer): void; - setObject(parameterName: string, x: any): void; - setObject(parameterName: string, x: any, targetSqlType: Integer): void; - setObject(parameterName: string, x: any, targetSqlType: Integer, scale: Integer): void; - setPoolable(poolable: boolean): void; - setQueryTimeout(seconds: Integer): void; - setRef(parameterIndex: Integer, x: JdbcRef): void; - setRowId(parameterIndex: Integer, x: JdbcRowId): void; - setRowId(parameterName: string, x: JdbcRowId): void; - setSQLXML(parameterIndex: Integer, x: JdbcSQLXML): void; - setSQLXML(parameterName: string, xmlObject: JdbcSQLXML): void; - setShort(parameterIndex: Integer, x: Integer): void; - setShort(parameterName: string, x: Integer): void; - setString(parameterIndex: Integer, x: string): void; - setString(parameterName: string, x: string): void; - setTime(parameterIndex: Integer, x: JdbcTime): void; - setTime(parameterIndex: Integer, x: JdbcTime, timeZone: string): void; - setTime(parameterName: string, x: JdbcTime): void; - setTime(parameterName: string, x: JdbcTime, timeZone: string): void; - setTimestamp(parameterIndex: Integer, x: JdbcTimestamp): void; - setTimestamp(parameterIndex: Integer, x: JdbcTimestamp, timeZone: string): void; - setTimestamp(parameterName: string, x: JdbcTimestamp): void; - setTimestamp(parameterName: string, x: JdbcTimestamp, timeZone: string): void; - setURL(parameterIndex: Integer, x: string): void; - setURL(parameterName: string, val: string): void; - wasNull(): boolean; - } - /** - * A JDBC Clob. For documentation of this class, see java.sql.Clob - * . - */ - interface JdbcClob { - free(): void; - getAppsScriptBlob(): Base.Blob; - getAs(contentType: string): Base.Blob; - getSubString(position: Integer, length: Integer): string; - length(): Integer; - position(search: JdbcClob, start: Integer): Integer; - position(search: string, start: Integer): Integer; - setString(position: Integer, blobSource: Base.BlobSource): Integer; - setString(position: Integer, blobSource: Base.BlobSource, offset: Integer, len: Integer): Integer; - setString(position: Integer, value: string): Integer; - setString(position: Integer, value: string, offset: Integer, len: Integer): Integer; - truncate(length: Integer): void; - } - /** - * A JDBC Connection. For documentation of this class, see - * java.sql.Connection. - */ - interface JdbcConnection { - clearWarnings(): void; - close(): void; - commit(): void; - createArrayOf(typeName: string, elements: any[]): JdbcArray; - createBlob(): JdbcBlob; - createClob(): JdbcClob; - createNClob(): JdbcClob; - createSQLXML(): JdbcSQLXML; - createStatement(): JdbcStatement; - createStatement(resultSetType: Integer, resultSetConcurrency: Integer): JdbcStatement; - createStatement( - resultSetType: Integer, - resultSetConcurrency: Integer, - resultSetHoldability: Integer, - ): JdbcStatement; - createStruct(typeName: string, attributes: any[]): JdbcStruct; - getAutoCommit(): boolean; - getCatalog(): string; - getHoldability(): Integer; - getMetaData(): JdbcDatabaseMetaData; - getTransactionIsolation(): Integer; - getWarnings(): string[]; - isClosed(): boolean; - isReadOnly(): boolean; - isValid(timeout: Integer): boolean; - nativeSQL(sql: string): string; - prepareCall(sql: string): JdbcCallableStatement; - prepareCall(sql: string, resultSetType: Integer, resultSetConcurrency: Integer): JdbcCallableStatement; - prepareCall( - sql: string, - resultSetType: Integer, - resultSetConcurrency: Integer, - resultSetHoldability: Integer, - ): JdbcCallableStatement; - prepareStatement(sql: string): JdbcPreparedStatement; - prepareStatement(sql: string, autoGeneratedKeys: Integer): JdbcPreparedStatement; - prepareStatement(sql: string, resultSetType: Integer, resultSetConcurrency: Integer): JdbcPreparedStatement; - prepareStatement( - sql: string, - resultSetType: Integer, - resultSetConcurrency: Integer, - resultSetHoldability: Integer, - ): JdbcPreparedStatement; - prepareStatementByIndex(sql: string, indices: Integer[]): JdbcPreparedStatement; - prepareStatementByName(sql: string, columnNames: string[]): JdbcPreparedStatement; - releaseSavepoint(savepoint: JdbcSavepoint): void; - rollback(): void; - rollback(savepoint: JdbcSavepoint): void; - setAutoCommit(autoCommit: boolean): void; - setCatalog(catalog: string): void; - setHoldability(holdability: Integer): void; - setReadOnly(readOnly: boolean): void; - setSavepoint(): JdbcSavepoint; - setSavepoint(name: string): JdbcSavepoint; - setTransactionIsolation(level: Integer): void; - } - /** - * A JDBC database metadata object. For documentation of this class, see - * java.sql.DatabaseMetaData. - */ - interface JdbcDatabaseMetaData { - allProceduresAreCallable(): boolean; - allTablesAreSelectable(): boolean; - autoCommitFailureClosesAllResultSets(): boolean; - dataDefinitionCausesTransactionCommit(): boolean; - dataDefinitionIgnoredInTransactions(): boolean; - deletesAreDetected(type: Integer): boolean; - doesMaxRowSizeIncludeBlobs(): boolean; - getAttributes( - catalog: string, - schemaPattern: string, - typeNamePattern: string, - attributeNamePattern: string, - ): JdbcResultSet; - getBestRowIdentifier( - catalog: string, - schema: string, - table: string, - scope: Integer, - nullable: boolean, - ): JdbcResultSet; - getCatalogSeparator(): string; - getCatalogTerm(): string; - getCatalogs(): JdbcResultSet; - getClientInfoProperties(): JdbcResultSet; - getColumnPrivileges( - catalog: string, - schema: string, - table: string, - columnNamePattern: string, - ): JdbcResultSet; - getColumns( - catalog: string, - schemaPattern: string, - tableNamePattern: string, - columnNamePattern: string, - ): JdbcResultSet; - getConnection(): JdbcConnection; - getCrossReference( - parentCatalog: string, - parentSchema: string, - parentTable: string, - foreignCatalog: string, - foreignSchema: string, - foreignTable: string, - ): JdbcResultSet; - getDatabaseMajorVersion(): Integer; - getDatabaseMinorVersion(): Integer; - getDatabaseProductName(): string; - getDatabaseProductVersion(): string; - getDefaultTransactionIsolation(): Integer; - getDriverMajorVersion(): Integer; - getDriverMinorVersion(): Integer; - getDriverName(): string; - getDriverVersion(): string; - getExportedKeys(catalog: string, schema: string, table: string): JdbcResultSet; - getExtraNameCharacters(): string; - getFunctionColumns( - catalog: string, - schemaPattern: string, - functionNamePattern: string, - columnNamePattern: string, - ): JdbcResultSet; - getFunctions(catalog: string, schemaPattern: string, functionNamePattern: string): JdbcResultSet; - getIdentifierQuoteString(): string; - getImportedKeys(catalog: string, schema: string, table: string): JdbcResultSet; - getIndexInfo( - catalog: string, - schema: string, - table: string, - unique: boolean, - approximate: boolean, - ): JdbcResultSet; - getJDBCMajorVersion(): Integer; - getJDBCMinorVersion(): Integer; - getMaxBinaryLiteralLength(): Integer; - getMaxCatalogNameLength(): Integer; - getMaxCharLiteralLength(): Integer; - getMaxColumnNameLength(): Integer; - getMaxColumnsInGroupBy(): Integer; - getMaxColumnsInIndex(): Integer; - getMaxColumnsInOrderBy(): Integer; - getMaxColumnsInSelect(): Integer; - getMaxColumnsInTable(): Integer; - getMaxConnections(): Integer; - getMaxCursorNameLength(): Integer; - getMaxIndexLength(): Integer; - getMaxProcedureNameLength(): Integer; - getMaxRowSize(): Integer; - getMaxSchemaNameLength(): Integer; - getMaxStatementLength(): Integer; - getMaxStatements(): Integer; - getMaxTableNameLength(): Integer; - getMaxTablesInSelect(): Integer; - getMaxUserNameLength(): Integer; - getNumericFunctions(): string; - getPrimaryKeys(catalog: string, schema: string, table: string): JdbcResultSet; - getProcedureColumns( - catalog: string, - schemaPattern: string, - procedureNamePattern: string, - columnNamePattern: string, - ): JdbcResultSet; - getProcedureTerm(): string; - getProcedures(catalog: string, schemaPattern: string, procedureNamePattern: string): JdbcResultSet; - getResultSetHoldability(): Integer; - getRowIdLifetime(): Integer; - getSQLKeywords(): string; - getSQLStateType(): Integer; - getSchemaTerm(): string; - getSchemas(): JdbcResultSet; - getSchemas(catalog: string, schemaPattern: string): JdbcResultSet; - getSearchStringEscape(): string; - getStringFunctions(): string; - getSuperTables(catalog: string, schemaPattern: string, tableNamePattern: string): JdbcResultSet; - getSuperTypes(catalog: string, schemaPattern: string, typeNamePattern: string): JdbcResultSet; - getSystemFunctions(): string; - getTablePrivileges(catalog: string, schemaPattern: string, tableNamePattern: string): JdbcResultSet; - getTableTypes(): JdbcResultSet; - getTables(catalog: string, schemaPattern: string, tableNamePattern: string, types: string[]): JdbcResultSet; - getTimeDateFunctions(): string; - getTypeInfo(): JdbcResultSet; - getUDTs(catalog: string, schemaPattern: string, typeNamePattern: string, types: Integer[]): JdbcResultSet; - getURL(): string; - getUserName(): string; - getVersionColumns(catalog: string, schema: string, table: string): JdbcResultSet; - insertsAreDetected(type: Integer): boolean; - isCatalogAtStart(): boolean; - isReadOnly(): boolean; - locatorsUpdateCopy(): boolean; - nullPlusNonNullIsNull(): boolean; - nullsAreSortedAtEnd(): boolean; - nullsAreSortedAtStart(): boolean; - nullsAreSortedHigh(): boolean; - nullsAreSortedLow(): boolean; - othersDeletesAreVisible(type: Integer): boolean; - othersInsertsAreVisible(type: Integer): boolean; - othersUpdatesAreVisible(type: Integer): boolean; - ownDeletesAreVisible(type: Integer): boolean; - ownInsertsAreVisible(type: Integer): boolean; - ownUpdatesAreVisible(type: Integer): boolean; - storesLowerCaseIdentifiers(): boolean; - storesLowerCaseQuotedIdentifiers(): boolean; - storesMixedCaseIdentifiers(): boolean; - storesMixedCaseQuotedIdentifiers(): boolean; - storesUpperCaseIdentifiers(): boolean; - storesUpperCaseQuotedIdentifiers(): boolean; - supportsANSI92EntryLevelSQL(): boolean; - supportsANSI92FullSQL(): boolean; - supportsANSI92IntermediateSQL(): boolean; - supportsAlterTableWithAddColumn(): boolean; - supportsAlterTableWithDropColumn(): boolean; - supportsBatchUpdates(): boolean; - supportsCatalogsInDataManipulation(): boolean; - supportsCatalogsInIndexDefinitions(): boolean; - supportsCatalogsInPrivilegeDefinitions(): boolean; - supportsCatalogsInProcedureCalls(): boolean; - supportsCatalogsInTableDefinitions(): boolean; - supportsColumnAliasing(): boolean; - supportsConvert(): boolean; - supportsConvert(fromType: Integer, toType: Integer): boolean; - supportsCoreSQLGrammar(): boolean; - supportsCorrelatedSubqueries(): boolean; - supportsDataDefinitionAndDataManipulationTransactions(): boolean; - supportsDataManipulationTransactionsOnly(): boolean; - supportsDifferentTableCorrelationNames(): boolean; - supportsExpressionsInOrderBy(): boolean; - supportsExtendedSQLGrammar(): boolean; - supportsFullOuterJoins(): boolean; - supportsGetGeneratedKeys(): boolean; - supportsGroupBy(): boolean; - supportsGroupByBeyondSelect(): boolean; - supportsGroupByUnrelated(): boolean; - supportsIntegrityEnhancementFacility(): boolean; - supportsLikeEscapeClause(): boolean; - supportsLimitedOuterJoins(): boolean; - supportsMinimumSQLGrammar(): boolean; - supportsMixedCaseIdentifiers(): boolean; - supportsMixedCaseQuotedIdentifiers(): boolean; - supportsMultipleOpenResults(): boolean; - supportsMultipleResultSets(): boolean; - supportsMultipleTransactions(): boolean; - supportsNamedParameters(): boolean; - supportsNonNullableColumns(): boolean; - supportsOpenCursorsAcrossCommit(): boolean; - supportsOpenCursorsAcrossRollback(): boolean; - supportsOpenStatementsAcrossCommit(): boolean; - supportsOpenStatementsAcrossRollback(): boolean; - supportsOrderByUnrelated(): boolean; - supportsOuterJoins(): boolean; - supportsPositionedDelete(): boolean; - supportsPositionedUpdate(): boolean; - supportsResultSetConcurrency(type: Integer, concurrency: Integer): boolean; - supportsResultSetHoldability(holdability: Integer): boolean; - supportsResultSetType(type: Integer): boolean; - supportsSavepoints(): boolean; - supportsSchemasInDataManipulation(): boolean; - supportsSchemasInIndexDefinitions(): boolean; - supportsSchemasInPrivilegeDefinitions(): boolean; - supportsSchemasInProcedureCalls(): boolean; - supportsSchemasInTableDefinitions(): boolean; - supportsSelectForUpdate(): boolean; - supportsStatementPooling(): boolean; - supportsStoredFunctionsUsingCallSyntax(): boolean; - supportsStoredProcedures(): boolean; - supportsSubqueriesInComparisons(): boolean; - supportsSubqueriesInExists(): boolean; - supportsSubqueriesInIns(): boolean; - supportsSubqueriesInQuantifieds(): boolean; - supportsTableCorrelationNames(): boolean; - supportsTransactionIsolationLevel(level: Integer): boolean; - supportsTransactions(): boolean; - supportsUnion(): boolean; - supportsUnionAll(): boolean; - updatesAreDetected(type: Integer): boolean; - usesLocalFilePerTable(): boolean; - usesLocalFiles(): boolean; - } - /** - * A JDBC Date. For documentation of this class, see java.sql.Date - * . - */ - interface JdbcDate { - after(when: JdbcDate): boolean; - before(when: JdbcDate): boolean; - getDate(): Integer; - getMonth(): Integer; - getTime(): Integer; - getYear(): Integer; - setDate(date: Integer): void; - setMonth(month: Integer): void; - setTime(milliseconds: Integer): void; - setYear(year: Integer): void; - } - /** - * A JDBC ParameterMetaData. For documentation of this class, see - * java.sql.ParameterMetaData. - */ - interface JdbcParameterMetaData { - getParameterClassName(param: Integer): string; - getParameterCount(): Integer; - getParameterMode(param: Integer): Integer; - getParameterType(param: Integer): Integer; - getParameterTypeName(param: Integer): string; - getPrecision(param: Integer): Integer; - getScale(param: Integer): Integer; - isNullable(param: Integer): Integer; - isSigned(param: Integer): boolean; - } - /** - * A JDBC PreparedStatement. For documentation of this class, see - * java.sql.PreparedStatement. - */ - interface JdbcPreparedStatement { - addBatch(): void; - addBatch(sql: string): void; - cancel(): void; - clearBatch(): void; - clearParameters(): void; - clearWarnings(): void; - close(): void; - execute(): boolean; - execute(sql: string): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: string[]): boolean; - executeBatch(): Integer[]; - executeQuery(): JdbcResultSet; - executeQuery(sql: string): JdbcResultSet; - executeUpdate(): Integer; - executeUpdate(sql: string): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: string[]): Integer; - getConnection(): JdbcConnection; - getFetchDirection(): Integer; - getFetchSize(): Integer; - getGeneratedKeys(): JdbcResultSet; - getMaxFieldSize(): Integer; - getMaxRows(): Integer; - getMetaData(): JdbcResultSetMetaData; - getMoreResults(): boolean; - getMoreResults(current: Integer): boolean; - getParameterMetaData(): JdbcParameterMetaData; - getQueryTimeout(): Integer; - getResultSet(): JdbcResultSet; - getResultSetConcurrency(): Integer; - getResultSetHoldability(): Integer; - getResultSetType(): Integer; - getUpdateCount(): Integer; - getWarnings(): string[]; - isClosed(): boolean; - isPoolable(): boolean; - setArray(parameterIndex: Integer, x: JdbcArray): void; - setBigDecimal(parameterIndex: Integer, x: BigNumber): void; - setBlob(parameterIndex: Integer, x: JdbcBlob): void; - setBoolean(parameterIndex: Integer, x: boolean): void; - setByte(parameterIndex: Integer, x: Byte): void; - setBytes(parameterIndex: Integer, x: Byte[]): void; - setClob(parameterIndex: Integer, x: JdbcClob): void; - setCursorName(name: string): void; - setDate(parameterIndex: Integer, x: JdbcDate): void; - setDate(parameterIndex: Integer, x: JdbcDate, timeZone: string): void; - setDouble(parameterIndex: Integer, x: number): void; - setEscapeProcessing(enable: boolean): void; - setFetchDirection(direction: Integer): void; - setFetchSize(rows: Integer): void; - setFloat(parameterIndex: Integer, x: number): void; - setInt(parameterIndex: Integer, x: Integer): void; - setLong(parameterIndex: Integer, x: Integer): void; - setMaxFieldSize(max: Integer): void; - setMaxRows(max: Integer): void; - setNClob(parameterIndex: Integer, x: JdbcClob): void; - setNString(parameterIndex: Integer, x: string): void; - setNull(parameterIndex: Integer, sqlType: Integer): void; - setNull(parameterIndex: Integer, sqlType: Integer, typeName: string): void; - setObject(index: Integer, x: any): void; - setObject(parameterIndex: Integer, x: any, targetSqlType: Integer): void; - setObject(parameterIndex: Integer, x: any, targetSqlType: Integer, scaleOrLength: Integer): void; - setPoolable(poolable: boolean): void; - setQueryTimeout(seconds: Integer): void; - setRef(parameterIndex: Integer, x: JdbcRef): void; - setRowId(parameterIndex: Integer, x: JdbcRowId): void; - setSQLXML(parameterIndex: Integer, x: JdbcSQLXML): void; - setShort(parameterIndex: Integer, x: Integer): void; - setString(parameterIndex: Integer, x: string): void; - setTime(parameterIndex: Integer, x: JdbcTime): void; - setTime(parameterIndex: Integer, x: JdbcTime, timeZone: string): void; - setTimestamp(parameterIndex: Integer, x: JdbcTimestamp): void; - setTimestamp(parameterIndex: Integer, x: JdbcTimestamp, timeZone: string): void; - setURL(parameterIndex: Integer, x: string): void; - } - /** - * A JDBC Ref. For documentation of this class, see java.sql.Ref. - */ - interface JdbcRef { - getBaseTypeName(): string; - getObject(): any; - setObject(object: any): void; - } - /** - * A JDBC ResultSet. For documentation of this class, see java.sql.ResultSet - * . - */ - interface JdbcResultSet { - absolute(row: Integer): boolean; - afterLast(): void; - beforeFirst(): void; - cancelRowUpdates(): void; - clearWarnings(): void; - close(): void; - deleteRow(): void; - findColumn(columnLabel: string): Integer; - first(): boolean; - getArray(columnIndex: Integer): JdbcArray; - getArray(columnLabel: string): JdbcArray; - getBigDecimal(columnIndex: Integer): BigNumber; - getBigDecimal(columnLabel: string): BigNumber; - getBlob(columnIndex: Integer): JdbcBlob; - getBlob(columnLabel: string): JdbcBlob; - getBoolean(columnIndex: Integer): boolean; - getBoolean(columnLabel: string): boolean; - getByte(columnIndex: Integer): Byte; - getByte(columnLabel: string): Byte; - getBytes(columnIndex: Integer): Byte[]; - getBytes(columnLabel: string): Byte[]; - getClob(columnIndex: Integer): JdbcClob; - getClob(columnLabel: string): JdbcClob; - getConcurrency(): Integer; - getCursorName(): string; - getDate(columnIndex: Integer): JdbcDate; - getDate(columnIndex: Integer, timeZone: string): JdbcDate; - getDate(columnLabel: string): JdbcDate; - getDate(columnLabel: string, timeZone: string): JdbcDate; - getDouble(columnIndex: Integer): number; - getDouble(columnLabel: string): number; - getFetchDirection(): Integer; - getFetchSize(): Integer; - getFloat(columnIndex: Integer): number; - getFloat(columnLabel: string): number; - getHoldability(): Integer; - getInt(columnIndex: Integer): Integer; - getInt(columnLabel: string): Integer; - getLong(columnIndex: Integer): Integer; - getLong(columnLabel: string): Integer; - getMetaData(): JdbcResultSetMetaData; - getNClob(columnIndex: Integer): JdbcClob; - getNClob(columnLabel: string): JdbcClob; - getNString(columnIndex: Integer): string; - getNString(columnLabel: string): string; - getObject(columnIndex: Integer): any; - getObject(columnLabel: string): any; - getRef(columnIndex: Integer): JdbcRef; - getRef(columnLabel: string): JdbcRef; - getRow(): Integer; - getRowId(columnIndex: Integer): JdbcRowId; - getRowId(columnLabel: string): JdbcRowId; - getSQLXML(columnIndex: Integer): JdbcSQLXML; - getSQLXML(columnLabel: string): JdbcSQLXML; - getShort(columnIndex: Integer): Integer; - getShort(columnLabel: string): Integer; - getStatement(): JdbcStatement; - getString(columnIndex: Integer): string; - getString(columnLabel: string): string; - getTime(columnIndex: Integer): JdbcTime; - getTime(columnIndex: Integer, timeZone: string): JdbcTime; - getTime(columnLabel: string): JdbcTime; - getTime(columnLabel: string, timeZone: string): JdbcTime; - getTimestamp(columnIndex: Integer): JdbcTimestamp; - getTimestamp(columnIndex: Integer, timeZone: string): JdbcTimestamp; - getTimestamp(columnLabel: string): JdbcTimestamp; - getTimestamp(columnLabel: string, timeZone: string): JdbcTimestamp; - getType(): Integer; - getURL(columnIndex: Integer): string; - getURL(columnLabel: string): string; - getWarnings(): string[]; - insertRow(): void; - isAfterLast(): boolean; - isBeforeFirst(): boolean; - isClosed(): boolean; - isFirst(): boolean; - isLast(): boolean; - last(): boolean; - moveToCurrentRow(): void; - moveToInsertRow(): void; - next(): boolean; - previous(): boolean; - refreshRow(): void; - relative(rows: Integer): boolean; - rowDeleted(): boolean; - rowInserted(): boolean; - rowUpdated(): boolean; - setFetchDirection(direction: Integer): void; - setFetchSize(rows: Integer): void; - updateArray(columnIndex: Integer, x: JdbcArray): void; - updateArray(columnLabel: string, x: JdbcArray): void; - updateBigDecimal(columnIndex: Integer, x: BigNumber): void; - updateBigDecimal(columnLabel: string, x: BigNumber): void; - updateBlob(columnIndex: Integer, x: JdbcBlob): void; - updateBlob(columnLabel: string, x: JdbcBlob): void; - updateBoolean(columnIndex: Integer, x: boolean): void; - updateBoolean(columnLabel: string, x: boolean): void; - updateByte(columnIndex: Integer, x: Byte): void; - updateByte(columnLabel: string, x: Byte): void; - updateBytes(columnIndex: Integer, x: Byte[]): void; - updateBytes(columnLabel: string, x: Byte[]): void; - updateClob(columnIndex: Integer, x: JdbcClob): void; - updateClob(columnLabel: string, x: JdbcClob): void; - updateDate(columnIndex: Integer, x: JdbcDate): void; - updateDate(columnLabel: string, x: JdbcDate): void; - updateDouble(columnIndex: Integer, x: number): void; - updateDouble(columnLabel: string, x: number): void; - updateFloat(columnIndex: Integer, x: number): void; - updateFloat(columnLabel: string, x: number): void; - updateInt(columnIndex: Integer, x: Integer): void; - updateInt(columnLabel: string, x: Integer): void; - updateLong(columnIndex: Integer, x: Integer): void; - updateLong(columnLabel: string, x: Integer): void; - updateNClob(columnIndex: Integer, x: JdbcClob): void; - updateNClob(columnLabel: string, x: JdbcClob): void; - updateNString(columnIndex: Integer, x: string): void; - updateNString(columnLabel: string, x: string): void; - updateNull(columnIndex: Integer): void; - updateNull(columnLabel: string): void; - updateObject(columnIndex: Integer, x: any): void; - updateObject(columnIndex: Integer, x: any, scaleOrLength: Integer): void; - updateObject(columnLabel: string, x: any): void; - updateObject(columnLabel: string, x: any, scaleOrLength: Integer): void; - updateRef(columnIndex: Integer, x: JdbcRef): void; - updateRef(columnLabel: string, x: JdbcRef): void; - updateRow(): void; - updateRowId(columnIndex: Integer, x: JdbcRowId): void; - updateRowId(columnLabel: string, x: JdbcRowId): void; - updateSQLXML(columnIndex: Integer, x: JdbcSQLXML): void; - updateSQLXML(columnLabel: string, x: JdbcSQLXML): void; - updateShort(columnIndex: Integer, x: Integer): void; - updateShort(columnLabel: string, x: Integer): void; - updateString(columnIndex: Integer, x: string): void; - updateString(columnLabel: string, x: string): void; - updateTime(columnIndex: Integer, x: JdbcTime): void; - updateTime(columnLabel: string, x: JdbcTime): void; - updateTimestamp(columnIndex: Integer, x: JdbcTimestamp): void; - updateTimestamp(columnLabel: string, x: JdbcTimestamp): void; - wasNull(): boolean; - } - /** - * A JDBC ResultSetMetaData. For documentation of this class, see - * java.sql.ResultSetMetaData. - */ - interface JdbcResultSetMetaData { - getCatalogName(column: Integer): string; - getColumnClassName(column: Integer): string; - getColumnCount(): Integer; - getColumnDisplaySize(column: Integer): Integer; - getColumnLabel(column: Integer): string; - getColumnName(column: Integer): string; - getColumnType(column: Integer): Integer; - getColumnTypeName(column: Integer): string; - getPrecision(column: Integer): Integer; - getScale(column: Integer): Integer; - getSchemaName(column: Integer): string; - getTableName(column: Integer): string; - isAutoIncrement(column: Integer): boolean; - isCaseSensitive(column: Integer): boolean; - isCurrency(column: Integer): boolean; - isDefinitelyWritable(column: Integer): boolean; - isNullable(column: Integer): Integer; - isReadOnly(column: Integer): boolean; - isSearchable(column: Integer): boolean; - isSigned(column: Integer): boolean; - isWritable(column: Integer): boolean; - } - /** - * A JDBC RowId. For documentation of this class, see java.sql.RowId - * . - */ - interface JdbcRowId { - getBytes(): Byte[]; - } - /** - * A JDBC SQLXML. For documentation of this class, see java.sql.SQLXML - * . - */ - interface JdbcSQLXML { - free(): void; - getString(): string; - setString(value: string): void; - } - /** - * A JDBC Savepoint. For documentation of this class, see java.sql.Savepoint - * . - */ - interface JdbcSavepoint { - getSavepointId(): Integer; - getSavepointName(): string; - } - /** - * A JDBC Statement. For documentation of this class, see java.sql.Statement - * . - */ - interface JdbcStatement { - addBatch(sql: string): void; - cancel(): void; - clearBatch(): void; - clearWarnings(): void; - close(): void; - execute(sql: string): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): boolean; - execute(sql: string, columnNames: string[]): boolean; - executeBatch(): Integer[]; - executeQuery(sql: string): JdbcResultSet; - executeUpdate(sql: string): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, autoGeneratedKeys: Integer, sql_: string, columnIndexes: Integer[]): Integer; - executeUpdate(sql: string, columnNames: string[]): Integer; - getConnection(): JdbcConnection; - getFetchDirection(): Integer; - getFetchSize(): Integer; - getGeneratedKeys(): JdbcResultSet; - getMaxFieldSize(): Integer; - getMaxRows(): Integer; - getMoreResults(): boolean; - getMoreResults(current: Integer): boolean; - getQueryTimeout(): Integer; - getResultSet(): JdbcResultSet; - getResultSetConcurrency(): Integer; - getResultSetHoldability(): Integer; - getResultSetType(): Integer; - getUpdateCount(): Integer; - getWarnings(): string[]; - isClosed(): boolean; - isPoolable(): boolean; - setCursorName(name: string): void; - setEscapeProcessing(enable: boolean): void; - setFetchDirection(direction: Integer): void; - setFetchSize(rows: Integer): void; - setMaxFieldSize(max: Integer): void; - setMaxRows(max: Integer): void; - setPoolable(poolable: boolean): void; - setQueryTimeout(seconds: Integer): void; - } - /** - * A JDBC Struct. For documentation of this class, see java.sql.Struct - * . - */ - interface JdbcStruct { - getAttributes(): any[]; - getSQLTypeName(): string; - } - /** - * A JDBC Time. For documentation of this class, see java.sql.Time - * . - */ - interface JdbcTime { - after(when: JdbcTime): boolean; - before(when: JdbcTime): boolean; - getHours(): Integer; - getMinutes(): Integer; - getSeconds(): Integer; - getTime(): Integer; - setHours(hours: Integer): void; - setMinutes(minutes: Integer): void; - setSeconds(seconds: Integer): void; - setTime(milliseconds: Integer): void; - } - /** - * A JDBC Timestamp. For documentation of this class, see java.sql.Timestamp - * . - */ - interface JdbcTimestamp { - after(when: JdbcTimestamp): boolean; - before(when: JdbcTimestamp): boolean; - getDate(): Integer; - getHours(): Integer; - getMinutes(): Integer; - getMonth(): Integer; - getNanos(): Integer; - getSeconds(): Integer; - getTime(): Integer; - getYear(): Integer; - setDate(date: Integer): void; - setHours(hours: Integer): void; - setMinutes(minutes: Integer): void; - setMonth(month: Integer): void; - setNanos(nanoseconds: Integer): void; - setSeconds(seconds: Integer): void; - setTime(milliseconds: Integer): void; - setYear(year: Integer): void; - } - } -} - -declare var Jdbc: GoogleAppsScript.JDBC.Jdbc; diff --git a/node_modules/@types/google-apps-script/google-apps-script.language.d.ts b/node_modules/@types/google-apps-script/google-apps-script.language.d.ts deleted file mode 100644 index 226612b..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.language.d.ts +++ /dev/null @@ -1,28 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Language { - interface LanguageAdvancedParameters { - /** the content type of the text; supported values are 'text' (default) and 'html' */ - contentType?: "html" | "text" | undefined; - } - /** - * The Language service provides scripts a way to compute automatic translations of text. - * - * // The code below will write "Esta es una prueba" to the log. - * var spanish = LanguageApp.translate('This is a test', 'en', 'es'); - * Logger.log(spanish); - */ - interface LanguageApp { - translate(text: string, sourceLanguage: string, targetLanguage: string): string; - translate( - text: string, - sourceLanguage: string, - targetLanguage: string, - advancedArgs: LanguageAdvancedParameters, - ): string; - } - } -} - -declare var LanguageApp: GoogleAppsScript.Language.LanguageApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.lock.d.ts b/node_modules/@types/google-apps-script/google-apps-script.lock.d.ts deleted file mode 100644 index 0a11160..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.lock.d.ts +++ /dev/null @@ -1,53 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Lock { - /** - * A representation of a mutual-exclusion lock. - * - * This class allows scripts to make sure that only one instance of the script is executing a - * given section of code at a time. This is particularly useful for callbacks and triggers, where a - * user action may cause changes to a shared resource and you want to ensure that aren't collisions. - * - * The following examples shows how to use a lock in a form submit handler. - * - * // Generates a unique ticket number for every form submission. - * function onFormSubmit(e) { - * var targetCell = e.range.offset(0, e.range.getNumColumns(), 1, 1); - * - * // Get a script lock, because we're about to modify a shared resource. - * var lock = LockService.getScriptLock(); - * // Wait for up to 30 seconds for other processes to finish. - * lock.waitLock(30000); - * - * var ticketNumber = Number(ScriptProperties.getProperty('lastTicketNumber')) + 1; - * ScriptProperties.setProperty('lastTicketNumber', ticketNumber); - * - * // Release the lock so that other processes can continue. - * lock.releaseLock(); - * - * targetCell.setValue(ticketNumber); - * } - * - * lastTicketNumber - * ScriptProperties - */ - interface Lock { - hasLock(): boolean; - releaseLock(): void; - tryLock(timeoutInMillis: Integer): boolean; - waitLock(timeoutInMillis: Integer): void; - } - /** - * Prevents concurrent access to sections of code. This can be useful when you have multiple users - * or processes modifying a shared resource and want to prevent collisions. - */ - interface LockService { - getDocumentLock(): Lock; - getScriptLock(): Lock; - getUserLock(): Lock; - } - } -} - -declare var LockService: GoogleAppsScript.Lock.LockService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.mail.d.ts b/node_modules/@types/google-apps-script/google-apps-script.mail.d.ts deleted file mode 100644 index 6679b0c..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.mail.d.ts +++ /dev/null @@ -1,49 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Mail { - interface MailAdvancedParameters { - /** an array of files to send with the email */ - attachments?: Base.BlobSource[] | undefined; - /** a comma-separated list of email addresses to BCC */ - bcc?: string | undefined; - /** the body of the email */ - body?: string | undefined; - /** a comma-separated list of email addresses to CC */ - cc?: string | undefined; - /** if set, devices capable of rendering HTML will use it instead of the required body argument; you can add an optional inlineImages field in HTML body if you have inlined images for your email */ - htmlBody?: string | undefined; - /** a JavaScript object containing a mapping from image key (String) to image data (BlobSource); this assumes that the htmlBody parameter is used and contains references to these images in the format */ - inlineImages?: { [imageKey: string]: Base.BlobSource } | undefined; - /** the name of the sender of the email (default: the user's name) */ - name?: string | undefined; - /** true if the email should be sent from a generic no-reply email address to discourage recipients from responding to emails; this option is only possible for G Suite accounts, not Gmail users */ - noReply?: boolean | undefined; - /** an email address to use as the default reply-to address (default: the user's email address) */ - replyTo?: string | undefined; - /** the subject of the email */ - subject?: string | undefined; - /** the address of the recipient */ - to?: string | undefined; - } - /** - * Sends email. - * - * This service allows users to send emails with complete control over the content of the email. - * Unlike GmailApp, MailApp's sole purpose is sending email. MailApp cannot access a user's Gmail - * inbox. - * - * Changes to scripts written using GmailApp are more likely to trigger a re-authorization - * request from a user than MailApp scripts. - */ - interface MailApp { - getRemainingDailyQuota(): Integer; - sendEmail(message: MailAdvancedParameters): void; - sendEmail(recipient: string, subject: string, body: string): void; - sendEmail(recipient: string, subject: string, body: string, options: MailAdvancedParameters): void; - sendEmail(to: string, replyTo: string, subject: string, body: string): void; - } - } -} - -declare var MailApp: GoogleAppsScript.Mail.MailApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.maps.d.ts b/node_modules/@types/google-apps-script/google-apps-script.maps.d.ts deleted file mode 100644 index 3ab19e1..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.maps.d.ts +++ /dev/null @@ -1,332 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Maps { - /** - * An enum representing the types of restrictions to avoid when finding directions. - */ - enum Avoid { - TOLLS, - HIGHWAYS, - } - /** - * An enum representing the named colors available to use in map images. - */ - enum Color { - BLACK, - BROWN, - GREEN, - PURPLE, - YELLOW, - BLUE, - GRAY, - ORANGE, - RED, - WHITE, - } - /** - * Allows for the retrieval of directions between locations. - * The example below shows how you can use this class to get the directions from Times Square to - * Central Park, stopping first at Lincoln Center, plot the locations and path on a map, and send - * the map in an email. - * - * // Get the directions. - * var directions = Maps.newDirectionFinder() - * .setOrigin('Times Square, New York, NY') - * .addWaypoint('Lincoln Center, New York, NY') - * .setDestination('Central Park, New York, NY') - * .setMode(Maps.DirectionFinder.Mode.DRIVING) - * .getDirections(); - * var route = directions.routes[0]; - * - * // Set up marker styles. - * var markerSize = Maps.StaticMap.MarkerSize.MID; - * var markerColor = Maps.StaticMap.Color.GREEN - * var markerLetterCode = 'A'.charCodeAt(); - * - * // Add markers to the map. - * var map = Maps.newStaticMap(); - * for (var i = 0; i < route.legs.length; i++) { - * var leg = route.legs[i]; - * if (i == 0) { - * // Add a marker for the start location of the first leg only. - * map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode)); - * map.addMarker(leg.start_location.lat, leg.start_location.lng); - * markerLetterCode++; - * } - * map.setMarkerStyle(markerSize, markerColor, String.fromCharCode(markerLetterCode)); - * map.addMarker(leg.end_location.lat, leg.end_location.lng); - * markerLetterCode++; - * } - * - * // Add a path for the entire route. - * map.addPath(route.overview_polyline.points); - * - * // Send the map in an email. - * var toAddress = Session.getActiveUser().getEmail(); - * MailApp.sendEmail( - * toAddress, - * 'Directions', - * 'Please open: ' + map.getMapUrl() + '&key=YOUR_API_KEY', { - * htmlBody: 'See below.
', - * inlineImages: { - * mapImage: Utilities.newBlob(map.getMapImage(), 'image/png') - * } - * } - * ); - * - * See also - * - * Google Directions API - */ - interface DirectionFinder { - addWaypoint(latitude: number, longitude: number): DirectionFinder; - addWaypoint(address: string): DirectionFinder; - clearWaypoints(): DirectionFinder; - getDirections(): any; - setAlternatives(useAlternatives: boolean): DirectionFinder; - setArrive(time: Base.Date): DirectionFinder; - setAvoid(avoid: string): DirectionFinder; - setDepart(time: Base.Date): DirectionFinder; - setDestination(latitude: number, longitude: number): DirectionFinder; - setDestination(address: string): DirectionFinder; - setLanguage(language: string): DirectionFinder; - setMode(mode: Mode): DirectionFinder; - setOptimizeWaypoints(optimizeOrder: boolean): DirectionFinder; - setOrigin(latitude: number, longitude: number): DirectionFinder; - setOrigin(address: string): DirectionFinder; - setRegion(region: string): DirectionFinder; - } - /** - * A collection of enums used by DirectionFinder. - */ - interface DirectionFinderEnums { - Avoid: typeof Avoid; - Mode: typeof Mode; - } - /** - * Allows for the sampling of elevations at particular locations. - * The example below shows how you can use this class to determine the highest point along the route - * from Denver to Grand Junction in Colorado, plot it on a map, and save the map to Google Drive. - * - * // Get directions from Denver to Grand Junction. - * var directions = Maps.newDirectionFinder() - * .setOrigin('Denver, CO') - * .setDestination('Grand Junction, CO') - * .setMode(Maps.DirectionFinder.Mode.DRIVING) - * .getDirections(); - * var route = directions.routes[0]; - * - * // Get elevation samples along the route. - * var numberOfSamples = 30; - * var response = Maps.newElevationSampler() - * .samplePath(route.overview_polyline.points, numberOfSamples) - * - * // Determine highest point. - * var maxElevation = Number.MIN_VALUE; - * var highestPoint = null; - * for (var i = 0; i < response.results.length; i++) { - * var sample = response.results[i]; - * if (sample.elevation > maxElevation) { - * maxElevation = sample.elevation; - * highestPoint = sample.location; - * } - * } - * - * // Add the path and marker to a map. - * var map = Maps.newStaticMap() - * .addPath(route.overview_polyline.points) - * .addMarker(highestPoint.lat, highestPoint.lng); - * - * // Save the map to your drive - * DocsList.createFile(Utilities.newBlob(map.getMapImage(), 'image/png', 'map.png')); - * - * See also - * - * Google Elevation API - */ - interface ElevationSampler { - sampleLocation(latitude: number, longitude: number): any; - sampleLocations(points: number[]): any; - sampleLocations(encodedPolyline: string): any; - samplePath(points: number[], numSamples: Integer): any; - samplePath(encodedPolyline: string, numSamples: Integer): any; - } - /** - * An enum representing the format of the map image. - * See also - * - * Google Static Maps API - */ - enum Format { - PNG, - PNG8, - PNG32, - GIF, - JPG, - JPG_BASELINE, - } - /** - * Allows for the conversion between an address and geographical coordinates. - * The example below shows how you can use this class find the top nine matches for the location - * "Main St" in Colorado, add them to a map, and then embed it in a new Google Doc. - * - * // Find the best matches for "Main St" in Colorado. - * var response = Maps.newGeocoder() - * // The latitudes and longitudes of southwest and northeast corners of Colorado, respectively. - * .setBounds(36.998166, -109.045486, 41.001666,-102.052002) - * .geocode('Main St'); - * - * // Create a Google Doc and map. - * var doc = DocumentApp.create('My Map'); - * var map = Maps.newStaticMap(); - * - * // Add each result to the map and doc. - * for (var i = 0; i < response.results.length && i < 9; i++) { - * var result = response.results[i]; - * map.setMarkerStyle(null, null, i + 1); - * map.addMarker(result.geometry.location.lat, result.geometry.location.lng); - * doc.appendListItem(result.formatted_address); - * } - * - * // Add the finished map to the doc. - * doc.appendImage(Utilities.newBlob(map.getMapImage(), 'image/png')); - * - * See also - * - * Google Geocoding API - */ - interface Geocoder { - geocode(address: string): any; - reverseGeocode(latitude: number, longitude: number): any; - reverseGeocode(swLatitude: number, swLongitude: number, neLatitude: number, neLongitude: number): any; - setBounds(swLatitude: number, swLongitude: number, neLatitude: number, neLongitude: number): Geocoder; - setLanguage(language: string): Geocoder; - setRegion(region: string): Geocoder; - } - /** - * Allows for direction finding, geocoding, elevation sampling and the creation of static map - * images. - */ - interface Maps { - DirectionFinder: DirectionFinderEnums; - StaticMap: StaticMapEnums; - decodePolyline(polyline: string): number[]; - encodePolyline(points: number[]): string; - newDirectionFinder(): DirectionFinder; - newElevationSampler(): ElevationSampler; - newGeocoder(): Geocoder; - newStaticMap(): StaticMap; - setAuthentication(clientId: string, signingKey: string): void; - } - /** - * An enum representing the size of a marker added to a map. - * See also - * - * Google Static Maps API - */ - enum MarkerSize { - TINY, - MID, - SMALL, - } - /** - * An enum representing the mode of travel to use when finding directions. - */ - enum Mode { - DRIVING, - WALKING, - BICYCLING, - TRANSIT, - } - /** - * Allows for the creation and decoration of static map images. - * - * The example below shows how you can use this class to create a map of New York City's Theatre - * District, including nearby train stations, and display it in a simple web app. - * - * // Create a map centered on Times Square. - * var map = Maps.newStaticMap() - * .setSize(600, 600) - * .setCenter('Times Square, New York, NY'); - * - * // Add markers for the nearbye train stations. - * map.setMarkerStyle(Maps.StaticMap.MarkerSize.MID, Maps.StaticMap.Color.RED, 'T'); - * map.addMarker('Grand Central Station, New York, NY'); - * map.addMarker('Penn Station, New York, NY'); - * - * // Show the boundaries of the Theatre District. - * var corners = [ - * '8th Ave & 53rd St, New York, NY', - * '6th Ave & 53rd St, New York, NY', - * '6th Ave & 40th St, New York, NY', - * '8th Ave & 40th St, New York, NY' - * ]; - * map.setPathStyle(4, Maps.StaticMap.Color.BLACK, Maps.StaticMap.Color.BLUE); - * map.beginPath(); - * for (var i = 0; i < corners.length; i++) { - * map.addAddress(corners[i]); - * } - * // All static map URLs require an API key. - * var url = map.getMapUrl() + "&key=YOUR_API_KEY"; - * - * See also - * - * Google Static Maps API - */ - interface StaticMap { - addAddress(address: string): StaticMap; - addMarker(latitude: number, longitude: number): StaticMap; - addMarker(address: string): StaticMap; - addPath(points: number[]): StaticMap; - addPath(polyline: string): StaticMap; - addPoint(latitude: number, longitude: number): StaticMap; - addVisible(latitude: number, longitude: number): StaticMap; - addVisible(address: string): StaticMap; - beginPath(): StaticMap; - clearMarkers(): StaticMap; - clearPaths(): StaticMap; - clearVisibles(): StaticMap; - endPath(): StaticMap; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getMapImage(): Byte[]; - getMapUrl(): string; - setCenter(latitude: number, longitude: number): StaticMap; - setCenter(address: string): StaticMap; - setCustomMarkerStyle(imageUrl: string, useShadow: boolean): StaticMap; - setFormat(format: string): StaticMap; - setLanguage(language: string): StaticMap; - setMapType(mapType: string): StaticMap; - setMarkerStyle(size: string, color: string, label: string): StaticMap; - setMobile(useMobileTiles: boolean): StaticMap; - setPathStyle(weight: Integer, color: string, fillColor: string): StaticMap; - setSize(width: Integer, height: Integer): StaticMap; - setZoom(zoom: Integer): StaticMap; - } - /** - * A collection of enums used by StaticMap. - */ - interface StaticMapEnums { - Color: typeof Color; - Format: typeof Format; - MarkerSize: typeof MarkerSize; - Type: typeof Type; - } - /** - * An enum representing the type of map to render. - * See also - * - * Google Static Maps API - */ - enum Type { - ROADMAP, - SATELLITE, - TERRAIN, - HYBRID, - } - } -} - -declare var Maps: GoogleAppsScript.Maps.Maps; diff --git a/node_modules/@types/google-apps-script/google-apps-script.optimization.d.ts b/node_modules/@types/google-apps-script/google-apps-script.optimization.d.ts deleted file mode 100644 index 2e1a9e5..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.optimization.d.ts +++ /dev/null @@ -1,253 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Optimization { - /** - * Object storing a linear constraint of the form lowerBound ≤ Sum(a(i) x(i)) ≤ upperBound - * where lowerBound and upperBound are constants, a(i) are constant - * coefficients and x(i) are variables (unknowns). - * - * The example below creates one variable x with values between 0 and 5 - * and creates the constraint 0 ≤ 2 * x ≤ 5. This is done by first creating a constraint - * with the lower bound 5 and upper bound 5. Then the coefficient for variable - * x in this constraint is set to 2. - * - * var engine = LinearOptimizationService.createEngine(); - * // Create a variable so we can add it to the constraint - * engine.addVariable('x', 0, 5); - * // Create a linear constraint with the bounds 0 and 10 - * var constraint = engine.addConstraint(0, 10); - * // Set the coefficient of the variable in the constraint. The constraint is now: - * // 0 <= 2 * x <= 5 - * constraint.setCoefficient('x', 2); - */ - interface LinearOptimizationConstraint { - setCoefficient(variableName: string, coefficient: number): LinearOptimizationConstraint; - } - /** - * The engine used to model and solve a linear program. The example below solves the following - * linear program: - * - * Two variables, x and y: - * - * 0 ≤ x ≤ 10 - * - * 0 ≤ y ≤ 5 - * - * Constraints: - * - * 0 ≤ 2 * x + 5 * y ≤ 10 - * - * 0 ≤ 10 * x + 3 * y ≤ 20 - * - * Objective: - * Maximize x + y - * - * var engine = LinearOptimizationService.createEngine(); - * - * // Add variables, constraints and define the objective with addVariable(), addConstraint(), etc - * // Add two variables, 0 <= x <= 10 and 0 <= y <= 5 - * engine.addVariable('x', 0, 10); - * engine.addVariable('y', 0, 5); - * - * // Create the constraint: 0 <= 2 * x + 5 * y <= 10 - * var constraint = engine.addConstraint(0, 10); - * constraint.setCoefficient('x', 2); - * constraint.setCoefficient('y', 5); - * - * // Create the constraint: 0 <= 10 * x + 3 * y <= 20 - * var constraint = engine.addConstraint(0, 20); - * constraint.setCoefficient('x', 10); - * constraint.setCoefficient('y', 3); - * - * // Set the objective to be x + y - * engine.setObjectiveCoefficient('x', 1); - * engine.setObjectiveCoefficient('y', 1); - * - * // Engine should maximize the objective - * engine.setMaximization(); - * - * // Solve the linear program - * var solution = engine.solve(); - * if (!solution.isValid()) { - * Logger.log('No solution ' + solution.getStatus()); - * } else { - * Logger.log('Value of x: ' + solution.getVariableValue('x')); - * Logger.log('Value of y: ' + solution.getVariableValue('y')); - * } - */ - interface LinearOptimizationEngine { - addConstraint(lowerBound: number, upperBound: number): LinearOptimizationConstraint; - addConstraints( - lowerBounds: number[], - upperBounds: number[], - variableNames: string[][], - coefficients: number[][], - ): LinearOptimizationEngine; - addVariable(name: string, lowerBound: number, upperBound: number): LinearOptimizationEngine; - addVariable( - name: string, - lowerBound: number, - upperBound: number, - type: VariableType, - ): LinearOptimizationEngine; - addVariable( - name: string, - lowerBound: number, - upperBound: number, - type: VariableType, - objectiveCoefficient: number, - ): LinearOptimizationEngine; - addVariables( - names: string[], - lowerBounds: number[], - upperBounds: number[], - types: VariableType[], - objectiveCoefficients: number[], - ): LinearOptimizationEngine; - setMaximization(): LinearOptimizationEngine; - setMinimization(): LinearOptimizationEngine; - setObjectiveCoefficient(variableName: string, coefficient: number): LinearOptimizationEngine; - solve(): LinearOptimizationSolution; - solve(seconds: number): LinearOptimizationSolution; - } - /** - * The linear optimization service, used to model and solve linear and mixed-integer linear - * programs. The example below solves the following linear program: - * - * Two variables, x and y: - * - * 0 ≤ x ≤ 10 - * - * 0 ≤ y ≤ 5 - * - * Constraints: - * - * 0 ≤ 2 * x + 5 * y ≤ 10 - * - * 0 ≤ 10 * x + 3 * y ≤ 20 - * - * Objective: - * Maximize x + y - * - * var engine = LinearOptimizationService.createEngine(); - * - * // Add variables, constraints and define the objective using addVariable(), addConstraint(), etc. - * // Add two variables, 0 <= x <= 10 and 0 <= y <= 5 - * engine.addVariable('x', 0, 10); - * engine.addVariable('y', 0, 5); - * - * // Create the constraint: 0 <= 2 * x + 5 * y <= 10 - * var constraint = engine.addConstraint(0, 10); - * constraint.setCoefficient('x', 2); - * constraint.setCoefficient('y', 5); - * - * // Create the constraint: 0 <= 10 * x + 3 * y <= 20 - * var constraint = engine.addConstraint(0, 20); - * constraint.setCoefficient('x', 10); - * constraint.setCoefficient('y', 3); - * - * // Set the objective to be x + y - * engine.setObjectiveCoefficient('x', 1); - * engine.setObjectiveCoefficient('y', 1); - * - * // Engine should maximize the objective. - * engine.setMaximization(); - * - * // Solve the linear program - * var solution = engine.solve(); - * if (!solution.isValid()) { - * Logger.log('No solution ' + solution.getStatus()); - * } else { - * Logger.log('Value of x: ' + solution.getVariableValue('x')); - * Logger.log('Value of y: ' + solution.getVariableValue('y')); - * } - */ - interface LinearOptimizationService { - Status: typeof Status; - VariableType: typeof VariableType; - createEngine(): LinearOptimizationEngine; - } - /** - * The solution of a linear program. The example below solves the following linear program: - * - * Two variables, x and y: - * - * 0 ≤ x ≤ 10 - * - * 0 ≤ y ≤ 5 - * - * Constraints: - * - * 0 ≤ 2 * x + 5 * y ≤ 10 - * - * 0 ≤ 10 * x + 3 * y ≤ 20 - * - * Objective: - * Maximize x + y - * - * var engine = LinearOptimizationService.createEngine(); - * - * // Add variables, constraints and define the objective with addVariable(), addConstraint(), etc. - * // Add two variables, 0 <= x <= 10 and 0 <= y <= 5 - * engine.addVariable('x', 0, 10); - * engine.addVariable('y', 0, 5); - * - * // Create the constraint: 0 <= 2 * x + 5 * y <= 10 - * var constraint = engine.addConstraint(0, 10); - * constraint.setCoefficient('x', 2); - * constraint.setCoefficient('y', 5); - * - * // Create the constraint: 0 <= 10 * x + 3 * y <= 20 - * var constraint = engine.addConstraint(0, 20); - * constraint.setCoefficient('x', 10); - * constraint.setCoefficient('y', 3); - * - * // Set the objective to be x + y - * engine.setObjectiveCoefficient('x', 1); - * engine.setObjectiveCoefficient('y', 1); - * - * // Engine should maximize the objective - * engine.setMaximization(); - * - * // Solve the linear program - * var solution = engine.solve(); - * if (!solution.isValid()) { - * Logger.log('No solution ' + solution.getStatus()); - * } else { - * Logger.log('Objective value: ' + solution.getObjectiveValue()); - * Logger.log('Value of x: ' + solution.getVariableValue('x')); - * Logger.log('Value of y: ' + solution.getVariableValue('y')); - * } - */ - interface LinearOptimizationSolution { - getObjectiveValue(): number; - getStatus(): Status; - getVariableValue(variableName: string): number; - isValid(): boolean; - } - /** - * Status of the solution. Before solving a problem the status will be NOT_SOLVED; - * afterwards it will take any of the other values depending if it successfully found a solution and - * if the solution is optimal. - */ - enum Status { - OPTIMAL, - FEASIBLE, - INFEASIBLE, - UNBOUNDED, - ABNORMAL, - MODEL_INVALID, - NOT_SOLVED, - } - /** - * Type of variables created by the engine. - */ - enum VariableType { - INTEGER, - CONTINUOUS, - } - } -} - -declare var LinearOptimizationService: GoogleAppsScript.Optimization.LinearOptimizationService; diff --git a/node_modules/@types/google-apps-script/google-apps-script.properties.d.ts b/node_modules/@types/google-apps-script/google-apps-script.properties.d.ts deleted file mode 100644 index 1c628b2..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.properties.d.ts +++ /dev/null @@ -1,82 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace Properties { - /** - * The properties object acts as the interface to access user, document, or script properties. The - * specific property type depends on which of the three methods of PropertiesService the - * script called: PropertiesService.getDocumentProperties(), PropertiesService.getUserProperties(), or PropertiesService.getScriptProperties(). - * Properties cannot be shared between scripts. For more information about property types, see the - * guide to the Properties service. - */ - interface Properties { - deleteAllProperties(): Properties; - deleteProperty(key: string): Properties; - getKeys(): string[]; - getProperties(): { [key: string]: string }; - getProperty(key: string): string | null; - setProperties(properties: { [key: string]: string }): Properties; - setProperties(properties: { [key: string]: string }, deleteAllOthers: boolean): Properties; - setProperty(key: string, value: string): Properties; - } - /** - * Allows scripts to store simple data in key-value pairs scoped to one script, one user of a - * script, or one document in which an add-on is used. Properties cannot be shared between scripts. - * For more information about when to use each type of property, see the guide to the Properties service. - * - * // Sets three properties of different types. - * var documentProperties = PropertiesService.getDocumentProperties(); - * var scriptProperties = PropertiesService.getScriptProperties(); - * var userProperties = PropertiesService.getUserProperties(); - * - * documentProperties.setProperty('DAYS_TO_FETCH', '5'); - * scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/'); - * userProperties.setProperty('DISPLAY_UNITS', 'metric'); - */ - interface PropertiesService { - getDocumentProperties(): Properties; - getScriptProperties(): Properties; - getUserProperties(): Properties; - } - /** - * Deprecated. This class is deprecated and should not be used in new scripts. - * Script Properties are key-value pairs stored by a script in a persistent store. Script Properties - * are scoped per script, regardless of which user runs the script. - */ - interface ScriptProperties { - /** @deprecated DO NOT USE */ deleteAllProperties(): ScriptProperties; - /** @deprecated DO NOT USE */ deleteProperty(key: string): ScriptProperties; - /** @deprecated DO NOT USE */ getKeys(): string[]; - /** @deprecated DO NOT USE */ getProperties(): { [key: string]: string }; - /** @deprecated DO NOT USE */ getProperty(key: string): string | null; - /** @deprecated DO NOT USE */ setProperties(properties: { [key: string]: string }): ScriptProperties; - /** @deprecated DO NOT USE */ setProperties( - properties: { [key: string]: string }, - deleteAllOthers: boolean, - ): ScriptProperties; - /** @deprecated DO NOT USE */ setProperty(key: string, value: string): ScriptProperties; - } - /** - * Deprecated. This class is deprecated and should not be used in new scripts. - * User Properties are key-value pairs unique to a user. User Properties are scoped per user; any - * script running under the identity of a user can access User Properties for that user only. - */ - interface UserProperties { - /** @deprecated DO NOT USE */ deleteAllProperties(): UserProperties; - /** @deprecated DO NOT USE */ deleteProperty(key: string): UserProperties; - /** @deprecated DO NOT USE */ getKeys(): string[]; - /** @deprecated DO NOT USE */ getProperties(): { [key: string]: string }; - /** @deprecated DO NOT USE */ getProperty(key: string): string | null; - /** @deprecated DO NOT USE */ setProperties(properties: { [key: string]: string }): UserProperties; - /** @deprecated DO NOT USE */ setProperties( - properties: { [key: string]: string }, - deleteAllOthers: boolean, - ): UserProperties; - /** @deprecated DO NOT USE */ setProperty(key: string, value: string): UserProperties; - } - } -} - -declare var PropertiesService: GoogleAppsScript.Properties.PropertiesService; -declare var ScriptProperties: GoogleAppsScript.Properties.ScriptProperties; -declare var UserProperties: GoogleAppsScript.Properties.UserProperties; diff --git a/node_modules/@types/google-apps-script/google-apps-script.script.d.ts b/node_modules/@types/google-apps-script/google-apps-script.script.d.ts deleted file mode 100644 index 3a2db89..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.script.d.ts +++ /dev/null @@ -1,229 +0,0 @@ -/// -/// -/// -/// -/// - -declare namespace GoogleAppsScript { - namespace Script { - /** - * An enumeration that identifies which categories of authorized services Apps Script is able to - * execute through a triggered function. These values are exposed in triggered functions as the authMode - * property of the event parameter, e. For - * more information, see the guide to the - * authorization lifecycle for add-ons. - * - * function onOpen(e) { - * var menu = SpreadsheetApp.getUi().createAddonMenu(); - * if (e && e.authMode == ScriptApp.AuthMode.NONE) { - * // Add a normal menu item (works in all authorization modes). - * menu.addItem('Start workflow', 'startWorkflow'); - * } else { - * // Add a menu item based on properties (doesn't work in AuthMode.NONE). - * var properties = PropertiesService.getDocumentProperties(); - * var workflowStarted = properties.getProperty('workflowStarted'); - * if (workflowStarted) { - * menu.addItem('Check workflow status', 'checkWorkflow'); - * } else { - * menu.addItem('Start workflow', 'startWorkflow'); - * } - * // Record analytics. - * UrlFetchApp.fetch('http://www.example.com/analytics?event=open'); - * } - * menu.addToUi(); - * } - */ - enum AuthMode { - NONE, - CUSTOM_FUNCTION, - LIMITED, - FULL, - } - /** - * An object used to determine whether the user needs to authorize this script to use one or more - * services, and to provide the URL for an authorization dialog. If the script is published as an add-on that uses installable triggers, this information can be used - * to control access to sections of code for which the user lacks the necessary authorization. - * Alternately, the add-on can ask the user to open the URL for the authorization dialog to resolve - * the problem. - * - * This object is returned by ScriptApp.getAuthorizationInfo(authMode). In almost - * all cases, scripts should call ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL), - * since no other authorization mode requires that users grant authorization. - */ - interface AuthorizationInfo { - getAuthorizationStatus(): AuthorizationStatus; - getAuthorizationUrl(): string; - } - /** - * An enumeration denoting the authorization status of a script. - */ - enum AuthorizationStatus { - REQUIRED, - NOT_REQUIRED, - } - /** - * Builder for calendar triggers. - */ - interface CalendarTriggerBuilder { - create(): Trigger; - onEventUpdated(): CalendarTriggerBuilder; - } - /** - * A builder for clock triggers. - */ - interface ClockTriggerBuilder { - after(durationMilliseconds: Integer): ClockTriggerBuilder; - at(date: Base.Date): ClockTriggerBuilder; - atDate(year: Integer, month: Integer, day: Integer): ClockTriggerBuilder; - atHour(hour: Integer): ClockTriggerBuilder; - create(): Trigger; - everyDays(n: Integer): ClockTriggerBuilder; - everyHours(n: Integer): ClockTriggerBuilder; - everyMinutes(n: Integer): ClockTriggerBuilder; - everyWeeks(n: Integer): ClockTriggerBuilder; - inTimezone(timezone: string): ClockTriggerBuilder; - nearMinute(minute: Integer): ClockTriggerBuilder; - onMonthDay(day: Integer): ClockTriggerBuilder; - onWeekDay(day: Base.Weekday): ClockTriggerBuilder; - } - /** - * A builder for document triggers. - */ - interface DocumentTriggerBuilder { - create(): Trigger; - onOpen(): DocumentTriggerBuilder; - } - /** - * An enumeration denoting the type of triggered event. - */ - enum EventType { - CLOCK, - ON_OPEN, - ON_EDIT, - ON_FORM_SUBMIT, - ON_CHANGE, - ON_EVENT_UPDATED, - } - /** - * A builder for form triggers. - */ - interface FormTriggerBuilder { - create(): Trigger; - onFormSubmit(): FormTriggerBuilder; - onOpen(): FormTriggerBuilder; - } - /** - * An enumeration that indicates how the script came to be installed as an add-on for the current - * user. - */ - enum InstallationSource { - APPS_MARKETPLACE_DOMAIN_ADD_ON, - NONE, - WEB_STORE_ADD_ON, - } - /** - * Access and manipulate script publishing and triggers. This class allows users to create script - * triggers and control publishing the script as a service. - */ - interface ScriptApp { - AuthMode: typeof AuthMode; - AuthorizationStatus: typeof AuthorizationStatus; - EventType: typeof EventType; - InstallationSource: typeof InstallationSource; - TriggerSource: typeof TriggerSource; - WeekDay: typeof Base.Weekday; - deleteTrigger(trigger: Trigger): void; - getAuthorizationInfo(authMode: AuthMode): AuthorizationInfo; - getIdentityToken(): string; - getInstallationSource(): InstallationSource; - getOAuthToken(): string; - getProjectTriggers(): Trigger[]; - getScriptId(): string; - getService(): Service; - getUserTriggers(document: Document.Document): Trigger[]; - getUserTriggers(form: Forms.Form): Trigger[]; - getUserTriggers(spreadsheet: Spreadsheet.Spreadsheet): Trigger[]; - invalidateAuth(): void; - newStateToken(): StateTokenBuilder; - newTrigger(functionName: string): TriggerBuilder; - /** @deprecated DO NOT USE */ getProjectKey(): string; - /** @deprecated DO NOT USE */ getScriptTriggers(): Trigger[]; - } - /** - * Access and manipulate script publishing. - */ - interface Service { - getUrl(): string; - isEnabled(): boolean; - /** @deprecated DO NOT USE */ disable(): void; - } - /** - * Builder for spreadsheet triggers. - */ - interface SpreadsheetTriggerBuilder { - create(): Trigger; - onChange(): SpreadsheetTriggerBuilder; - onEdit(): SpreadsheetTriggerBuilder; - onFormSubmit(): SpreadsheetTriggerBuilder; - onOpen(): SpreadsheetTriggerBuilder; - } - /** - * Allows scripts to create state tokens that can be used in callback APIs (like OAuth flows). - * - * // Reusable function to generate a callback URL, assuming the script has been published as a - * // web app (necessary to obtain the URL programmatically). If the script has not been published - * // as a web app, set `var url` in the first line to the URL of your script project (which - * // cannot be obtained programmatically). - * function getCallbackURL(callbackFunction){ - * var url = ScriptApp.getService().getUrl(); // Ends in /exec (for a web app) - * url = url.slice(0, -4) + 'usercallback?state='; // Change /exec to /usercallback - * var stateToken = ScriptApp.newStateToken() - * .withMethod(callbackFunction) - * .withTimeout(120) - * .createToken(); - * return url + stateToken; - * } - */ - interface StateTokenBuilder { - createToken(): string; - withArgument(name: string, value: string): StateTokenBuilder; - withMethod(method: string): StateTokenBuilder; - withTimeout(seconds: Integer): StateTokenBuilder; - } - /** - * A script trigger. - */ - interface Trigger { - getEventType(): EventType; - getHandlerFunction(): string; - getTriggerSource(): TriggerSource; - getTriggerSourceId(): string; - getUniqueId(): string; - } - /** - * A generic builder for script triggers. - */ - interface TriggerBuilder { - forDocument(document: Document.Document): DocumentTriggerBuilder; - forDocument(key: string): DocumentTriggerBuilder; - forForm(form: Forms.Form): FormTriggerBuilder; - forForm(key: string): FormTriggerBuilder; - forSpreadsheet(sheet: Spreadsheet.Spreadsheet): SpreadsheetTriggerBuilder; - forSpreadsheet(key: string): SpreadsheetTriggerBuilder; - forUserCalendar(emailId: string): CalendarTriggerBuilder; - timeBased(): ClockTriggerBuilder; - } - /** - * An enumeration denoting the source of the event that causes the trigger to fire. - */ - enum TriggerSource { - SPREADSHEETS, - CLOCK, - FORMS, - DOCUMENTS, - CALENDAR, - } - } -} - -declare var ScriptApp: GoogleAppsScript.Script.ScriptApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.sites.d.ts b/node_modules/@types/google-apps-script/google-apps-script.sites.d.ts deleted file mode 100644 index 60ef890..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.sites.d.ts +++ /dev/null @@ -1,293 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Sites { - /** - * A Sites Attachment such as a file attached to a page. - * - * Note that an Attachment is a Blob and can be used anywhere Blob input is expected. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - * - * var filesPage = SitesApp.getSite('example.com', 'mysite').getChildByName("files"); - * var attachments = filesPage.getAttachments(); - * - * // DocsList.createFile accepts a blob input. Since an Attachment is just a blob, we can - * // just pass it directly to that method - * var file = DocsList.createFile(attachments[0]); - */ - interface Attachment { - deleteAttachment(): void; - getAs(contentType: string): Base.Blob; - getAttachmentType(): AttachmentType; - getBlob(): Base.Blob; - getContentType(): string; - getDatePublished(): Base.Date; - getDescription(): string; - getLastUpdated(): Base.Date; - getParent(): Page; - getTitle(): string; - getUrl(): string; - setContentType(contentType: string): Attachment; - setDescription(description: string): Attachment; - setFrom(blob: Base.BlobSource): Attachment; - setParent(parent: Page): Attachment; - setTitle(title: string): Attachment; - setUrl(url: string): Attachment; - } - /** - * A typesafe enum for sites attachment type. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - enum AttachmentType { - WEB, - HOSTED, - } - /** - * A Sites Column - a column from a Sites List page. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface Column { - deleteColumn(): void; - getName(): string; - getParent(): Page; - setName(name: string): Column; - } - /** - * A Comment attached to any Sites page. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface Comment { - deleteComment(): void; - getAuthorEmail(): string; - getAuthorName(): string; - getContent(): string; - getDatePublished(): Base.Date; - getLastUpdated(): Base.Date; - getParent(): Page; - setContent(content: string): Comment; - setParent(parent: Page): Comment; - } - /** - * A Sites ListItem - a list element from a Sites List page. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface ListItem { - deleteListItem(): void; - getDatePublished(): Base.Date; - getLastUpdated(): Base.Date; - getParent(): Page; - getValueByIndex(index: Integer): string; - getValueByName(name: string): string; - setParent(parent: Page): ListItem; - setValueByIndex(index: Integer, value: string): ListItem; - setValueByName(name: string, value: string): ListItem; - } - interface PageAdvancedParameters { - /** only get pages of this type */ - type?: PageType[] | undefined; - /** start the results here */ - start?: Integer | undefined; - /** the max number of results (default 200) */ - max?: Integer | undefined; - /** whether to include draft pages (default false) */ - includeDrafts?: boolean | undefined; - /** whether to include deleted pages (default false) */ - includeDeleted?: boolean | undefined; - /** only return pages matching this query */ - search?: string | undefined; - } - /** - * A Page on a Google Site. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface Page { - addColumn(name: string): Column; - addHostedAttachment(blob: Base.BlobSource): Attachment; - addHostedAttachment(blob: Base.BlobSource, description: string): Attachment; - addListItem(values: string[]): ListItem; - addWebAttachment(title: string, description: string, url: string): Attachment; - createAnnouncement(title: string, html: string): Page; - createAnnouncement(title: string, html: string, asDraft: boolean): Page; - createAnnouncementsPage(title: string, name: string, html: string): Page; - createFileCabinetPage(title: string, name: string, html: string): Page; - createListPage(title: string, name: string, html: string, columnNames: string[]): Page; - createPageFromTemplate(title: string, name: string, template: Page): Page; - createWebPage(title: string, name: string, html: string): Page; - deletePage(): void; - getAllDescendants(): Page[]; - getAllDescendants(options: PageAdvancedParameters): Page[]; - getAnnouncements(): Page[]; - getAnnouncements(optOptions: PageAdvancedParameters): Page[]; - getAttachments(): Attachment[]; - getAttachments(optOptions: { start?: Integer | undefined; max?: Integer | undefined }): Attachment[]; - getAuthors(): string[]; - getChildByName(name: string): Page; - getChildren(): Page[]; - getChildren(options: PageAdvancedParameters): Page[]; - getColumns(): Column[]; - getDatePublished(): Base.Date; - getHtmlContent(): string; - getIsDraft(): boolean; - getLastEdited(): Base.Date; - getLastUpdated(): Base.Date; - getListItems(): ListItem[]; - getListItems(optOptions: { start?: Integer | undefined; max?: Integer | undefined }): ListItem[]; - getName(): string; - getPageType(): PageType; - getParent(): Page; - getTextContent(): string; - getTitle(): string; - getUrl(): string; - isDeleted(): boolean; - isTemplate(): boolean; - publishAsTemplate(name: string): Page; - search(query: string): Page[]; - search(query: string, options: PageAdvancedParameters): Page[]; - setHtmlContent(html: string): Page; - setIsDraft(draft: boolean): Page; - setName(name: string): Page; - setParent(parent: Page): Page; - setTitle(title: string): Page; - /** @deprecated DO NOT USE */ addComment(content: string): Comment; - /** @deprecated DO NOT USE */ getComments(): Comment[]; - /** @deprecated DO NOT USE */ getComments( - optOptions: { start?: Integer | undefined; max?: Integer | undefined }, - ): Comment[]; - /** @deprecated DO NOT USE */ getPageName(): string; - /** @deprecated DO NOT USE */ getSelfLink(): string; - } - /** - * A typesafe enum for sites page type. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - enum PageType { - WEB_PAGE, - LIST_PAGE, - ANNOUNCEMENT, - ANNOUNCEMENTS_PAGE, - FILE_CABINET_PAGE, - } - /** - * An object representing a Google Site. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface Site { - addEditor(emailAddress: string): Site; - addEditor(user: Base.User): Site; - addEditors(emailAddresses: string[]): Site; - addOwner(email: string): Site; - addOwner(user: Base.User): Site; - addViewer(emailAddress: string): Site; - addViewer(user: Base.User): Site; - addViewers(emailAddresses: string[]): Site; - createAnnouncementsPage(title: string, name: string, html: string): Page; - createFileCabinetPage(title: string, name: string, html: string): Page; - createListPage(title: string, name: string, html: string, columnNames: string[]): Page; - createPageFromTemplate(title: string, name: string, template: Page): Page; - createWebPage(title: string, name: string, html: string): Page; - getAllDescendants(): Page[]; - getAllDescendants(options: PageAdvancedParameters): Page[]; - getChildByName(name: string): Page; - getChildren(): Page[]; - getChildren(options: PageAdvancedParameters): Page[]; - getEditors(): Base.User[]; - getName(): string; - getOwners(): Base.User[]; - getSummary(): string; - getTemplates(): Page[]; - getTheme(): string; - getTitle(): string; - getUrl(): string; - getViewers(): Base.User[]; - removeEditor(emailAddress: string): Site; - removeEditor(user: Base.User): Site; - removeOwner(email: string): Site; - removeOwner(user: Base.User): Site; - removeViewer(emailAddress: string): Site; - removeViewer(user: Base.User): Site; - search(query: string): Page[]; - search(query: string, options: PageAdvancedParameters): Page[]; - setSummary(summary: string): Site; - setTheme(theme: string): Site; - setTitle(title: string): Site; - /** @deprecated DO NOT USE */ addCollaborator(email: string): Site; - /** @deprecated DO NOT USE */ addCollaborator(user: Base.User): Site; - /** @deprecated DO NOT USE */ createAnnouncement(title: string, html: string, parent: Page): Page; - /** @deprecated DO NOT USE */ createComment(inReplyTo: string, html: string, parent: Page): Comment; - /** @deprecated DO NOT USE */ createListItem( - html: string, - columnNames: string[], - values: string[], - parent: Page, - ): ListItem; - /** @deprecated DO NOT USE */ createWebAttachment(title: string, url: string, parent: Page): Attachment; - /** @deprecated DO NOT USE */ deleteSite(): void; - /** @deprecated DO NOT USE */ getAnnouncements(): Page[]; - /** @deprecated DO NOT USE */ getAnnouncementsPages(): Page[]; - /** @deprecated DO NOT USE */ getAttachments(): Attachment[]; - /** @deprecated DO NOT USE */ getCollaborators(): Base.User[]; - /** @deprecated DO NOT USE */ getComments(): Comment[]; - /** @deprecated DO NOT USE */ getFileCabinetPages(): Page[]; - /** @deprecated DO NOT USE */ getListItems(): ListItem[]; - /** @deprecated DO NOT USE */ getListPages(): Page[]; - /** @deprecated DO NOT USE */ getSelfLink(): string; - /** @deprecated DO NOT USE */ getSiteName(): string; - /** @deprecated DO NOT USE */ getWebAttachments(): Attachment[]; - /** @deprecated DO NOT USE */ getWebPages(): Page[]; - /** @deprecated DO NOT USE */ removeCollaborator(email: string): Site; - /** @deprecated DO NOT USE */ removeCollaborator(user: Base.User): Site; - } - /** - * Create and access Google Sites. - * A rebuilt - * version of Sites was launched on November 22, 2016. Apps Script cannot currently access or - * modify Sites made with this version, but script can still access - * classic Sites. - */ - interface SitesApp { - AttachmentType: typeof AttachmentType; - PageType: typeof PageType; - copySite(domain: string, name: string, title: string, summary: string, site: Site): Site; - createSite(domain: string, name: string, title: string, summary: string): Site; - getActivePage(): Page; - getActiveSite(): Site; - getAllSites(domain: string): Site[]; - getAllSites(domain: string, start: Integer, max: Integer): Site[]; - getPageByUrl(url: string): Page; - getSite(name: string): Site; - getSite(domain: string, name: string): Site; - getSiteByUrl(url: string): Site; - getSites(): Site[]; - getSites(start: Integer, max: Integer): Site[]; - getSites(domain: string): Site[]; - getSites(domain: string, start: Integer, max: Integer): Site[]; - } - } -} - -declare var SitesApp: GoogleAppsScript.Sites.SitesApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.slides.d.ts b/node_modules/@types/google-apps-script/google-apps-script.slides.d.ts deleted file mode 100644 index e5ee7a3..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.slides.d.ts +++ /dev/null @@ -1,1901 +0,0 @@ -/// -/// -/// - -declare namespace GoogleAppsScript { - namespace Slides { - /** - * A 3x3 matrix used to transform source coordinates (x1, y1) into destination coordinates (x2, y2) - * according to matrix multiplication: - * - * [ x2 ] [ scaleX shearX translateX ] [ x1 ] - * [ y2 ] = [ shearY scaleY translateY ] [ y1 ] - * [ 1 ] [ 0 0 1 ] [ 1 ] - * - * After transformation, - * - * x2 = scaleX * x1 + shearX * y1 + translateX - * y2 = scaleY * y1 + shearY * x1 + translateY - */ - interface AffineTransform { - getScaleX(): number; - getScaleY(): number; - getShearX(): number; - getShearY(): number; - getTranslateX(): number; - getTranslateY(): number; - toBuilder(): AffineTransformBuilder; - } - /** - * A builder for AffineTransform objects. Defaults to the identity transform. - * - * Call AffineTransformBuilder#build() to get the AffineTransform object. - * - * var transform = - * SlidesApp.newAffineTransformBuilder().setScaleX(2.0).setShearY(1.1).build(); - * - * The resulting transform matrix is - * [ 2.0 0.0 0.0 ] - * [ 1.1 1.0 0.0 ] - * [ 0 0 1 ] - */ - interface AffineTransformBuilder { - build(): AffineTransform; - setScaleX(scaleX: number): AffineTransformBuilder; - setScaleY(scaleY: number): AffineTransformBuilder; - setShearX(shearX: number): AffineTransformBuilder; - setShearY(shearY: number): AffineTransformBuilder; - setTranslateX(translateX: number): AffineTransformBuilder; - setTranslateY(translateY: number): AffineTransformBuilder; - } - /** - * The alignment position to apply. - */ - enum AlignmentPosition { - CENTER, - HORIZONTAL_CENTER, - VERTICAL_CENTER, - } - /** - * The kinds of start and end forms with which linear geometry can be rendered. - * - * Some values are based on the "ST_LineEndType" simple type described in section 20.1.10.33 of - * of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th - * edition. - */ - enum ArrowStyle { - UNSUPPORTED, - NONE, - STEALTH_ARROW, - FILL_ARROW, - FILL_CIRCLE, - FILL_SQUARE, - FILL_DIAMOND, - OPEN_ARROW, - OPEN_CIRCLE, - OPEN_SQUARE, - OPEN_DIAMOND, - } - /** - * An element of text that is dynamically replaced with content that can change over time, such as a - * slide number. - */ - interface AutoText { - getAutoTextType(): AutoTextType; - getIndex(): Integer; - getRange(): TextRange; - } - /** - * The types of auto text. - */ - enum AutoTextType { - UNSUPPORTED, - SLIDE_NUMBER, - } - /** - * Describes the border around an element. - */ - interface Border { - getDashStyle(): DashStyle; - getLineFill(): LineFill; - getWeight(): number; - isVisible(): boolean; - setDashStyle(style: DashStyle): Border; - setTransparent(): Border; - setWeight(points: number): Border; - } - /** - * The table cell merge states. - */ - enum CellMergeState { - NORMAL, - HEAD, - MERGED, - } - /** - * An opaque color - */ - interface Color { - asRgbColor(): Base.RgbColor; - asThemeColor(): ThemeColor; - getColorType(): Base.ColorType; - } - /** - * A color scheme defines a mapping from members of ThemeColorType to the actual colors used - * to render them. - */ - interface ColorScheme { - getConcreteColor(theme: ThemeColorType): Color; - getThemeColors(): ThemeColorType[]; - setConcreteColor(type: ThemeColorType, color: Color): ColorScheme; - setConcreteColor(type: ThemeColorType, red: Integer, green: Integer, blue: Integer): ColorScheme; - setConcreteColor(type: ThemeColorType, hexColor: string): ColorScheme; - } - /** - * The connection site on a PageElement that can connect to a connector. - */ - interface ConnectionSite { - getIndex(): Integer; - getPageElement(): PageElement; - } - /** - * The content alignments for a Shape or TableCell. The supported alignments - * correspond to predefined text anchoring types from the ECMA-376 standard. - * - * More information on those alignments can be found in the description of - * the ST_TextAnchoringType simple type in section 20.1.10.59 of "Office Open XML File - * Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th - * edition. - */ - enum ContentAlignment { - UNSUPPORTED, - TOP, - MIDDLE, - BOTTOM, - } - /** - * The kinds of dashes with which linear geometry can be rendered. These values are based on the - * "ST_PresetLineDashVal" simple type described in section 20.1.10.48 of "Office Open XML File - * Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th - * edition. - */ - enum DashStyle { - UNSUPPORTED, - SOLID, - DOT, - DASH, - DASH_DOT, - LONG_DASH, - LONG_DASH_DOT, - } - /** - * Describes the page element's background - */ - interface Fill { - getSolidFill(): SolidFill; - getType(): FillType; - isVisible(): boolean; - setSolidFill(color: Color): void; - setSolidFill(color: Color, alpha: number): void; - setSolidFill(red: Integer, green: Integer, blue: Integer): void; - setSolidFill(red: Integer, green: Integer, blue: Integer, alpha: number): void; - setSolidFill(hexString: string): void; - setSolidFill(hexString: string, alpha: number): void; - setSolidFill(color: ThemeColorType): void; - setSolidFill(color: ThemeColorType, alpha: number): void; - setTransparent(): void; - } - /** - * The kinds of fill. - */ - enum FillType { - UNSUPPORTED, - NONE, - SOLID, - } - /** - * A collection of PageElements joined as a single unit. - */ - interface Group { - alignOnPage(alignmentPosition: AlignmentPosition): Group; - bringForward(): Group; - bringToFront(): Group; - duplicate(): PageElement; - getChildren(): PageElement[]; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): Group; - remove(): void; - scaleHeight(ratio: number): Group; - scaleWidth(ratio: number): Group; - select(): void; - select(replace: boolean): void; - sendBackward(): Group; - sendToBack(): Group; - setDescription(description: string): Group; - setHeight(height: number): Group; - setLeft(left: number): Group; - setRotation(angle: number): Group; - setTitle(title: string): Group; - setTop(top: number): Group; - setTransform(transform: AffineTransform): Group; - setWidth(width: number): Group; - ungroup(): void; - } - /** - * A PageElement representing an image. - */ - interface Image { - alignOnPage(alignmentPosition: AlignmentPosition): Image; - bringForward(): Image; - bringToFront(): Image; - duplicate(): PageElement; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getBorder(): Border; - getConnectionSites(): ConnectionSite[]; - getContentUrl(): string; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getLink(): Link; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getSourceUrl(): string; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): Image; - remove(): void; - removeLink(): void; - replace(blobSource: Base.BlobSource): Image; - replace(blobSource: Base.BlobSource, crop: boolean): Image; - replace(imageUrl: string): Image; - replace(imageUrl: string, crop: boolean): Image; - scaleHeight(ratio: number): Image; - scaleWidth(ratio: number): Image; - select(): void; - select(replace: boolean): void; - sendBackward(): Image; - sendToBack(): Image; - setDescription(description: string): Image; - setHeight(height: number): Image; - setLeft(left: number): Image; - setLinkSlide(slideIndex: Integer): Link; - setLinkSlide(slide: Slide): Link; - setLinkSlide(slidePosition: SlidePosition): Link; - setLinkUrl(url: string): Link; - setRotation(angle: number): Image; - setTitle(title: string): Image; - setTop(top: number): Image; - setTransform(transform: AffineTransform): Image; - setWidth(width: number): Image; - } - /** - * A layout in a presentation. - * - * Each layout serves as a template for slides that inherit from it, determining how content on - * those slides is arranged and styled. - */ - interface Layout { - getBackground(): PageBackground; - getColorScheme(): ColorScheme; - getGroups(): Group[]; - getImages(): Image[]; - getLayoutName(): string; - getLines(): Line[]; - getMaster(): Master; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPageType(): PageType; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - group(pageElements: PageElement[]): Group; - insertGroup(group: Group): Group; - insertImage(blobSource: Base.BlobSource): Image; - insertImage(blobSource: Base.BlobSource, left: number, top: number, width: number, height: number): Image; - insertImage(image: Image): Image; - insertImage(imageUrl: string): Image; - insertImage(imageUrl: string, left: number, top: number, width: number, height: number): Image; - insertLine(line: Line): Line; - insertLine( - lineCategory: LineCategory, - startConnectionSite: ConnectionSite, - endConnectionSite: ConnectionSite, - ): Line; - insertLine( - lineCategory: LineCategory, - startLeft: number, - startTop: number, - endLeft: number, - endTop: number, - ): Line; - insertPageElement(pageElement: PageElement): PageElement; - insertShape(shape: Shape): Shape; - insertShape(shapeType: ShapeType): Shape; - insertShape(shapeType: ShapeType, left: number, top: number, width: number, height: number): Shape; - insertSheetsChart(sourceChart: Spreadsheet.EmbeddedChart): SheetsChart; - insertSheetsChart( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): SheetsChart; - insertSheetsChart(sheetsChart: SheetsChart): SheetsChart; - insertSheetsChartAsImage(sourceChart: Spreadsheet.EmbeddedChart): Image; - insertSheetsChartAsImage( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): Image; - insertTable(numRows: Integer, numColumns: Integer): Table; - insertTable( - numRows: Integer, - numColumns: Integer, - left: number, - top: number, - width: number, - height: number, - ): Table; - insertTable(table: Table): Table; - insertTextBox(text: string): Shape; - insertTextBox(text: string, left: number, top: number, width: number, height: number): Shape; - insertVideo(videoUrl: string): Video; - insertVideo(videoUrl: string, left: number, top: number, width: number, height: number): Video; - insertVideo(video: Video): Video; - insertWordArt(wordArt: WordArt): WordArt; - remove(): void; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - selectAsCurrentPage(): void; - } - /** - * A PageElement representing a line. - */ - interface Line { - alignOnPage(alignmentPosition: AlignmentPosition): Line; - bringForward(): Line; - bringToFront(): Line; - duplicate(): PageElement; - getConnectionSites(): ConnectionSite[]; - getDashStyle(): DashStyle; - getDescription(): string; - getEnd(): Point; - getEndArrow(): ArrowStyle; - getEndConnection(): ConnectionSite; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getLineCategory(): LineCategory; - getLineFill(): LineFill; - getLineType(): LineType; - getLink(): Link; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getStart(): Point; - getStartArrow(): ArrowStyle; - getStartConnection(): ConnectionSite; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWeight(): number; - getWidth(): number; - isConnector(): boolean; - preconcatenateTransform(transform: AffineTransform): Line; - remove(): void; - removeLink(): void; - reroute(): Line; - scaleHeight(ratio: number): Line; - scaleWidth(ratio: number): Line; - select(): void; - select(replace: boolean): void; - sendBackward(): Line; - sendToBack(): Line; - setDashStyle(style: DashStyle): Line; - setDescription(description: string): Line; - setEnd(left: number, top: number): Line; - setEnd(point: Point): Line; - setEndArrow(style: ArrowStyle): Line; - setEndConnection(connectionSite: ConnectionSite): Line; - setHeight(height: number): Line; - setLeft(left: number): Line; - setLineCategory(lineCategory: LineCategory): Line; - setLinkSlide(slideIndex: Integer): Link; - setLinkSlide(slide: Slide): Link; - setLinkSlide(slidePosition: SlidePosition): Link; - setLinkUrl(url: string): Link; - setRotation(angle: number): Line; - setStart(left: number, top: number): Line; - setStart(point: Point): Line; - setStartArrow(style: ArrowStyle): Line; - setStartConnection(connectionSite: ConnectionSite): Line; - setTitle(title: string): Line; - setTop(top: number): Line; - setTransform(transform: AffineTransform): Line; - setWeight(points: number): Line; - setWidth(width: number): Line; - } - /** - * The line category. - * - * The exact LineType created is determined based on the category and how it's routed to - * connect to other page elements. - */ - enum LineCategory { - UNSUPPORTED, - STRAIGHT, - BENT, - CURVED, - } - /** - * Describes the fill of a line or outline - */ - interface LineFill { - getFillType(): LineFillType; - getSolidFill(): SolidFill; - setSolidFill(color: Color): void; - setSolidFill(color: Color, alpha: number): void; - setSolidFill(red: Integer, green: Integer, blue: Integer): void; - setSolidFill(red: Integer, green: Integer, blue: Integer, alpha: number): void; - setSolidFill(hexString: string): void; - setSolidFill(hexString: string, alpha: number): void; - setSolidFill(color: ThemeColorType): void; - setSolidFill(color: ThemeColorType, alpha: number): void; - } - /** - * The kinds of line fill. - */ - enum LineFillType { - UNSUPPORTED, - NONE, - SOLID, - } - /** - * The line types. - * - * Derived from a subset of the values of the "ST_ShapeType" simple type in section 20.1.10.55 of - * "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th - * edition. - */ - enum LineType { - UNSUPPORTED, - STRAIGHT_CONNECTOR_1, - BENT_CONNECTOR_2, - BENT_CONNECTOR_3, - BENT_CONNECTOR_4, - BENT_CONNECTOR_5, - CURVED_CONNECTOR_2, - CURVED_CONNECTOR_3, - CURVED_CONNECTOR_4, - CURVED_CONNECTOR_5, - STRAIGHT_LINE, - } - /** - * A hypertext link. - */ - interface Link { - getLinkType(): LinkType; - getLinkedSlide(): Slide; - getSlideId(): string; - getSlideIndex(): Integer; - getSlidePosition(): SlidePosition; - getUrl(): string; - } - /** - * The types of a Link. - */ - enum LinkType { - UNSUPPORTED, - URL, - SLIDE_POSITION, - SLIDE_ID, - SLIDE_INDEX, - } - /** - * A list in the text. - */ - interface List { - getListId(): string; - getListParagraphs(): Paragraph[]; - } - /** - * Preset patterns of glyphs for lists in text. - * - * These presets use these glyphs: - * - * ARROW: An arrow, ➔, corresponding to a Unicode U+2794 code point - * - * ARROW3D: An arrow with 3D shading, ➢, corresponding to a Unicode U+27a2 code point - * - * CHECKBOX: A hollow square, ❏, corresponding to a Unicode U+274f code point - * - * CIRCLE: A hollow circle, ○, corresponding to a Unicode U+25cb code point - * - * DIAMOND: A solid diamond, ◆, corresponding to a Unicode U+25c6 code point - * - * `DIAMONDX: A diamond with an 'x', ❖, corresponding to a Unicode U+2756 code point - * - * HOLLOWDIAMOND: A hollow diamond, ◇, corresponding to a Unicode U+25c7 code point - * - * DISC: A solid circle, ●, corresponding to a Unicode U+25cf code point - * - * SQUARE: A solid square, ■, corresponding to a Unicode U+25a0 code point - * - * STAR: A star, ★, corresponding to a Unicode U+2605 code point - * - * ALPHA: A lowercase letter, like 'a', 'b', or 'c'. - * - * UPPERALPHA: An uppercase letter, like 'A', 'B', or 'C'. - * - * DIGIT: A number, like '1', '2', or '3'. - * - * ZERODIGIT: A number where single digit numbers are prefixed with a zero, like '01', '02', - * or '03'. Numbers with more than one digit are not prefixed a zero. - * - * ROMAN: A lowercase roman numeral, like 'i', 'ii', or 'iii'. - * - * UPPERROMAN: A uppercase roman numeral, like 'I', 'II', or 'III'. - * - * LEFTTRIANGLE: A triangle pointing left, ◄, corresponding to a Unicode U+25c4 code - * point - */ - enum ListPreset { - DISC_CIRCLE_SQUARE, - DIAMONDX_ARROW3D_SQUARE, - CHECKBOX, - ARROW_DIAMOND_DISC, - STAR_CIRCLE_SQUARE, - ARROW3D_CIRCLE_SQUARE, - LEFTTRIANGLE_DIAMOND_DISC, - DIAMONDX_HOLLOWDIAMOND_SQUARE, - DIAMOND_CIRCLE_SQUARE, - DIGIT_ALPHA_ROMAN, - DIGIT_ALPHA_ROMAN_PARENS, - DIGIT_NESTED, - UPPERALPHA_ALPHA_ROMAN, - UPPERROMAN_UPPERALPHA_DIGIT, - ZERODIGIT_ALPHA_ROMAN, - } - /** - * The list styling for a range of text. - */ - interface ListStyle { - applyListPreset(listPreset: ListPreset): ListStyle; - getGlyph(): string; - getList(): List; - getNestingLevel(): Integer; - isInList(): boolean; - removeFromList(): ListStyle; - } - /** - * A master in a presentation. - * - * Masters contains all common page elements and the common properties for a set of layouts. They - * serve three purposes: - * - * Placeholder shapes on a master contain the default text styles and shape properties of all - * placeholder shapes on pages that use that master. - * - * The properties of a master page define the common page properties inherited by its layouts. - * - * Any other shapes on the master slide appear on all slides using that master, regardless of - * their layout. - */ - interface Master { - getBackground(): PageBackground; - getColorScheme(): ColorScheme; - getGroups(): Group[]; - getImages(): Image[]; - getLayouts(): Layout[]; - getLines(): Line[]; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPageType(): PageType; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - group(pageElements: PageElement[]): Group; - insertGroup(group: Group): Group; - insertImage(blobSource: Base.BlobSource): Image; - insertImage(blobSource: Base.BlobSource, left: number, top: number, width: number, height: number): Image; - insertImage(image: Image): Image; - insertImage(imageUrl: string): Image; - insertImage(imageUrl: string, left: number, top: number, width: number, height: number): Image; - insertLine(line: Line): Line; - insertLine( - lineCategory: LineCategory, - startConnectionSite: ConnectionSite, - endConnectionSite: ConnectionSite, - ): Line; - insertLine( - lineCategory: LineCategory, - startLeft: number, - startTop: number, - endLeft: number, - endTop: number, - ): Line; - insertPageElement(pageElement: PageElement): PageElement; - insertShape(shape: Shape): Shape; - insertShape(shapeType: ShapeType): Shape; - insertShape(shapeType: ShapeType, left: number, top: number, width: number, height: number): Shape; - insertSheetsChart(sourceChart: Spreadsheet.EmbeddedChart): SheetsChart; - insertSheetsChart( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): SheetsChart; - insertSheetsChart(sheetsChart: SheetsChart): SheetsChart; - insertSheetsChartAsImage(sourceChart: Spreadsheet.EmbeddedChart): Image; - insertSheetsChartAsImage( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): Image; - insertTable(numRows: Integer, numColumns: Integer): Table; - insertTable( - numRows: Integer, - numColumns: Integer, - left: number, - top: number, - width: number, - height: number, - ): Table; - insertTable(table: Table): Table; - insertTextBox(text: string): Shape; - insertTextBox(text: string, left: number, top: number, width: number, height: number): Shape; - insertVideo(videoUrl: string): Video; - insertVideo(videoUrl: string, left: number, top: number, width: number, height: number): Video; - insertVideo(video: Video): Video; - insertWordArt(wordArt: WordArt): WordArt; - remove(): void; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - selectAsCurrentPage(): void; - } - /** - * A notes master in a presentation. - * - * Notes masters define the default text styles and page elements for all notes pages. Notes - * masters are read-only. - */ - interface NotesMaster { - getGroups(): Group[]; - getImages(): Image[]; - getLines(): Line[]; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - } - /** - * A notes page in a presentation. - * - * These pages contain the content for presentation handouts, including a a shape that contains - * the slide's speaker notes. Each slide has one corresponding notes page. Only the text in the - * speaker notes shape can be modified. - */ - interface NotesPage { - getGroups(): Group[]; - getImages(): Image[]; - getLines(): Line[]; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getSpeakerNotesShape(): Shape; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - } - /** - * A page in a presentation. - */ - interface Page { - asLayout(): Layout; - asMaster(): Master; - asSlide(): Slide; - getBackground(): PageBackground; - getColorScheme(): ColorScheme; - getGroups(): Group[]; - getImages(): Image[]; - getLines(): Line[]; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPageType(): PageType; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - group(pageElements: PageElement[]): Group; - insertGroup(group: Group): Group; - insertImage(blobSource: Base.BlobSource): Image; - insertImage(blobSource: Base.BlobSource, left: number, top: number, width: number, height: number): Image; - insertImage(image: Image): Image; - insertImage(imageUrl: string): Image; - insertImage(imageUrl: string, left: number, top: number, width: number, height: number): Image; - insertLine(line: Line): Line; - insertLine( - lineCategory: LineCategory, - startConnectionSite: ConnectionSite, - endConnectionSite: ConnectionSite, - ): Line; - insertLine( - lineCategory: LineCategory, - startLeft: number, - startTop: number, - endLeft: number, - endTop: number, - ): Line; - insertPageElement(pageElement: PageElement): PageElement; - insertShape(shape: Shape): Shape; - insertShape(shapeType: ShapeType): Shape; - insertShape(shapeType: ShapeType, left: number, top: number, width: number, height: number): Shape; - insertSheetsChart(sourceChart: Spreadsheet.EmbeddedChart): SheetsChart; - insertSheetsChart( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): SheetsChart; - insertSheetsChart(sheetsChart: SheetsChart): SheetsChart; - insertSheetsChartAsImage(sourceChart: Spreadsheet.EmbeddedChart): Image; - insertSheetsChartAsImage( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): Image; - insertTable(numRows: Integer, numColumns: Integer): Table; - insertTable( - numRows: Integer, - numColumns: Integer, - left: number, - top: number, - width: number, - height: number, - ): Table; - insertTable(table: Table): Table; - insertTextBox(text: string): Shape; - insertTextBox(text: string, left: number, top: number, width: number, height: number): Shape; - insertVideo(videoUrl: string): Video; - insertVideo(videoUrl: string, left: number, top: number, width: number, height: number): Video; - insertVideo(video: Video): Video; - insertWordArt(wordArt: WordArt): WordArt; - remove(): void; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - selectAsCurrentPage(): void; - } - /** - * Describes the page's background - */ - interface PageBackground { - getPictureFill(): PictureFill; - getSolidFill(): SolidFill; - getType(): PageBackgroundType; - isVisible(): boolean; - setPictureFill(blobSource: Base.BlobSource): void; - setPictureFill(imageUrl: string): void; - setSolidFill(color: Color): void; - setSolidFill(color: Color, alpha: number): void; - setSolidFill(red: Integer, green: Integer, blue: Integer): void; - setSolidFill(red: Integer, green: Integer, blue: Integer, alpha: number): void; - setSolidFill(hexString: string): void; - setSolidFill(hexString: string, alpha: number): void; - setSolidFill(color: ThemeColorType): void; - setSolidFill(color: ThemeColorType, alpha: number): void; - setTransparent(): void; - } - /** - * The kinds of page backgrounds. - */ - enum PageBackgroundType { - UNSUPPORTED, - NONE, - SOLID, - PICTURE, - } - /** - * A visual element rendered on a page. - */ - interface PageElement { - alignOnPage(alignmentPosition: AlignmentPosition): PageElement; - asGroup(): Group; - asImage(): Image; - asLine(): Line; - asShape(): Shape; - asSheetsChart(): SheetsChart; - asTable(): Table; - asVideo(): Video; - asWordArt(): WordArt; - bringForward(): PageElement; - bringToFront(): PageElement; - duplicate(): PageElement; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): PageElement; - remove(): void; - scaleHeight(ratio: number): PageElement; - scaleWidth(ratio: number): PageElement; - select(): void; - select(replace: boolean): void; - sendBackward(): PageElement; - sendToBack(): PageElement; - setDescription(description: string): PageElement; - setHeight(height: number): PageElement; - setLeft(left: number): PageElement; - setRotation(angle: number): PageElement; - setTitle(title: string): PageElement; - setTop(top: number): PageElement; - setTransform(transform: AffineTransform): PageElement; - setWidth(width: number): PageElement; - } - /** - * A collection of one or more PageElement instances. - */ - interface PageElementRange { - getPageElements(): PageElement[]; - } - /** - * The page element type. - */ - enum PageElementType { - UNSUPPORTED, - SHAPE, - IMAGE, - VIDEO, - TABLE, - GROUP, - LINE, - WORD_ART, - SHEETS_CHART, - } - /** - * A collection of one or more Page instances. - */ - interface PageRange { - getPages(): Page[]; - } - /** - * The page types. - */ - enum PageType { - UNSUPPORTED, - SLIDE, - LAYOUT, - MASTER, - } - /** - * A segment of text terminated by a newline character. - */ - interface Paragraph { - getIndex(): Integer; - getRange(): TextRange; - } - /** - * The types of text alignment for a paragraph. - */ - enum ParagraphAlignment { - UNSUPPORTED, - START, - CENTER, - END, - JUSTIFIED, - } - /** - * The styles of text that apply to entire paragraphs. - * - * Read methods in this class return null if the corresponding TextRange spans - * multiple paragraphs, and those paragraphs have different values for the read method being called. - * To avoid this, query for paragraph styles using the TextRange returned by the Paragraph.getRange() method. - */ - interface ParagraphStyle { - getIndentEnd(): number; - getIndentFirstLine(): number; - getIndentStart(): number; - getLineSpacing(): number; - getParagraphAlignment(): ParagraphAlignment; - getSpaceAbove(): number; - getSpaceBelow(): number; - getSpacingMode(): SpacingMode; - getTextDirection(): TextDirection; - setIndentEnd(indent: number): ParagraphStyle; - setIndentFirstLine(indent: number): ParagraphStyle; - setIndentStart(indent: number): ParagraphStyle; - setLineSpacing(spacing: number): ParagraphStyle; - setParagraphAlignment(alignment: ParagraphAlignment): ParagraphStyle; - setSpaceAbove(space: number): ParagraphStyle; - setSpaceBelow(space: number): ParagraphStyle; - setSpacingMode(mode: SpacingMode): ParagraphStyle; - setTextDirection(direction: TextDirection): ParagraphStyle; - } - /** - * A fill that renders an image that's stretched to the dimensions of its container. - */ - interface PictureFill { - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getContentUrl(): string; - getSourceUrl(): string; - } - /** - * The placeholder types. Many of these placeholder types correspond to placeholder IDs from the - * ECMA-376 standard. More information on those shapes can be found in the description of the - * "ST_PlaceholderType" type in section 19.7.10 of "Office Open XML File Formats - Fundamentals and - * Markup Language Reference", part 1 of ECMA-376 5th - * edition. - */ - enum PlaceholderType { - UNSUPPORTED, - NONE, - BODY, - CHART, - CLIP_ART, - CENTERED_TITLE, - DIAGRAM, - DATE_AND_TIME, - FOOTER, - HEADER, - MEDIA, - OBJECT, - PICTURE, - SLIDE_NUMBER, - SUBTITLE, - TABLE, - TITLE, - SLIDE_IMAGE, - } - /** - * A point representing a location. - */ - interface Point { - getX(): number; - getY(): number; - } - /** - * Predefined layouts. These are commonly found layouts in presentations. However, there is no - * guarantee that these layouts are present in the current master as they could have been deleted or - * not part of the used theme. Additionally, the placeholders on each layout may have been changed. - */ - enum PredefinedLayout { - UNSUPPORTED, - BLANK, - CAPTION_ONLY, - TITLE, - TITLE_AND_BODY, - TITLE_AND_TWO_COLUMNS, - TITLE_ONLY, - SECTION_HEADER, - SECTION_TITLE_AND_DESCRIPTION, - ONE_COLUMN_TEXT, - MAIN_POINT, - BIG_NUMBER, - } - /** - * A presentation. - */ - interface Presentation { - addEditor(emailAddress: string): Presentation; - addEditor(user: Base.User): Presentation; - addEditors(emailAddresses: string[]): Presentation; - addViewer(emailAddress: string): Presentation; - addViewer(user: Base.User): Presentation; - addViewers(emailAddresses: string[]): Presentation; - appendSlide(): Slide; - appendSlide(layout: Layout): Slide; - appendSlide(predefinedLayout: PredefinedLayout): Slide; - appendSlide(slide: Slide): Slide; - appendSlide(slide: Slide, linkingMode: SlideLinkingMode): Slide; - getEditors(): Base.User[]; - getId(): string; - getLayouts(): Layout[]; - getMasters(): Master[]; - getName(): string; - getNotesMaster(): NotesMaster; - getNotesPageHeight(): number; - getNotesPageWidth(): number; - getPageElementById(id: string): PageElement; - getPageHeight(): number; - getPageWidth(): number; - getSelection(): Selection; - getSlideById(id: string): Slide; - getSlides(): Slide[]; - getUrl(): string; - getViewers(): Base.User[]; - insertSlide(insertionIndex: Integer): Slide; - insertSlide(insertionIndex: Integer, layout: Layout): Slide; - insertSlide(insertionIndex: Integer, predefinedLayout: PredefinedLayout): Slide; - insertSlide(insertionIndex: Integer, slide: Slide): Slide; - insertSlide(insertionIndex: Integer, slide: Slide, linkingMode: SlideLinkingMode): Slide; - removeEditor(emailAddress: string): Presentation; - removeEditor(user: Base.User): Presentation; - removeViewer(emailAddress: string): Presentation; - removeViewer(user: Base.User): Presentation; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - saveAndClose(): void; - setName(name: string): void; - } - /** - * The user's selection in the active presentation. - * - * var selection = SlidesApp.getActivePresentation().getSelection(); - * var currentPage = selection.getCurrentPage(); - * var selectionType = selection.getSelectionType(); - * } - */ - interface Selection { - getCurrentPage(): Page; - getPageElementRange(): PageElementRange; - getPageRange(): PageRange; - getSelectionType(): SelectionType; - getTableCellRange(): TableCellRange; - getTextRange(): TextRange; - } - /** - * Type of Selection. - * - * The SelectionType represents the most specific type of one or more objects that are - * selected. As an example if one or more TableCell instances are selected in a Table, the selection type is SelectionType.TABLE_CELL. The TableCellRange can be - * retrieved by using the Selection.getTableCellRange. The Table can be retrieved by - * using the Selection.getPageElementRange and the Page can be retrieved from the - * Selection.getCurrentPage. - */ - enum SelectionType { - UNSUPPORTED, - NONE, - TEXT, - TABLE_CELL, - PAGE, - PAGE_ELEMENT, - CURRENT_PAGE, - } - /** - * A PageElement representing a generic shape that does not have a more specific - * classification. Includes text boxes, rectangles, and other predefined shapes. - */ - interface Shape { - alignOnPage(alignmentPosition: AlignmentPosition): Shape; - bringForward(): Shape; - bringToFront(): Shape; - duplicate(): PageElement; - getBorder(): Border; - getConnectionSites(): ConnectionSite[]; - getContentAlignment(): ContentAlignment; - getDescription(): string; - getFill(): Fill; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getLink(): Link; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getParentPlaceholder(): PageElement; - getPlaceholderIndex(): Integer; - getPlaceholderType(): PlaceholderType; - getRotation(): number; - getShapeType(): ShapeType; - getText(): TextRange; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): Shape; - remove(): void; - removeLink(): void; - replaceWithImage(blobSource: Base.BlobSource): Image; - replaceWithImage(blobSource: Base.BlobSource, crop: boolean): Image; - replaceWithImage(imageUrl: string): Image; - replaceWithImage(imageUrl: string, crop: boolean): Image; - replaceWithSheetsChart(sourceChart: Spreadsheet.EmbeddedChart): SheetsChart; - replaceWithSheetsChartAsImage(sourceChart: Spreadsheet.EmbeddedChart): Image; - scaleHeight(ratio: number): Shape; - scaleWidth(ratio: number): Shape; - select(): void; - select(replace: boolean): void; - sendBackward(): Shape; - sendToBack(): Shape; - setContentAlignment(contentAlignment: ContentAlignment): Shape; - setDescription(description: string): Shape; - setHeight(height: number): Shape; - setLeft(left: number): Shape; - setLinkSlide(slideIndex: Integer): Link; - setLinkSlide(slide: Slide): Link; - setLinkSlide(slidePosition: SlidePosition): Link; - setLinkUrl(url: string): Link; - setRotation(angle: number): Shape; - setTitle(title: string): Shape; - setTop(top: number): Shape; - setTransform(transform: AffineTransform): Shape; - setWidth(width: number): Shape; - } - /** - * The shape types. Many of these shapes correspond to predefined shapes from the ECMA-376 standard. - * More information on those shapes can be found in the description of the "ST_ShapeType" simple - * type in section 20.1.10.55 of "Office Open XML File Formats - Fundamentals and Markup Language - * Reference", part 1 of ECMA-376 4th - * edition. - */ - enum ShapeType { - UNSUPPORTED, - TEXT_BOX, - RECTANGLE, - ROUND_RECTANGLE, - ELLIPSE, - ARC, - BENT_ARROW, - BENT_UP_ARROW, - BEVEL, - BLOCK_ARC, - BRACE_PAIR, - BRACKET_PAIR, - CAN, - CHEVRON, - CHORD, - CLOUD, - CORNER, - CUBE, - CURVED_DOWN_ARROW, - CURVED_LEFT_ARROW, - CURVED_RIGHT_ARROW, - CURVED_UP_ARROW, - DECAGON, - DIAGONAL_STRIPE, - DIAMOND, - DODECAGON, - DONUT, - DOUBLE_WAVE, - DOWN_ARROW, - DOWN_ARROW_CALLOUT, - FOLDED_CORNER, - FRAME, - HALF_FRAME, - HEART, - HEPTAGON, - HEXAGON, - HOME_PLATE, - HORIZONTAL_SCROLL, - IRREGULAR_SEAL_1, - IRREGULAR_SEAL_2, - LEFT_ARROW, - LEFT_ARROW_CALLOUT, - LEFT_BRACE, - LEFT_BRACKET, - LEFT_RIGHT_ARROW, - LEFT_RIGHT_ARROW_CALLOUT, - LEFT_RIGHT_UP_ARROW, - LEFT_UP_ARROW, - LIGHTNING_BOLT, - MATH_DIVIDE, - MATH_EQUAL, - MATH_MINUS, - MATH_MULTIPLY, - MATH_NOT_EQUAL, - MATH_PLUS, - MOON, - NO_SMOKING, - NOTCHED_RIGHT_ARROW, - OCTAGON, - PARALLELOGRAM, - PENTAGON, - PIE, - PLAQUE, - PLUS, - QUAD_ARROW, - QUAD_ARROW_CALLOUT, - RIBBON, - RIBBON_2, - RIGHT_ARROW, - RIGHT_ARROW_CALLOUT, - RIGHT_BRACE, - RIGHT_BRACKET, - ROUND_1_RECTANGLE, - ROUND_2_DIAGONAL_RECTANGLE, - ROUND_2_SAME_RECTANGLE, - RIGHT_TRIANGLE, - SMILEY_FACE, - SNIP_1_RECTANGLE, - SNIP_2_DIAGONAL_RECTANGLE, - SNIP_2_SAME_RECTANGLE, - SNIP_ROUND_RECTANGLE, - STAR_10, - STAR_12, - STAR_16, - STAR_24, - STAR_32, - STAR_4, - STAR_5, - STAR_6, - STAR_7, - STAR_8, - STRIPED_RIGHT_ARROW, - SUN, - TRAPEZOID, - TRIANGLE, - UP_ARROW, - UP_ARROW_CALLOUT, - UP_DOWN_ARROW, - UTURN_ARROW, - VERTICAL_SCROLL, - WAVE, - WEDGE_ELLIPSE_CALLOUT, - WEDGE_RECTANGLE_CALLOUT, - WEDGE_ROUND_RECTANGLE_CALLOUT, - FLOW_CHART_ALTERNATE_PROCESS, - FLOW_CHART_COLLATE, - FLOW_CHART_CONNECTOR, - FLOW_CHART_DECISION, - FLOW_CHART_DELAY, - FLOW_CHART_DISPLAY, - FLOW_CHART_DOCUMENT, - FLOW_CHART_EXTRACT, - FLOW_CHART_INPUT_OUTPUT, - FLOW_CHART_INTERNAL_STORAGE, - FLOW_CHART_MAGNETIC_DISK, - FLOW_CHART_MAGNETIC_DRUM, - FLOW_CHART_MAGNETIC_TAPE, - FLOW_CHART_MANUAL_INPUT, - FLOW_CHART_MANUAL_OPERATION, - FLOW_CHART_MERGE, - FLOW_CHART_MULTIDOCUMENT, - FLOW_CHART_OFFLINE_STORAGE, - FLOW_CHART_OFFPAGE_CONNECTOR, - FLOW_CHART_ONLINE_STORAGE, - FLOW_CHART_OR, - FLOW_CHART_PREDEFINED_PROCESS, - FLOW_CHART_PREPARATION, - FLOW_CHART_PROCESS, - FLOW_CHART_PUNCHED_CARD, - FLOW_CHART_PUNCHED_TAPE, - FLOW_CHART_SORT, - FLOW_CHART_SUMMING_JUNCTION, - FLOW_CHART_TERMINATOR, - ARROW_EAST, - ARROW_NORTH_EAST, - ARROW_NORTH, - SPEECH, - STARBURST, - TEARDROP, - ELLIPSE_RIBBON, - ELLIPSE_RIBBON_2, - CLOUD_CALLOUT, - CUSTOM, - } - /** - * A PageElement representing a linked chart embedded from Google Sheets. - */ - interface SheetsChart { - alignOnPage(alignmentPosition: AlignmentPosition): SheetsChart; - asImage(): Image; - bringForward(): SheetsChart; - bringToFront(): SheetsChart; - duplicate(): PageElement; - getChartId(): Integer; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getEmbedType(): SheetsChartEmbedType; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getLink(): Link; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getSpreadsheetId(): string; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): SheetsChart; - refresh(): void; - remove(): void; - removeLink(): void; - scaleHeight(ratio: number): SheetsChart; - scaleWidth(ratio: number): SheetsChart; - select(): void; - select(replace: boolean): void; - sendBackward(): SheetsChart; - sendToBack(): SheetsChart; - setDescription(description: string): SheetsChart; - setHeight(height: number): SheetsChart; - setLeft(left: number): SheetsChart; - setLinkSlide(slideIndex: Integer): Link; - setLinkSlide(slide: Slide): Link; - setLinkSlide(slidePosition: SlidePosition): Link; - setLinkUrl(url: string): Link; - setRotation(angle: number): SheetsChart; - setTitle(title: string): SheetsChart; - setTop(top: number): SheetsChart; - setTransform(transform: AffineTransform): SheetsChart; - setWidth(width: number): SheetsChart; - } - /** - * The Sheets chart's embed type. - */ - enum SheetsChartEmbedType { - UNSUPPORTED, - IMAGE, - } - /** - * A slide in a presentation. - * - * These pages contain the content you are presenting to your audience. Most slides are based on - * a master and a layout. You can specify which layout to use for each slide when it is created. - */ - interface Slide { - duplicate(): Slide; - getBackground(): PageBackground; - getColorScheme(): ColorScheme; - getGroups(): Group[]; - getImages(): Image[]; - getLayout(): Layout; - getLines(): Line[]; - getNotesPage(): NotesPage; - getObjectId(): string; - getPageElementById(id: string): PageElement; - getPageElements(): PageElement[]; - getPageType(): PageType; - getPlaceholder(placeholderType: PlaceholderType): PageElement; - getPlaceholder(placeholderType: PlaceholderType, placeholderIndex: Integer): PageElement; - getPlaceholders(): PageElement[]; - getShapes(): Shape[]; - getSheetsCharts(): SheetsChart[]; - getSlideLinkingMode(): SlideLinkingMode; - getSourcePresentationId(): string; - getSourceSlideObjectId(): string; - getTables(): Table[]; - getVideos(): Video[]; - getWordArts(): WordArt[]; - group(pageElements: PageElement[]): Group; - insertGroup(group: Group): Group; - insertImage(blobSource: Base.BlobSource): Image; - insertImage(blobSource: Base.BlobSource, left: number, top: number, width: number, height: number): Image; - insertImage(image: Image): Image; - insertImage(imageUrl: string): Image; - insertImage(imageUrl: string, left: number, top: number, width: number, height: number): Image; - insertLine(line: Line): Line; - insertLine( - lineCategory: LineCategory, - startConnectionSite: ConnectionSite, - endConnectionSite: ConnectionSite, - ): Line; - insertLine( - lineCategory: LineCategory, - startLeft: number, - startTop: number, - endLeft: number, - endTop: number, - ): Line; - insertPageElement(pageElement: PageElement): PageElement; - insertShape(shape: Shape): Shape; - insertShape(shapeType: ShapeType): Shape; - insertShape(shapeType: ShapeType, left: number, top: number, width: number, height: number): Shape; - insertSheetsChart(sourceChart: Spreadsheet.EmbeddedChart): SheetsChart; - insertSheetsChart( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): SheetsChart; - insertSheetsChart(sheetsChart: SheetsChart): SheetsChart; - insertSheetsChartAsImage(sourceChart: Spreadsheet.EmbeddedChart): Image; - insertSheetsChartAsImage( - sourceChart: Spreadsheet.EmbeddedChart, - left: number, - top: number, - width: number, - height: number, - ): Image; - insertTable(numRows: Integer, numColumns: Integer): Table; - insertTable( - numRows: Integer, - numColumns: Integer, - left: number, - top: number, - width: number, - height: number, - ): Table; - insertTable(table: Table): Table; - insertTextBox(text: string): Shape; - insertTextBox(text: string, left: number, top: number, width: number, height: number): Shape; - insertVideo(videoUrl: string): Video; - insertVideo(videoUrl: string, left: number, top: number, width: number, height: number): Video; - insertVideo(video: Video): Video; - insertWordArt(wordArt: WordArt): WordArt; - isSkipped(): boolean; - move(index: Integer): void; - refreshSlide(): void; - remove(): void; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - selectAsCurrentPage(): void; - setSkipped(isSkipped: boolean): void; - unlink(): void; - } - /** - * The mode of links between slides. - */ - enum SlideLinkingMode { - UNSUPPORTED, - LINKED, - NOT_LINKED, - } - /** - * The relative position of a Slide. - */ - enum SlidePosition { - NEXT_SLIDE, - PREVIOUS_SLIDE, - FIRST_SLIDE, - LAST_SLIDE, - } - /** - * Creates and opens Presentations that can be edited. - * - * // Open a presentation by ID. - * var preso = SlidesApp.openById('PRESENTATION_ID_GOES_HERE'); - * - * // Create and open a presentation. - * preso = SlidesApp.create('Presentation Name'); - */ - interface SlidesApp { - AlignmentPosition: typeof AlignmentPosition; - ArrowStyle: typeof ArrowStyle; - AutoTextType: typeof AutoTextType; - CellMergeState: typeof CellMergeState; - ColorType: typeof Base.ColorType; - ContentAlignment: typeof ContentAlignment; - DashStyle: typeof DashStyle; - FillType: typeof FillType; - LineCategory: typeof LineCategory; - LineFillType: typeof LineFillType; - LineType: typeof LineType; - LinkType: typeof LinkType; - ListPreset: typeof ListPreset; - PageBackgroundType: typeof PageBackgroundType; - PageElementType: typeof PageElementType; - PageType: typeof PageType; - ParagraphAlignment: typeof ParagraphAlignment; - PlaceholderType: typeof PlaceholderType; - PredefinedLayout: typeof PredefinedLayout; - SelectionType: typeof SelectionType; - ShapeType: typeof ShapeType; - SheetsChartEmbedType: typeof SheetsChartEmbedType; - SlideLinkingMode: typeof SlideLinkingMode; - SlidePosition: typeof SlidePosition; - SpacingMode: typeof SpacingMode; - TextBaselineOffset: typeof TextBaselineOffset; - TextDirection: typeof TextDirection; - ThemeColorType: typeof ThemeColorType; - VideoSourceType: typeof VideoSourceType; - create(name: string): Presentation; - getActivePresentation(): Presentation; - getUi(): Base.Ui; - newAffineTransformBuilder(): AffineTransformBuilder; - openById(id: string): Presentation; - openByUrl(url: string): Presentation; - } - /** - * A solid color fill. - * - * SolidFill objects are detached and immutable, so do not reflect changes made after - * they have been created. - */ - interface SolidFill { - getAlpha(): number; - getColor(): Color; - } - /** - * The different modes for paragraph spacing. - */ - enum SpacingMode { - UNSUPPORTED, - NEVER_COLLAPSE, - COLLAPSE_LISTS, - } - /** - * A PageElement representing a table. - */ - interface Table { - alignOnPage(alignmentPosition: AlignmentPosition): Table; - appendColumn(): TableColumn; - appendRow(): TableRow; - bringForward(): Table; - bringToFront(): Table; - duplicate(): PageElement; - getCell(rowIndex: Integer, columnIndex: Integer): TableCell; - getColumn(columnIndex: Integer): TableColumn; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getNumColumns(): Integer; - getNumRows(): Integer; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getRow(rowIndex: Integer): TableRow; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - insertColumn(index: Integer): TableColumn; - insertRow(index: Integer): TableRow; - preconcatenateTransform(transform: AffineTransform): Table; - remove(): void; - scaleHeight(ratio: number): Table; - scaleWidth(ratio: number): Table; - select(): void; - select(replace: boolean): void; - sendBackward(): Table; - sendToBack(): Table; - setDescription(description: string): Table; - setHeight(height: number): Table; - setLeft(left: number): Table; - setRotation(angle: number): Table; - setTitle(title: string): Table; - setTop(top: number): Table; - setTransform(transform: AffineTransform): Table; - setWidth(width: number): Table; - } - /** - * A cell in a table. - */ - interface TableCell { - getColumnIndex(): Integer; - getColumnSpan(): Integer; - getContentAlignment(): ContentAlignment; - getFill(): Fill; - getHeadCell(): TableCell; - getMergeState(): CellMergeState; - getParentColumn(): TableColumn; - getParentRow(): TableRow; - getParentTable(): Table; - getRowIndex(): Integer; - getRowSpan(): Integer; - getText(): TextRange; - setContentAlignment(contentAlignment: ContentAlignment): TableCell; - } - /** - * A collection of one or more TableCell instances. - */ - interface TableCellRange { - getTableCells(): TableCell[]; - } - /** - * A column in a table. A column consists of a list of table cells. A column is identified by the - * column index. - */ - interface TableColumn { - getCell(cellIndex: Integer): TableCell; - getIndex(): Integer; - getNumCells(): Integer; - getParentTable(): Table; - getWidth(): number; - remove(): void; - } - /** - * A row in a table. A row consists of a list of table cells. A row is identified by the row index. - */ - interface TableRow { - getCell(cellIndex: Integer): TableCell; - getIndex(): Integer; - getMinimumHeight(): number; - getNumCells(): Integer; - getParentTable(): Table; - remove(): void; - } - /** - * The text vertical offset from its normal position. - */ - enum TextBaselineOffset { - UNSUPPORTED, - NONE, - SUPERSCRIPT, - SUBSCRIPT, - } - /** - * The directions text can flow in. - */ - enum TextDirection { - UNSUPPORTED, - LEFT_TO_RIGHT, - RIGHT_TO_LEFT, - } - /** - * A segment of the text contents of a Shape or a TableCell. - */ - interface TextRange { - appendParagraph(text: string): Paragraph; - appendRange(textRange: TextRange): TextRange; - appendRange(textRange: TextRange, matchSourceFormatting: boolean): TextRange; - appendText(text: string): TextRange; - asRenderedString(): string; - asString(): string; - clear(): void; - clear(startOffset: Integer, endOffset: Integer): void; - find(pattern: string): TextRange[]; - find(pattern: string, startOffset: Integer): TextRange[]; - getAutoTexts(): AutoText[]; - getEndIndex(): Integer; - getLength(): Integer; - getLinks(): TextRange[]; - getListParagraphs(): Paragraph[]; - getListStyle(): ListStyle; - getParagraphStyle(): ParagraphStyle; - getParagraphs(): Paragraph[]; - getRange(startOffset: Integer, endOffset: Integer): TextRange; - getRuns(): TextRange[]; - getStartIndex(): Integer; - getTextStyle(): TextStyle; - insertParagraph(startOffset: Integer, text: string): Paragraph; - insertRange(startOffset: Integer, textRange: TextRange): TextRange; - insertRange(startOffset: Integer, textRange: TextRange, matchSourceFormatting: boolean): TextRange; - insertText(startOffset: Integer, text: string): TextRange; - isEmpty(): boolean; - replaceAllText(findText: string, replaceText: string): Integer; - replaceAllText(findText: string, replaceText: string, matchCase: boolean): Integer; - select(): void; - setText(newText: string): TextRange; - } - /** - * The style of text. - * - * Read methods in this class return null if the corresponding TextRange spans - * multiple text runs, and those runs have different values for the read method being called. To - * avoid this, query for text styles using the TextRanges returned by the TextRange.getRuns() method. - */ - interface TextStyle { - getBackgroundColor(): Color; - getBaselineOffset(): TextBaselineOffset; - getFontFamily(): string; - getFontSize(): number; - getFontWeight(): Integer; - getForegroundColor(): Color; - getLink(): Link; - hasLink(): boolean; - isBackgroundTransparent(): boolean; - isBold(): boolean; - isItalic(): boolean; - isSmallCaps(): boolean; - isStrikethrough(): boolean; - isUnderline(): boolean; - removeLink(): TextStyle; - setBackgroundColor(color: Color): TextStyle; - setBackgroundColor(red: Integer, green: Integer, blue: Integer): TextStyle; - setBackgroundColor(hexColor: string): TextStyle; - setBackgroundColor(color: ThemeColorType): TextStyle; - setBackgroundColorTransparent(): TextStyle; - setBaselineOffset(offset: TextBaselineOffset): TextStyle; - setBold(bold: boolean): TextStyle; - setFontFamily(fontFamily: string): TextStyle; - setFontFamilyAndWeight(fontFamily: string, fontWeight: Integer): TextStyle; - setFontSize(fontSize: number): TextStyle; - setForegroundColor(foregroundColor: Color): TextStyle; - setForegroundColor(red: Integer, green: Integer, blue: Integer): TextStyle; - setForegroundColor(hexColor: string): TextStyle; - setForegroundColor(color: ThemeColorType): TextStyle; - setItalic(italic: boolean): TextStyle; - setLinkSlide(slideIndex: Integer): TextStyle; - setLinkSlide(slide: Slide): TextStyle; - setLinkSlide(slidePosition: SlidePosition): TextStyle; - setLinkUrl(url: string): TextStyle; - setSmallCaps(smallCaps: boolean): TextStyle; - setStrikethrough(strikethrough: boolean): TextStyle; - setUnderline(underline: boolean): TextStyle; - } - /** - * A color that refers to an entry in the page's ColorScheme. - */ - interface ThemeColor { - getColorType(): Base.ColorType; - getThemeColorType(): ThemeColorType; - } - /** - * The name of an entry in the page's color scheme. - */ - enum ThemeColorType { - UNSUPPORTED, - DARK1, - LIGHT1, - DARK2, - LIGHT2, - ACCENT1, - ACCENT2, - ACCENT3, - ACCENT4, - ACCENT5, - ACCENT6, - HYPERLINK, - FOLLOWED_HYPERLINK, - } - /** - * A PageElement representing a video. - */ - interface Video { - alignOnPage(alignmentPosition: AlignmentPosition): Video; - bringForward(): Video; - bringToFront(): Video; - duplicate(): PageElement; - getBorder(): Border; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRotation(): number; - getSource(): VideoSourceType; - getThumbnailUrl(): string; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getUrl(): string; - getVideoId(): string; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): Video; - remove(): void; - scaleHeight(ratio: number): Video; - scaleWidth(ratio: number): Video; - select(): void; - select(replace: boolean): void; - sendBackward(): Video; - sendToBack(): Video; - setDescription(description: string): Video; - setHeight(height: number): Video; - setLeft(left: number): Video; - setRotation(angle: number): Video; - setTitle(title: string): Video; - setTop(top: number): Video; - setTransform(transform: AffineTransform): Video; - setWidth(width: number): Video; - } - /** - * The video source types. - */ - enum VideoSourceType { - UNSUPPORTED, - YOUTUBE, - } - /** - * A PageElement representing word art. - */ - interface WordArt { - alignOnPage(alignmentPosition: AlignmentPosition): WordArt; - bringForward(): WordArt; - bringToFront(): WordArt; - duplicate(): PageElement; - getConnectionSites(): ConnectionSite[]; - getDescription(): string; - getHeight(): number; - getInherentHeight(): number; - getInherentWidth(): number; - getLeft(): number; - getLink(): Link; - getObjectId(): string; - getPageElementType(): PageElementType; - getParentGroup(): Group; - getParentPage(): Page; - getRenderedText(): string; - getRotation(): number; - getTitle(): string; - getTop(): number; - getTransform(): AffineTransform; - getWidth(): number; - preconcatenateTransform(transform: AffineTransform): WordArt; - remove(): void; - removeLink(): void; - scaleHeight(ratio: number): WordArt; - scaleWidth(ratio: number): WordArt; - select(): void; - select(replace: boolean): void; - sendBackward(): WordArt; - sendToBack(): WordArt; - setDescription(description: string): WordArt; - setHeight(height: number): WordArt; - setLeft(left: number): WordArt; - setLinkSlide(slideIndex: Integer): Link; - setLinkSlide(slide: Slide): Link; - setLinkSlide(slidePosition: SlidePosition): Link; - setLinkUrl(url: string): Link; - setRotation(angle: number): WordArt; - setTitle(title: string): WordArt; - setTop(top: number): WordArt; - setTransform(transform: AffineTransform): WordArt; - setWidth(width: number): WordArt; - } - } -} - -declare var SlidesApp: GoogleAppsScript.Slides.SlidesApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.spreadsheet.d.ts b/node_modules/@types/google-apps-script/google-apps-script.spreadsheet.d.ts deleted file mode 100644 index 9c40d2f..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.spreadsheet.d.ts +++ /dev/null @@ -1,2606 +0,0 @@ -/// -/// -/// -/// - -declare namespace GoogleAppsScript { - namespace Spreadsheet { - /** - * An enumeration of the types of series used to calculate auto-filled values. The manner in which - * these series affect calculated values differs depending on the type and amount of source data. - */ - enum AutoFillSeries { - DEFAULT_SERIES, - ALTERNATE_SERIES, - } - /** - * Access and modify bandings, the color patterns applied to rows or columns of a range. Each - * banding consists of a range and a set of colors for rows, columns, headers, and footers. - */ - interface Banding { - copyTo(range: Range): Banding; - getFirstColumnColor(): string | null; - getFirstRowColor(): string | null; - getFooterColumnColor(): string | null; - getFooterRowColor(): string | null; - getHeaderColumnColor(): string | null; - getHeaderRowColor(): string | null; - getRange(): Range; - getSecondColumnColor(): string | null; - getSecondRowColor(): string | null; - remove(): void; - setFirstColumnColor(color: string | null): Banding; - setFirstRowColor(color: string | null): Banding; - setFooterColumnColor(color: string | null): Banding; - setFooterRowColor(color: string | null): Banding; - setHeaderColumnColor(color: string | null): Banding; - setHeaderRowColor(color: string | null): Banding; - setRange(range: Range): Banding; - setSecondColumnColor(color: string | null): Banding; - setSecondRowColor(color: string | null): Banding; - } - /** - * An enumeration of banding themes. Each theme consists of several complementary colors that are - * applied to different cells based on the banding settings. - */ - enum BandingTheme { - LIGHT_GREY, - CYAN, - GREEN, - YELLOW, - ORANGE, - BLUE, - TEAL, - GREY, - BROWN, - LIGHT_GREEN, - INDIGO, - PINK, - } - /** - * Access the existing BigQuery data source specification. To create a new data source - * specification, use SpreadsheetApp.newDataSourceSpec(). - */ - interface BigQueryDataSourceSpec { - copy(): DataSourceSpecBuilder; - getParameters(): DataSourceParameter[]; - getProjectId(): string; - getRawQuery(): string; - getType(): DataSourceType; - } - /** - * The builder for BigQueryDataSourceSpecBuilder. - */ - interface BigQueryDataSourceSpecBuilder { - build(): DataSourceSpec; - copy(): DataSourceSpecBuilder; - getParameters(): DataSourceParameter[]; - getProjectId(): string; - getRawQuery(): string; - getType(): DataSourceType; - removeAllParameters(): BigQueryDataSourceSpecBuilder; - removeParameter(parameterName: string): BigQueryDataSourceSpecBuilder; - setParameterFromCell(parameterName: string, sourceCell: string): BigQueryDataSourceSpecBuilder; - setProjectId(projectId: string): BigQueryDataSourceSpecBuilder; - setRawQuery(rawQuery: string): BigQueryDataSourceSpecBuilder; - } - /** - * Access boolean conditions in ConditionalFormatRules. Each - * conditional format rule may contain a single boolean condition. The boolean condition itself - * contains a boolean criteria (with values) and formatting settings. The criteria is evaluated - * against the content of a cell resulting in either a true or false value. If the - * criteria evaluates to true, the condition's formatting settings are applied to the cell. - */ - interface BooleanCondition { - getBackground(): string | null; - getBold(): boolean | null; - getCriteriaType(): BooleanCriteria; - getCriteriaValues(): any[]; - getFontColor(): string | null; - getItalic(): boolean | null; - getStrikethrough(): boolean | null; - getUnderline(): boolean | null; - } - /** - * An enumeration representing the boolean criteria that can be used in conditional format or - * filter. - */ - enum BooleanCriteria { - CELL_EMPTY, - CELL_NOT_EMPTY, - DATE_AFTER, - DATE_BEFORE, - DATE_EQUAL_TO, - DATE_AFTER_RELATIVE, - DATE_BEFORE_RELATIVE, - DATE_EQUAL_TO_RELATIVE, - NUMBER_BETWEEN, - NUMBER_EQUAL_TO, - NUMBER_GREATER_THAN, - NUMBER_GREATER_THAN_OR_EQUAL_TO, - NUMBER_LESS_THAN, - NUMBER_LESS_THAN_OR_EQUAL_TO, - NUMBER_NOT_BETWEEN, - NUMBER_NOT_EQUAL_TO, - TEXT_CONTAINS, - TEXT_DOES_NOT_CONTAIN, - TEXT_EQUAL_TO, - TEXT_STARTS_WITH, - TEXT_ENDS_WITH, - CUSTOM_FORMULA, - } - /** - * Styles that can be set on a range using Range.setBorder(top, left, bottom, right, vertical, horizontal, color, style). - */ - enum BorderStyle { - DOTTED, - DASHED, - SOLID, - SOLID_MEDIUM, - SOLID_THICK, - DOUBLE, - } - /** - * Represents an image to add to a cell. To add an image to a cell, you must create a new image - * value for the image using SpreadsheetApp.newCellImage() and CellImageBuilder. Then you can - * use Range.setValue(value) or Range.setValues(values) to add the image value to the cell. - */ - interface CellImage { - valueType: ValueType; - getAltTextDescription(): string; - getAltTextTitle(): string; - getContentUrl(): string; - getUrl(): string | null; - toBuilder(): CellImageBuilder; - } - /** - * Builder for CellImage. This builder creates the image value needed to add an image to a cell. - */ - interface CellImageBuilder { - valueType: ValueType; - build(): CellImage; - getAltTextDescription(): string; - getAltTextTitle(): string; - getContentUrl(): string; - getUrl(): string | null; - setAltTextDescription(description: string): CellImageBuilder; - setAltTextTitle(title: string): CellImageBuilder; - setSourceUrl(url: string): CellImageBuilder; - toBuilder(): CellImageBuilder; - } - /** - * A representation for a color. - */ - interface Color { - asRgbColor(): Base.RgbColor; - asThemeColor(): ThemeColor; - getColorType(): Base.ColorType; - } - /** - * The builder for ColorBuilder. To create a new builder, use SpreadsheetApp.newColor(). - */ - interface ColorBuilder { - asRgbColor(): Base.RgbColor; - asThemeColor(): ThemeColor; - build(): Color; - getColorType(): Base.ColorType; - setRgbColor(cssString: string): ColorBuilder; - setThemeColor(themeColorType: ThemeColorType): ColorBuilder; - } - /** - * Access conditional formatting rules. To create a new rule, use SpreadsheetApp.newConditionalFormatRule() and ConditionalFormatRuleBuilder. - * You can use Sheet.setConditionalFormatRules(rules) to set the - * rules for a given sheet. - */ - interface ConditionalFormatRule { - copy(): ConditionalFormatRuleBuilder; - getBooleanCondition(): BooleanCondition | null; - getGradientCondition(): GradientCondition | null; - getRanges(): Range[]; - } - /** - * Builder for conditional format rules. - * - * // Adds a conditional format rule to a sheet that causes cells in range A1:B3 to turn red if - * // they contain a number between 1 and 10. - * var sheet = SpreadsheetApp.getActiveSheet(); - * var range = sheet.getRange("A1:B3"); - * var rule = SpreadsheetApp.newConditionalFormatRule() - * .whenNumberBetween(1, 10) - * .setBackground("#FF0000") - * .setRanges([range]) - * .build(); - * var rules = sheet.getConditionalFormatRules(); - * rules.push(rule); - * sheet.setConditionalFormatRules(rules); - */ - interface ConditionalFormatRuleBuilder { - build(): ConditionalFormatRule; - copy(): ConditionalFormatRuleBuilder; - getBooleanCondition(): BooleanCondition | null; - getGradientCondition(): GradientCondition | null; - getRanges(): Range[]; - setBackground(color: string | null): ConditionalFormatRuleBuilder; - setBold(bold: boolean | null): ConditionalFormatRuleBuilder; - setFontColor(color: string | null): ConditionalFormatRuleBuilder; - setGradientMaxpoint(color: string): ConditionalFormatRuleBuilder; - setGradientMaxpointWithValue( - color: string, - type: InterpolationType, - value: string, - ): ConditionalFormatRuleBuilder; - setGradientMidpointWithValue( - color: string, - type: InterpolationType, - value: string, - ): ConditionalFormatRuleBuilder; - setGradientMinpoint(color: string): ConditionalFormatRuleBuilder; - setGradientMinpointWithValue( - color: string, - type: InterpolationType, - value: string, - ): ConditionalFormatRuleBuilder; - setItalic(italic: boolean | null): ConditionalFormatRuleBuilder; - setRanges(ranges: Range[]): ConditionalFormatRuleBuilder; - setStrikethrough(strikethrough: boolean | null): ConditionalFormatRuleBuilder; - setUnderline(underline: boolean | null): ConditionalFormatRuleBuilder; - whenCellEmpty(): ConditionalFormatRuleBuilder; - whenCellNotEmpty(): ConditionalFormatRuleBuilder; - whenDateAfter(date: Base.Date): ConditionalFormatRuleBuilder; - whenDateAfter(date: RelativeDate): ConditionalFormatRuleBuilder; - whenDateBefore(date: Base.Date): ConditionalFormatRuleBuilder; - whenDateBefore(date: RelativeDate): ConditionalFormatRuleBuilder; - whenDateEqualTo(date: Base.Date): ConditionalFormatRuleBuilder; - whenDateEqualTo(date: RelativeDate): ConditionalFormatRuleBuilder; - whenFormulaSatisfied(formula: string): ConditionalFormatRuleBuilder; - whenNumberBetween(start: number, end: number): ConditionalFormatRuleBuilder; - whenNumberEqualTo(number: number): ConditionalFormatRuleBuilder; - whenNumberGreaterThan(number: number): ConditionalFormatRuleBuilder; - whenNumberGreaterThanOrEqualTo(number: number): ConditionalFormatRuleBuilder; - whenNumberLessThan(number: number): ConditionalFormatRuleBuilder; - whenNumberLessThanOrEqualTo(number: number): ConditionalFormatRuleBuilder; - whenNumberNotBetween(start: number, end: number): ConditionalFormatRuleBuilder; - whenNumberNotEqualTo(number: number): ConditionalFormatRuleBuilder; - whenTextContains(text: string): ConditionalFormatRuleBuilder; - whenTextDoesNotContain(text: string): ConditionalFormatRuleBuilder; - whenTextEndsWith(text: string): ConditionalFormatRuleBuilder; - whenTextEqualTo(text: string): ConditionalFormatRuleBuilder; - whenTextStartsWith(text: string): ConditionalFormatRuleBuilder; - withCriteria(criteria: BooleanCriteria, args: any[]): ConditionalFormatRuleBuilder; - } - /** - * Access the chart's position within a sheet. Can be updated using the EmbeddedChart.modify() function. - * - * chart = chart.modify().setPosition(5, 5, 0, 0).build(); - * sheet.updateChart(chart); - */ - interface ContainerInfo { - getAnchorColumn(): Integer; - getAnchorRow(): Integer; - getOffsetX(): Integer; - getOffsetY(): Integer; - } - /** - * An enumeration of possible special paste types. - */ - enum CopyPasteType { - PASTE_NORMAL, - PASTE_NO_BORDERS, - PASTE_FORMAT, - PASTE_FORMULA, - PASTE_DATA_VALIDATION, - PASTE_VALUES, - PASTE_CONDITIONAL_FORMATTING, - PASTE_COLUMN_WIDTHS, - } - /** - * An enumeration of data execution error codes. - */ - enum DataExecutionErrorCode { - DATA_EXECUTION_ERROR_CODE_UNSUPPORTED, - NONE, - TIME_OUT, - TOO_MANY_ROWS, - TOO_MANY_CELLS, - ENGINE, - PARAMETER_INVALID, - UNSUPPORTED_DATA_TYPE, - DUPLICATE_COLUMN_NAMES, - INTERRUPTED, - OTHER, - TOO_MANY_CHARS_PER_CELL, - } - /** - * An enumeration of data execution states. - */ - enum DataExecutionState { - DATA_EXECUTION_STATE_UNSUPPORTED, - RUNNING, - SUCCESS, - ERROR, - NOT_STARTED, - } - /** - * The data execution status. - */ - interface DataExecutionStatus { - getErrorCode(): DataExecutionErrorCode; - getErrorMessage(): string; - getExecutionState(): DataExecutionState; - getLastRefreshedTime(): Base.Date | null; - isTruncated(): boolean; - } - /** - * Access and modify existing data source. To create a data source table with new data source, see - * DataSourceTable. - */ - interface DataSource { - getSpec(): DataSourceSpec; - updateSpec(spec: DataSourceSpec): DataSource; - } - /** - * Access and modify a data source column. - * - * Only use this class with data that's connected to a database. - */ - interface DataSourceColumn { - getDataSource(): DataSource; - getFormula(): string; - getName(): string; - hasArrayDependency(): boolean; - isCalculatedColumn(): boolean; - remove(): void; - setFormula(formula: string): DataSourceColumn; - setName(name: string): DataSourceColumn; - } - /** - * Access and modify existing data source formulas. - */ - interface DataSourceFormula { - forceRefreshData(): DataSourceFormula; - getAnchorCell(): Range; - getDataSource(): DataSource; - getDisplayValue(): string; - getFormula(): string; - getStatus(): DataExecutionStatus; - refreshData(): DataSourceFormula; - setFormula(formula: string): DataSourceFormula; - waitForCompletion(timeoutInSeconds: number): DataExecutionStatus; - } - /** - * Access existing data source parameters. - */ - interface DataSourceParameter { - getName(): string; - getSourceCell(): string | null; - getType(): DataSourceParameterType; - } - /** - * An enumeration of data source parameter types. - */ - enum DataSourceParameterType { - DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED, - CELL, - } - /** - * Access and modify existing data source pivot table. - * Only use this class with data that's connected to a database - */ - interface DataSourcePivotTable { - addColumnGroup(columnName: string): PivotGroup; - addFilter(columnName: string, filterCriteria: FilterCriteria): PivotFilter; - addPivotValue(columnName: string, summarizeFunction: PivotTableSummarizeFunction): PivotValue; - addRowGroup(columnName: string): PivotGroup; - asPivotTable(): PivotTable; - forceRefreshData(): DataSourcePivotTable; - getDataSource(): DataSource; - getStatus(): DataExecutionStatus; - refreshData(): DataSourcePivotTable; - waitForCompletion(timeoutInSeconds: number): DataExecutionStatus; - } - /** - * Access and modify existing data source sheet. To create a new data source sheet, use Spreadsheet.insertDataSourceSheet(spec). - * - * Only use this class with data that's connected to a database. - */ - interface DataSourceSheet { - addFilter(columnName: string, filterCriteria: FilterCriteria): DataSourceSheet; - asSheet(): Sheet; - autoResizeColumn(columnName: string): DataSourceSheet; - autoResizeColumns(columnNames: string[]): DataSourceSheet; - forceRefreshData(): DataSourceSheet; - getColumnWidth(columnName: string): number; - getDataSource(): DataSource; - getFilters(): DataSourceSheetFilter[]; - getSheetValues(columnName: string, startRow?: number, numRows?: number): any[]; - getSortSpecs(): SortSpec[]; - getStatus(): DataExecutionStatus; - refreshData(): DataSourceSheet; - removeFilters(columnName: string): DataSourceSheet; - removeSortSpec(columnName: string): DataSourceSheet; - setColumnWidth(columnName: string, width: number): DataSourceSheet; - setColumnWidths(columnNames: string[], width: number): DataSourceSheet; - setSortSpec(columnName: string, ascending: boolean): DataSourceSheet; - waitForCompletion(timeoutInSeconds: number): DataExecutionStatus; - } - /** - * Access and modify an existing data source sheet filter. To create a new data source sheet filter, use DataSourceSheet.addFilter(columnName, filterCriteria). - * - * Only use this class with data that's connected to a database. - */ - interface DataSourceSheetFilter { - getDataSourceColumn(): DataSourceColumn; - getDataSourceSheet(): DataSourceSheet; - getFilterCriteria(): FilterCriteria; - remove(): void; - setFilterCriteria(filterCriteria: FilterCriteria): DataSourceSheetFilter; - } - /** - * Access the general settings of an existing data source spec. To access data source spec for - * certain type, use as...() method. To create a new data source spec, use SpreadsheetApp.newDataSourceSpec(). - * - * This example shows how to get information from a BigQuery data source spec. - * - * var dataSourceTable = - * SpreadsheetApp.getActive().getSheetByName("Data Sheet 1").getDataSourceTables()[0]; - * var spec = dataSourceTable.getDataSource().getSpec(); - * if (spec.getType() == SpreadsheetApp.DataSourceType.BIGQUERY) { - * var bqSpec = spec.asBigQuery(); - * Logger.log("Project ID: %s\n", bqSpec.getProjectId()); - * Logger.log("Raw query string: %s\n", bqSpec.getRawQuery()); - * } - */ - interface DataSourceSpec { - asBigQuery(): BigQueryDataSourceSpec; - copy(): DataSourceSpecBuilder; - getParameters(): DataSourceParameter[]; - getType(): DataSourceType; - } - /** - * The builder for DataSourceSpec. To create a specification for certain type, use as...() method. To create a new builder, use SpreadsheetApp.newDataSourceSpec(). To use the specification, see DataSourceTable. - * - * This examples show how to build a BigQuery data source specification. - * - * var spec = SpreadsheetApp.newDataSourceSpec() - * .asBigQuery() - * .setProjectId('big_query_project') - * .setRawQuery('select @FIELD from table limit @LIMIT') - * .setParameterFromCell('FIELD', 'Sheet1!A1') - * .setParameterFromCell('LIMIT', 'namedRangeCell') - * .build(); - */ - interface DataSourceSpecBuilder { - asBigQuery(): BigQueryDataSourceSpecBuilder; - build(): DataSourceSpec; - copy(): DataSourceSpecBuilder; - getParameters(): DataSourceParameter[]; - getType(): DataSourceType; - removeAllParameters(): DataSourceSpecBuilder; - removeParameter(parameterName: string): DataSourceSpecBuilder; - setParameterFromCell(parameterName: string, sourceCell: string): DataSourceSpecBuilder; - } - /** - * Access and modify existing data source table. To create a new data source table on a new sheet, - * use Spreadsheet.insertSheetWithDataSourceTable(spec). - * - * This example shows how to create a new data source table. - * - * SpreadsheetApp.enableBigQueryExecution(); - * var spreadsheet = SpreadsheetApp.getActive(); - * var spec = SpreadsheetApp.newDataSourceSpec() - * .asBigQuery() - * .setProjectId('big_query_project') - * .setRawQuery('select @FIELD from table limit @LIMIT') - * .setParameterFromCell('FIELD', 'Sheet1!A1') - * .setParameterFromCell('LIMIT', 'namedRangeCell') - * .build(); - * // Starts data execution asynchronously. - * var dataSheet = spreadsheet.insertSheetWithDataSourceTable(spec); - * var dataSourceTable = dataSheet.getDataSourceTables()[0]; - * // waitForCompletion() blocks script execution until data execution completes. - * dataSourceTable.waitForCompletion(60); - * // Check status after execution. - * Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); - * - * This example shows how to edit a data source. - * - * SpreadsheetApp.enableBigQueryExecution(); - * var dataSheet = SpreadsheetApp.getActive().getSheetByName("Data Sheet 1"); - * var dataSourceTable = dataSheet.getDataSourceTables()[0]; - * var dataSource = dataSourceTable.getDataSource(); - * var newSpec = dataSource.getSpec() - * .copy() - * .asBigQuery() - * .setRawQuery('select name from table limit 2') - * .removeAllParameters() - * .build(); - * // Updates data source specification and starts data execution asynchronously. - * dataSource.updateSpec(newSpec); - * // Check status during execution. - * Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); - * // waitForCompletion() blocks script execution until data execution completes. - * dataSourceTable.waitForCompletion(60); - * // Check status after execution. - * Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState()); - */ - interface DataSourceTable { - forceRefreshData(): DataSourceTable; - getDataSource(): DataSource; - getRange(): Range; - getStatus(): DataExecutionStatus; - refreshData(): DataSourceTable; - waitForCompletion(timeoutInSeconds: Integer): DataExecutionStatus; - } - /** - * An enumeration of data source types. - */ - enum DataSourceType { - DATA_SOURCE_TYPE_UNSUPPORTED, - BIGQUERY, - } - /** - * Access data validation rules. To create a new rule, use SpreadsheetApp.newDataValidation() and DataValidationBuilder. You can use - * Range.setDataValidation(rule) to set the validation rule for a range. - * - * // Log information about the data validation rule for cell A1. - * var cell = SpreadsheetApp.getActive().getRange('A1'); - * var rule = cell.getDataValidation(); - * if (rule != null) { - * var criteria = rule.getCriteriaType(); - * var args = rule.getCriteriaValues(); - * Logger.log('The data validation rule is %s %s', criteria, args); - * } else { - * Logger.log('The cell does not have a data validation rule.') - * } - */ - interface DataValidation { - copy(): DataValidationBuilder; - getAllowInvalid(): boolean; - getCriteriaType(): DataValidationCriteria; - getCriteriaValues(): any[]; - getHelpText(): string; - } - /** - * Builder for data validation rules. - * - * // Set the data validation for cell A1 to require a value from B1:B10. - * var cell = SpreadsheetApp.getActive().getRange('A1'); - * var range = SpreadsheetApp.getActive().getRange('B1:B10'); - * var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build(); - * cell.setDataValidation(rule); - */ - interface DataValidationBuilder { - build(): DataValidation; - copy(): DataValidationBuilder; - getAllowInvalid(): boolean; - getCriteriaType(): DataValidationCriteria; - getCriteriaValues(): any[]; - getHelpText(): string | null; - requireCheckbox(): DataValidationBuilder; - requireCheckbox(checkedValue: any): DataValidationBuilder; - requireCheckbox(checkedValue: any, uncheckedValue: any): DataValidationBuilder; - requireDate(): DataValidationBuilder; - requireDateAfter(date: Base.Date): DataValidationBuilder; - requireDateBefore(date: Base.Date): DataValidationBuilder; - requireDateBetween(start: Base.Date, end: Base.Date): DataValidationBuilder; - requireDateEqualTo(date: Base.Date): DataValidationBuilder; - requireDateNotBetween(start: Base.Date, end: Base.Date): DataValidationBuilder; - requireDateOnOrAfter(date: Base.Date): DataValidationBuilder; - requireDateOnOrBefore(date: Base.Date): DataValidationBuilder; - requireFormulaSatisfied(formula: string): DataValidationBuilder; - requireNumberBetween(start: number, end: number): DataValidationBuilder; - requireNumberEqualTo(number: number): DataValidationBuilder; - requireNumberGreaterThan(number: number): DataValidationBuilder; - requireNumberGreaterThanOrEqualTo(number: number): DataValidationBuilder; - requireNumberLessThan(number: number): DataValidationBuilder; - requireNumberLessThanOrEqualTo(number: number): DataValidationBuilder; - requireNumberNotBetween(start: number, end: number): DataValidationBuilder; - requireNumberNotEqualTo(number: number): DataValidationBuilder; - requireTextContains(text: string): DataValidationBuilder; - requireTextDoesNotContain(text: string): DataValidationBuilder; - requireTextEqualTo(text: string): DataValidationBuilder; - requireTextIsEmail(): DataValidationBuilder; - requireTextIsUrl(): DataValidationBuilder; - requireValueInList(values: string[]): DataValidationBuilder; - requireValueInList(values: string[], showDropdown: boolean): DataValidationBuilder; - requireValueInRange(range: Range): DataValidationBuilder; - requireValueInRange(range: Range, showDropdown: boolean): DataValidationBuilder; - setAllowInvalid(allowInvalidData: boolean): DataValidationBuilder; - setHelpText(helpText: string): DataValidationBuilder; - withCriteria(criteria: DataValidationCriteria, args: any[]): DataValidationBuilder; - } - /** - * An enumeration representing the data validation criteria that can be set on a range. - * - * // Change existing data-validation rules that require a date in 2013 to require a date in 2014. - * var oldDates = [new Date('1/1/2013'), new Date('12/31/2013')]; - * var newDates = [new Date('1/1/2014'), new Date('12/31/2014')]; - * var sheet = SpreadsheetApp.getActiveSheet(); - * var range = sheet.getRange(1, 1, sheet.getMaxRows(), sheet.getMaxColumns()); - * var rules = range.getDataValidations(); - * - * for (var i = 0; i < rules.length; i++) { - * for (var j = 0; j < rules[i].length; j++) { - * var rule = rules[i][j]; - * - * if (rule != null) { - * var criteria = rule.getCriteriaType(); - * var args = rule.getCriteriaValues(); - * - * if (criteria == SpreadsheetApp.DataValidationCriteria.DATE_BETWEEN - * && args[0].getTime() == oldDates[0].getTime() - * && args[1].getTime() == oldDates[1].getTime()) { - * // Create a builder from the existing rule, then change the dates. - * rules[i][j] = rule.copy().withCriteria(criteria, newDates).build(); - * } - * } - * } - * } - * range.setDataValidations(rules); - */ - enum DataValidationCriteria { - DATE_AFTER, - DATE_BEFORE, - DATE_BETWEEN, - DATE_EQUAL_TO, - DATE_IS_VALID_DATE, - DATE_NOT_BETWEEN, - DATE_ON_OR_AFTER, - DATE_ON_OR_BEFORE, - NUMBER_BETWEEN, - NUMBER_EQUAL_TO, - NUMBER_GREATER_THAN, - NUMBER_GREATER_THAN_OR_EQUAL_TO, - NUMBER_LESS_THAN, - NUMBER_LESS_THAN_OR_EQUAL_TO, - NUMBER_NOT_BETWEEN, - NUMBER_NOT_EQUAL_TO, - TEXT_CONTAINS, - TEXT_DOES_NOT_CONTAIN, - TEXT_EQUAL_TO, - TEXT_IS_VALID_EMAIL, - TEXT_IS_VALID_URL, - VALUE_IN_LIST, - VALUE_IN_RANGE, - CUSTOM_FORMULA, - CHECKBOX, - } - /** - * Access and modify developer metadata. To create new developer metadata use Range.addDeveloperMetadata(key), Sheet.addDeveloperMetadata(key), or Spreadsheet.addDeveloperMetadata(key). - */ - interface DeveloperMetadata { - getId(): Integer; - getKey(): string; - getLocation(): DeveloperMetadataLocation; - getValue(): string | null; - getVisibility(): DeveloperMetadataVisibility; - moveToColumn(column: Range): DeveloperMetadata; - moveToRow(row: Range): DeveloperMetadata; - moveToSheet(sheet: Sheet): DeveloperMetadata; - moveToSpreadsheet(): DeveloperMetadata; - remove(): void; - setKey(key: string): DeveloperMetadata; - setValue(value: string): DeveloperMetadata; - setVisibility(visibility: DeveloperMetadataVisibility): DeveloperMetadata; - } - /** - * Search for developer metadata in a spreadsheet. To create new developer metadata finder use - * Range.createDeveloperMetadataFinder(), Sheet.createDeveloperMetadataFinder(), - * or Spreadsheet.createDeveloperMetadataFinder(). - */ - interface DeveloperMetadataFinder { - find(): DeveloperMetadata[]; - onIntersectingLocations(): DeveloperMetadataFinder; - withId(id: Integer): DeveloperMetadataFinder; - withKey(key: string): DeveloperMetadataFinder; - withLocationType(locationType: DeveloperMetadataLocationType): DeveloperMetadataFinder; - withValue(value: string): DeveloperMetadataFinder; - withVisibility(visibility: DeveloperMetadataVisibility): DeveloperMetadataFinder; - } - /** - * Access developer metadata location information. - */ - interface DeveloperMetadataLocation { - getColumn(): Range | null; - getLocationType(): DeveloperMetadataLocationType; - getRow(): Range | null; - getSheet(): Sheet | null; - getSpreadsheet(): Spreadsheet | null; - } - /** - * An enumeration of the types of developer metadata location types. - */ - enum DeveloperMetadataLocationType { - SPREADSHEET, - SHEET, - ROW, - COLUMN, - } - /** - * An enumeration of the types of developer metadata visibility. - */ - enum DeveloperMetadataVisibility { - DOCUMENT, - PROJECT, - } - /** - * An enumeration of possible directions along which data can be stored in a spreadsheet. - */ - enum Dimension { - COLUMNS, - ROWS, - } - /** - * An enumeration representing the possible directions that one can move within a spreadsheet using - * the arrow keys. - */ - enum Direction { - UP, - DOWN, - PREVIOUS, - NEXT, - } - /** - * Represents a drawing over a sheet in a spreadsheet. - */ - interface Drawing { - getContainerInfo(): ContainerInfo; - getHeight(): Integer; - getOnAction(): string; - getSheet(): Sheet; - getWidth(): Integer; - getZIndex(): number; - remove(): void; - setHeight(height: Integer): Drawing; - setOnAction(macroName: string): Drawing; - setPosition(anchorRowPos: Integer, anchorColPos: Integer, offsetX: Integer, offsetY: Integer): Drawing; - setWidth(width: Integer): Drawing; - setZIndex(zIndex: number): Drawing; - } - /** - * Builder for area charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedAreaChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedAreaChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedAreaChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedAreaChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedAreaChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPointStyle(style: Charts.PointStyle): EmbeddedAreaChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedAreaChartBuilder; - setStacked(): EmbeddedAreaChartBuilder; - setTitle(chartTitle: string): EmbeddedAreaChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - setXAxisTitle(title: string): EmbeddedAreaChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - setYAxisTitle(title: string): EmbeddedAreaChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedAreaChartBuilder; - useLogScale(): EmbeddedAreaChartBuilder; - } - /** - * Builder for bar charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedBarChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedBarChartBuilder; - reverseDirection(): EmbeddedBarChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedBarChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedBarChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedBarChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedBarChartBuilder; - setStacked(): EmbeddedBarChartBuilder; - setTitle(chartTitle: string): EmbeddedBarChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - setXAxisTitle(title: string): EmbeddedBarChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - setYAxisTitle(title: string): EmbeddedBarChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedBarChartBuilder; - useLogScale(): EmbeddedBarChartBuilder; - } - /** - * Represents a chart that has been embedded into a spreadsheet. - * - * This example shows how to modify an existing chart: - * - * var sheet = SpreadsheetApp.getActiveSheet(); - * var range = sheet.getRange("A2:B8") - * var chart = sheet.getCharts()[0]; - * chart = chart.modify() - * .addRange(range) - * .setOption('title', 'Updated!') - * .setOption('animation.duration', 500) - * .setPosition(2,2,0,0) - * .build(); - * sheet.updateChart(chart); - * - * This example shows how to create a new chart: - * - * function newChart(range, sheet) { - * var sheet = SpreadsheetApp.getActiveSheet(); - * var chartBuilder = sheet.newChart(); - * chartBuilder.addRange(range) - * .setChartType(Charts.ChartType.LINE) - * .setOption('title', 'My Line Chart!'); - * sheet.insertChart(chartBuilder.build()); - * } - */ - interface EmbeddedChart { - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getChartId(): Integer | null; - getContainerInfo(): ContainerInfo; - getHiddenDimensionStrategy(): Charts.ChartHiddenDimensionStrategy; - getMergeStrategy(): Charts.ChartMergeStrategy; - getNumHeaders(): Integer; - getOptions(): Charts.ChartOptions; - getRanges(): Range[]; - getTransposeRowsAndColumns(): boolean; - modify(): EmbeddedChartBuilder; - } - /** - * Builder used to edit an EmbeddedChart. Changes made to the chart are not saved until - * Sheet.updateChart(chart) is called on the rebuilt chart. - * - * var sheet = SpreadsheetApp.getActiveSheet(); - * var range = sheet.getRange("A1:B8"); - * var chart = sheet.getCharts()[0]; - * chart = chart.modify() - * .addRange(range) - * .setOption('title', 'Updated!') - * .setOption('animation.duration', 500) - * .setPosition(2,2,0,0) - * .build(); - * sheet.updateChart(chart); - */ - interface EmbeddedChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - } - /** - * Builder for column charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedColumnChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedColumnChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedColumnChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedColumnChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedColumnChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedColumnChartBuilder; - setStacked(): EmbeddedColumnChartBuilder; - setTitle(chartTitle: string): EmbeddedColumnChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - setXAxisTitle(title: string): EmbeddedColumnChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - setYAxisTitle(title: string): EmbeddedColumnChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedColumnChartBuilder; - useLogScale(): EmbeddedColumnChartBuilder; - } - /** - * Builder for combo charts. For more details, see the Gviz documentation. - */ - interface EmbeddedComboChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedComboChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedComboChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedComboChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedComboChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedComboChartBuilder; - setStacked(): EmbeddedComboChartBuilder; - setTitle(chartTitle: string): EmbeddedComboChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - setXAxisTitle(title: string): EmbeddedComboChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - setYAxisTitle(title: string): EmbeddedComboChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedComboChartBuilder; - useLogScale(): EmbeddedComboChartBuilder; - } - /** - * Builder for histogram charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedHistogramChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedHistogramChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedHistogramChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedHistogramChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedHistogramChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedHistogramChartBuilder; - setStacked(): EmbeddedHistogramChartBuilder; - setTitle(chartTitle: string): EmbeddedHistogramChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - setXAxisTitle(title: string): EmbeddedHistogramChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - setYAxisTitle(title: string): EmbeddedHistogramChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedHistogramChartBuilder; - useLogScale(): EmbeddedHistogramChartBuilder; - } - /** - * Builder for line charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedLineChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedLineChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedLineChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedLineChartBuilder; - setCurveStyle(style: Charts.CurveStyle): EmbeddedLineChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedLineChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPointStyle(style: Charts.PointStyle): EmbeddedLineChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setRange(start: number, end: number): EmbeddedLineChartBuilder; - setTitle(chartTitle: string): EmbeddedLineChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - setXAxisTitle(title: string): EmbeddedLineChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - setYAxisTitle(title: string): EmbeddedLineChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedLineChartBuilder; - useLogScale(): EmbeddedLineChartBuilder; - } - /** - * Builder for pie charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedPieChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - reverseCategories(): EmbeddedPieChartBuilder; - set3D(): EmbeddedPieChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedPieChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedPieChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedPieChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedPieChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setTitle(chartTitle: string): EmbeddedPieChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedPieChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - } - /** - * Builder for scatter charts. For more details, see the Gviz - * documentation. - */ - interface EmbeddedScatterChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - setBackgroundColor(cssValue: string): EmbeddedScatterChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setColors(cssValues: string[]): EmbeddedScatterChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setLegendPosition(position: Charts.Position): EmbeddedScatterChartBuilder; - setLegendTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPointStyle(style: Charts.PointStyle): EmbeddedScatterChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setTitle(chartTitle: string): EmbeddedScatterChartBuilder; - setTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - setXAxisLogScale(): EmbeddedScatterChartBuilder; - setXAxisRange(start: number, end: number): EmbeddedScatterChartBuilder; - setXAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - setXAxisTitle(title: string): EmbeddedScatterChartBuilder; - setXAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - setYAxisLogScale(): EmbeddedScatterChartBuilder; - setYAxisRange(start: number, end: number): EmbeddedScatterChartBuilder; - setYAxisTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - setYAxisTitle(title: string): EmbeddedScatterChartBuilder; - setYAxisTitleTextStyle(textStyle: Charts.TextStyle): EmbeddedScatterChartBuilder; - } - /** - * Builder for table charts. For more details, see the Gviz documentation. - */ - interface EmbeddedTableChartBuilder { - addRange(range: Range): EmbeddedChartBuilder; - asAreaChart(): EmbeddedAreaChartBuilder; - asBarChart(): EmbeddedBarChartBuilder; - asColumnChart(): EmbeddedColumnChartBuilder; - asComboChart(): EmbeddedComboChartBuilder; - asHistogramChart(): EmbeddedHistogramChartBuilder; - asLineChart(): EmbeddedLineChartBuilder; - asPieChart(): EmbeddedPieChartBuilder; - asScatterChart(): EmbeddedScatterChartBuilder; - asTableChart(): EmbeddedTableChartBuilder; - build(): EmbeddedChart; - clearRanges(): EmbeddedChartBuilder; - enablePaging(enablePaging: boolean): EmbeddedTableChartBuilder; - enablePaging(pageSize: Integer): EmbeddedTableChartBuilder; - enablePaging(pageSize: Integer, startPage: Integer): EmbeddedTableChartBuilder; - enableRtlTable(rtlEnabled: boolean): EmbeddedTableChartBuilder; - enableSorting(enableSorting: boolean): EmbeddedTableChartBuilder; - getChartType(): Charts.ChartType; - getContainer(): ContainerInfo; - getRanges(): Range[]; - removeRange(range: Range): EmbeddedChartBuilder; - setChartType(type: Charts.ChartType): EmbeddedChartBuilder; - setFirstRowNumber(number: Integer): EmbeddedTableChartBuilder; - setHiddenDimensionStrategy(strategy: Charts.ChartHiddenDimensionStrategy): EmbeddedChartBuilder; - setInitialSortingAscending(column: Integer): EmbeddedTableChartBuilder; - setInitialSortingDescending(column: Integer): EmbeddedTableChartBuilder; - setMergeStrategy(mergeStrategy: Charts.ChartMergeStrategy): EmbeddedChartBuilder; - setNumHeaders(headers: Integer): EmbeddedChartBuilder; - setOption(option: string, value: any): EmbeddedChartBuilder; - setPosition( - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): EmbeddedChartBuilder; - setTransposeRowsAndColumns(transpose: boolean): EmbeddedChartBuilder; - showRowNumberColumn(showRowNumber: boolean): EmbeddedTableChartBuilder; - useAlternatingRowStyle(alternate: boolean): EmbeddedTableChartBuilder; - } - /** - * Access and modify existing filters. To create a new filter, use Range.createFilter(). - */ - interface Filter { - getColumnFilterCriteria(columnPosition: Integer): FilterCriteria | null; - getRange(): Range; - remove(): void; - removeColumnFilterCriteria(columnPosition: Integer): Filter; - setColumnFilterCriteria(columnPosition: Integer, filterCriteria: FilterCriteria | null): Filter; - sort(columnPosition: Integer, ascending: boolean): Filter; - } - /** - * Access filter criteria. To create a new criteria, use SpreadsheetApp.newFilterCriteria() and FilterCriteriaBuilder. - */ - interface FilterCriteria { - copy(): FilterCriteriaBuilder; - getCriteriaType(): BooleanCriteria; - getCriteriaValues(): any[]; - getHiddenValues(): string[]; - getVisibleValues(): string[]; - } - /** - * Builder for FilterCriteria. - */ - interface FilterCriteriaBuilder { - build(): FilterCriteria; - copy(): FilterCriteriaBuilder; - getCriteriaType(): BooleanCriteria; - getCriteriaValues(): any[]; - getHiddenValues(): string[]; - getVisibleValues(): string[]; - setHiddenValues(values: string[]): FilterCriteriaBuilder; - setVisibleValues(values: string[]): FilterCriteriaBuilder; - whenCellEmpty(): FilterCriteriaBuilder; - whenCellNotEmpty(): FilterCriteriaBuilder; - whenDateAfter(date: Base.Date): FilterCriteriaBuilder; - whenDateAfter(date: RelativeDate): FilterCriteriaBuilder; - whenDateBefore(date: Base.Date): FilterCriteriaBuilder; - whenDateBefore(date: RelativeDate): FilterCriteriaBuilder; - whenDateEqualTo(date: Base.Date): FilterCriteriaBuilder; - whenDateEqualTo(date: RelativeDate): FilterCriteriaBuilder; - whenFormulaSatisfied(formula: string): FilterCriteriaBuilder; - whenNumberBetween(start: number, end: number): FilterCriteriaBuilder; - whenNumberEqualTo(number: number): FilterCriteriaBuilder; - whenNumberGreaterThan(number: number): FilterCriteriaBuilder; - whenNumberGreaterThanOrEqualTo(number: number): FilterCriteriaBuilder; - whenNumberLessThan(number: number): FilterCriteriaBuilder; - whenNumberLessThanOrEqualTo(number: number): FilterCriteriaBuilder; - whenNumberNotBetween(start: number, end: number): FilterCriteriaBuilder; - whenNumberNotEqualTo(number: number): FilterCriteriaBuilder; - whenTextContains(text: string): FilterCriteriaBuilder; - whenTextDoesNotContain(text: string): FilterCriteriaBuilder; - whenTextEndsWith(text: string): FilterCriteriaBuilder; - whenTextEqualTo(text: string): FilterCriteriaBuilder; - whenTextStartsWith(text: string): FilterCriteriaBuilder; - withCriteria(criteria: BooleanCriteria, args: any[]): FilterCriteriaBuilder; - } - /** - * Access gradient (color) conditions in ConditionalFormatRuleApis. - * Each conditional format rule may contain a single gradient condition. A gradient condition is - * defined by three points along a number scale (min, mid, and max), each of which has a color, a - * value, and a InterpolationType. The content of a cell is - * compared to the values in the number scale and the color applied to the cell is interpolated - * based on the cell content's proximity to the gradient condition min, mid, and max points. - * - * // Logs all the information inside gradient conditional format rules on a sheet. - * var sheet = SpreadsheetApp.getActiveSheet(); - * var rules = sheet.getConditionalFormatRules(); - * for (int i = 0; i < rules.length; i++) { - * var gradient = rules[i].getGradientCondition(); - * Logger.log("The conditional format gradient information for rule %d:\n - * MinColor %s, MinType %s, MinValue %s, \n - * MidColor %s, MidType %s, MidValue %s, \n - * MaxColor %s, MaxType %s, MaxValue %s \n", i, - * gradient.getMinColor(), gradient.getMinType(), gradient.getMinValue(), - * gradient.getMidColor(), gradient.getMidType(), gradient.getMidValue(), - * gradient.getMaxColor(), gradient.getMaxType(), gradient.getMaxValue()); - * } - */ - interface GradientCondition { - getMaxColor(): string; - getMaxType(): InterpolationType | null; - getMaxValue(): string; - getMidColor(): string; - getMidType(): InterpolationType | null; - getMidValue(): string; - getMinColor(): string; - getMinType(): InterpolationType | null; - getMinValue(): string; - } - /** - * Access and modify spreadsheet groups. Groups are an association between an interval of contiguous - * rows or columns that can be expanded or collapsed as a unit to hide/show the rows or columns. - * Each group has a control toggle on the row or column directly before or after the group - * (depending on settings) that can expand or collapse the group as a whole. - * - * The depth of a group refers to the nested position of the group and how many larger - * groups contain the group. The collapsed state of a group refers to whether the group - * should remain collapsed or expanded after a parent group has been expanded. Additionally, at the - * time that a group is collapsed or expanded, the rows or columns within the group are hidden or - * set visible, though individual rows or columns can be hidden or set visible irrespective of the - * collapsed state. - */ - interface Group { - collapse(): Group; - expand(): Group; - getControlIndex(): Integer; - getDepth(): Integer; - getRange(): Range; - isCollapsed(): boolean; - remove(): void; - } - /** - * An enumeration representing the possible positions that a group control toggle can have. - */ - enum GroupControlTogglePosition { - BEFORE, - AFTER, - } - /** - * An enumeration representing the interpolation options for calculating a value to be used in a - * GradientCondition in a ConditionalFormatRule. - */ - enum InterpolationType { - NUMBER, - PERCENT, - PERCENTILE, - MIN, - MAX, - } - /** - * Create, access and modify named ranges in a spreadsheet. Named ranges are ranges that have - * associated string aliases. They can be viewed and edited via the Sheets UI under the Data > - * Named ranges... menu. - */ - interface NamedRange { - getName(): string; - getRange(): Range; - remove(): void; - setName(name: string): NamedRange; - setRange(range: Range): NamedRange; - } - /** - * Represents an image over the grid in a spreadsheet. - */ - interface OverGridImage { - assignScript(functionName: string): OverGridImage; - getAltTextDescription(): string; - getAltTextTitle(): string; - getAnchorCell(): Range; - getAnchorCellXOffset(): Integer; - getAnchorCellYOffset(): Integer; - getHeight(): Integer; - getInherentHeight(): Integer; - getInherentWidth(): Integer; - getScript(): string; - getSheet(): Sheet; - getUrl(): string | null; - getWidth(): Integer; - remove(): void; - replace(blob: Base.BlobSource): OverGridImage; - replace(url: string): OverGridImage; - resetSize(): OverGridImage; - setAltTextDescription(description: string): OverGridImage; - setAltTextTitle(title: string): OverGridImage; - setAnchorCell(cell: Range): OverGridImage; - setAnchorCellXOffset(offset: Integer): OverGridImage; - setAnchorCellYOffset(offset: Integer): OverGridImage; - setHeight(height: Integer): OverGridImage; - setWidth(width: Integer): OverGridImage; - } - /** - * Deprecated. For spreadsheets created in the newer version of Google Sheets, use the more powerful - * Protection class instead. Although this class is deprecated, it remains available - * for compatibility with the older version of Sheets. - * Access and modify protected sheets in the older version of Google Sheets. - */ - interface PageProtection { - /** @deprecated DO NOT USE */ addUser(email: string): void; - /** @deprecated DO NOT USE */ getUsers(): string[]; - /** @deprecated DO NOT USE */ isProtected(): boolean; - /** @deprecated DO NOT USE */ removeUser(user: string): void; - /** @deprecated DO NOT USE */ setProtected(protection: boolean): void; - } - /** - * Access and modify pivot table filters. - */ - interface PivotFilter { - getFilterCriteria(): FilterCriteria; - getPivotTable(): PivotTable; - getSourceDataColumn(): Integer; - remove(): void; - setFilterCriteria(filterCriteria: FilterCriteria): PivotFilter; - } - /** - * Access and modify pivot table breakout groups. - */ - interface PivotGroup { - addManualGroupingRule(groupName: string, groupMembers: any[]): PivotGroup; - areLabelsRepeated(): boolean; - clearGroupingRule(): PivotGroup; - clearSort(): PivotGroup; - getDimension(): Dimension; - getIndex(): Integer; - getPivotTable(): PivotTable; - getSourceDataColumn(): Integer; - hideRepeatedLabels(): PivotGroup; - isSortAscending(): boolean; - moveToIndex(index: Integer): PivotGroup; - remove(): void; - removeManualGroupingRule(groupName: string): PivotGroup; - resetDisplayName(): PivotGroup; - setDisplayName(name: string): PivotGroup; - setHistogramGroupingRule(minValue: Integer, maxValue: Integer, intervalSize: Integer): PivotGroup; - showRepeatedLabels(): PivotGroup; - showTotals(showTotals: boolean): PivotGroup; - sortAscending(): PivotGroup; - sortBy(value: PivotValue, oppositeGroupValues: any[]): PivotGroup; - sortDescending(): PivotGroup; - totalsAreShown(): boolean; - } - /** - * Access and modify pivot tables. - */ - interface PivotTable { - addCalculatedPivotValue(name: string, formula: string): PivotValue; - addColumnGroup(sourceDataColumn: Integer): PivotGroup; - addFilter(sourceDataColumn: Integer, filterCriteria: FilterCriteria): PivotFilter; - addPivotValue(sourceDataColumn: Integer, summarizeFunction: PivotTableSummarizeFunction): PivotValue; - addRowGroup(sourceDataColumn: Integer): PivotGroup; - getAnchorCell(): Range; - getColumnGroups(): PivotGroup[]; - getFilters(): PivotFilter[]; - getPivotValues(): PivotValue[]; - getRowGroups(): PivotGroup[]; - getValuesDisplayOrientation(): Dimension; - remove(): void; - setValuesDisplayOrientation(dimension: Dimension): PivotTable; - } - /** - * An enumeration of functions that summarize pivot table data. - */ - enum PivotTableSummarizeFunction { - CUSTOM, - SUM, - COUNTA, - COUNT, - COUNTUNIQUE, - AVERAGE, - MAX, - MIN, - MEDIAN, - PRODUCT, - STDEV, - STDEVP, - VAR, - VARP, - } - /** - * Access and modify value groups in pivot tables. - */ - interface PivotValue { - getDisplayType(): PivotValueDisplayType; - getFormula(): string | null; - getPivotTable(): PivotTable; - getSummarizedBy(): PivotTableSummarizeFunction; - setDisplayName(name: string): PivotValue; - setFormula(formula: string): PivotValue; - showAs(displayType: PivotValueDisplayType): PivotValue; - summarizeBy(summarizeFunction: PivotTableSummarizeFunction): PivotValue; - } - /** - * An enumeration of ways to display a pivot value as a function of another value. - */ - enum PivotValueDisplayType { - DEFAULT, - PERCENT_OF_ROW_TOTAL, - PERCENT_OF_COLUMN_TOTAL, - PERCENT_OF_GRAND_TOTAL, - } - /** - * Access and modify protected ranges and sheets. A protected range can protect either a static - * range of cells or a named range. A protected sheet may include unprotected regions. For - * spreadsheets created with the older version of Google Sheets, use the PageProtection - * class instead. - * - * // Protect range A1:B10, then remove all other users from the list of editors. - * var ss = SpreadsheetApp.getActive(); - * var range = ss.getRange('A1:B10'); - * var protection = range.protect().setDescription('Sample protected range'); - * - * // Ensure the current user is an editor before removing others. Otherwise, if the user's edit - * // permission comes from a group, the script throws an exception upon removing the group. - * var me = Session.getEffectiveUser(); - * protection.addEditor(me); - * protection.removeEditors(protection.getEditors()); - * if (protection.canDomainEdit()) { - * protection.setDomainEdit(false); - * } - * - * // Remove all range protections in the spreadsheet that the user has permission to edit. - * var ss = SpreadsheetApp.getActive(); - * var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE); - * for (var i = 0; i < protections.length; i++) { - * var protection = protections[i]; - * if (protection.canEdit()) { - * protection.remove(); - * } - * } - * - * // Protect the active sheet, then remove all other users from the list of editors. - * var sheet = SpreadsheetApp.getActiveSheet(); - * var protection = sheet.protect().setDescription('Sample protected sheet'); - * - * // Ensure the current user is an editor before removing others. Otherwise, if the user's edit - * // permission comes from a group, the script throws an exception upon removing the group. - * var me = Session.getEffectiveUser(); - * protection.addEditor(me); - * protection.removeEditors(protection.getEditors()); - * if (protection.canDomainEdit()) { - * protection.setDomainEdit(false); - * } - */ - interface Protection { - addEditor(emailAddress: string): Protection; - addEditor(user: Base.User): Protection; - addEditors(emailAddresses: string[]): Protection; - canDomainEdit(): boolean; - canEdit(): boolean; - getDescription(): string; - getEditors(): Base.User[]; - getProtectionType(): ProtectionType; - getRange(): Range; - getRangeName(): string | null; - getUnprotectedRanges(): Range[]; - isWarningOnly(): boolean; - remove(): void; - removeEditor(emailAddress: string): Protection; - removeEditor(user: Base.User): Protection; - removeEditors(emailAddresses: string[]): Protection; - removeEditors(users: Base.User[]): Protection; - setDescription(description: string): Protection; - setDomainEdit(editable: boolean): Protection; - setNamedRange(namedRange: NamedRange): Protection; - setRange(range: Range): Protection; - setRangeName(rangeName: string): Protection; - setUnprotectedRanges(ranges: Range[]): Protection; - setWarningOnly(warningOnly: boolean): Protection; - } - /** - * An enumeration representing the parts of a spreadsheet that can be protected from edits. - * - * // Remove all range protections in the spreadsheet that the user has permission to edit. - * var ss = SpreadsheetApp.getActive(); - * var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE); - * for (var i = 0; i < protections.length; i++) { - * var protection = protections[i]; - * if (protection.canEdit()) { - * protection.remove(); - * } - * } - * - * // Removes sheet protection from the active sheet, if the user has permission to edit it. - * var sheet = SpreadsheetApp.getActiveSheet(); - * var protection = sheet.getProtections(SpreadsheetApp.ProtectionType.SHEET)[0]; - * if (protection && protection.canEdit()) { - * protection.remove(); - * } - */ - enum ProtectionType { - RANGE, - SHEET, - } - - type FontLine = "none" | "underline" | "line-through"; - type FontStyle = "normal" | "italic"; - type FontWeight = "normal" | "bold"; - /** - * Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of - * adjacent cells in a sheet. - */ - interface Range { - activate(): Range; - activateAsCurrentCell(): Range; - addDeveloperMetadata(key: string): Range; - addDeveloperMetadata(key: string, visibility: DeveloperMetadataVisibility): Range; - addDeveloperMetadata(key: string, value: string): Range; - addDeveloperMetadata(key: string, value: string, visibility: DeveloperMetadataVisibility): Range; - applyColumnBanding(): Banding; - applyColumnBanding(bandingTheme: BandingTheme): Banding; - applyColumnBanding(bandingTheme: BandingTheme, showHeader: boolean, showFooter: boolean): Banding; - applyRowBanding(): Banding; - applyRowBanding(bandingTheme: BandingTheme): Banding; - applyRowBanding(bandingTheme: BandingTheme, showHeader: boolean, showFooter: boolean): Banding; - autoFill(destination: Range, series: AutoFillSeries): void; - autoFillToNeighbor(series: AutoFillSeries): void; - breakApart(): Range; - canEdit(): boolean; - check(): Range; - clear(): Range; - clear( - options: { - commentsOnly?: boolean | undefined; - contentsOnly?: boolean | undefined; - formatOnly?: boolean | undefined; - validationsOnly?: boolean | undefined; - skipFilteredRows?: boolean | undefined; - }, - ): Range; - clearContent(): Range; - clearDataValidations(): Range; - clearFormat(): Range; - clearNote(): Range; - collapseGroups(): Range; - copyFormatToRange( - gridId: Integer, - column: Integer, - columnEnd: Integer, - row: Integer, - rowEnd: Integer, - ): void; - copyFormatToRange(sheet: Sheet, column: Integer, columnEnd: Integer, row: Integer, rowEnd: Integer): void; - copyTo(destination: Range): void; - copyTo(destination: Range, copyPasteType: CopyPasteType, transposed: boolean): void; - copyTo( - destination: Range, - options: { formatOnly?: boolean | undefined; contentsOnly?: boolean | undefined }, - ): void; - copyValuesToRange( - gridId: Integer, - column: Integer, - columnEnd: Integer, - row: Integer, - rowEnd: Integer, - ): void; - copyValuesToRange(sheet: Sheet, column: Integer, columnEnd: Integer, row: Integer, rowEnd: Integer): void; - createDataSourcePivotTable(dataSource: DataSource): DataSourcePivotTable; - createDataSourceTable(dataSource: DataSource): DataSourceTable; - createDeveloperMetadataFinder(): DeveloperMetadataFinder; - createFilter(): Filter; - createPivotTable(sourceData: Range): PivotTable; - createTextFinder(findText: string): TextFinder; - deleteCells(shiftDimension: Dimension): void; - expandGroups(): Range; - getA1Notation(): string; - getBackground(): string; - getBackgroundObject(): Color; - getBackgroundObjects(): Color[][]; - getBackgrounds(): string[][]; - getBandings(): Banding[]; - getCell(row: Integer, column: Integer): Range; - getColumn(): Integer; - getDataRegion(): Range; - getDataRegion(dimension: Dimension): Range; - getDataSourceFormula(): DataSourceFormula; - getDataSourceFormulas(): DataSourceFormula[]; - getDataSourcePivotTables(): DataSourcePivotTable[]; - getDataSourceTables(): DataSourceTable[]; - getDataSourceUrl(): string; - getDataTable(): Charts.DataTable; - getDataTable(firstRowIsHeader: boolean): Charts.DataTable; - getDataValidation(): DataValidation | null; - getDataValidations(): Array>; - getDeveloperMetadata(): DeveloperMetadata[]; - getDisplayValue(): string; - getDisplayValues(): string[][]; - getFilter(): Filter | null; - /** @deprecated Deprecated, use getFontColorObject */ getFontColor(): string; - /** @deprecated Deprecated, use getFontColorObjects */ getFontColors(): string[][]; - getFontColorObject(): Color; - getFontColorObjects(): Color[][]; - getFontFamilies(): string[][]; - getFontFamily(): string; - getFontLine(): FontLine; - getFontLines(): FontLine[][]; - getFontSize(): Integer; - getFontSizes(): Integer[][]; - getFontStyle(): FontStyle; - getFontStyles(): FontStyle[][]; - getFontWeight(): FontWeight; - getFontWeights(): FontWeight[][]; - getFormula(): string; - getFormulaR1C1(): string | null; - getFormulas(): string[][]; - getFormulasR1C1(): Array>; - getGridId(): Integer; - getHeight(): Integer; - getHorizontalAlignment(): string; - getHorizontalAlignments(): string[][]; - getLastColumn(): Integer; - getLastRow(): Integer; - getMergedRanges(): Range[]; - getNextDataCell(direction: Direction): Range; - getNote(): string; - getNotes(): string[][]; - getNumColumns(): Integer; - getNumRows(): Integer; - getNumberFormat(): string; - getNumberFormats(): string[][]; - getRichTextValue(): RichTextValue | null; - getRichTextValues(): Array>; - getRow(): Integer; - getRowIndex(): Integer; - getSheet(): Sheet; - getTextDirection(): TextDirection | null; - getTextDirections(): Array>; - getTextRotation(): TextRotation; - getTextRotations(): TextRotation[][]; - getTextStyle(): TextStyle; - getTextStyles(): TextStyle[][]; - getValue(): any; - getValues(): any[][]; - getVerticalAlignment(): string; - getVerticalAlignments(): string[][]; - getWidth(): Integer; - getWrap(): boolean; - getWrapStrategies(): WrapStrategy[][]; - getWrapStrategy(): WrapStrategy; - getWraps(): boolean[][]; - insertCells(shiftDimension: Dimension): Range; - insertCheckboxes(): Range; - insertCheckboxes(checkedValue: any): Range; - insertCheckboxes(checkedValue: any, uncheckedValue: any): Range; - isBlank(): boolean; - isChecked(): boolean | null; - isEndColumnBounded(): boolean; - isEndRowBounded(): boolean; - isPartOfMerge(): boolean; - isStartColumnBounded(): boolean; - isStartRowBounded(): boolean; - merge(): Range; - mergeAcross(): Range; - mergeVertically(): Range; - moveTo(target: Range): void; - offset(rowOffset: Integer, columnOffset: Integer): Range; - offset(rowOffset: Integer, columnOffset: Integer, numRows: Integer): Range; - offset(rowOffset: Integer, columnOffset: Integer, numRows: Integer, numColumns: Integer): Range; - protect(): Protection; - randomize(): Range; - removeCheckboxes(): Range; - removeDuplicates(): Range; - removeDuplicates(columnsToCompare: Integer[]): Range; - setBackground(color: string | null): Range; - setBackgroundObject(color: Color | null): Range; - setBackgroundObjects(color: Color[][] | null): Range; - setBackgroundRGB(red: Integer, green: Integer, blue: Integer): Range; - setBackgrounds(color: Array>): Range; - setBorder( - top: boolean | null, - left: boolean | null, - bottom: boolean | null, - right: boolean | null, - vertical: boolean | null, - horizontal: boolean | null, - ): Range; - setBorder( - top: boolean | null, - left: boolean | null, - bottom: boolean | null, - right: boolean | null, - vertical: boolean | null, - horizontal: boolean | null, - color: string | null, - style: BorderStyle | null, - ): Range; - setDataValidation(rule: DataValidation | null): Range; - setDataValidations(rules: Array>): Range; - setFontColor(color: string | null): Range; - setFontColorObject(color: Color | null): Range; - setFontColorObjects(colors: Array>): Range; - setFontColors(colors: any[][]): Range; - setFontFamilies(fontFamilies: Array>): Range; - setFontFamily(fontFamily: string | null): Range; - setFontLine(fontLine: FontLine | null): Range; - setFontLines(fontLines: Array>): Range; - setFontSize(size: Integer): Range; - setFontSizes(sizes: Integer[][]): Range; - setFontStyle(fontStyle: FontStyle | null): Range; - setFontStyles(fontStyles: Array>): Range; - setFontWeight(fontWeight: FontWeight | null): Range; - setFontWeights(fontWeights: Array>): Range; - setFormula(formula: string): Range; - setFormulaR1C1(formula: string): Range; - setFormulas(formulas: string[][]): Range; - setFormulasR1C1(formulas: string[][]): Range; - setHorizontalAlignment(alignment: "left" | "center" | "normal" | "right" | null): Range; - setHorizontalAlignments(alignments: Array>): Range; - setNote(note: string | null): Range; - setNotes(notes: Array>): Range; - setNumberFormat(numberFormat: string): Range; - setNumberFormats(numberFormats: string[][]): Range; - setRichTextValue(value: RichTextValue): Range; - setRichTextValues(values: RichTextValue[][]): Range; - setShowHyperlink(showHyperlink: boolean): Range; - setTextDirection(direction: TextDirection | null): Range; - setTextDirections(directions: Array>): Range; - setTextRotation(degrees: Integer): Range; - setTextRotation(rotation: TextRotation): Range; - setTextRotations(rotations: TextRotation[][]): Range; - setTextStyle(style: TextStyle): Range; - setTextStyles(styles: TextStyle[][]): Range; - setValue(value: any): Range; - setValues(values: any[][]): Range; - setVerticalAlignment(alignment: "top" | "middle" | "bottom" | null): Range; - setVerticalAlignments(alignments: Array>): Range; - setVerticalText(isVertical: boolean): Range; - setWrap(isWrapEnabled: boolean): Range; - setWrapStrategies(strategies: WrapStrategy[][]): Range; - setWrapStrategy(strategy: WrapStrategy): Range; - setWraps(isWrapEnabled: boolean[][]): Range; - shiftColumnGroupDepth(delta: Integer): Range; - shiftRowGroupDepth(delta: Integer): Range; - sort(sortSpecObj: any): Range; - splitTextToColumns(): void; - splitTextToColumns(delimiter: string): void; - splitTextToColumns(delimiter: TextToColumnsDelimiter): void; - trimWhitespace(): Range; - uncheck(): Range; - } - /** - * A collection of one or more Range instances in the same sheet. You can use this class - * to apply operations on collections of non-adjacent ranges or cells. - */ - interface RangeList { - activate(): RangeList; - breakApart(): RangeList; - check(): RangeList; - clear(): RangeList; - clear( - options: { - commentsOnly?: boolean | undefined; - contentsOnly?: boolean | undefined; - formatOnly?: boolean | undefined; - validationsOnly?: boolean | undefined; - skipFilteredRows?: boolean | undefined; - }, - ): RangeList; - clearContent(): RangeList; - clearDataValidations(): RangeList; - clearFormat(): RangeList; - clearNote(): RangeList; - getRanges(): Range[]; - insertCheckboxes(): RangeList; - insertCheckboxes(checkedValue: any): RangeList; - insertCheckboxes(checkedValue: any, uncheckedValue: any): RangeList; - removeCheckboxes(): RangeList; - setBackground(color: string | null): RangeList; - setBackgroundRGB(red: Integer, green: Integer, blue: Integer): RangeList; - setBorder( - top: boolean | null, - left: boolean | null, - bottom: boolean | null, - right: boolean | null, - vertical: boolean | null, - horizontal: boolean | null, - ): RangeList; - setBorder( - top: boolean | null, - left: boolean | null, - bottom: boolean | null, - right: boolean | null, - vertical: boolean | null, - horizontal: boolean | null, - color: string | null, - style: BorderStyle | null, - ): RangeList; - setFontColor(color: string | null): RangeList; - setFontFamily(fontFamily: string | null): RangeList; - setFontLine(fontLine: FontLine | null): RangeList; - setFontSize(size: Integer): RangeList; - setFontStyle(fontStyle: FontStyle | null): RangeList; - setFontWeight(fontWeight: FontWeight | null): RangeList; - setFormula(formula: string): RangeList; - setFormulaR1C1(formula: string): RangeList; - setHorizontalAlignment(alignment: "left" | "center" | "normal" | "right" | null): RangeList; - setNote(note: string | null): RangeList; - setNumberFormat(numberFormat: string): RangeList; - setShowHyperlink(showHyperlink: boolean): RangeList; - setTextDirection(direction: TextDirection | null): RangeList; - setTextRotation(degrees: Integer): RangeList; - setValue(value: any): RangeList; - setVerticalAlignment(alignment: "top" | "middle" | "bottom" | null): RangeList; - setVerticalText(isVertical: boolean): RangeList; - setWrap(isWrapEnabled: boolean): RangeList; - setWrapStrategy(strategy: WrapStrategy): RangeList; - trimWhitespace(): RangeList; - uncheck(): RangeList; - } - /** - * An enumeration representing the possible intervals used in spreadsheet recalculation. - */ - enum RecalculationInterval { - ON_CHANGE, - MINUTE, - HOUR, - } - /** - * An enumeration representing the relative date options for calculating a value to be used in - * date-based BooleanCriteria. - */ - enum RelativeDate { - TODAY, - TOMORROW, - YESTERDAY, - PAST_WEEK, - PAST_MONTH, - PAST_YEAR, - } - /** - * A stylized text string used to represent cell text. Substrings of the text can have different - * text styles. - * - * A run is the longest unbroken substring having the same text style. For example, the - * sentence "This kid has two apples." has four runs: ["This ", "kid ", "has two ", - * "apples."]. - */ - interface RichTextValue { - copy(): RichTextValueBuilder; - getEndIndex(): Integer; - getLinkUrl(): string | null; - getLinkUrl(startOffset: Integer, endOffset: Integer): string | null; - getRuns(): RichTextValue[]; - getStartIndex(): Integer; - getText(): string; - getTextStyle(): TextStyle; - getTextStyle(startOffset: Integer, endOffset: Integer): TextStyle; - } - /** - * A builder for Rich Text values. - */ - interface RichTextValueBuilder { - build(): RichTextValue; - setLinkUrl(startOffset: Integer, endOffset: Integer, linkUrl: string | null): RichTextValueBuilder; - setLinkUrl(linkUrl: string | null): RichTextValueBuilder; - setText(text: string): RichTextValueBuilder; - setTextStyle(startOffset: Integer, endOffset: Integer, textStyle: TextStyle | null): RichTextValueBuilder; - setTextStyle(textStyle: TextStyle | null): RichTextValueBuilder; - } - /** - * Access the current active selection in the active sheet. A selection is the set of cells the user - * has highlighted in the sheet, which can be non-adjacent ranges. One cell in the selection is the - * current cell, where the user's current focus is. The current cell is highlighted with a - * darker border in the Google Sheets UI. - * - * var activeSheet = SpreadsheetApp.getActiveSheet(); - * var rangeList = activeSheet.getRangeList(['A1:B4', 'D1:E4']); - * rangeList.activate(); - * - * var selection = activeSheet.getSelection(); - * // Current Cell: D1 - * Logger.log('Current Cell: ' + selection.getCurrentCell().getA1Notation()); - * // Active Range: D1:E4 - * Logger.log('Active Range: ' + selection.getActiveRange().getA1Notation()); - * // Active Ranges: A1:B4, D1:E4 - * var ranges = selection.getActiveRangeList().getRanges(); - * for (var i = 0; i < ranges.length; i++) { - * Logger.log('Active Ranges: ' + ranges[i].getA1Notation()); - * } - * Logger.log('Active Sheet: ' + selection.getActiveSheet().getName()); - */ - interface Selection { - getActiveRange(): Range | null; - getActiveRangeList(): RangeList | null; - getActiveSheet(): Sheet; - getCurrentCell(): Range | null; - getNextDataRange(direction: Direction): Range | null; - } - /** - * Access and modify spreadsheet sheets. Common operations are renaming a sheet and accessing range - * objects from the sheet. - */ - interface Sheet { - activate(): Sheet; - addDeveloperMetadata(key: string): Sheet; - addDeveloperMetadata(key: string, visibility: DeveloperMetadataVisibility): Sheet; - addDeveloperMetadata(key: string, value: string): Sheet; - addDeveloperMetadata(key: string, value: string, visibility: DeveloperMetadataVisibility): Sheet; - appendRow(rowContents: any[]): Sheet; - asDataSourceSheet(): DataSourceSheet | null; - autoResizeColumn(columnPosition: Integer): Sheet; - autoResizeColumns(startColumn: Integer, numColumns: Integer): Sheet; - autoResizeRows(startRow: Integer, numRows: Integer): Sheet; - clear(): Sheet; - clear(options: { formatOnly?: boolean | undefined; contentsOnly?: boolean | undefined }): Sheet; - clearConditionalFormatRules(): void; - clearContents(): Sheet; - clearFormats(): Sheet; - clearNotes(): Sheet; - collapseAllColumnGroups(): Sheet; - collapseAllRowGroups(): Sheet; - copyTo(spreadsheet: Spreadsheet): Sheet; - createDeveloperMetadataFinder(): DeveloperMetadataFinder; - createTextFinder(findText: string): TextFinder; - deleteColumn(columnPosition: Integer): Sheet; - deleteColumns(columnPosition: Integer, howMany: Integer): void; - deleteRow(rowPosition: Integer): Sheet; - deleteRows(rowPosition: Integer, howMany: Integer): void; - expandAllColumnGroups(): Sheet; - expandAllRowGroups(): Sheet; - expandColumnGroupsUpToDepth(groupDepth: Integer): Sheet; - expandRowGroupsUpToDepth(groupDepth: Integer): Sheet; - getActiveCell(): Range; - getActiveRange(): Range | null; - getActiveRangeList(): RangeList | null; - getBandings(): Banding[]; - getCharts(): EmbeddedChart[]; - getColumnGroup(columnIndex: Integer, groupDepth: Integer): Group | null; - getColumnGroupControlPosition(): GroupControlTogglePosition; - getColumnGroupDepth(columnIndex: Integer): Integer; - getColumnWidth(columnPosition: Integer): Integer; - getConditionalFormatRules(): ConditionalFormatRule[]; - getCurrentCell(): Range | null; - getDataRange(): Range; - getDataSourceTables(): DataSourceTable[]; - getDeveloperMetadata(): DeveloperMetadata[]; - getDrawings(): Drawing[]; - getFilter(): Filter | null; - getFormUrl(): string | null; - getFrozenColumns(): Integer; - getFrozenRows(): Integer; - getImages(): OverGridImage[]; - getIndex(): Integer; - getLastColumn(): Integer; - getLastRow(): Integer; - getMaxColumns(): Integer; - getMaxRows(): Integer; - getName(): string; - getNamedRanges(): NamedRange[]; - getParent(): Spreadsheet; - getPivotTables(): PivotTable[]; - getProtections(type: ProtectionType): Protection[]; - getRange(row: Integer, column: Integer): Range; - getRange(row: Integer, column: Integer, numRows: Integer): Range; - getRange(row: Integer, column: Integer, numRows: Integer, numColumns: Integer): Range; - getRange(a1Notation: string): Range; - getRangeList(a1Notations: string[]): RangeList; - getRowGroup(rowIndex: Integer, groupDepth: Integer): Group | null; - getRowGroupControlPosition(): GroupControlTogglePosition; - getRowGroupDepth(rowIndex: Integer): Integer; - getRowHeight(rowPosition: Integer): Integer; - getSelection(): Selection; - getSheetId(): Integer; - getSheetName(): string; - getSheetValues(startRow: Integer, startColumn: Integer, numRows: Integer, numColumns: Integer): any[][]; - getSlicers(): Slicer[]; - getTabColor(): string | null; - getType(): SheetType; - hasHiddenGridlines(): boolean; - hideColumn(column: Range): void; - hideColumns(columnIndex: Integer): void; - hideColumns(columnIndex: Integer, numColumns: Integer): void; - hideRow(row: Range): void; - hideRows(rowIndex: Integer): void; - hideRows(rowIndex: Integer, numRows: Integer): void; - hideSheet(): Sheet; - insertChart(chart: EmbeddedChart): void; - insertColumnAfter(afterPosition: Integer): Sheet; - insertColumnBefore(beforePosition: Integer): Sheet; - insertColumns(columnIndex: Integer): void; - insertColumns(columnIndex: Integer, numColumns: Integer): void; - insertColumnsAfter(afterPosition: Integer, howMany: Integer): Sheet; - insertColumnsBefore(beforePosition: Integer, howMany: Integer): Sheet; - insertImage(blobSource: Base.BlobSource, column: Integer, row: Integer): OverGridImage; - insertImage( - blobSource: Base.BlobSource, - column: Integer, - row: Integer, - offsetX: Integer, - offsetY: Integer, - ): OverGridImage; - insertImage(url: string, column: Integer, row: Integer): OverGridImage; - insertImage(url: string, column: Integer, row: Integer, offsetX: Integer, offsetY: Integer): OverGridImage; - insertRowAfter(afterPosition: Integer): Sheet; - insertRowBefore(beforePosition: Integer): Sheet; - insertRows(rowIndex: Integer): void; - insertRows(rowIndex: Integer, numRows: Integer): void; - insertRowsAfter(afterPosition: Integer, howMany: Integer): Sheet; - insertRowsBefore(beforePosition: Integer, howMany: Integer): Sheet; - insertSlicer(range: Range, anchorRowPos: Integer, anchorColPos: Integer): Slicer; - insertSlicer( - range: Range, - anchorRowPos: Integer, - anchorColPos: Integer, - offsetX: Integer, - offsetY: Integer, - ): Slicer; - isColumnHiddenByUser(columnPosition: Integer): boolean; - isRightToLeft(): boolean; - isRowHiddenByFilter(rowPosition: Integer): boolean; - isRowHiddenByUser(rowPosition: Integer): boolean; - isSheetHidden(): boolean; - moveColumns(columnSpec: Range, destinationIndex: Integer): void; - moveRows(rowSpec: Range, destinationIndex: Integer): void; - newChart(): EmbeddedChartBuilder; - protect(): Protection; - removeChart(chart: EmbeddedChart): void; - setActiveRange(range: Range): Range; - setActiveRangeList(rangeList: RangeList): RangeList; - setActiveSelection(range: Range): Range; - setActiveSelection(a1Notation: string): Range; - setColumnGroupControlPosition(position: GroupControlTogglePosition): Sheet; - setColumnWidth(columnPosition: Integer, width: Integer): Sheet; - setColumnWidths(startColumn: Integer, numColumns: Integer, width: Integer): Sheet; - setConditionalFormatRules(rules: ConditionalFormatRule[]): void; - setCurrentCell(cell: Range): Range; - setFrozenColumns(columns: Integer): void; - setFrozenRows(rows: Integer): void; - setHiddenGridlines(hideGridlines: boolean): Sheet; - setName(name: string): Sheet; - setRightToLeft(rightToLeft: boolean): Sheet; - setRowGroupControlPosition(position: GroupControlTogglePosition): Sheet; - setRowHeight(rowPosition: Integer, height: Integer): Sheet; - setRowHeights(startRow: Integer, numRows: Integer, height: Integer): Sheet; - setRowHeightsForced(startRow: Integer, numRows: Integer, height: Integer): Sheet; - setTabColor(color: string | null): Sheet; - showColumns(columnIndex: Integer): void; - showColumns(columnIndex: Integer, numColumns: Integer): void; - showRows(rowIndex: Integer): void; - showRows(rowIndex: Integer, numRows: Integer): void; - showSheet(): Sheet; - sort(columnPosition: Integer): Sheet; - sort(columnPosition: Integer, ascending: boolean): Sheet; - unhideColumn(column: Range): void; - unhideRow(row: Range): void; - updateChart(chart: EmbeddedChart): void; - /** @deprecated DO NOT USE */ getSheetProtection(): PageProtection; - /** @deprecated DO NOT USE */ setSheetProtection(permissions: PageProtection): void; - } - /** - * The different types of sheets that can exist in a spreadsheet. - */ - enum SheetType { - GRID, - OBJECT, - } - /** - * Represents a slicer, which is used - * to filter ranges, charts and pivot tables in a non-collaborative manner. This class contains - * methods to access and modify existing slicers. To create a new slicer, use Sheet.insertSlicer(range, anchorRowPos, anchorColPos). - */ - interface Slicer { - getBackgroundColor(): string | null; - getColumnPosition(): Integer | null; - getContainerInfo(): ContainerInfo; - getFilterCriteria(): FilterCriteria | null; - getRange(): Range; - getTitle(): string; - getTitleHorizontalAlignment(): string; - getTitleTextStyle(): TextStyle; - isAppliedToPivotTables(): boolean; - remove(): void; - setApplyToPivotTables(applyToPivotTables: boolean): Slicer; - setBackgroundColor(color: string | null): Slicer; - setColumnFilterCriteria(columnPosition: Integer, filterCriteria: FilterCriteria | null): Slicer; - setPosition(anchorRowPos: Integer, anchorColPos: Integer, offsetX: Integer, offsetY: Integer): Slicer; - setRange(rangeApi: Range): Slicer; - setTitle(title: string): Slicer; - setTitleHorizontalAlignment(horizontalAlignment: string | null): Slicer; - setTitleTextStyle(textStyle: TextStyle): Slicer; - } - /** - * Access and modify Google Sheets files. Common operations are adding new sheets and adding - * collaborators. - */ - interface Spreadsheet { - addDeveloperMetadata(key: string): Spreadsheet; - addDeveloperMetadata(key: string, visibility: DeveloperMetadataVisibility): Spreadsheet; - addDeveloperMetadata(key: string, value: string): Spreadsheet; - addDeveloperMetadata(key: string, value: string, visibility: DeveloperMetadataVisibility): Spreadsheet; - addEditor(emailAddress: string): Spreadsheet; - addEditor(user: Base.User): Spreadsheet; - addEditors(emailAddresses: string[]): Spreadsheet; - addMenu(name: string, subMenus: Array<{ name: string; functionName: string } | null>): void; - addViewer(emailAddress: string): Spreadsheet; - addViewer(user: Base.User): Spreadsheet; - addViewers(emailAddresses: string[]): Spreadsheet; - appendRow(rowContents: any[]): Sheet; - autoResizeColumn(columnPosition: Integer): Sheet; - copy(name: string): Spreadsheet; - createDeveloperMetadataFinder(): DeveloperMetadataFinder; - createTextFinder(findText: string): TextFinder; - deleteActiveSheet(): Sheet; - deleteColumn(columnPosition: Integer): Sheet; - deleteColumns(columnPosition: Integer, howMany: Integer): void; - deleteRow(rowPosition: Integer): Sheet; - deleteRows(rowPosition: Integer, howMany: Integer): void; - deleteSheet(sheet: Sheet): void; - duplicateActiveSheet(): Sheet; - getActiveCell(): Range; - getActiveRange(): Range | null; - getActiveRangeList(): RangeList | null; - getActiveSheet(): Sheet; - getAs(contentType: string): Base.Blob; - getBandings(): Banding[]; - getBlob(): Base.Blob; - getColumnWidth(columnPosition: Integer): Integer; - getCurrentCell(): Range | null; - getDataRange(): Range; - getDataSourceTables(): DataSourceTable[]; - getDeveloperMetadata(): DeveloperMetadata[]; - getEditors(): Base.User[]; - getFormUrl(): string | null; - getFrozenColumns(): Integer; - getFrozenRows(): Integer; - getId(): string; - getImages(): OverGridImage[]; - getIterativeCalculationConvergenceThreshold(): number; - getLastColumn(): Integer; - getLastRow(): Integer; - getMaxIterativeCalculationCycles(): Integer; - getName(): string; - getNamedRanges(): NamedRange[]; - getNumSheets(): Integer; - getOwner(): Base.User | null; - getPredefinedSpreadsheetThemes(): SpreadsheetTheme[]; - getProtections(type: ProtectionType): Protection[]; - getRange(a1Notation: string): Range; - getRangeByName(name: string): Range | null; - getRangeList(a1Notations: string[]): RangeList; - getRecalculationInterval(): RecalculationInterval; - getRowHeight(rowPosition: Integer): Integer; - getSelection(): Selection; - getSheetByName(name: string): Sheet | null; - getSheetId(): Integer; - getSheetName(): string; - getSheetValues(startRow: Integer, startColumn: Integer, numRows: Integer, numColumns: Integer): any[][]; - getSheets(): Sheet[]; - getSpreadsheetLocale(): string; - getSpreadsheetTheme(): SpreadsheetTheme | null; - getSpreadsheetTimeZone(): string; - getUrl(): string; - getViewers(): Base.User[]; - hideColumn(column: Range): void; - hideRow(row: Range): void; - insertColumnAfter(afterPosition: Integer): Sheet; - insertColumnBefore(beforePosition: Integer): Sheet; - insertColumnsAfter(afterPosition: Integer, howMany: Integer): Sheet; - insertColumnsBefore(beforePosition: Integer, howMany: Integer): Sheet; - insertImage(blobSource: Base.BlobSource, column: Integer, row: Integer): OverGridImage; - insertImage( - blobSource: Base.BlobSource, - column: Integer, - row: Integer, - offsetX: Integer, - offsetY: Integer, - ): OverGridImage; - insertImage(url: string, column: Integer, row: Integer): OverGridImage; - insertImage(url: string, column: Integer, row: Integer, offsetX: Integer, offsetY: Integer): OverGridImage; - insertRowAfter(afterPosition: Integer): Sheet; - insertRowBefore(beforePosition: Integer): Sheet; - insertRowsAfter(afterPosition: Integer, howMany: Integer): Sheet; - insertRowsBefore(beforePosition: Integer, howMany: Integer): Sheet; - insertSheet(): Sheet; - insertSheet(sheetIndex: Integer): Sheet; - insertSheet(sheetIndex: Integer, options: { template?: Sheet | undefined }): Sheet; - insertSheet(options: { template?: Sheet | undefined }): Sheet; - insertSheet(sheetName: string): Sheet; - insertSheet(sheetName: string, sheetIndex: Integer): Sheet; - insertSheet(sheetName: string, sheetIndex: Integer, options: { template?: Sheet | undefined }): Sheet; - insertSheet(sheetName: string, options: { template?: Sheet | undefined }): Sheet; - insertSheetWithDataSourceTable(spec: DataSourceSpec): Sheet; - isColumnHiddenByUser(columnPosition: Integer): boolean; - isIterativeCalculationEnabled(): boolean; - isRowHiddenByFilter(rowPosition: Integer): boolean; - isRowHiddenByUser(rowPosition: Integer): boolean; - moveActiveSheet(pos: Integer): void; - moveChartToObjectSheet(chart: EmbeddedChart): Sheet; - removeEditor(emailAddress: string): Spreadsheet; - removeEditor(user: Base.User): Spreadsheet; - removeMenu(name: string): void; - removeNamedRange(name: string): void; - removeViewer(emailAddress: string): Spreadsheet; - removeViewer(user: Base.User): Spreadsheet; - rename(newName: string): void; - renameActiveSheet(newName: string): void; - resetSpreadsheetTheme(): SpreadsheetTheme; - setActiveRange(range: Range): Range; - setActiveRangeList(rangeList: RangeList): RangeList; - setActiveSelection(range: Range): Range; - setActiveSelection(a1Notation: string): Range; - setActiveSheet(sheet: Sheet): Sheet; - setActiveSheet(sheet: Sheet, restoreSelection: boolean): Sheet; - setColumnWidth(columnPosition: Integer, width: Integer): Sheet; - setCurrentCell(cell: Range): Range; - setFrozenColumns(columns: Integer): void; - setFrozenRows(rows: Integer): void; - setIterativeCalculationConvergenceThreshold(minThreshold: number): Spreadsheet; - setIterativeCalculationEnabled(isEnabled: boolean): Spreadsheet; - setMaxIterativeCalculationCycles(maxIterations: Integer): Spreadsheet; - setNamedRange(name: string, range: Range): void; - setRecalculationInterval(recalculationInterval: RecalculationInterval): Spreadsheet; - setRowHeight(rowPosition: Integer, height: Integer): Sheet; - setSpreadsheetLocale(locale: string): void; - setSpreadsheetTheme(theme: SpreadsheetTheme): SpreadsheetTheme; - setSpreadsheetTimeZone(timezone: string): void; - show(userInterface: HTML.HtmlOutput): void; - sort(columnPosition: Integer): Sheet; - sort(columnPosition: Integer, ascending: boolean): Sheet; - toast(msg: string): void; - toast(msg: string, title: string): void; - toast(msg: string, title: string, timeoutSeconds: number | null): void; - unhideColumn(column: Range): void; - unhideRow(row: Range): void; - updateMenu(name: string, subMenus: Array<{ name: string; functionName: string }>): void; - /** @deprecated DO NOT USE */ getSheetProtection(): PageProtection; - /** @deprecated DO NOT USE */ isAnonymousView(): boolean; - /** @deprecated DO NOT USE */ isAnonymousWrite(): boolean; - /** @deprecated DO NOT USE */ setAnonymousAccess( - anonymousReadAllowed: boolean, - anonymousWriteAllowed: boolean, - ): void; - /** @deprecated DO NOT USE */ setSheetProtection(permissions: PageProtection): void; - } - /** - * Access and create Google Sheets files. This class is the parent class for the Spreadsheet service. - */ - interface SpreadsheetApp { - AutoFillSeries: typeof AutoFillSeries; - BandingTheme: typeof BandingTheme; - BooleanCriteria: typeof BooleanCriteria; - BorderStyle: typeof BorderStyle; - ColorType: typeof Base.ColorType; - CopyPasteType: typeof CopyPasteType; - DataExecutionErrorCode: typeof DataExecutionErrorCode; - DataExecutionState: typeof DataExecutionState; - DataSourceParameterType: typeof DataSourceParameterType; - DataSourceType: typeof DataSourceType; - DataValidationCriteria: typeof DataValidationCriteria; - DeveloperMetadataLocationType: typeof DeveloperMetadataLocationType; - DeveloperMetadataVisibility: typeof DeveloperMetadataVisibility; - Dimension: typeof Dimension; - Direction: typeof Direction; - GroupControlTogglePosition: typeof GroupControlTogglePosition; - InterpolationType: typeof InterpolationType; - PivotTableSummarizeFunction: typeof PivotTableSummarizeFunction; - PivotValueDisplayType: typeof PivotValueDisplayType; - ProtectionType: typeof ProtectionType; - RecalculationInterval: typeof RecalculationInterval; - RelativeDate: typeof RelativeDate; - SheetType: typeof SheetType; - TextDirection: typeof TextDirection; - TextToColumnsDelimiter: typeof TextToColumnsDelimiter; - ThemeColorType: typeof ThemeColorType; - ValueType: typeof ValueType; - WrapStrategy: typeof WrapStrategy; - create(name: string): Spreadsheet; - create(name: string, rows: Integer, columns: Integer): Spreadsheet; - enableAllDataSourcesExecution(): void; - enableBigQueryExecution(): void; - flush(): void; - getActive(): Spreadsheet; - getActiveRange(): Range; - getActiveRangeList(): RangeList; - getActiveSheet(): Sheet; - getActiveSpreadsheet(): Spreadsheet; - getCurrentCell(): Range; - getSelection(): Selection; - getUi(): Base.Ui; - newCellImage(): CellImageBuilder; - newColor(): ColorBuilder; - newConditionalFormatRule(): ConditionalFormatRuleBuilder; - newDataSourceSpec(): DataSourceSpecBuilder; - newDataValidation(): DataValidationBuilder; - newFilterCriteria(): FilterCriteriaBuilder; - newRichTextValue(): RichTextValueBuilder; - newTextStyle(): TextStyleBuilder; - open(file: Drive.File): Spreadsheet; - openById(id: string): Spreadsheet; - openByUrl(url: string): Spreadsheet; - setActiveRange(range: Range): Range; - setActiveRangeList(rangeList: RangeList): RangeList; - setActiveSheet(sheet: Sheet): Sheet; - setActiveSheet(sheet: Sheet, restoreSelection: boolean): Sheet; - setActiveSpreadsheet(newActiveSpreadsheet: Spreadsheet): void; - setCurrentCell(cell: Range): Range; - } - /** - * Access and modify existing themes. To set a theme on a spreadsheet, use Spreadsheet.setSpreadsheetTheme(theme). - */ - interface SpreadsheetTheme { - getConcreteColor(themeColorType: ThemeColorType): Color; - getFontFamily(): string | null; - getThemeColors(): ThemeColorType[]; - setConcreteColor(themeColorType: ThemeColorType, color: Color): SpreadsheetTheme; - setConcreteColor( - themeColorType: ThemeColorType, - red: Integer, - green: Integer, - blue: Integer, - ): SpreadsheetTheme; - setFontFamily(fontFamily: string): SpreadsheetTheme; - } - /** - * An enumerations representing the sort order. - */ - enum SortOrder { - ASCENDING, - DESCENDING, - } - /** - * The sorting specification. - */ - interface SortSpec { - getBackgroundColor(): Color | null; - getDataSourceColumn(): DataSourceColumn; - getDimensionIndex(): number | null; - getForegroundColor(): Color | null; - getSortOrder(): SortOrder; - isAscending(): boolean; - } - /** - * An enumerations of text directions. - */ - enum TextDirection { - LEFT_TO_RIGHT, - RIGHT_TO_LEFT, - } - /** - * Find or replace text within a range, sheet or spreadsheet. Can also specify search options. - */ - interface TextFinder { - findAll(): Range[]; - findNext(): Range | null; - findPrevious(): Range | null; - getCurrentMatch(): Range | null; - ignoreDiacritics(ignoreDiacritics: boolean): TextFinder; - matchCase(matchCase: boolean): TextFinder; - matchEntireCell(matchEntireCell: boolean): TextFinder; - matchFormulaText(matchFormulaText: boolean): TextFinder; - replaceAllWith(replaceText: string): Integer; - replaceWith(replaceText: string): Integer; - startFrom(startRange: Range): TextFinder; - useRegularExpression(useRegEx: boolean): TextFinder; - } - /** - * Access the text rotation settings for a cell. - */ - interface TextRotation { - getDegrees(): Integer; - isVertical(): boolean; - } - /** - * The rendered style of text in a cell. - * - * Text styles can have a corresponding RichTextValue. If the RichTextValue spans multiple text runs that have different values for a given text style read - * method, the method returns null. To avoid this, query for text styles using the Rich Text - * values returned by the RichTextValue.getRuns() method. - */ - interface TextStyle { - copy(): TextStyleBuilder; - getFontFamily(): string | null; - getFontSize(): Integer | null; - getForegroundColor(): string | null; - getForegroundColorObject(): Color | null; - isBold(): boolean | null; - isItalic(): boolean | null; - isStrikethrough(): boolean | null; - isUnderline(): boolean | null; - } - /** - * A builder for text styles. - */ - interface TextStyleBuilder { - build(): TextStyle; - setBold(bold: boolean): TextStyleBuilder; - setFontFamily(fontFamily: string): TextStyleBuilder; - setFontSize(fontSize: Integer): TextStyleBuilder; - setForegroundColor(cssString: string): TextStyleBuilder; - setForegroundColorObject(color: Color): TextStyleBuilder; - setItalic(italic: boolean): TextStyleBuilder; - setStrikethrough(strikethrough: boolean): TextStyleBuilder; - setUnderline(underline: boolean): TextStyleBuilder; - } - /** - * An enumeration of the types of preset delimiters that can split a column of text into multiple - * columns. - */ - enum TextToColumnsDelimiter { - COMMA, - SEMICOLON, - PERIOD, - SPACE, - } - /** - * A representation for a theme color. - */ - interface ThemeColor { - getColorType(): Base.ColorType; - getThemeColorType(): ThemeColorType; - } - /** - * An enum which describes various color entries supported in themes. - */ - enum ThemeColorType { - UNSUPPORTED, - TEXT, - BACKGROUND, - ACCENT1, - ACCENT2, - ACCENT3, - ACCENT4, - ACCENT5, - ACCENT6, - HYPERLINK, - } - /** - * An enumeration of the value types returned by Range.getValue and Range.getValues() from the Range class of the Spreadsheet service. - * The enumeration values listed below are in addition to Number, Boolean, Date, or String. - */ - enum ValueType { - IMAGE, - } - /** - * An enumeration of the strategies used to handle cell text wrapping. - */ - enum WrapStrategy { - WRAP, - OVERFLOW, - CLIP, - } - } -} - -declare var SpreadsheetApp: GoogleAppsScript.Spreadsheet.SpreadsheetApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.types.d.ts b/node_modules/@types/google-apps-script/google-apps-script.types.d.ts deleted file mode 100644 index 5b1b33f..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.types.d.ts +++ /dev/null @@ -1,7 +0,0 @@ -declare namespace GoogleAppsScript { - type BigNumber = any; - type Byte = number; - type Integer = number; - type Char = string; - type JdbcSQL_XML = any; -} diff --git a/node_modules/@types/google-apps-script/google-apps-script.url-fetch.d.ts b/node_modules/@types/google-apps-script/google-apps-script.url-fetch.d.ts deleted file mode 100644 index e96e9fa..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.url-fetch.d.ts +++ /dev/null @@ -1,106 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace URL_Fetch { - /** - * This class allows users to access specific information on HTTP responses. - * See also - * - * UrlFetchApp - */ - interface HTTPResponse { - getAllHeaders(): object; - getAs(contentType: string): Base.Blob; - getBlob(): Base.Blob; - getContent(): Byte[]; - getContentText(): string; - getContentText(charset: string): string; - getHeaders(): object; - getResponseCode(): Integer; - } - interface URLFetchRequest extends URLFetchRequestOptions { - url: string; - } - interface URLFetchRequestOptions { - /** - * the content type (defaults to 'application/x-www-form-urlencoded'). Another example of content - * type is 'application/xml; charset=utf-8'. - */ - contentType?: string | undefined; - /** - * a JavaScript key/value map of HTTP headers for the request - */ - headers?: HttpHeaders | undefined; - /** - * the HTTP method for the request: get, delete, patch, post, or put. The default is get. - */ - method?: HttpMethod | undefined; - /** - * the payload (e.g. POST body) for the request. Certain HTTP methods (e.g. GET) do not accept a - * payload. It can be a string, a byte array, or a JavaScript object. A JavaScript object will be - * interpretted as a map of form field names to values, where the values can be either strings or blobs. - */ - payload?: Payload | undefined; - /** - * Deprecated. This instructs fetch to resolve the specified URL within the intranet linked to your - * domain through (deprecated) SDC - */ - useIntranet?: boolean | undefined; - /** - * if this is set to false, the fetch will ignore any invalid certificates for HTTPS requests. - * The default is true. - */ - validateHttpsCertificates?: boolean | undefined; - /** - * if this is set to false, the fetch not automatically follow HTTP redirects; it will return - * the original HTTP response. The default is true. - */ - followRedirects?: boolean | undefined; - /** - * if this is set to true, the fetch will not throw an exception if the response code indicates - * failure, and will instead return the HTTPResponse (default: false) - */ - muteHttpExceptions?: boolean | undefined; - /** - * if this is set to false, reserved characters in the URL will not be escaped (default: true) - */ - escaping?: boolean | undefined; - } - /** - * Fetch resources and communicate with other hosts over the Internet. - * - * This service allows scripts to communicate with other applications or access other resources - * on the web by fetching URLs. A script can use the URL Fetch service to issue HTTP and HTTPS - * requests and receive responses. The URL Fetch service uses Google's network infrastructure for - * efficiency and scaling purposes. - * - * Requests made using this service originate from a set pool of IP ranges. You can look up the full list of IP addresses - * if you need to whitelist or approve these requests. - * - * This service requires the https://www.googleapis.com/auth/script.external_request - * scope. In most cases Apps Script automatically detects and includes the scopes a script needs, - * but if you are setting your scopes - * explicitly you must manually add this scope to use UrlFetchApp. - * See also - * - * HTTPResponse - * - * Setting explicit scopes - */ - interface UrlFetchApp { - fetch(url: string): HTTPResponse; - fetch(url: string, params: URLFetchRequestOptions): HTTPResponse; - fetchAll(requests: Array): HTTPResponse[]; - getRequest(url: string): URLFetchRequest; - getRequest(url: string, params: URLFetchRequestOptions): URLFetchRequest; - } - interface HttpHeaders { - [key: string]: string; - } - type HttpMethod = "get" | "delete" | "patch" | "post" | "put"; - type Payload = string | { [key: string]: any } | Base.Blob; - } -} - -declare var UrlFetchApp: GoogleAppsScript.URL_Fetch.UrlFetchApp; diff --git a/node_modules/@types/google-apps-script/google-apps-script.utilities.d.ts b/node_modules/@types/google-apps-script/google-apps-script.utilities.d.ts deleted file mode 100644 index b46bb86..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.utilities.d.ts +++ /dev/null @@ -1,104 +0,0 @@ -/// -/// - -declare namespace GoogleAppsScript { - namespace Utilities { - /** - * A typesafe enum for character sets. - */ - enum Charset { - US_ASCII, - UTF_8, - } - /** - * Selector of Digest algorithm. - */ - enum DigestAlgorithm { - MD2, - MD5, - SHA_1, - SHA_256, - SHA_384, - SHA_512, - } - /** - * Selector of MAC algorithm - */ - enum MacAlgorithm { - HMAC_MD5, - HMAC_SHA_1, - HMAC_SHA_256, - HMAC_SHA_384, - HMAC_SHA_512, - } - /** - * Selector of RSA algorithm - */ - enum RsaAlgorithm { - RSA_SHA_1, - RSA_SHA_256, - } - /** - * This service provides utilities for string encoding/decoding, date formatting, JSON manipulation, - * and other miscellaneous tasks. - */ - interface Utilities { - Charset: typeof Charset; - DigestAlgorithm: typeof DigestAlgorithm; - MacAlgorithm: typeof MacAlgorithm; - RsaAlgorithm: typeof RsaAlgorithm; - base64Decode(encoded: string): Byte[]; - base64Decode(encoded: string, charset: Charset): Byte[]; - base64DecodeWebSafe(encoded: string): Byte[]; - base64DecodeWebSafe(encoded: string, charset: Charset): Byte[]; - base64Encode(data: Byte[]): string; - base64Encode(data: string): string; - base64Encode(data: string, charset: Charset): string; - base64EncodeWebSafe(data: Byte[]): string; - base64EncodeWebSafe(data: string): string; - base64EncodeWebSafe(data: string, charset: Charset): string; - computeDigest(algorithm: DigestAlgorithm, value: Byte[]): Byte[]; - computeDigest(algorithm: DigestAlgorithm, value: string): Byte[]; - computeDigest(algorithm: DigestAlgorithm, value: string, charset: Charset): Byte[]; - computeHmacSha256Signature(value: Byte[], key: Byte[]): Byte[]; - computeHmacSha256Signature(value: string, key: string): Byte[]; - computeHmacSha256Signature(value: string, key: string, charset: Charset): Byte[]; - computeHmacSignature(algorithm: MacAlgorithm, value: Byte[], key: Byte[]): Byte[]; - computeHmacSignature(algorithm: MacAlgorithm, value: string, key: string): Byte[]; - computeHmacSignature(algorithm: MacAlgorithm, value: string, key: string, charset: Charset): Byte[]; - computeRsaSha1Signature(value: string, key: string): Byte[]; - computeRsaSha1Signature(value: string, key: string, charset: Charset): Byte[]; - computeRsaSha256Signature(value: string, key: string): Byte[]; - computeRsaSha256Signature(value: string, key: string, charset: Charset): Byte[]; - computeRsaSignature(algorithm: RsaAlgorithm, value: string, key: string): Byte[]; - computeRsaSignature(algorithm: RsaAlgorithm, value: string, key: string, charset: Charset): Byte[]; - formatDate(date: Base.Date, timeZone: string, format: string): string; - formatString(template: string, ...args: any[]): string; - getUuid(): string; - gzip(blob: Base.BlobSource): Base.Blob; - gzip(blob: Base.BlobSource, name: string): Base.Blob; - newBlob(data: Byte[]): Base.Blob; - newBlob(data: Byte[], contentType: string): Base.Blob; - newBlob(data: Byte[], contentType: string, name: string): Base.Blob; - newBlob(data: string): Base.Blob; - newBlob(data: string, contentType: string): Base.Blob; - newBlob(data: string, contentType: string, name: string): Base.Blob; - parseCsv(csv: string): string[][]; - parseCsv(csv: string, delimiter: Char): string[][]; - parseDate(date: string, timeZone: string, format: string): Date; - sleep(milliseconds: Integer): void; - ungzip(blob: Base.BlobSource): Base.Blob; - unzip(blob: Base.BlobSource): Base.Blob[]; - zip(blobs: Base.BlobSource[]): Base.Blob; - zip(blobs: Base.BlobSource[], name: string): Base.Blob; - /** @deprecated DO NOT USE */ jsonParse(jsonString: string): any; - /** @deprecated DO NOT USE */ jsonStringify(obj: any): string; - } - } -} - -declare var Charset: GoogleAppsScript.Utilities.Charset; -declare var DigestAlgorithm: GoogleAppsScript.Utilities.DigestAlgorithm; -declare var MacAlgorithm: GoogleAppsScript.Utilities.MacAlgorithm; -declare var RsaAlgorithm: GoogleAppsScript.Utilities.RsaAlgorithm; -declare var Utilities: GoogleAppsScript.Utilities.Utilities; diff --git a/node_modules/@types/google-apps-script/google-apps-script.xml-service.d.ts b/node_modules/@types/google-apps-script/google-apps-script.xml-service.d.ts deleted file mode 100644 index 9f1e261..0000000 --- a/node_modules/@types/google-apps-script/google-apps-script.xml-service.d.ts +++ /dev/null @@ -1,336 +0,0 @@ -/// - -declare namespace GoogleAppsScript { - namespace XML_Service { - /** - * A representation of an XML attribute. - * - * // Reads the first and last name of each person and adds a new attribute with the full name. - * var xml = '' - * + '' - * + '' - * + ''; - * var document = XmlService.parse(xml); - * var people = document.getRootElement().getChildren('person'); - * for (var i = 0; i < people.length; i++) { - * var person = people[i]; - * var firstName = person.getAttribute('first').getValue(); - * var lastName = person.getAttribute('last').getValue(); - * person.setAttribute('full', firstName + ' ' + lastName); - * } - * xml = XmlService.getPrettyFormat().format(document); - * Logger.log(xml); - */ - interface Attribute { - getName(): string; - getNamespace(): Namespace; - getValue(): string; - setName(name: string): Attribute; - setNamespace(namespace: Namespace): Attribute; - setValue(value: string): Attribute; - } - /** - * A representation of an XML CDATASection node. - * - * // Create and log an XML document that shows how special characters like '<', '>', and '&' are - * // stored in a CDATASection node as compared to in a Text node. - * var illegalCharacters = 'The Amazing Adventures of Kavalier & Clay'; - * var cdata = XmlService.createCdata(illegalCharacters); - * var text = XmlService.createText(illegalCharacters); - * var root = XmlService.createElement('root').addContent(cdata).addContent(text); - * var document = XmlService.createDocument(root); - * var xml = XmlService.getPrettyFormat().format(document); - * Logger.log(xml); - */ - interface Cdata extends Content { - append(text: string): Text; - detach(): Content; - getParentElement(): Element; - getText(): string; - getValue(): string; - setText(text: string): Text; - } - /** - * A representation of an XML Comment node. - */ - interface Comment extends Content { - detach(): Content; - getParentElement(): Element; - getText(): string; - getValue(): string; - setText(text: string): Comment; - } - /** - * A representation of a generic XML node. - * Implementing classes - * - * NameBrief description - * - * CdataA representation of an XML CDATASection node. - * - * CommentA representation of an XML Comment node. - * - * DocTypeA representation of an XML DocumentType node. - * - * ElementA representation of an XML Element node. - * - * EntityRefA representation of an XML EntityReference node. - * - * ProcessingInstructionA representation of an XML ProcessingInstruction node. - * - * TextA representation of an XML Text node. - */ - interface Content { - asCdata(): Cdata; - asComment(): Comment; - asDocType(): DocType; - asElement(): Element; - asEntityRef(): EntityRef; - asProcessingInstruction(): ProcessingInstruction; - asText(): Text; - detach(): Content; - getParentElement(): Element; - getType(): ContentType; - getValue(): string; - } - /** - * An enumeration representing the types of XML content nodes. - */ - enum ContentType { - CDATA, - COMMENT, - DOCTYPE, - ELEMENT, - ENTITYREF, - PROCESSINGINSTRUCTION, - TEXT, - } - /** - * A representation of an XML DocumentType node. - */ - interface DocType extends Content { - detach(): Content; - getElementName(): string; - getInternalSubset(): string; - getParentElement(): Element; - getPublicId(): string; - getSystemId(): string; - getValue(): string; - setElementName(name: string): DocType; - setInternalSubset(data: string): DocType; - setPublicId(id: string): DocType; - setSystemId(id: string): DocType; - } - /** - * A representation of an XML document. - */ - interface Document { - addContent(content: Content): Document; - addContent(index: Integer, content: Content): Document; - cloneContent(): Content[]; - detachRootElement(): Element; - getAllContent(): Content[]; - getContent(index: Integer): Content; - getContentSize(): Integer; - getDescendants(): Content[]; - getDocType(): DocType; - getRootElement(): Element; - hasRootElement(): boolean; - removeContent(): Content[]; - removeContent(content: Content): boolean; - removeContent(index: Integer): Content; - setDocType(docType: DocType): Document; - setRootElement(element: Element): Document; - } - /** - * A representation of an XML Element node. - * - * // Adds up the values listed in a sample XML document and adds a new element with the total. - * var xml = '' - * + '12' - * + '18' - * + '25' - * + ''; - * var document = XmlService.parse(xml); - * var root = document.getRootElement(); - * var items = root.getChildren(); - * var total = 0; - * for (var i = 0; i < items.length; i++) { - * total += Number(items[i].getText()); - * } - * var totalElement = XmlService.createElement('total').setText(total); - * root.addContent(totalElement); - * xml = XmlService.getPrettyFormat().format(document); - * Logger.log(xml); - */ - interface Element extends Content { - addContent(content: Content): Element; - addContent(index: Integer, content: Content): Element; - cloneContent(): Content[]; - detach(): Content; - getAllContent(): Content[]; - getAttribute(name: string): Attribute; - getAttribute(name: string, namespace: Namespace): Attribute; - getAttributes(): Attribute[]; - getChild(name: string): Element; - getChild(name: string, namespace: Namespace): Element; - getChildText(name: string): string; - getChildText(name: string, namespace: Namespace): string; - getChildren(): Element[]; - getChildren(name: string): Element[]; - getChildren(name: string, namespace: Namespace): Element[]; - getContent(index: Integer): Content; - getContentSize(): Integer; - getDescendants(): Content[]; - getDocument(): Document; - getName(): string; - getNamespace(): Namespace; - getNamespace(prefix: string): Namespace; - getParentElement(): Element; - getQualifiedName(): string; - getText(): string; - getValue(): string; - isAncestorOf(other: Element): boolean; - isRootElement(): boolean; - removeAttribute(attribute: Attribute): boolean; - removeAttribute(attributeName: string): boolean; - removeAttribute(attributeName: string, namespace: Namespace): boolean; - removeContent(): Content[]; - removeContent(content: Content): boolean; - removeContent(index: Integer): Content; - setAttribute(attribute: Attribute): Element; - setAttribute(name: string, value: string): Element; - setAttribute(name: string, value: string, namespace: Namespace): Element; - setName(name: string): Element; - setNamespace(namespace: Namespace): Element; - setText(text: string): Element; - } - /** - * A representation of an XML EntityReference node. - */ - interface EntityRef extends Content { - detach(): Content; - getName(): string; - getParentElement(): Element; - getPublicId(): string; - getSystemId(): string; - getValue(): string; - setName(name: string): EntityRef; - setPublicId(id: string): EntityRef; - setSystemId(id: string): EntityRef; - } - /** - * A formatter for outputting an XML document, with three pre-defined formats that can be further - * customized. - * - * // Log an XML document with specified formatting options. - * var xml = 'Text!More text!'; - * var document = XmlService.parse(xml); - * var output = XmlService.getCompactFormat() - * .setLineSeparator('\n') - * .setEncoding('UTF-8') - * .setIndent(' ') - * .format(document); - * Logger.log(output); - */ - interface Format { - format(document: Document): string; - format(element: Element): string; - setEncoding(encoding: string): Format; - setIndent(indent: string): Format; - setLineSeparator(separator: string): Format; - setOmitDeclaration(omitDeclaration: boolean): Format; - setOmitEncoding(omitEncoding: boolean): Format; - } - /** - * A representation of an XML namespace. - */ - interface Namespace { - getPrefix(): string; - getURI(): string; - } - /** - * A representation of an XML ProcessingInstruction node. - */ - interface ProcessingInstruction extends Content { - detach(): Content; - getData(): string; - getParentElement(): Element; - getTarget(): string; - getValue(): string; - } - /** - * A representation of an XML Text node. - */ - interface Text extends Content { - append(text: string): Text; - detach(): Content; - getParentElement(): Element; - getText(): string; - getValue(): string; - setText(text: string): Text; - } - /** - * This service allows scripts to parse, navigate, and programmatically create XML documents. - * - * // Log the title and labels for the first page of blog posts on the G Suite Developer blog. - * function parseXml() { - * var url = 'https://gsuite-developers.googleblog.com/atom.xml'; - * var xml = UrlFetchApp.fetch(url).getContentText(); - * var document = XmlService.parse(xml); - * var root = document.getRootElement(); - * var atom = XmlService.getNamespace('http://www.w3.org/2005/Atom'); - * - * var entries = root.getChildren('entry', atom); - * for (var i = 0; i < entries.length; i++) { - * var title = entries[i].getChild('title', atom).getText(); - * var categoryElements = entries[i].getChildren('category', atom); - * var labels = []; - * for (var j = 0; j < categoryElements.length; j++) { - * labels.push(categoryElements[j].getAttribute('term').getValue()); - * } - * Logger.log('%s (%s)', title, labels.join(', ')); - * } - * } - * - * // Create and log an XML representation of the threads in your Gmail inbox. - * function createXml() { - * var root = XmlService.createElement('threads'); - * var threads = GmailApp.getInboxThreads(); - * for (var i = 0; i < threads.length; i++) { - * var child = XmlService.createElement('thread') - * .setAttribute('messageCount', threads[i].getMessageCount()) - * .setAttribute('isUnread', threads[i].isUnread()) - * .setText(threads[i].getFirstMessageSubject()); - * root.addContent(child); - * } - * var document = XmlService.createDocument(root); - * var xml = XmlService.getPrettyFormat().format(document); - * Logger.log(xml); - * } - */ - interface XmlService { - ContentTypes: typeof ContentType; - createCdata(text: string): Cdata; - createComment(text: string): Comment; - createDocType(elementName: string): DocType; - createDocType(elementName: string, systemId: string): DocType; - createDocType(elementName: string, publicId: string, systemId: string): DocType; - createDocument(): Document; - createDocument(rootElement: Element): Document; - createElement(name: string): Element; - createElement(name: string, namespace: Namespace): Element; - createText(text: string): Text; - getCompactFormat(): Format; - getNamespace(uri: string): Namespace; - getNamespace(prefix: string, uri: string): Namespace; - getNoNamespace(): Namespace; - getPrettyFormat(): Format; - getRawFormat(): Format; - getXmlNamespace(): Namespace; - parse(xml: string): Document; - } - } -} - -declare var XmlService: GoogleAppsScript.XML_Service.XmlService; diff --git a/node_modules/@types/google-apps-script/index.d.ts b/node_modules/@types/google-apps-script/index.d.ts deleted file mode 100644 index 3969cf5..0000000 --- a/node_modules/@types/google-apps-script/index.d.ts +++ /dev/null @@ -1,68 +0,0 @@ -// Base Types -/// -/// -/// - -// Google Services (Google APIs) -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// - -// Script Services (Other *App / *Service) -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// - -// Events -/// -/// - -// API Types (Advanced Google Services) -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// diff --git a/node_modules/@types/google-apps-script/package.json b/node_modules/@types/google-apps-script/package.json deleted file mode 100644 index 1aa96a1..0000000 --- a/node_modules/@types/google-apps-script/package.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "name": "@types/google-apps-script", - "version": "1.0.84", - "description": "TypeScript definitions for google-apps-script", - "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/google-apps-script", - "license": "MIT", - "contributors": [ - { - "name": "PopGoesTheWza", - "githubUsername": "PopGoesTheWza", - "url": "https://github.com/PopGoesTheWza" - }, - { - "name": "motemen", - "githubUsername": "motemen", - "url": "https://github.com/motemen" - }, - { - "name": "pierluigi-montagna", - "githubUsername": "pierluigi-montagna", - "url": "https://github.com/pierluigi-montagna" - }, - { - "name": "mtgto", - "githubUsername": "mtgto", - "url": "https://github.com/mtgto" - } - ], - "main": "", - "types": "index.d.ts", - "repository": { - "type": "git", - "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git", - "directory": "types/google-apps-script" - }, - "scripts": {}, - "dependencies": {}, - "typesPublisherContentHash": "bd92fac46d3824a3ac42292c2668faf5dad2fed8bdfbbbe5187dde06cac8974a", - "typeScriptVersion": "4.8" -} \ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 41fbed4..e72822a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -5,13 +5,13 @@ "packages": { "": { "devDependencies": { - "@types/google-apps-script": "^1.0.84" + "@types/google-apps-script": "^1.0.85" } }, "node_modules/@types/google-apps-script": { - "version": "1.0.84", - "resolved": "https://registry.npmjs.org/@types/google-apps-script/-/google-apps-script-1.0.84.tgz", - "integrity": "sha512-qZBeCyk3vJBGEiWtBSRrV89KVovdo9qruw1rQH8OZAQUgXS8RNbMKnnPI5dW+PuJwM8rMiYZpvl6LeaW9IS+WA==", + "version": "1.0.85", + "resolved": "https://registry.npmjs.org/@types/google-apps-script/-/google-apps-script-1.0.85.tgz", + "integrity": "sha512-O5w3PxI75uqU4d7t24ukQtU87OZ2j0vQp3VWmx9sJ6PTwBRvGhMA+qWShKNetofI8TYaVd8tFzBQXgv3e7ycCQ==", "dev": true, "license": "MIT" } diff --git a/package.json b/package.json index 8610477..bd67c32 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { "devDependencies": { - "@types/google-apps-script": "^1.0.84" + "@types/google-apps-script": "^1.0.85" } }