vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-11 12:30:18 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

google-apps-script: 2019-10-23 (#39413)

Browse Source 
* set package version to 1.*.*

* 2019-10-23 update

* enable more lintiing rules

* linting fixes
This commit is contained in:
PopGoesTheWza
2019-11-04 11:09:30 -08:00
committed by Nathan Shively-Sanders
parent f9adf4245e
commit ffd35a14b2
63 changed files with 3122 additions and 3307 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/google-apps-script/apis/adsense_v1_4.d.ts
Vendored
+58 -58
View File
@@ -9,7 +9,7 @@ declare namespace GoogleAppsScript {
namespace Collection {
namespace Accounts {
namespace Adunits {
export interface CustomchannelsCollection {
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.
@@ -17,7 +17,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Customchannels {
export interface AdunitsCollection {
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.
@@ -25,7 +25,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Reports {
export interface SavedCollection {
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.
@@ -36,7 +36,7 @@ declare namespace GoogleAppsScript {
list(accountId: string, optionalArgs: object): Adsense.Schema.SavedReports;
}
}
export interface AdclientsCollection {
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.
@@ -44,7 +44,7 @@ declare namespace GoogleAppsScript {
// List all ad clients in the specified account.
list(accountId: string, optionalArgs: object): Adsense.Schema.AdClients;
}
export interface AdunitsCollection {
interface AdunitsCollection {
Customchannels?: Adsense.Collection.Accounts.Adunits.CustomchannelsCollection;
// Gets the specified ad unit in the specified ad client for the specified account.
get(accountId: string, adClientId: string, adUnitId: string): Adsense.Schema.AdUnit;
@@ -55,7 +55,7 @@ declare namespace GoogleAppsScript {
// List all ad units in the specified ad client for the specified account.
list(accountId: string, adClientId: string, optionalArgs: object): Adsense.Schema.AdUnits;
}
export interface AlertsCollection {
interface AlertsCollection {
// List the alerts for the specified AdSense account.
list(accountId: string): Adsense.Schema.Alerts;
// List the alerts for the specified AdSense account.
@@ -63,7 +63,7 @@ declare namespace GoogleAppsScript {
// Dismiss (delete) the specified alert from the specified publisher AdSense account.
remove(accountId: string, alertId: string): void;
}
export interface CustomchannelsCollection {
interface CustomchannelsCollection {
Adunits?: Adsense.Collection.Accounts.Customchannels.AdunitsCollection;
// Get the specified custom channel from the specified ad client for the specified account.
get(accountId: string, adClientId: string, customChannelId: string): Adsense.Schema.CustomChannel;
@@ -72,18 +72,18 @@ declare namespace GoogleAppsScript {
// List all custom channels in the specified ad client for the specified account.
list(accountId: string, adClientId: string, optionalArgs: object): Adsense.Schema.CustomChannels;
}
export interface PaymentsCollection {
interface PaymentsCollection {
// List the payments for the specified AdSense account.
list(accountId: string): Adsense.Schema.Payments;
}
export interface ReportsCollection {
interface ReportsCollection {
Saved?: Adsense.Collection.Accounts.Reports.SavedCollection;
// 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;
}
export interface SavedadstylesCollection {
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.
@@ -91,7 +91,7 @@ declare namespace GoogleAppsScript {
// List all saved ad styles in the specified account.
list(accountId: string, optionalArgs: object): Adsense.Schema.SavedAdStyles;
}
export interface UrlchannelsCollection {
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.
@@ -99,7 +99,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Adunits {
export interface CustomchannelsCollection {
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.
@@ -107,7 +107,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Customchannels {
export interface AdunitsCollection {
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.
@@ -115,17 +115,17 @@ declare namespace GoogleAppsScript {
}
}
namespace Metadata {
export interface DimensionsCollection {
interface DimensionsCollection {
// List the metadata for the dimensions available to this AdSense account.
list(): Adsense.Schema.Metadata;
}
export interface MetricsCollection {
interface MetricsCollection {
// List the metadata for the metrics available to this AdSense account.
list(): Adsense.Schema.Metadata;
}
}
namespace Reports {
export interface SavedCollection {
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.
@@ -136,7 +136,7 @@ declare namespace GoogleAppsScript {
list(optionalArgs: object): Adsense.Schema.SavedReports;
}
}
export interface AccountsCollection {
interface AccountsCollection {
Adclients?: Adsense.Collection.Accounts.AdclientsCollection;
Adunits?: Adsense.Collection.Accounts.AdunitsCollection;
Alerts?: Adsense.Collection.Accounts.AlertsCollection;
@@ -154,13 +154,13 @@ declare namespace GoogleAppsScript {
// List all accounts available to this AdSense account.
list(optionalArgs: object): Adsense.Schema.Accounts;
}
export interface AdclientsCollection {
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;
}
export interface AdunitsCollection {
interface AdunitsCollection {
Customchannels?: Adsense.Collection.Adunits.CustomchannelsCollection;
// Gets the specified ad unit in the specified ad client.
get(adClientId: string, adUnitId: string): Adsense.Schema.AdUnit;
@@ -171,7 +171,7 @@ declare namespace GoogleAppsScript {
// List all ad units in the specified ad client for this AdSense account.
list(adClientId: string, optionalArgs: object): Adsense.Schema.AdUnits;
}
export interface AlertsCollection {
interface AlertsCollection {
// List the alerts for this AdSense account.
list(): Adsense.Schema.Alerts;
// List the alerts for this AdSense account.
@@ -179,7 +179,7 @@ declare namespace GoogleAppsScript {
// Dismiss (delete) the specified alert from the publisher's AdSense account.
remove(alertId: string): void;
}
export interface CustomchannelsCollection {
interface CustomchannelsCollection {
Adunits?: Adsense.Collection.Customchannels.AdunitsCollection;
// Get the specified custom channel from the specified ad client.
get(adClientId: string, customChannelId: string): Adsense.Schema.CustomChannel;
@@ -188,22 +188,22 @@ declare namespace GoogleAppsScript {
// List all custom channels in the specified ad client for this AdSense account.
list(adClientId: string, optionalArgs: object): Adsense.Schema.CustomChannels;
}
export interface MetadataCollection {
interface MetadataCollection {
Dimensions?: Adsense.Collection.Metadata.DimensionsCollection;
Metrics?: Adsense.Collection.Metadata.MetricsCollection;
}
export interface PaymentsCollection {
interface PaymentsCollection {
// List the payments for this AdSense account.
list(): Adsense.Schema.Payments;
}
export interface ReportsCollection {
interface ReportsCollection {
Saved?: Adsense.Collection.Reports.SavedCollection;
// 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;
}
export interface SavedadstylesCollection {
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.
@@ -211,7 +211,7 @@ declare namespace GoogleAppsScript {
// List all saved ad styles in the user's account.
list(optionalArgs: object): Adsense.Schema.SavedAdStyles;
}
export interface UrlchannelsCollection {
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.
@@ -219,7 +219,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Account {
interface Account {
creation_time?: string;
id?: string;
kind?: string;
@@ -228,49 +228,49 @@ declare namespace GoogleAppsScript {
subAccounts?: Adsense.Schema.Account[];
timezone?: string;
}
export interface Accounts {
interface Accounts {
etag?: string;
items?: Adsense.Schema.Account[];
kind?: string;
nextPageToken?: string;
}
export interface AdClient {
interface AdClient {
arcOptIn?: boolean;
id?: string;
kind?: string;
productCode?: string;
supportsReporting?: boolean;
}
export interface AdClients {
interface AdClients {
etag?: string;
items?: Adsense.Schema.AdClient[];
kind?: string;
nextPageToken?: string;
}
export interface AdCode {
interface AdCode {
adCode?: string;
ampBody?: string;
ampHead?: string;
kind?: string;
}
export interface AdStyle {
interface AdStyle {
colors?: Adsense.Schema.AdStyleColors;
corners?: string;
font?: Adsense.Schema.AdStyleFont;
kind?: string;
}
export interface AdStyleColors {
interface AdStyleColors {
background?: string;
border?: string;
text?: string;
title?: string;
url?: string;
}
export interface AdStyleFont {
interface AdStyleFont {
family?: string;
size?: string;
}
export interface AdUnit {
interface AdUnit {
code?: string;
contentAdsSettings?: Adsense.Schema.AdUnitContentAdsSettings;
customStyle?: Adsense.Schema.AdStyle;
@@ -282,35 +282,35 @@ declare namespace GoogleAppsScript {
savedStyleId?: string;
status?: string;
}
export interface AdUnitContentAdsSettings {
interface AdUnitContentAdsSettings {
backupOption?: Adsense.Schema.AdUnitContentAdsSettingsBackupOption;
size?: string;
type?: string;
}
export interface AdUnitContentAdsSettingsBackupOption {
interface AdUnitContentAdsSettingsBackupOption {
color?: string;
type?: string;
url?: string;
}
export interface AdUnitFeedAdsSettings {
interface AdUnitFeedAdsSettings {
adPosition?: string;
frequency?: number;
minimumWordCount?: number;
type?: string;
}
export interface AdUnitMobileContentAdsSettings {
interface AdUnitMobileContentAdsSettings {
markupLanguage?: string;
scriptingLanguage?: string;
size?: string;
type?: string;
}
export interface AdUnits {
interface AdUnits {
etag?: string;
items?: Adsense.Schema.AdUnit[];
kind?: string;
nextPageToken?: string;
}
export interface AdsenseReportsGenerateResponse {
interface AdsenseReportsGenerateResponse {
averages?: string[];
endDate?: string;
headers?: Adsense.Schema.AdsenseReportsGenerateResponseHeaders[];
@@ -321,12 +321,12 @@ declare namespace GoogleAppsScript {
totals?: string[];
warnings?: string[];
}
export interface AdsenseReportsGenerateResponseHeaders {
interface AdsenseReportsGenerateResponseHeaders {
currency?: string;
name?: string;
type?: string;
}
export interface Alert {
interface Alert {
id?: string;
isDismissible?: boolean;
kind?: string;
@@ -334,45 +334,45 @@ declare namespace GoogleAppsScript {
severity?: string;
type?: string;
}
export interface Alerts {
interface Alerts {
items?: Adsense.Schema.Alert[];
kind?: string;
}
export interface CustomChannel {
interface CustomChannel {
code?: string;
id?: string;
kind?: string;
name?: string;
targetingInfo?: Adsense.Schema.CustomChannelTargetingInfo;
}
export interface CustomChannelTargetingInfo {
interface CustomChannelTargetingInfo {
adsAppearOn?: string;
description?: string;
location?: string;
siteLanguage?: string;
}
export interface CustomChannels {
interface CustomChannels {
etag?: string;
items?: Adsense.Schema.CustomChannel[];
kind?: string;
nextPageToken?: string;
}
export interface Metadata {
interface Metadata {
items?: Adsense.Schema.ReportingMetadataEntry[];
kind?: string;
}
export interface Payment {
interface Payment {
id?: string;
kind?: string;
paymentAmount?: string;
paymentAmountCurrencyCode?: string;
paymentDate?: string;
}
export interface Payments {
interface Payments {
items?: Adsense.Schema.Payment[];
kind?: string;
}
export interface ReportingMetadataEntry {
interface ReportingMetadataEntry {
compatibleDimensions?: string[];
compatibleMetrics?: string[];
id?: string;
@@ -381,35 +381,35 @@ declare namespace GoogleAppsScript {
requiredMetrics?: string[];
supportedProducts?: string[];
}
export interface SavedAdStyle {
interface SavedAdStyle {
adStyle?: Adsense.Schema.AdStyle;
id?: string;
kind?: string;
name?: string;
}
export interface SavedAdStyles {
interface SavedAdStyles {
etag?: string;
items?: Adsense.Schema.SavedAdStyle[];
kind?: string;
nextPageToken?: string;
}
export interface SavedReport {
interface SavedReport {
id?: string;
kind?: string;
name?: string;
}
export interface SavedReports {
interface SavedReports {
etag?: string;
items?: Adsense.Schema.SavedReport[];
kind?: string;
nextPageToken?: string;
}
export interface UrlChannel {
interface UrlChannel {
id?: string;
kind?: string;
urlPattern?: string;
}
export interface UrlChannels {
interface UrlChannels {
etag?: string;
items?: Adsense.Schema.UrlChannel[];
kind?: string;
@@ -417,7 +417,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface Adsense {
interface Adsense {
Accounts?: Adsense.Collection.AccountsCollection;
Adclients?: Adsense.Collection.AdclientsCollection;
Adunits?: Adsense.Collection.AdunitsCollection;
types/google-apps-script/apis/analytics_v3.d.ts
Vendored
+138 -138
View File
@@ -8,19 +8,19 @@ declare namespace GoogleAppsScript {
namespace Analytics {
namespace Collection {
namespace Data {
export interface GaCollection {
interface GaCollection {
// Returns Analytics data for a view (profile).
get(ids: string, start_date: string, end_date: string, metrics: string): Analytics.Schema.GaData;
// Returns Analytics data for a view (profile).
get(ids: string, start_date: string, end_date: string, metrics: string, optionalArgs: object): Analytics.Schema.GaData;
}
export interface McfCollection {
interface McfCollection {
// Returns Analytics Multi-Channel Funnels data for a view (profile).
get(ids: string, start_date: string, end_date: string, metrics: string): Analytics.Schema.McfData;
// Returns Analytics Multi-Channel Funnels data for a view (profile).
get(ids: string, start_date: string, end_date: string, metrics: string, optionalArgs: object): Analytics.Schema.McfData;
}
export interface RealtimeCollection {
interface RealtimeCollection {
// Returns real time data for a view (profile).
get(ids: string, metrics: string): Analytics.Schema.RealtimeData;
// Returns real time data for a view (profile).
@@ -28,13 +28,13 @@ declare namespace GoogleAppsScript {
}
}
namespace Management {
export interface AccountSummariesCollection {
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: object): Analytics.Schema.AccountSummaries;
}
export interface AccountUserLinksCollection {
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.
@@ -46,23 +46,23 @@ declare namespace GoogleAppsScript {
// Updates permissions for an existing user on the given account.
update(resource: Schema.EntityUserLink, accountId: string, linkId: string): Analytics.Schema.EntityUserLink;
}
export interface AccountsCollection {
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: object): Analytics.Schema.Accounts;
}
export interface ClientIdCollection {
interface ClientIdCollection {
// Hashes the given Client ID.
hashClientId(resource: Analytics.Schema.HashClientIdRequest): Analytics.Schema.HashClientIdResponse;
}
export interface CustomDataSourcesCollection {
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: object): Analytics.Schema.CustomDataSources;
}
export interface CustomDimensionsCollection {
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.
@@ -80,7 +80,7 @@ declare namespace GoogleAppsScript {
// Updates an existing custom dimension.
update(resource: Schema.CustomDimension, accountId: string, webPropertyId: string, customDimensionId: string, optionalArgs: object): Analytics.Schema.CustomDimension;
}
export interface CustomMetricsCollection {
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.
@@ -98,7 +98,7 @@ declare namespace GoogleAppsScript {
// Updates an existing custom metric.
update(resource: Schema.CustomMetric, accountId: string, webPropertyId: string, customMetricId: string, optionalArgs: object): Analytics.Schema.CustomMetric;
}
export interface ExperimentsCollection {
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.
@@ -114,7 +114,7 @@ declare namespace GoogleAppsScript {
// Update an existing experiment.
update(resource: Schema.Experiment, accountId: string, webPropertyId: string, profileId: string, experimentId: string): Analytics.Schema.Experiment;
}
export interface FiltersCollection {
interface FiltersCollection {
// Returns a filters to which the user has access.
get(accountId: string, filterId: string): Analytics.Schema.Filter;
// Create a new filter.
@@ -130,7 +130,7 @@ declare namespace GoogleAppsScript {
// Updates an existing filter.
update(resource: Schema.Filter, accountId: string, filterId: string): Analytics.Schema.Filter;
}
export interface GoalsCollection {
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.
@@ -144,7 +144,7 @@ declare namespace GoogleAppsScript {
// Updates an existing goal.
update(resource: Schema.Goal, accountId: string, webPropertyId: string, profileId: string, goalId: string): Analytics.Schema.Goal;
}
export interface ProfileFilterLinksCollection {
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.
@@ -160,7 +160,7 @@ declare namespace GoogleAppsScript {
// Update an existing profile filter link.
update(resource: Schema.ProfileFilterLink, accountId: string, webPropertyId: string, profileId: string, linkId: string): Analytics.Schema.ProfileFilterLink;
}
export interface ProfileUserLinksCollection {
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).
@@ -172,7 +172,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface ProfilesCollection {
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).
@@ -188,7 +188,7 @@ declare namespace GoogleAppsScript {
// Updates an existing view (profile).
update(resource: Schema.Profile, accountId: string, webPropertyId: string, profileId: string): Analytics.Schema.Profile;
}
export interface RemarketingAudienceCollection {
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.
@@ -204,13 +204,13 @@ declare namespace GoogleAppsScript {
// Updates an existing remarketing audience.
update(resource: Schema.RemarketingAudience, accountId: string, webPropertyId: string, remarketingAudienceId: string): Analytics.Schema.RemarketingAudience;
}
export interface SegmentsCollection {
interface SegmentsCollection {
// Lists segments to which the user has access.
list(): Analytics.Schema.Segments;
// Lists segments to which the user has access.
list(optionalArgs: object): Analytics.Schema.Segments;
}
export interface UnsampledReportsCollection {
interface UnsampledReportsCollection {
// Returns a single unsampled report.
get(accountId: string, webPropertyId: string, profileId: string, unsampledReportId: string): Analytics.Schema.UnsampledReport;
// Create a new unsampled report.
@@ -222,7 +222,7 @@ declare namespace GoogleAppsScript {
// Deletes an unsampled report.
remove(accountId: string, webPropertyId: string, profileId: string, unsampledReportId: string): void;
}
export interface UploadsCollection {
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.
@@ -236,7 +236,7 @@ declare namespace GoogleAppsScript {
// Upload data for a custom data source.
uploadData(accountId: string, webPropertyId: string, customDataSourceId: string, mediaData: any): Analytics.Schema.Upload;
}
export interface WebPropertyAdWordsLinksCollection {
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.
@@ -252,7 +252,7 @@ declare namespace GoogleAppsScript {
// Updates an existing webProperty-Google Ads link.
update(resource: Schema.EntityAdWordsLink, accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): Analytics.Schema.EntityAdWordsLink;
}
export interface WebpropertiesCollection {
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.
@@ -266,7 +266,7 @@ declare namespace GoogleAppsScript {
// Updates an existing web property.
update(resource: Schema.Webproperty, accountId: string, webPropertyId: string): Analytics.Schema.Webproperty;
}
export interface WebpropertyUserLinksCollection {
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.
@@ -280,23 +280,23 @@ declare namespace GoogleAppsScript {
}
}
namespace Metadata {
export interface ColumnsCollection {
interface ColumnsCollection {
// Lists all columns for a report type
list(reportType: string): Analytics.Schema.Columns;
}
}
namespace UserDeletion {
export interface UserDeletionRequestCollection {
interface UserDeletionRequestCollection {
// Insert or update a user deletion requests.
upsert(resource: Schema.UserDeletionRequest): Analytics.Schema.UserDeletionRequest;
}
}
export interface DataCollection {
interface DataCollection {
Ga?: Analytics.Collection.Data.GaCollection;
Mcf?: Analytics.Collection.Data.McfCollection;
Realtime?: Analytics.Collection.Data.RealtimeCollection;
}
export interface ManagementCollection {
interface ManagementCollection {
AccountSummaries?: Analytics.Collection.Management.AccountSummariesCollection;
AccountUserLinks?: Analytics.Collection.Management.AccountUserLinksCollection;
Accounts?: Analytics.Collection.Management.AccountsCollection;
@@ -318,21 +318,21 @@ declare namespace GoogleAppsScript {
Webproperties?: Analytics.Collection.Management.WebpropertiesCollection;
WebpropertyUserLinks?: Analytics.Collection.Management.WebpropertyUserLinksCollection;
}
export interface MetadataCollection {
interface MetadataCollection {
Columns?: Analytics.Collection.Metadata.ColumnsCollection;
}
export interface ProvisioningCollection {
interface ProvisioningCollection {
// Creates an account ticket.
createAccountTicket(resource: Schema.AccountTicket): Analytics.Schema.AccountTicket;
// Provision account.
createAccountTree(resource: Schema.AccountTreeRequest): Analytics.Schema.AccountTreeResponse;
}
export interface UserDeletionCollection {
interface UserDeletionCollection {
UserDeletionRequest?: Analytics.Collection.UserDeletion.UserDeletionRequestCollection;
}
}
namespace Schema {
export interface Account {
interface Account {
childLink?: Analytics.Schema.AccountChildLink;
created?: string;
id?: string;
@@ -343,20 +343,20 @@ declare namespace GoogleAppsScript {
starred?: boolean;
updated?: string;
}
export interface AccountChildLink {
interface AccountChildLink {
href?: string;
type?: string;
}
export interface AccountPermissions {
interface AccountPermissions {
effective?: string[];
}
export interface AccountRef {
interface AccountRef {
href?: string;
id?: string;
kind?: string;
name?: string;
}
export interface AccountSummaries {
interface AccountSummaries {
items?: Analytics.Schema.AccountSummary[];
itemsPerPage?: number;
kind?: string;
@@ -366,14 +366,14 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface AccountSummary {
interface AccountSummary {
id?: string;
kind?: string;
name?: string;
starred?: boolean;
webProperties?: Analytics.Schema.WebPropertySummary[];
}
export interface AccountTicket {
interface AccountTicket {
account?: Analytics.Schema.Account;
id?: string;
kind?: string;
@@ -381,7 +381,7 @@ declare namespace GoogleAppsScript {
redirectUri?: string;
webproperty?: Analytics.Schema.Webproperty;
}
export interface AccountTreeRequest {
interface AccountTreeRequest {
accountName?: string;
kind?: string;
profileName?: string;
@@ -389,13 +389,13 @@ declare namespace GoogleAppsScript {
webpropertyName?: string;
websiteUrl?: string;
}
export interface AccountTreeResponse {
interface AccountTreeResponse {
account?: Analytics.Schema.Account;
kind?: string;
profile?: Analytics.Schema.Profile;
webproperty?: Analytics.Schema.Webproperty;
}
export interface Accounts {
interface Accounts {
items?: Analytics.Schema.Account[];
itemsPerPage?: number;
kind?: string;
@@ -405,27 +405,27 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface AdWordsAccount {
interface AdWordsAccount {
autoTaggingEnabled?: boolean;
customerId?: string;
kind?: string;
}
export interface AnalyticsDataimportDeleteUploadDataRequest {
interface AnalyticsDataimportDeleteUploadDataRequest {
customDataImportUids?: string[];
}
export interface Column {
interface Column {
attributes?: object;
id?: string;
kind?: string;
}
export interface Columns {
interface Columns {
attributeNames?: string[];
etag?: string;
items?: Analytics.Schema.Column[];
kind?: string;
totalResults?: number;
}
export interface CustomDataSource {
interface CustomDataSource {
accountId?: string;
childLink?: Analytics.Schema.CustomDataSourceChildLink;
created?: string;
@@ -443,15 +443,15 @@ declare namespace GoogleAppsScript {
uploadType?: string;
webPropertyId?: string;
}
export interface CustomDataSourceChildLink {
interface CustomDataSourceChildLink {
href?: string;
type?: string;
}
export interface CustomDataSourceParentLink {
interface CustomDataSourceParentLink {
href?: string;
type?: string;
}
export interface CustomDataSources {
interface CustomDataSources {
items?: Analytics.Schema.CustomDataSource[];
itemsPerPage?: number;
kind?: string;
@@ -461,7 +461,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface CustomDimension {
interface CustomDimension {
accountId?: string;
active?: boolean;
created?: string;
@@ -475,11 +475,11 @@ declare namespace GoogleAppsScript {
updated?: string;
webPropertyId?: string;
}
export interface CustomDimensionParentLink {
interface CustomDimensionParentLink {
href?: string;
type?: string;
}
export interface CustomDimensions {
interface CustomDimensions {
items?: Analytics.Schema.CustomDimension[];
itemsPerPage?: number;
kind?: string;
@@ -489,7 +489,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface CustomMetric {
interface CustomMetric {
accountId?: string;
active?: boolean;
created?: string;
@@ -506,11 +506,11 @@ declare namespace GoogleAppsScript {
updated?: string;
webPropertyId?: string;
}
export interface CustomMetricParentLink {
interface CustomMetricParentLink {
href?: string;
type?: string;
}
export interface CustomMetrics {
interface CustomMetrics {
items?: Analytics.Schema.CustomMetric[];
itemsPerPage?: number;
kind?: string;
@@ -520,7 +520,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface EntityAdWordsLink {
interface EntityAdWordsLink {
adWordsAccounts?: Analytics.Schema.AdWordsAccount[];
entity?: Analytics.Schema.EntityAdWordsLinkEntity;
id?: string;
@@ -529,10 +529,10 @@ declare namespace GoogleAppsScript {
profileIds?: string[];
selfLink?: string;
}
export interface EntityAdWordsLinkEntity {
interface EntityAdWordsLinkEntity {
webPropertyRef?: Analytics.Schema.WebPropertyRef;
}
export interface EntityAdWordsLinks {
interface EntityAdWordsLinks {
items?: Analytics.Schema.EntityAdWordsLink[];
itemsPerPage?: number;
kind?: string;
@@ -541,7 +541,7 @@ declare namespace GoogleAppsScript {
startIndex?: number;
totalResults?: number;
}
export interface EntityUserLink {
interface EntityUserLink {
entity?: Analytics.Schema.EntityUserLinkEntity;
id?: string;
kind?: string;
@@ -549,16 +549,16 @@ declare namespace GoogleAppsScript {
selfLink?: string;
userRef?: Analytics.Schema.UserRef;
}
export interface EntityUserLinkEntity {
interface EntityUserLinkEntity {
accountRef?: Analytics.Schema.AccountRef;
profileRef?: Analytics.Schema.ProfileRef;
webPropertyRef?: Analytics.Schema.WebPropertyRef;
}
export interface EntityUserLinkPermissions {
interface EntityUserLinkPermissions {
effective?: string[];
local?: string[];
}
export interface EntityUserLinks {
interface EntityUserLinks {
items?: Analytics.Schema.EntityUserLink[];
itemsPerPage?: number;
kind?: string;
@@ -567,7 +567,7 @@ declare namespace GoogleAppsScript {
startIndex?: number;
totalResults?: number;
}
export interface Experiment {
interface Experiment {
accountId?: string;
created?: string;
description?: string;
@@ -597,18 +597,18 @@ declare namespace GoogleAppsScript {
winnerConfidenceLevel?: number;
winnerFound?: boolean;
}
export interface ExperimentParentLink {
interface ExperimentParentLink {
href?: string;
type?: string;
}
export interface ExperimentVariations {
interface ExperimentVariations {
name?: string;
status?: string;
url?: string;
weight?: number;
won?: boolean;
}
export interface Experiments {
interface Experiments {
items?: Analytics.Schema.Experiment[];
itemsPerPage?: number;
kind?: string;
@@ -618,7 +618,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface Filter {
interface Filter {
accountId?: string;
advancedDetails?: Analytics.Schema.FilterAdvancedDetails;
created?: string;
@@ -635,7 +635,7 @@ declare namespace GoogleAppsScript {
updated?: string;
uppercaseDetails?: Analytics.Schema.FilterUppercaseDetails;
}
export interface FilterAdvancedDetails {
interface FilterAdvancedDetails {
caseSensitive?: boolean;
extractA?: string;
extractB?: string;
@@ -650,7 +650,7 @@ declare namespace GoogleAppsScript {
outputToFieldIndex?: number;
overrideOutputField?: boolean;
}
export interface FilterExpression {
interface FilterExpression {
caseSensitive?: boolean;
expressionValue?: string;
field?: string;
@@ -658,33 +658,33 @@ declare namespace GoogleAppsScript {
kind?: string;
matchType?: string;
}
export interface FilterLowercaseDetails {
interface FilterLowercaseDetails {
field?: string;
fieldIndex?: number;
}
export interface FilterParentLink {
interface FilterParentLink {
href?: string;
type?: string;
}
export interface FilterRef {
interface FilterRef {
accountId?: string;
href?: string;
id?: string;
kind?: string;
name?: string;
}
export interface FilterSearchAndReplaceDetails {
interface FilterSearchAndReplaceDetails {
caseSensitive?: boolean;
field?: string;
fieldIndex?: number;
replaceString?: string;
searchString?: string;
}
export interface FilterUppercaseDetails {
interface FilterUppercaseDetails {
field?: string;
fieldIndex?: number;
}
export interface Filters {
interface Filters {
items?: Analytics.Schema.Filter[];
itemsPerPage?: number;
kind?: string;
@@ -694,7 +694,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface GaData {
interface GaData {
columnHeaders?: Analytics.Schema.GaDataColumnHeaders[];
containsSampledData?: boolean;
dataLastRefreshed?: string;
@@ -713,27 +713,27 @@ declare namespace GoogleAppsScript {
totalResults?: number;
totalsForAllResults?: object;
}
export interface GaDataColumnHeaders {
interface GaDataColumnHeaders {
columnType?: string;
dataType?: string;
name?: string;
}
export interface GaDataDataTable {
interface GaDataDataTable {
cols?: Analytics.Schema.GaDataDataTableCols[];
rows?: Analytics.Schema.GaDataDataTableRows[];
}
export interface GaDataDataTableCols {
interface GaDataDataTableCols {
id?: string;
label?: string;
type?: string;
}
export interface GaDataDataTableRows {
interface GaDataDataTableRows {
c?: Analytics.Schema.GaDataDataTableRowsC[];
}
export interface GaDataDataTableRowsC {
interface GaDataDataTableRowsC {
v?: string;
}
export interface GaDataProfileInfo {
interface GaDataProfileInfo {
accountId?: string;
internalWebPropertyId?: string;
profileId?: string;
@@ -741,7 +741,7 @@ declare namespace GoogleAppsScript {
tableId?: string;
webPropertyId?: string;
}
export interface GaDataQuery {
interface GaDataQuery {
dimensions?: string;
end_date?: string;
filters?: string;
@@ -754,7 +754,7 @@ declare namespace GoogleAppsScript {
start_date?: string;
start_index?: number;
}
export interface Goal {
interface Goal {
accountId?: string;
active?: boolean;
created?: string;
@@ -774,42 +774,42 @@ declare namespace GoogleAppsScript {
visitTimeOnSiteDetails?: Analytics.Schema.GoalVisitTimeOnSiteDetails;
webPropertyId?: string;
}
export interface GoalEventDetails {
interface GoalEventDetails {
eventConditions?: GoalEventDetailsEventConditions[];
useEventValue?: boolean;
}
export interface GoalEventDetailsEventConditions {
interface GoalEventDetailsEventConditions {
comparisonType?: string;
comparisonValue?: string;
expression?: string;
matchType?: string;
type?: string;
}
export interface GoalParentLink {
interface GoalParentLink {
href?: string;
type?: string;
}
export interface GoalUrlDestinationDetails {
interface GoalUrlDestinationDetails {
caseSensitive?: boolean;
firstStepRequired?: boolean;
matchType?: string;
steps?: GoalUrlDestinationDetailsSteps[];
url?: string;
}
export interface GoalUrlDestinationDetailsSteps {
interface GoalUrlDestinationDetailsSteps {
name?: string;
number?: number;
url?: string;
}
export interface GoalVisitNumPagesDetails {
interface GoalVisitNumPagesDetails {
comparisonType?: string;
comparisonValue?: string;
}
export interface GoalVisitTimeOnSiteDetails {
interface GoalVisitTimeOnSiteDetails {
comparisonType?: string;
comparisonValue?: string;
}
export interface Goals {
interface Goals {
items?: Goal[];
itemsPerPage?: number;
kind?: string;
@@ -819,25 +819,25 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface HashClientIdRequest {
interface HashClientIdRequest {
clientId?: string;
kind?: string;
webPropertyId?: string;
}
export interface HashClientIdResponse {
interface HashClientIdResponse {
clientId?: string;
hashedClientId?: string;
kind?: string;
webPropertyId?: string;
}
export interface IncludeConditions {
interface IncludeConditions {
daysToLookBack?: number;
isSmartList?: boolean;
kind?: string;
membershipDurationDays?: number;
segment?: string;
}
export interface LinkedForeignAccount {
interface LinkedForeignAccount {
accountId?: string;
eligibleForSearch?: boolean;
id?: string;
@@ -849,7 +849,7 @@ declare namespace GoogleAppsScript {
type?: string;
webPropertyId?: string;
}
export interface McfData {
interface McfData {
columnHeaders?: McfDataColumnHeaders[];
containsSampledData?: boolean;
id?: string;
@@ -866,12 +866,12 @@ declare namespace GoogleAppsScript {
totalResults?: number;
totalsForAllResults?: object;
}
export interface McfDataColumnHeaders {
interface McfDataColumnHeaders {
columnType?: string;
dataType?: string;
name?: string;
}
export interface McfDataProfileInfo {
interface McfDataProfileInfo {
accountId?: string;
internalWebPropertyId?: string;
profileId?: string;
@@ -879,7 +879,7 @@ declare namespace GoogleAppsScript {
tableId?: string;
webPropertyId?: string;
}
export interface McfDataQuery {
interface McfDataQuery {
dimensions?: string;
end_date?: string;
filters?: string;
@@ -892,15 +892,15 @@ declare namespace GoogleAppsScript {
start_date?: string;
start_index?: number;
}
export interface McfDataRows {
interface McfDataRows {
conversionPathValue?: McfDataRowsConversionPathValue[];
primitiveValue?: string;
}
export interface McfDataRowsConversionPathValue {
interface McfDataRowsConversionPathValue {
interactionType?: string;
nodeValue?: string;
}
export interface Profile {
interface Profile {
accountId?: string;
botFilteringEnabled?: boolean;
childLink?: ProfileChildLink;
@@ -928,11 +928,11 @@ declare namespace GoogleAppsScript {
webPropertyId?: string;
websiteUrl?: string;
}
export interface ProfileChildLink {
interface ProfileChildLink {
href?: string;
type?: string;
}
export interface ProfileFilterLink {
interface ProfileFilterLink {
filterRef?: Analytics.Schema.FilterRef;
id?: string;
kind?: string;
@@ -940,7 +940,7 @@ declare namespace GoogleAppsScript {
rank?: number;
selfLink?: string;
}
export interface ProfileFilterLinks {
interface ProfileFilterLinks {
items?: ProfileFilterLink[];
itemsPerPage?: number;
kind?: string;
@@ -950,14 +950,14 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface ProfileParentLink {
interface ProfileParentLink {
href?: string;
type?: string;
}
export interface ProfilePermissions {
interface ProfilePermissions {
effective?: string[];
}
export interface ProfileRef {
interface ProfileRef {
accountId?: string;
href?: string;
id?: string;
@@ -966,14 +966,14 @@ declare namespace GoogleAppsScript {
name?: string;
webPropertyId?: string;
}
export interface ProfileSummary {
interface ProfileSummary {
id?: string;
kind?: string;
name?: string;
starred?: boolean;
type?: string;
}
export interface Profiles {
interface Profiles {
items?: Profile[];
itemsPerPage?: number;
kind?: string;
@@ -983,7 +983,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface RealtimeData {
interface RealtimeData {
columnHeaders?: RealtimeDataColumnHeaders[];
id?: string;
kind?: string;
@@ -994,12 +994,12 @@ declare namespace GoogleAppsScript {
totalResults?: number;
totalsForAllResults?: object;
}
export interface RealtimeDataColumnHeaders {
interface RealtimeDataColumnHeaders {
columnType?: string;
dataType?: string;
name?: string;
}
export interface RealtimeDataProfileInfo {
interface RealtimeDataProfileInfo {
accountId?: string;
internalWebPropertyId?: string;
profileId?: string;
@@ -1007,7 +1007,7 @@ declare namespace GoogleAppsScript {
tableId?: string;
webPropertyId?: string;
}
export interface RealtimeDataQuery {
interface RealtimeDataQuery {
dimensions?: string;
filters?: string;
ids?: string;
@@ -1015,7 +1015,7 @@ declare namespace GoogleAppsScript {
metrics?: string[];
sort?: string[];
}
export interface RemarketingAudience {
interface RemarketingAudience {
accountId?: string;
audienceDefinition?: RemarketingAudienceAudienceDefinition;
audienceType?: string;
@@ -1031,18 +1031,18 @@ declare namespace GoogleAppsScript {
updated?: string;
webPropertyId?: string;
}
export interface RemarketingAudienceAudienceDefinition {
interface RemarketingAudienceAudienceDefinition {
includeConditions?: IncludeConditions;
}
export interface RemarketingAudienceStateBasedAudienceDefinition {
interface RemarketingAudienceStateBasedAudienceDefinition {
excludeConditions?: RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions;
includeConditions?: IncludeConditions;
}
export interface RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions {
interface RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions {
exclusionDuration?: string;
segment?: string;
}
export interface RemarketingAudiences {
interface RemarketingAudiences {
items?: RemarketingAudience[];
itemsPerPage?: number;
kind?: string;
@@ -1052,7 +1052,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface Segment {
interface Segment {
created?: string;
definition?: string;
id?: string;
@@ -1063,7 +1063,7 @@ declare namespace GoogleAppsScript {
type?: string;
updated?: string;
}
export interface Segments {
interface Segments {
items?: Segment[];
itemsPerPage?: number;
kind?: string;
@@ -1073,7 +1073,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface UnsampledReport {
interface UnsampledReport {
accountId?: string;
cloudStorageDownloadDetails?: UnsampledReportCloudStorageDownloadDetails;
created?: string;
@@ -1094,14 +1094,14 @@ declare namespace GoogleAppsScript {
updated?: string;
webPropertyId?: string;
}
export interface UnsampledReportCloudStorageDownloadDetails {
interface UnsampledReportCloudStorageDownloadDetails {
bucketId?: string;
objectId?: string;
}
export interface UnsampledReportDriveDownloadDetails {
interface UnsampledReportDriveDownloadDetails {
documentId?: string;
}
export interface UnsampledReports {
interface UnsampledReports {
items?: UnsampledReport[];
itemsPerPage?: number;
kind?: string;
@@ -1111,7 +1111,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface Upload {
interface Upload {
accountId?: string;
customDataSourceId?: string;
errors?: string[];
@@ -1120,7 +1120,7 @@ declare namespace GoogleAppsScript {
status?: string;
uploadTime?: string;
}
export interface Uploads {
interface Uploads {
items?: Upload[];
itemsPerPage?: number;
kind?: string;
@@ -1129,23 +1129,23 @@ declare namespace GoogleAppsScript {
startIndex?: number;
totalResults?: number;
}
export interface UserDeletionRequest {
interface UserDeletionRequest {
deletionRequestTime?: string;
firebaseProjectId?: string;
id?: UserDeletionRequestId;
kind?: string;
webPropertyId?: string;
}
export interface UserDeletionRequestId {
interface UserDeletionRequestId {
type?: string;
userId?: string;
}
export interface UserRef {
interface UserRef {
email?: string;
id?: string;
kind?: string;
}
export interface WebPropertyRef {
interface WebPropertyRef {
accountId?: string;
href?: string;
id?: string;
@@ -1153,7 +1153,7 @@ declare namespace GoogleAppsScript {
kind?: string;
name?: string;
}
export interface WebPropertySummary {
interface WebPropertySummary {
id?: string;
internalWebPropertyId?: string;
kind?: string;
@@ -1163,7 +1163,7 @@ declare namespace GoogleAppsScript {
starred?: boolean;
websiteUrl?: string;
}
export interface Webproperties {
interface Webproperties {
items?: Webproperty[];
itemsPerPage?: number;
kind?: string;
@@ -1173,7 +1173,7 @@ declare namespace GoogleAppsScript {
totalResults?: number;
username?: string;
}
export interface Webproperty {
interface Webproperty {
accountId?: string;
childLink?: WebpropertyChildLink;
created?: string;
@@ -1194,20 +1194,20 @@ declare namespace GoogleAppsScript {
updated?: string;
websiteUrl?: string;
}
export interface WebpropertyChildLink {
interface WebpropertyChildLink {
href?: string;
type?: string;
}
export interface WebpropertyParentLink {
interface WebpropertyParentLink {
href?: string;
type?: string;
}
export interface WebpropertyPermissions {
interface WebpropertyPermissions {
effective?: string[];
}
}
}
export interface Analytics {
interface Analytics {
Data?: Analytics.Collection.DataCollection;
Management?: Analytics.Collection.ManagementCollection;
Metadata?: Analytics.Collection.MetadataCollection;
types/google-apps-script/apis/analyticsreporting_v4.d.ts
Vendored
+53 -53
View File
@@ -7,17 +7,17 @@
declare namespace GoogleAppsScript {
namespace Analyticsreporting {
namespace Collection {
export interface ReportsCollection {
interface ReportsCollection {
// Returns the Analytics data.
batchGet(resource: Schema.GetReportsRequest): Analyticsreporting.Schema.GetReportsResponse;
}
export interface UserActivityCollection {
interface UserActivityCollection {
// Returns User Activity data.
search(resource: Schema.SearchUserActivityRequest): Analyticsreporting.Schema.SearchUserActivityResponse;
}
}
namespace Schema {
export interface Activity {
interface Activity {
activityTime?: string;
activityType?: string;
appview?: Analyticsreporting.Schema.ScreenviewData;
@@ -34,74 +34,74 @@ declare namespace GoogleAppsScript {
pageview?: Analyticsreporting.Schema.PageviewData;
source?: string;
}
export interface Cohort {
interface Cohort {
dateRange?: Analyticsreporting.Schema.DateRange;
name?: string;
type?: string;
}
export interface CohortGroup {
interface CohortGroup {
cohorts?: Analyticsreporting.Schema.Cohort[];
lifetimeValue?: boolean;
}
export interface ColumnHeader {
interface ColumnHeader {
dimensions?: string[];
metricHeader?: Analyticsreporting.Schema.MetricHeader;
}
export interface CustomDimension {
interface CustomDimension {
index?: number;
value?: string;
}
export interface DateRange {
interface DateRange {
endDate?: string;
startDate?: string;
}
export interface DateRangeValues {
interface DateRangeValues {
pivotValueRegions?: Analyticsreporting.Schema.PivotValueRegion[];
values?: string[];
}
export interface Dimension {
interface Dimension {
histogramBuckets?: string[];
name?: string;
}
export interface DimensionFilter {
interface DimensionFilter {
caseSensitive?: boolean;
dimensionName?: string;
expressions?: string[];
not?: boolean;
operator?: string;
}
export interface DimensionFilterClause {
interface DimensionFilterClause {
filters?: Analyticsreporting.Schema.DimensionFilter[];
operator?: string;
}
export interface DynamicSegment {
interface DynamicSegment {
name?: string;
sessionSegment?: Analyticsreporting.Schema.SegmentDefinition;
userSegment?: Analyticsreporting.Schema.SegmentDefinition;
}
export interface EcommerceData {
interface EcommerceData {
actionType?: string;
ecommerceType?: string;
products?: Analyticsreporting.Schema.ProductData[];
transaction?: Analyticsreporting.Schema.TransactionData;
}
export interface EventData {
interface EventData {
eventAction?: string;
eventCategory?: string;
eventCount?: string;
eventLabel?: string;
eventValue?: string;
}
export interface GetReportsRequest {
interface GetReportsRequest {
reportRequests?: Analyticsreporting.Schema.ReportRequest[];
useResourceQuotas?: boolean;
}
export interface GetReportsResponse {
interface GetReportsResponse {
queryCost?: number;
reports?: Analyticsreporting.Schema.Report[];
resourceQuotasRemaining?: Analyticsreporting.Schema.ResourceQuotasRemaining;
}
export interface GoalData {
interface GoalData {
goalCompletionLocation?: string;
goalCompletions?: string;
goalIndex?: number;
@@ -111,75 +111,75 @@ declare namespace GoogleAppsScript {
goalPreviousStep3?: string;
goalValue?: number;
}
export interface GoalSetData {
interface GoalSetData {
goals?: Analyticsreporting.Schema.GoalData[];
}
export interface Metric {
interface Metric {
alias?: string;
expression?: string;
formattingType?: string;
}
export interface MetricFilter {
interface MetricFilter {
comparisonValue?: string;
metricName?: string;
not?: boolean;
operator?: string;
}
export interface MetricFilterClause {
interface MetricFilterClause {
filters?: Analyticsreporting.Schema.MetricFilter[];
operator?: string;
}
export interface MetricHeader {
interface MetricHeader {
metricHeaderEntries?: Analyticsreporting.Schema.MetricHeaderEntry[];
pivotHeaders?: Analyticsreporting.Schema.PivotHeader[];
}
export interface MetricHeaderEntry {
interface MetricHeaderEntry {
name?: string;
type?: string;
}
export interface OrFiltersForSegment {
interface OrFiltersForSegment {
segmentFilterClauses?: Analyticsreporting.Schema.SegmentFilterClause[];
}
export interface OrderBy {
interface OrderBy {
fieldName?: string;
orderType?: string;
sortOrder?: string;
}
export interface PageviewData {
interface PageviewData {
pagePath?: string;
pageTitle?: string;
}
export interface Pivot {
interface Pivot {
dimensionFilterClauses?: Analyticsreporting.Schema.DimensionFilterClause[];
dimensions?: Analyticsreporting.Schema.Dimension[];
maxGroupCount?: number;
metrics?: Analyticsreporting.Schema.Metric[];
startGroup?: number;
}
export interface PivotHeader {
interface PivotHeader {
pivotHeaderEntries?: Analyticsreporting.Schema.PivotHeaderEntry[];
totalPivotGroupsCount?: number;
}
export interface PivotHeaderEntry {
interface PivotHeaderEntry {
dimensionNames?: string[];
dimensionValues?: string[];
metric?: Analyticsreporting.Schema.MetricHeaderEntry;
}
export interface PivotValueRegion {
interface PivotValueRegion {
values?: string[];
}
export interface ProductData {
interface ProductData {
itemRevenue?: number;
productName?: string;
productQuantity?: string;
productSku?: string;
}
export interface Report {
interface Report {
columnHeader?: Analyticsreporting.Schema.ColumnHeader;
data?: Analyticsreporting.Schema.ReportData;
nextPageToken?: string;
}
export interface ReportData {
interface ReportData {
dataLastRefreshed?: string;
isDataGolden?: boolean;
maximums?: Analyticsreporting.Schema.DateRangeValues[];
@@ -190,7 +190,7 @@ declare namespace GoogleAppsScript {
samplingSpaceSizes?: string[];
totals?: Analyticsreporting.Schema.DateRangeValues[];
}
export interface ReportRequest {
interface ReportRequest {
cohortGroup?: Analyticsreporting.Schema.CohortGroup;
dateRanges?: Analyticsreporting.Schema.DateRange[];
dimensionFilterClauses?: Analyticsreporting.Schema.DimensionFilterClause[];
@@ -209,21 +209,21 @@ declare namespace GoogleAppsScript {
segments?: Analyticsreporting.Schema.Segment[];
viewId?: string;
}
export interface ReportRow {
interface ReportRow {
dimensions?: string[];
metrics?: Analyticsreporting.Schema.DateRangeValues[];
}
export interface ResourceQuotasRemaining {
interface ResourceQuotasRemaining {
dailyQuotaTokensRemaining?: number;
hourlyQuotaTokensRemaining?: number;
}
export interface ScreenviewData {
interface ScreenviewData {
appName?: string;
mobileDeviceBranding?: string;
mobileDeviceModel?: string;
screenName?: string;
}
export interface SearchUserActivityRequest {
interface SearchUserActivityRequest {
activityTypes?: string[];
dateRange?: Analyticsreporting.Schema.DateRange;
pageSize?: number;
@@ -231,20 +231,20 @@ declare namespace GoogleAppsScript {
user?: Analyticsreporting.Schema.User;
viewId?: string;
}
export interface SearchUserActivityResponse {
interface SearchUserActivityResponse {
nextPageToken?: string;
sampleRate?: number;
sessions?: Analyticsreporting.Schema.UserActivitySession[];
totalRows?: number;
}
export interface Segment {
interface Segment {
dynamicSegment?: Analyticsreporting.Schema.DynamicSegment;
segmentId?: string;
}
export interface SegmentDefinition {
interface SegmentDefinition {
segmentFilters?: Analyticsreporting.Schema.SegmentFilter[];
}
export interface SegmentDimensionFilter {
interface SegmentDimensionFilter {
caseSensitive?: boolean;
dimensionName?: string;
expressions?: string[];
@@ -252,45 +252,45 @@ declare namespace GoogleAppsScript {
minComparisonValue?: string;
operator?: string;
}
export interface SegmentFilter {
interface SegmentFilter {
not?: boolean;
sequenceSegment?: Analyticsreporting.Schema.SequenceSegment;
simpleSegment?: Analyticsreporting.Schema.SimpleSegment;
}
export interface SegmentFilterClause {
interface SegmentFilterClause {
dimensionFilter?: Analyticsreporting.Schema.SegmentDimensionFilter;
metricFilter?: Analyticsreporting.Schema.SegmentMetricFilter;
not?: boolean;
}
export interface SegmentMetricFilter {
interface SegmentMetricFilter {
comparisonValue?: string;
maxComparisonValue?: string;
metricName?: string;
operator?: string;
scope?: string;
}
export interface SegmentSequenceStep {
interface SegmentSequenceStep {
matchType?: string;
orFiltersForSegment?: Analyticsreporting.Schema.OrFiltersForSegment[];
}
export interface SequenceSegment {
interface SequenceSegment {
firstStepShouldMatchFirstHit?: boolean;
segmentSequenceSteps?: Analyticsreporting.Schema.SegmentSequenceStep[];
}
export interface SimpleSegment {
interface SimpleSegment {
orFiltersForSegment?: Analyticsreporting.Schema.OrFiltersForSegment[];
}
export interface TransactionData {
interface TransactionData {
transactionId?: string;
transactionRevenue?: number;
transactionShipping?: number;
transactionTax?: number;
}
export interface User {
interface User {
type?: string;
userId?: string;
}
export interface UserActivitySession {
interface UserActivitySession {
activities?: Analyticsreporting.Schema.Activity[];
dataSource?: string;
deviceCategory?: string;
@@ -300,7 +300,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface Analyticsreporting {
interface Analyticsreporting {
Reports?: Analyticsreporting.Collection.ReportsCollection;
UserActivity?: Analyticsreporting.Collection.UserActivityCollection;
// Create a new instance of Cohort
types/google-apps-script/apis/appsactivity_v1.d.ts
Vendored
+13 -13
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace Appsactivity {
namespace Collection {
export interface ActivitiesCollection {
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.
@@ -15,11 +15,11 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Activity {
interface Activity {
combinedEvent?: Appsactivity.Schema.Event;
singleEvents?: Appsactivity.Schema.Event[];
}
export interface Event {
interface Event {
additionalEventTypes?: string[];
eventTimeMillis?: string;
fromUserDeletion?: boolean;
@@ -30,20 +30,20 @@ declare namespace GoogleAppsScript {
target?: Appsactivity.Schema.Target;
user?: Appsactivity.Schema.User;
}
export interface ListActivitiesResponse {
interface ListActivitiesResponse {
activities?: Appsactivity.Schema.Activity[];
nextPageToken?: string;
}
export interface Move {
interface Move {
addedParents?: Appsactivity.Schema.Parent[];
removedParents?: Appsactivity.Schema.Parent[];
}
export interface Parent {
interface Parent {
id?: string;
isRoot?: boolean;
title?: string;
}
export interface Permission {
interface Permission {
name?: string;
permissionId?: string;
role?: string;
@@ -51,23 +51,23 @@ declare namespace GoogleAppsScript {
user?: Appsactivity.Schema.User;
withLink?: boolean;
}
export interface PermissionChange {
interface PermissionChange {
addedPermissions?: Appsactivity.Schema.Permission[];
removedPermissions?: Appsactivity.Schema.Permission[];
}
export interface Photo {
interface Photo {
url?: string;
}
export interface Rename {
interface Rename {
newTitle?: string;
oldTitle?: string;
}
export interface Target {
interface Target {
id?: string;
mimeType?: string;
name?: string;
}
export interface User {
interface User {
isDeleted?: boolean;
isMe?: boolean;
name?: string;
@@ -76,7 +76,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface Appsactivity {
interface Appsactivity {
Activities?: Appsactivity.Collection.ActivitiesCollection;
}
}
types/google-apps-script/apis/bigquery_v2.d.ts
Vendored
+81 -81
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace Bigquery {
namespace Collection {
export interface DatasetsCollection {
interface DatasetsCollection {
// Returns the dataset specified by datasetID.
get(projectId: string, datasetId: string): Bigquery.Schema.Dataset;
// Creates a new empty dataset.
@@ -25,7 +25,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface JobsCollection {
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.
@@ -49,7 +49,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface ProjectsCollection {
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.
@@ -57,7 +57,7 @@ declare namespace GoogleAppsScript {
// Lists all projects to which you have been granted any project role.
list(optionalArgs: object): Bigquery.Schema.ProjectList;
}
export interface TabledataCollection {
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.
@@ -65,7 +65,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface TablesCollection {
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.
@@ -85,11 +85,11 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface BigQueryModelTraining {
interface BigQueryModelTraining {
currentIteration?: number;
expectedTotalIterations?: string;
}
export interface BigtableColumn {
interface BigtableColumn {
encoding?: string;
fieldName?: string;
onlyReadLatest?: boolean;
@@ -97,32 +97,32 @@ declare namespace GoogleAppsScript {
qualifierString?: string;
type?: string;
}
export interface BigtableColumnFamily {
interface BigtableColumnFamily {
columns?: Bigquery.Schema.BigtableColumn[];
encoding?: string;
familyId?: string;
onlyReadLatest?: boolean;
type?: string;
}
export interface BigtableOptions {
interface BigtableOptions {
columnFamilies?: Bigquery.Schema.BigtableColumnFamily[];
ignoreUnspecifiedColumnFamilies?: boolean;
readRowkeyAsString?: boolean;
}
export interface BqmlIterationResult {
interface BqmlIterationResult {
durationMs?: string;
evalLoss?: number;
index?: number;
learnRate?: number;
trainingLoss?: number;
}
export interface BqmlTrainingRun {
interface BqmlTrainingRun {
iterationResults?: Bigquery.Schema.BqmlIterationResult[];
startTime?: string;
state?: string;
trainingOptions?: Bigquery.Schema.BqmlTrainingRunTrainingOptions;
}
export interface BqmlTrainingRunTrainingOptions {
interface BqmlTrainingRunTrainingOptions {
earlyStop?: boolean;
l1Reg?: number;
l2Reg?: number;
@@ -133,10 +133,10 @@ declare namespace GoogleAppsScript {
minRelProgress?: number;
warmStart?: boolean;
}
export interface Clustering {
interface Clustering {
fields?: string[];
}
export interface CsvOptions {
interface CsvOptions {
allowJaggedRows?: boolean;
allowQuotedNewlines?: boolean;
encoding?: string;
@@ -144,7 +144,7 @@ declare namespace GoogleAppsScript {
quote?: string;
skipLeadingRows?: string;
}
export interface Dataset {
interface Dataset {
access?: Bigquery.Schema.DatasetAccess[];
creationTime?: string;
datasetReference?: Bigquery.Schema.DatasetReference;
@@ -160,7 +160,7 @@ declare namespace GoogleAppsScript {
location?: string;
selfLink?: string;
}
export interface DatasetAccess {
interface DatasetAccess {
domain?: string;
groupByEmail?: string;
iamMember?: string;
@@ -169,13 +169,13 @@ declare namespace GoogleAppsScript {
userByEmail?: string;
view?: Bigquery.Schema.TableReference;
}
export interface DatasetList {
interface DatasetList {
datasets?: Bigquery.Schema.DatasetListDatasets[];
etag?: string;
kind?: string;
nextPageToken?: string;
}
export interface DatasetListDatasets {
interface DatasetListDatasets {
datasetReference?: Bigquery.Schema.DatasetReference;
friendlyName?: string;
id?: string;
@@ -183,25 +183,25 @@ declare namespace GoogleAppsScript {
labels?: object;
location?: string;
}
export interface DatasetReference {
interface DatasetReference {
datasetId?: string;
projectId?: string;
}
export interface DestinationTableProperties {
interface DestinationTableProperties {
description?: string;
friendlyName?: string;
labels?: object;
}
export interface EncryptionConfiguration {
interface EncryptionConfiguration {
kmsKeyName?: string;
}
export interface ErrorProto {
interface ErrorProto {
debugInfo?: string;
location?: string;
message?: string;
reason?: string;
}
export interface ExplainQueryStage {
interface ExplainQueryStage {
completedParallelInputs?: string;
computeMsAvg?: string;
computeMsMax?: string;
@@ -232,11 +232,11 @@ declare namespace GoogleAppsScript {
writeRatioAvg?: number;
writeRatioMax?: number;
}
export interface ExplainQueryStep {
interface ExplainQueryStep {
kind?: string;
substeps?: string[];
}
export interface ExternalDataConfiguration {
interface ExternalDataConfiguration {
autodetect?: boolean;
bigtableOptions?: Bigquery.Schema.BigtableOptions;
compression?: string;
@@ -249,7 +249,7 @@ declare namespace GoogleAppsScript {
sourceFormat?: string;
sourceUris?: string[];
}
export interface GetQueryResultsResponse {
interface GetQueryResultsResponse {
cacheHit?: boolean;
errors?: Bigquery.Schema.ErrorProto[];
etag?: string;
@@ -263,15 +263,15 @@ declare namespace GoogleAppsScript {
totalBytesProcessed?: string;
totalRows?: string;
}
export interface GetServiceAccountResponse {
interface GetServiceAccountResponse {
email?: string;
kind?: string;
}
export interface GoogleSheetsOptions {
interface GoogleSheetsOptions {
range?: string;
skipLeadingRows?: string;
}
export interface Job {
interface Job {
configuration?: Bigquery.Schema.JobConfiguration;
etag?: string;
id?: string;
@@ -282,11 +282,11 @@ declare namespace GoogleAppsScript {
status?: Bigquery.Schema.JobStatus;
user_email?: string;
}
export interface JobCancelResponse {
interface JobCancelResponse {
job?: Bigquery.Schema.Job;
kind?: string;
}
export interface JobConfiguration {
interface JobConfiguration {
copy?: Bigquery.Schema.JobConfigurationTableCopy;
dryRun?: boolean;
extract?: Bigquery.Schema.JobConfigurationExtract;
@@ -296,7 +296,7 @@ declare namespace GoogleAppsScript {
load?: Bigquery.Schema.JobConfigurationLoad;
query?: Bigquery.Schema.JobConfigurationQuery;
}
export interface JobConfigurationExtract {
interface JobConfigurationExtract {
compression?: string;
destinationFormat?: string;
destinationUri?: string;
@@ -305,7 +305,7 @@ declare namespace GoogleAppsScript {
printHeader?: boolean;
sourceTable?: Bigquery.Schema.TableReference;
}
export interface JobConfigurationLoad {
interface JobConfigurationLoad {
allowJaggedRows?: boolean;
allowQuotedNewlines?: boolean;
autodetect?: boolean;
@@ -334,7 +334,7 @@ declare namespace GoogleAppsScript {
useAvroLogicalTypes?: boolean;
writeDisposition?: string;
}
export interface JobConfigurationQuery {
interface JobConfigurationQuery {
allowLargeResults?: boolean;
clustering?: Bigquery.Schema.Clustering;
createDisposition?: string;
@@ -358,7 +358,7 @@ declare namespace GoogleAppsScript {
userDefinedFunctionResources?: Bigquery.Schema.UserDefinedFunctionResource[];
writeDisposition?: string;
}
export interface JobConfigurationTableCopy {
interface JobConfigurationTableCopy {
createDisposition?: string;
destinationEncryptionConfiguration?: Bigquery.Schema.EncryptionConfiguration;
destinationTable?: Bigquery.Schema.TableReference;
@@ -366,13 +366,13 @@ declare namespace GoogleAppsScript {
sourceTables?: Bigquery.Schema.TableReference[];
writeDisposition?: string;
}
export interface JobList {
interface JobList {
etag?: string;
jobs?: Bigquery.Schema.JobListJobs[];
kind?: string;
nextPageToken?: string;
}
export interface JobListJobs {
interface JobListJobs {
configuration?: Bigquery.Schema.JobConfiguration;
errorResult?: Bigquery.Schema.ErrorProto;
id?: string;
@@ -383,12 +383,12 @@ declare namespace GoogleAppsScript {
status?: Bigquery.Schema.JobStatus;
user_email?: string;
}
export interface JobReference {
interface JobReference {
jobId?: string;
location?: string;
projectId?: string;
}
export interface JobStatistics {
interface JobStatistics {
completionRatio?: number;
creationTime?: string;
endTime?: string;
@@ -403,7 +403,7 @@ declare namespace GoogleAppsScript {
totalBytesProcessed?: string;
totalSlotMs?: string;
}
export interface JobStatistics2 {
interface JobStatistics2 {
billingTier?: number;
cacheHit?: boolean;
ddlOperationPerformed?: string;
@@ -427,81 +427,81 @@ declare namespace GoogleAppsScript {
totalSlotMs?: string;
undeclaredQueryParameters?: Bigquery.Schema.QueryParameter[];
}
export interface JobStatistics2ReservationUsage {
interface JobStatistics2ReservationUsage {
name?: string;
slotMs?: string;
}
export interface JobStatistics3 {
interface JobStatistics3 {
badRecords?: string;
inputFileBytes?: string;
inputFiles?: string;
outputBytes?: string;
outputRows?: string;
}
export interface JobStatistics4 {
interface JobStatistics4 {
destinationUriFileCounts?: string[];
inputBytes?: string;
}
export interface JobStatisticsReservationUsage {
interface JobStatisticsReservationUsage {
name?: string;
slotMs?: string;
}
export interface JobStatus {
interface JobStatus {
errorResult?: Bigquery.Schema.ErrorProto;
errors?: Bigquery.Schema.ErrorProto[];
state?: string;
}
export interface MaterializedViewDefinition {
interface MaterializedViewDefinition {
lastRefreshTime?: string;
query?: string;
}
export interface ModelDefinition {
interface ModelDefinition {
modelOptions?: Bigquery.Schema.ModelDefinitionModelOptions;
trainingRuns?: Bigquery.Schema.BqmlTrainingRun[];
}
export interface ModelDefinitionModelOptions {
interface ModelDefinitionModelOptions {
labels?: string[];
lossType?: string;
modelType?: string;
}
export interface ProjectList {
interface ProjectList {
etag?: string;
kind?: string;
nextPageToken?: string;
projects?: Bigquery.Schema.ProjectListProjects[];
totalItems?: number;
}
export interface ProjectListProjects {
interface ProjectListProjects {
friendlyName?: string;
id?: string;
kind?: string;
numericId?: string;
projectReference?: Bigquery.Schema.ProjectReference;
}
export interface ProjectReference {
interface ProjectReference {
projectId?: string;
}
export interface QueryParameter {
interface QueryParameter {
name?: string;
parameterType?: Bigquery.Schema.QueryParameterType;
parameterValue?: Bigquery.Schema.QueryParameterValue;
}
export interface QueryParameterType {
interface QueryParameterType {
arrayType?: Bigquery.Schema.QueryParameterType;
structTypes?: Bigquery.Schema.QueryParameterTypeStructTypes[];
type?: string;
}
export interface QueryParameterTypeStructTypes {
interface QueryParameterTypeStructTypes {
description?: string;
name?: string;
type?: Bigquery.Schema.QueryParameterType;
}
export interface QueryParameterValue {
interface QueryParameterValue {
arrayValues?: Bigquery.Schema.QueryParameterValue[];
structValues?: object;
value?: string;
}
export interface QueryRequest {
interface QueryRequest {
defaultDataset?: Bigquery.Schema.DatasetReference;
dryRun?: boolean;
kind?: string;
@@ -515,7 +515,7 @@ declare namespace GoogleAppsScript {
useLegacySql?: boolean;
useQueryCache?: boolean;
}
export interface QueryResponse {
interface QueryResponse {
cacheHit?: boolean;
errors?: Bigquery.Schema.ErrorProto[];
jobComplete?: boolean;
@@ -528,33 +528,33 @@ declare namespace GoogleAppsScript {
totalBytesProcessed?: string;
totalRows?: string;
}
export interface QueryTimelineSample {
interface QueryTimelineSample {
activeUnits?: string;
completedUnits?: string;
elapsedMs?: string;
pendingUnits?: string;
totalSlotMs?: string;
}
export interface RangePartitioning {
interface RangePartitioning {
field?: string;
range?: Bigquery.Schema.RangePartitioningRange;
}
export interface RangePartitioningRange {
interface RangePartitioningRange {
end?: string;
interval?: string;
start?: string;
}
export interface RoutineReference {
interface RoutineReference {
datasetId?: string;
projectId?: string;
routineId?: string;
}
export interface Streamingbuffer {
interface Streamingbuffer {
estimatedBytes?: string;
estimatedRows?: string;
oldestEntryTime?: string;
}
export interface Table {
interface Table {
clustering?: Bigquery.Schema.Clustering;
creationTime?: string;
description?: string;
@@ -584,36 +584,36 @@ declare namespace GoogleAppsScript {
type?: string;
view?: Bigquery.Schema.ViewDefinition;
}
export interface TableCell {
interface TableCell {
v?: object;
}
export interface TableDataInsertAllRequest {
interface TableDataInsertAllRequest {
ignoreUnknownValues?: boolean;
kind?: string;
rows?: Bigquery.Schema.TableDataInsertAllRequestRows[];
skipInvalidRows?: boolean;
templateSuffix?: string;
}
export interface TableDataInsertAllRequestRows {
interface TableDataInsertAllRequestRows {
insertId?: string;
json?: object;
}
export interface TableDataInsertAllResponse {
interface TableDataInsertAllResponse {
insertErrors?: Bigquery.Schema.TableDataInsertAllResponseInsertErrors[];
kind?: string;
}
export interface TableDataInsertAllResponseInsertErrors {
interface TableDataInsertAllResponseInsertErrors {
errors?: Bigquery.Schema.ErrorProto[];
index?: number;
}
export interface TableDataList {
interface TableDataList {
etag?: string;
kind?: string;
pageToken?: string;
rows?: Bigquery.Schema.TableRow[];
totalRows?: string;
}
export interface TableFieldSchema {
interface TableFieldSchema {
categories?: Bigquery.Schema.TableFieldSchemaCategories;
description?: string;
fields?: Bigquery.Schema.TableFieldSchema[];
@@ -621,17 +621,17 @@ declare namespace GoogleAppsScript {
name?: string;
type?: string;
}
export interface TableFieldSchemaCategories {
interface TableFieldSchemaCategories {
names?: string[];
}
export interface TableList {
interface TableList {
etag?: string;
kind?: string;
nextPageToken?: string;
tables?: Bigquery.Schema.TableListTables[];
totalItems?: number;
}
export interface TableListTables {
interface TableListTables {
clustering?: Bigquery.Schema.Clustering;
creationTime?: string;
expirationTime?: string;
@@ -644,38 +644,38 @@ declare namespace GoogleAppsScript {
type?: string;
view?: Bigquery.Schema.TableListTablesView;
}
export interface TableListTablesView {
interface TableListTablesView {
useLegacySql?: boolean;
}
export interface TableReference {
interface TableReference {
datasetId?: string;
projectId?: string;
tableId?: string;
}
export interface TableRow {
interface TableRow {
f?: Bigquery.Schema.TableCell[];
}
export interface TableSchema {
interface TableSchema {
fields?: Bigquery.Schema.TableFieldSchema[];
}
export interface TimePartitioning {
interface TimePartitioning {
expirationMs?: string;
field?: string;
requirePartitionFilter?: boolean;
type?: string;
}
export interface UserDefinedFunctionResource {
interface UserDefinedFunctionResource {
inlineCode?: string;
resourceUri?: string;
}
export interface ViewDefinition {
interface ViewDefinition {
query?: string;
useLegacySql?: boolean;
userDefinedFunctionResources?: Bigquery.Schema.UserDefinedFunctionResource[];
}
}
}
export interface Bigquery {
interface Bigquery {
Datasets?: Bigquery.Collection.DatasetsCollection;
Jobs?: Bigquery.Collection.JobsCollection;
Projects?: Bigquery.Collection.ProjectsCollection;
types/google-apps-script/apis/calendar_v3.d.ts
Vendored
+50 -50
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace Calendar {
namespace Collection {
export interface AclCollection {
interface AclCollection {
// Returns an access control rule.
get(calendarId: string, ruleId: string): Calendar.Schema.AclRule;
// Returns an access control rule.
@@ -47,7 +47,7 @@ declare namespace GoogleAppsScript {
// Watch for changes to ACL resources.
watch(resource: Schema.Channel, calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Channel;
}
export interface CalendarListCollection {
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.
@@ -87,7 +87,7 @@ declare namespace GoogleAppsScript {
// Watch for changes to CalendarList resources.
watch(resource: Schema.Channel, optionalArgs: object, headers: object): Calendar.Schema.Channel;
}
export interface CalendarsCollection {
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.
@@ -113,19 +113,19 @@ declare namespace GoogleAppsScript {
// Updates metadata for a calendar.
update(resource: Schema.Calendar, calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Calendar;
}
export interface ChannelsCollection {
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;
}
export interface ColorsCollection {
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;
}
export interface EventsCollection {
interface EventsCollection {
// Returns an event.
get(calendarId: string, eventId: string): Calendar.Schema.Event;
// Returns an event.
@@ -193,13 +193,13 @@ declare namespace GoogleAppsScript {
// Watch for changes to Events resources.
watch(resource: Schema.Channel, calendarId: string, optionalArgs: object, headers: object): Calendar.Schema.Channel;
}
export interface FreebusyCollection {
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;
}
export interface SettingsCollection {
interface SettingsCollection {
// Returns a single user setting.
get(setting: string): Calendar.Schema.Setting;
// Returns a single user setting.
@@ -219,25 +219,25 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Acl {
interface Acl {
etag?: string;
items?: Calendar.Schema.AclRule[];
kind?: string;
nextPageToken?: string;
nextSyncToken?: string;
}
export interface AclRule {
interface AclRule {
etag?: string;
id?: string;
kind?: string;
role?: string;
scope?: Calendar.Schema.AclRuleScope;
}
export interface AclRuleScope {
interface AclRuleScope {
type?: string;
value?: string;
}
export interface Calendar {
interface Calendar {
conferenceProperties?: Calendar.Schema.ConferenceProperties;
description?: string;
etag?: string;
@@ -247,14 +247,14 @@ declare namespace GoogleAppsScript {
summary?: string;
timeZone?: string;
}
export interface CalendarList {
interface CalendarList {
etag?: string;
items?: Calendar.Schema.CalendarListEntry[];
kind?: string;
nextPageToken?: string;
nextSyncToken?: string;
}
export interface CalendarListEntry {
interface CalendarListEntry {
accessRole?: string;
backgroundColor?: string;
colorId?: string;
@@ -275,14 +275,14 @@ declare namespace GoogleAppsScript {
summaryOverride?: string;
timeZone?: string;
}
export interface CalendarListEntryNotificationSettings {
interface CalendarListEntryNotificationSettings {
notifications?: Calendar.Schema.CalendarNotification[];
}
export interface CalendarNotification {
interface CalendarNotification {
method?: string;
type?: string;
}
export interface Channel {
interface Channel {
address?: string;
expiration?: string;
id?: string;
@@ -294,17 +294,17 @@ declare namespace GoogleAppsScript {
token?: string;
type?: string;
}
export interface ColorDefinition {
interface ColorDefinition {
background?: string;
foreground?: string;
}
export interface Colors {
interface Colors {
calendar?: object;
event?: object;
kind?: string;
updated?: string;
}
export interface ConferenceData {
interface ConferenceData {
conferenceId?: string;
conferenceSolution?: Calendar.Schema.ConferenceSolution;
createRequest?: Calendar.Schema.CreateConferenceRequest;
@@ -313,32 +313,32 @@ declare namespace GoogleAppsScript {
parameters?: Calendar.Schema.ConferenceParameters;
signature?: string;
}
export interface ConferenceParameters {
interface ConferenceParameters {
addOnParameters?: Calendar.Schema.ConferenceParametersAddOnParameters;
}
export interface ConferenceParametersAddOnParameters {
interface ConferenceParametersAddOnParameters {
parameters?: object;
}
export interface ConferenceProperties {
interface ConferenceProperties {
allowedConferenceSolutionTypes?: string[];
}
export interface ConferenceRequestStatus {
interface ConferenceRequestStatus {
statusCode?: string;
}
export interface ConferenceSolution {
interface ConferenceSolution {
iconUri?: string;
key?: Calendar.Schema.ConferenceSolutionKey;
name?: string;
}
export interface ConferenceSolutionKey {
interface ConferenceSolutionKey {
type?: string;
}
export interface CreateConferenceRequest {
interface CreateConferenceRequest {
conferenceSolutionKey?: Calendar.Schema.ConferenceSolutionKey;
requestId?: string;
status?: Calendar.Schema.ConferenceRequestStatus;
}
export interface EntryPoint {
interface EntryPoint {
accessCode?: string;
entryPointFeatures?: string[];
entryPointType?: string;
@@ -350,11 +350,11 @@ declare namespace GoogleAppsScript {
regionCode?: string;
uri?: string;
}
export interface Error {
interface Error {
domain?: string;
reason?: string;
}
export interface Event {
interface Event {
anyoneCanAddSelf?: boolean;
attachments?: Calendar.Schema.EventAttachment[];
attendees?: Calendar.Schema.EventAttendee[];
@@ -394,14 +394,14 @@ declare namespace GoogleAppsScript {
updated?: string;
visibility?: string;
}
export interface EventAttachment {
interface EventAttachment {
fileId?: string;
fileUrl?: string;
iconLink?: string;
mimeType?: string;
title?: string;
}
export interface EventAttendee {
interface EventAttendee {
additionalGuests?: number;
comment?: string;
displayName?: string;
@@ -413,22 +413,22 @@ declare namespace GoogleAppsScript {
responseStatus?: string;
self?: boolean;
}
export interface EventCreator {
interface EventCreator {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
}
export interface EventDateTime {
interface EventDateTime {
date?: string;
dateTime?: string;
timeZone?: string;
}
export interface EventExtendedProperties {
interface EventExtendedProperties {
private?: object;
shared?: object;
}
export interface EventGadget {
interface EventGadget {
display?: string;
height?: number;
iconLink?: string;
@@ -438,25 +438,25 @@ declare namespace GoogleAppsScript {
type?: string;
width?: number;
}
export interface EventOrganizer {
interface EventOrganizer {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
}
export interface EventReminder {
interface EventReminder {
method?: string;
minutes?: number;
}
export interface EventReminders {
interface EventReminders {
overrides?: Calendar.Schema.EventReminder[];
useDefault?: boolean;
}
export interface EventSource {
interface EventSource {
title?: string;
url?: string;
}
export interface Events {
interface Events {
accessRole?: string;
defaultReminders?: Calendar.Schema.EventReminder[];
description?: string;
@@ -469,15 +469,15 @@ declare namespace GoogleAppsScript {
timeZone?: string;
updated?: string;
}
export interface FreeBusyCalendar {
interface FreeBusyCalendar {
busy?: Calendar.Schema.TimePeriod[];
errors?: Calendar.Schema.Error[];
}
export interface FreeBusyGroup {
interface FreeBusyGroup {
calendars?: string[];
errors?: Calendar.Schema.Error[];
}
export interface FreeBusyRequest {
interface FreeBusyRequest {
calendarExpansionMax?: number;
groupExpansionMax?: number;
items?: Calendar.Schema.FreeBusyRequestItem[];
@@ -485,36 +485,36 @@ declare namespace GoogleAppsScript {
timeMin?: string;
timeZone?: string;
}
export interface FreeBusyRequestItem {
interface FreeBusyRequestItem {
id?: string;
}
export interface FreeBusyResponse {
interface FreeBusyResponse {
calendars?: object;
groups?: object;
kind?: string;
timeMax?: string;
timeMin?: string;
}
export interface Setting {
interface Setting {
etag?: string;
id?: string;
kind?: string;
value?: string;
}
export interface Settings {
interface Settings {
etag?: string;
items?: Calendar.Schema.Setting[];
kind?: string;
nextPageToken?: string;
nextSyncToken?: string;
}
export interface TimePeriod {
interface TimePeriod {
end?: string;
start?: string;
}
}
}
export interface Calendar {
interface Calendar {
Acl?: Calendar.Collection.AclCollection;
CalendarList?: Calendar.Collection.CalendarListCollection;
Calendars?: Calendar.Collection.CalendarsCollection;
types/google-apps-script/apis/classroom_v1.d.ts
Vendored
+66 -66
View File
@@ -9,7 +9,7 @@ declare namespace GoogleAppsScript {
namespace Collection {
namespace Courses {
namespace CourseWork {
export interface StudentSubmissionsCollection {
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
@@ -140,7 +140,7 @@ declare namespace GoogleAppsScript {
turnIn(resource: any, courseId: string, courseWorkId: string, id: string): void;
}
}
export interface AliasesCollection {
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
@@ -173,7 +173,7 @@ declare namespace GoogleAppsScript {
// attempts to delete a domain-scoped alias).
remove(courseId: string, alias: string): void;
}
export interface AnnouncementsCollection {
interface AnnouncementsCollection {
// Creates an announcement.
// This method returns the following error codes:
// * `PERMISSION_DENIED` if the requesting user is not permitted to access the
@@ -249,7 +249,7 @@ declare namespace GoogleAppsScript {
// * `NOT_FOUND` if no course exists with the requested ID.
remove(courseId: string, id: string): void;
}
export interface CourseWorkCollection {
interface CourseWorkCollection {
StudentSubmissions?: Classroom.Collection.Courses.CourseWork.StudentSubmissionsCollection;
// Creates course work.
// The resulting course work (and corresponding student submissions) are
@@ -348,7 +348,7 @@ declare namespace GoogleAppsScript {
// * `NOT_FOUND` if no course exists with the requested ID.
remove(courseId: string, id: string): void;
}
export interface StudentsCollection {
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
@@ -402,7 +402,7 @@ declare namespace GoogleAppsScript {
// course does not exist.
remove(courseId: string, userId: string): void;
}
export interface TeachersCollection {
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
@@ -448,7 +448,7 @@ declare namespace GoogleAppsScript {
}
}
namespace UserProfiles {
export interface GuardianInvitationsCollection {
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
@@ -552,7 +552,7 @@ declare namespace GoogleAppsScript {
// refer to a guardian invitation known to Classroom.
patch(resource: Schema.GuardianInvitation, studentId: string, invitationId: string, optionalArgs: object): Classroom.Schema.GuardianInvitation;
}
export interface GuardiansCollection {
interface GuardiansCollection {
// Returns a specific guardian.
// This method returns the following error codes:
// * `PERMISSION_DENIED` if no user that matches the provided `student_id`
@@ -621,7 +621,7 @@ declare namespace GoogleAppsScript {
remove(studentId: string, guardianId: string): void;
}
}
export interface CoursesCollection {
interface CoursesCollection {
Aliases?: Classroom.Collection.Courses.AliasesCollection;
Announcements?: Classroom.Collection.Courses.AnnouncementsCollection;
CourseWork?: Classroom.Collection.Courses.CourseWorkCollection;
@@ -697,7 +697,7 @@ declare namespace GoogleAppsScript {
// * CourseNotModifiable
update(resource: Schema.Course, id: string): Classroom.Schema.Course;
}
export interface InvitationsCollection {
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.
@@ -749,7 +749,7 @@ declare namespace GoogleAppsScript {
// * `NOT_FOUND` if no invitation exists with the requested ID.
remove(id: string): void;
}
export interface RegistrationsCollection {
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
@@ -781,7 +781,7 @@ declare namespace GoogleAppsScript {
// for that `Registration`.
remove(registrationId: string): void;
}
export interface UserProfilesCollection {
interface UserProfilesCollection {
GuardianInvitations?: Classroom.Collection.UserProfiles.GuardianInvitationsCollection;
Guardians?: Classroom.Collection.UserProfiles.GuardiansCollection;
// Returns a user profile.
@@ -793,7 +793,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Announcement {
interface Announcement {
alternateLink?: string;
assigneeMode?: string;
courseId?: string;
@@ -807,22 +807,22 @@ declare namespace GoogleAppsScript {
text?: string;
updateTime?: string;
}
export interface Assignment {
interface Assignment {
studentWorkFolder?: Classroom.Schema.DriveFolder;
}
export interface AssignmentSubmission {
interface AssignmentSubmission {
attachments?: Classroom.Schema.Attachment[];
}
export interface Attachment {
interface Attachment {
driveFile?: Classroom.Schema.DriveFile;
form?: Classroom.Schema.Form;
link?: Classroom.Schema.Link;
youTubeVideo?: Classroom.Schema.YouTubeVideo;
}
export interface CloudPubsubTopic {
interface CloudPubsubTopic {
topicName?: string;
}
export interface Course {
interface Course {
alternateLink?: string;
calendarId?: string;
courseGroupEmail?: string;
@@ -842,23 +842,23 @@ declare namespace GoogleAppsScript {
teacherGroupEmail?: string;
updateTime?: string;
}
export interface CourseAlias {
interface CourseAlias {
alias?: string;
}
export interface CourseMaterial {
interface CourseMaterial {
driveFile?: Classroom.Schema.DriveFile;
form?: Classroom.Schema.Form;
link?: Classroom.Schema.Link;
youTubeVideo?: Classroom.Schema.YouTubeVideo;
}
export interface CourseMaterialSet {
interface CourseMaterialSet {
materials?: Classroom.Schema.CourseMaterial[];
title?: string;
}
export interface CourseRosterChangesInfo {
interface CourseRosterChangesInfo {
courseId?: string;
}
export interface CourseWork {
interface CourseWork {
alternateLink?: string;
assigneeMode?: string;
assignment?: Classroom.Schema.Assignment;
@@ -881,170 +881,170 @@ declare namespace GoogleAppsScript {
updateTime?: string;
workType?: string;
}
export interface CourseWorkChangesInfo {
interface CourseWorkChangesInfo {
courseId?: string;
}
export interface Date {
interface Date {
day?: number;
month?: number;
year?: number;
}
export interface DriveFile {
interface DriveFile {
alternateLink?: string;
id?: string;
thumbnailUrl?: string;
title?: string;
}
export interface DriveFolder {
interface DriveFolder {
alternateLink?: string;
id?: string;
title?: string;
}
export interface Feed {
interface Feed {
courseRosterChangesInfo?: Classroom.Schema.CourseRosterChangesInfo;
courseWorkChangesInfo?: Classroom.Schema.CourseWorkChangesInfo;
feedType?: string;
}
export interface Form {
interface Form {
formUrl?: string;
responseUrl?: string;
thumbnailUrl?: string;
title?: string;
}
export interface GlobalPermission {
interface GlobalPermission {
permission?: string;
}
export interface GradeHistory {
interface GradeHistory {
actorUserId?: string;
gradeChangeType?: string;
gradeTimestamp?: string;
maxPoints?: number;
pointsEarned?: number;
}
export interface Guardian {
interface Guardian {
guardianId?: string;
guardianProfile?: Classroom.Schema.UserProfile;
invitedEmailAddress?: string;
studentId?: string;
}
export interface GuardianInvitation {
interface GuardianInvitation {
creationTime?: string;
invitationId?: string;
invitedEmailAddress?: string;
state?: string;
studentId?: string;
}
export interface IndividualStudentsOptions {
interface IndividualStudentsOptions {
studentIds?: string[];
}
export interface Invitation {
interface Invitation {
courseId?: string;
id?: string;
role?: string;
userId?: string;
}
export interface Link {
interface Link {
thumbnailUrl?: string;
title?: string;
url?: string;
}
export interface ListAnnouncementsResponse {
interface ListAnnouncementsResponse {
announcements?: Classroom.Schema.Announcement[];
nextPageToken?: string;
}
export interface ListCourseAliasesResponse {
interface ListCourseAliasesResponse {
aliases?: Classroom.Schema.CourseAlias[];
nextPageToken?: string;
}
export interface ListCourseWorkResponse {
interface ListCourseWorkResponse {
courseWork?: Classroom.Schema.CourseWork[];
nextPageToken?: string;
}
export interface ListCoursesResponse {
interface ListCoursesResponse {
courses?: Classroom.Schema.Course[];
nextPageToken?: string;
}
export interface ListGuardianInvitationsResponse {
interface ListGuardianInvitationsResponse {
guardianInvitations?: Classroom.Schema.GuardianInvitation[];
nextPageToken?: string;
}
export interface ListGuardiansResponse {
interface ListGuardiansResponse {
guardians?: Classroom.Schema.Guardian[];
nextPageToken?: string;
}
export interface ListInvitationsResponse {
interface ListInvitationsResponse {
invitations?: Classroom.Schema.Invitation[];
nextPageToken?: string;
}
export interface ListStudentSubmissionsResponse {
interface ListStudentSubmissionsResponse {
nextPageToken?: string;
studentSubmissions?: Classroom.Schema.StudentSubmission[];
}
export interface ListStudentsResponse {
interface ListStudentsResponse {
nextPageToken?: string;
students?: Classroom.Schema.Student[];
}
export interface ListTeachersResponse {
interface ListTeachersResponse {
nextPageToken?: string;
teachers?: Classroom.Schema.Teacher[];
}
export interface Material {
interface Material {
driveFile?: Classroom.Schema.SharedDriveFile;
form?: Classroom.Schema.Form;
link?: Classroom.Schema.Link;
youtubeVideo?: Classroom.Schema.YouTubeVideo;
}
export interface ModifyAnnouncementAssigneesRequest {
interface ModifyAnnouncementAssigneesRequest {
assigneeMode?: string;
modifyIndividualStudentsOptions?: Classroom.Schema.ModifyIndividualStudentsOptions;
}
export interface ModifyAttachmentsRequest {
interface ModifyAttachmentsRequest {
addAttachments?: Classroom.Schema.Attachment[];
}
export interface ModifyCourseWorkAssigneesRequest {
interface ModifyCourseWorkAssigneesRequest {
assigneeMode?: string;
modifyIndividualStudentsOptions?: Classroom.Schema.ModifyIndividualStudentsOptions;
}
export interface ModifyIndividualStudentsOptions {
interface ModifyIndividualStudentsOptions {
addStudentIds?: string[];
removeStudentIds?: string[];
}
export interface MultipleChoiceQuestion {
interface MultipleChoiceQuestion {
choices?: string[];
}
export interface MultipleChoiceSubmission {
interface MultipleChoiceSubmission {
answer?: string;
}
export interface Name {
interface Name {
familyName?: string;
fullName?: string;
givenName?: string;
}
export interface Registration {
interface Registration {
cloudPubsubTopic?: Classroom.Schema.CloudPubsubTopic;
expiryTime?: string;
feed?: Classroom.Schema.Feed;
registrationId?: string;
}
export interface SharedDriveFile {
interface SharedDriveFile {
driveFile?: Classroom.Schema.DriveFile;
shareMode?: string;
}
export interface ShortAnswerSubmission {
interface ShortAnswerSubmission {
answer?: string;
}
export interface StateHistory {
interface StateHistory {
actorUserId?: string;
state?: string;
stateTimestamp?: string;
}
export interface Student {
interface Student {
courseId?: string;
profile?: Classroom.Schema.UserProfile;
studentWorkFolder?: Classroom.Schema.DriveFolder;
userId?: string;
}
export interface StudentSubmission {
interface StudentSubmission {
alternateLink?: string;
assignedGrade?: number;
assignmentSubmission?: Classroom.Schema.AssignmentSubmission;
@@ -1063,22 +1063,22 @@ declare namespace GoogleAppsScript {
updateTime?: string;
userId?: string;
}
export interface SubmissionHistory {
interface SubmissionHistory {
gradeHistory?: Classroom.Schema.GradeHistory;
stateHistory?: Classroom.Schema.StateHistory;
}
export interface Teacher {
interface Teacher {
courseId?: string;
profile?: Classroom.Schema.UserProfile;
userId?: string;
}
export interface TimeOfDay {
interface TimeOfDay {
hours?: number;
minutes?: number;
nanos?: number;
seconds?: number;
}
export interface UserProfile {
interface UserProfile {
emailAddress?: string;
id?: string;
name?: Classroom.Schema.Name;
@@ -1086,7 +1086,7 @@ declare namespace GoogleAppsScript {
photoUrl?: string;
verifiedTeacher?: boolean;
}
export interface YouTubeVideo {
interface YouTubeVideo {
alternateLink?: string;
id?: string;
thumbnailUrl?: string;
@@ -1094,7 +1094,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface Classroom {
interface Classroom {
Courses?: Classroom.Collection.CoursesCollection;
Invitations?: Classroom.Collection.InvitationsCollection;
Registrations?: Classroom.Collection.RegistrationsCollection;
types/google-apps-script/apis/content_v2.d.ts
Vendored
+286 -286
View File
File diff suppressed because it is too large Load Diff
types/google-apps-script/apis/dfareporting_v3_3.d.ts
Vendored
+289 -289
View File
File diff suppressed because it is too large Load Diff
types/google-apps-script/apis/directory_v1.d.ts
Vendored
+113 -113
View File
@@ -8,7 +8,7 @@ declare namespace GoogleAppsScript {
namespace AdminDirectory {
namespace Collection {
namespace Groups {
export interface AliasesCollection {
interface AliasesCollection {
// Add a alias for the group
insert(resource: Schema.Alias, groupKey: string): AdminDirectory.Schema.Alias;
// List all aliases for a group
@@ -18,7 +18,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Resources {
export interface BuildingsCollection {
interface BuildingsCollection {
// Retrieves a building.
get(customer: string, buildingId: string): AdminDirectory.Schema.Building;
// Inserts a building.
@@ -40,7 +40,7 @@ declare namespace GoogleAppsScript {
// Updates a building.
update(resource: Schema.Building, customer: string, buildingId: string, optionalArgs: object): AdminDirectory.Schema.Building;
}
export interface CalendarsCollection {
interface CalendarsCollection {
// Retrieves a calendar resource.
get(customer: string, calendarResourceId: string): AdminDirectory.Schema.CalendarResource;
// Inserts a calendar resource.
@@ -58,7 +58,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface FeaturesCollection {
interface FeaturesCollection {
// Retrieves a feature.
get(customer: string, featureKey: string): AdminDirectory.Schema.Feature;
// Inserts a feature.
@@ -78,7 +78,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Users {
export interface AliasesCollection {
interface AliasesCollection {
// Add a alias for the user
insert(resource: Schema.Alias, userKey: string): AdminDirectory.Schema.Alias;
// List all aliases for a user
@@ -92,7 +92,7 @@ declare namespace GoogleAppsScript {
// Watch for changes in user aliases list
watch(resource: Schema.Channel, userKey: string, optionalArgs: object): AdminDirectory.Schema.Channel;
}
export interface PhotosCollection {
interface PhotosCollection {
// Retrieve photo of a user
get(userKey: string): AdminDirectory.Schema.UserPhoto;
// Add a photo for the user. This method supports patch semantics.
@@ -103,7 +103,7 @@ declare namespace GoogleAppsScript {
update(resource: Schema.UserPhoto, userKey: string): AdminDirectory.Schema.UserPhoto;
}
}
export interface AspsCollection {
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.
@@ -111,11 +111,11 @@ declare namespace GoogleAppsScript {
// Delete an ASP issued by a user.
remove(userKey: string, codeId: number): void;
}
export interface ChannelsCollection {
interface ChannelsCollection {
// Stop watching resources through this channel
stop(resource: Schema.Channel): void;
}
export interface ChromeosdevicesCollection {
interface ChromeosdevicesCollection {
// Take action on Chrome OS Device
action(resource: Schema.ChromeOsDeviceAction, customerId: string, resourceId: string): void;
// Retrieve Chrome OS Device
@@ -137,7 +137,7 @@ declare namespace GoogleAppsScript {
// Update Chrome OS Device
update(resource: Schema.ChromeOsDevice, customerId: string, deviceId: string, optionalArgs: object): AdminDirectory.Schema.ChromeOsDevice;
}
export interface CustomersCollection {
interface CustomersCollection {
// Retrieves a customer.
get(customerKey: string): AdminDirectory.Schema.Customer;
// Updates a customer. This method supports patch semantics.
@@ -145,7 +145,7 @@ declare namespace GoogleAppsScript {
// Updates a customer.
update(resource: Schema.Customer, customerKey: string): AdminDirectory.Schema.Customer;
}
export interface DomainAliasesCollection {
interface DomainAliasesCollection {
// Retrieves a domain alias of the customer.
get(customer: string, domainAliasName: string): AdminDirectory.Schema.DomainAlias;
// Inserts a Domain alias of the customer.
@@ -157,7 +157,7 @@ declare namespace GoogleAppsScript {
// Deletes a Domain Alias of the customer.
remove(customer: string, domainAliasName: string): void;
}
export interface DomainsCollection {
interface DomainsCollection {
// Retrieves a domain of the customer.
get(customer: string, domainName: string): AdminDirectory.Schema.Domains;
// Inserts a domain of the customer.
@@ -167,7 +167,7 @@ declare namespace GoogleAppsScript {
// Deletes a domain of the customer.
remove(customer: string, domainName: string): void;
}
export interface GroupsCollection {
interface GroupsCollection {
Aliases?: AdminDirectory.Collection.Groups.AliasesCollection;
// Retrieve Group
get(groupKey: string): AdminDirectory.Schema.Group;
@@ -184,7 +184,7 @@ declare namespace GoogleAppsScript {
// Update Group
update(resource: Schema.Group, groupKey: string): AdminDirectory.Schema.Group;
}
export interface MembersCollection {
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.
@@ -202,7 +202,7 @@ declare namespace GoogleAppsScript {
// Update membership of a user in the specified group.
update(resource: Schema.Member, groupKey: string, memberKey: string): AdminDirectory.Schema.Member;
}
export interface MobiledevicesCollection {
interface MobiledevicesCollection {
// Take action on Mobile Device
action(resource: Schema.MobileDeviceAction, customerId: string, resourceId: string): void;
// Retrieve Mobile Device
@@ -216,7 +216,7 @@ declare namespace GoogleAppsScript {
// Delete Mobile Device
remove(customerId: string, resourceId: string): void;
}
export interface NotificationsCollection {
interface NotificationsCollection {
// Retrieves a notification.
get(customer: string, notificationId: string): AdminDirectory.Schema.Notification;
// Retrieves a list of notifications.
@@ -230,7 +230,7 @@ declare namespace GoogleAppsScript {
// Updates a notification.
update(resource: Schema.Notification, customer: string, notificationId: string): AdminDirectory.Schema.Notification;
}
export interface OrgunitsCollection {
interface OrgunitsCollection {
// Retrieve organizational unit
get(customerId: string, orgUnitPath: string[]): AdminDirectory.Schema.OrgUnit;
// Add organizational unit
@@ -246,22 +246,22 @@ declare namespace GoogleAppsScript {
// Update organizational unit
update(resource: Schema.OrgUnit, customerId: string, orgUnitPath: string[]): AdminDirectory.Schema.OrgUnit;
}
export interface PrivilegesCollection {
interface PrivilegesCollection {
// Retrieves a paginated list of all privileges for a customer.
list(customer: string): AdminDirectory.Schema.Privileges;
}
export interface ResolvedAppAccessSettingsCollection {
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;
}
export interface ResourcesCollection {
interface ResourcesCollection {
Buildings?: AdminDirectory.Collection.Resources.BuildingsCollection;
Calendars?: AdminDirectory.Collection.Resources.CalendarsCollection;
Features?: AdminDirectory.Collection.Resources.FeaturesCollection;
}
export interface RoleAssignmentsCollection {
interface RoleAssignmentsCollection {
// Retrieve a role assignment.
get(customer: string, roleAssignmentId: string): AdminDirectory.Schema.RoleAssignment;
// Creates a role assignment.
@@ -273,7 +273,7 @@ declare namespace GoogleAppsScript {
// Deletes a role assignment.
remove(customer: string, roleAssignmentId: string): void;
}
export interface RolesCollection {
interface RolesCollection {
// Retrieves a role.
get(customer: string, roleId: string): AdminDirectory.Schema.Role;
// Creates a role.
@@ -289,7 +289,7 @@ declare namespace GoogleAppsScript {
// Updates a role.
update(resource: Schema.Role, customer: string, roleId: string): AdminDirectory.Schema.Role;
}
export interface SchemasCollection {
interface SchemasCollection {
// Retrieve schema
get(customerId: string, schemaKey: string): AdminDirectory.Schema.Schema;
// Create schema.
@@ -303,7 +303,7 @@ declare namespace GoogleAppsScript {
// Update schema
update(resource: Schema.Schema, customerId: string, schemaKey: string): AdminDirectory.Schema.Schema;
}
export interface TokensCollection {
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.
@@ -311,7 +311,7 @@ declare namespace GoogleAppsScript {
// Delete all access tokens issued by a user for an application.
remove(userKey: string, clientId: string): void;
}
export interface UsersCollection {
interface UsersCollection {
Aliases?: AdminDirectory.Collection.Users.AliasesCollection;
Photos?: AdminDirectory.Collection.Users.PhotosCollection;
// retrieve user
@@ -339,7 +339,7 @@ declare namespace GoogleAppsScript {
// Watch for changes in users list
watch(resource: Schema.Channel, optionalArgs: object): AdminDirectory.Schema.Channel;
}
export interface VerificationCodesCollection {
interface VerificationCodesCollection {
// Generate new backup verification codes for the user.
generate(userKey: string): void;
// Invalidate the current backup verification codes for the user.
@@ -349,19 +349,19 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Alias {
interface Alias {
alias?: string;
etag?: string;
id?: string;
kind?: string;
primaryEmail?: string;
}
export interface Aliases {
interface Aliases {
aliases?: any[];
etag?: string;
kind?: string;
}
export interface AppAccessCollections {
interface AppAccessCollections {
blockedApiAccessBuckets?: string[];
enforceSettingsForAndroidDrive?: boolean;
errorMessage?: string;
@@ -371,7 +371,7 @@ declare namespace GoogleAppsScript {
resourceName?: string;
trustDomainOwnedApps?: boolean;
}
export interface Asp {
interface Asp {
codeId?: number;
creationTime?: string;
etag?: string;
@@ -380,12 +380,12 @@ declare namespace GoogleAppsScript {
name?: string;
userKey?: string;
}
export interface Asps {
interface Asps {
etag?: string;
items?: AdminDirectory.Schema.Asp[];
kind?: string;
}
export interface Building {
interface Building {
address?: AdminDirectory.Schema.BuildingAddress;
buildingId?: string;
buildingName?: string;
@@ -395,7 +395,7 @@ declare namespace GoogleAppsScript {
floorNames?: string[];
kind?: string;
}
export interface BuildingAddress {
interface BuildingAddress {
addressLines?: string[];
administrativeArea?: string;
languageCode?: string;
@@ -404,17 +404,17 @@ declare namespace GoogleAppsScript {
regionCode?: string;
sublocality?: string;
}
export interface BuildingCoordinates {
interface BuildingCoordinates {
latitude?: number;
longitude?: number;
}
export interface Buildings {
interface Buildings {
buildings?: AdminDirectory.Schema.Building[];
etag?: string;
kind?: string;
nextPageToken?: string;
}
export interface CalendarResource {
interface CalendarResource {
buildingId?: string;
capacity?: number;
etags?: string;
@@ -431,13 +431,13 @@ declare namespace GoogleAppsScript {
resourceType?: string;
userVisibleDescription?: string;
}
export interface CalendarResources {
interface CalendarResources {
etag?: string;
items?: AdminDirectory.Schema.CalendarResource[];
kind?: string;
nextPageToken?: string;
}
export interface Channel {
interface Channel {
address?: string;
expiration?: string;
id?: string;
@@ -449,7 +449,7 @@ declare namespace GoogleAppsScript {
token?: string;
type?: string;
}
export interface ChromeOsDevice {
interface ChromeOsDevice {
activeTimeRanges?: AdminDirectory.Schema.ChromeOsDeviceActiveTimeRanges[];
annotatedAssetId?: string;
annotatedLocation?: string;
@@ -482,46 +482,46 @@ declare namespace GoogleAppsScript {
tpmVersionInfo?: AdminDirectory.Schema.ChromeOsDeviceTpmVersionInfo;
willAutoRenew?: boolean;
}
export interface ChromeOsDeviceAction {
interface ChromeOsDeviceAction {
action?: string;
deprovisionReason?: string;
}
export interface ChromeOsDeviceActiveTimeRanges {
interface ChromeOsDeviceActiveTimeRanges {
activeTime?: number;
date?: string;
}
export interface ChromeOsDeviceCpuStatusReports {
interface ChromeOsDeviceCpuStatusReports {
cpuTemperatureInfo?: AdminDirectory.Schema.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo[];
cpuUtilizationPercentageInfo?: number[];
reportTime?: string;
}
export interface ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo {
interface ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo {
label?: string;
temperature?: number;
}
export interface ChromeOsDeviceDeviceFiles {
interface ChromeOsDeviceDeviceFiles {
createTime?: string;
downloadUrl?: string;
name?: string;
type?: string;
}
export interface ChromeOsDeviceDiskVolumeReports {
interface ChromeOsDeviceDiskVolumeReports {
volumeInfo?: AdminDirectory.Schema.ChromeOsDeviceDiskVolumeReportsVolumeInfo[];
}
export interface ChromeOsDeviceDiskVolumeReportsVolumeInfo {
interface ChromeOsDeviceDiskVolumeReportsVolumeInfo {
storageFree?: string;
storageTotal?: string;
volumeId?: string;
}
export interface ChromeOsDeviceRecentUsers {
interface ChromeOsDeviceRecentUsers {
email?: string;
type?: string;
}
export interface ChromeOsDeviceSystemRamFreeReports {
interface ChromeOsDeviceSystemRamFreeReports {
reportTime?: string;
systemRamFreeInfo?: string[];
}
export interface ChromeOsDeviceTpmVersionInfo {
interface ChromeOsDeviceTpmVersionInfo {
family?: string;
firmwareVersion?: string;
manufacturer?: string;
@@ -529,16 +529,16 @@ declare namespace GoogleAppsScript {
tpmModel?: string;
vendorSpecific?: string;
}
export interface ChromeOsDevices {
interface ChromeOsDevices {
chromeosdevices?: AdminDirectory.Schema.ChromeOsDevice[];
etag?: string;
kind?: string;
nextPageToken?: string;
}
export interface ChromeOsMoveDevicesToOu {
interface ChromeOsMoveDevicesToOu {
deviceIds?: string[];
}
export interface Customer {
interface Customer {
alternateEmail?: string;
customerCreationTime?: string;
customerDomain?: string;
@@ -549,7 +549,7 @@ declare namespace GoogleAppsScript {
phoneNumber?: string;
postalAddress?: AdminDirectory.Schema.CustomerPostalAddress;
}
export interface CustomerPostalAddress {
interface CustomerPostalAddress {
addressLine1?: string;
addressLine2?: string;
addressLine3?: string;
@@ -560,7 +560,7 @@ declare namespace GoogleAppsScript {
postalCode?: string;
region?: string;
}
export interface DomainAlias {
interface DomainAlias {
creationTime?: string;
domainAliasName?: string;
etag?: string;
@@ -568,12 +568,12 @@ declare namespace GoogleAppsScript {
parentDomainName?: string;
verified?: boolean;
}
export interface DomainAliases {
interface DomainAliases {
domainAliases?: AdminDirectory.Schema.DomainAlias[];
etag?: string;
kind?: string;
}
export interface Domains {
interface Domains {
creationTime?: string;
domainAliases?: AdminDirectory.Schema.DomainAlias[];
domainName?: string;
@@ -582,29 +582,29 @@ declare namespace GoogleAppsScript {
kind?: string;
verified?: boolean;
}
export interface Domains2 {
interface Domains2 {
domains?: AdminDirectory.Schema.Domains[];
etag?: string;
kind?: string;
}
export interface Feature {
interface Feature {
etags?: string;
kind?: string;
name?: string;
}
export interface FeatureInstance {
interface FeatureInstance {
feature?: AdminDirectory.Schema.Feature;
}
export interface FeatureRename {
interface FeatureRename {
newName?: string;
}
export interface Features {
interface Features {
etag?: string;
features?: AdminDirectory.Schema.Feature[];
kind?: string;
nextPageToken?: string;
}
export interface Group {
interface Group {
adminCreated?: boolean;
aliases?: string[];
description?: string;
@@ -616,13 +616,13 @@ declare namespace GoogleAppsScript {
name?: string;
nonEditableAliases?: string[];
}
export interface Groups {
interface Groups {
etag?: string;
groups?: AdminDirectory.Schema.Group[];
kind?: string;
nextPageToken?: string;
}
export interface Member {
interface Member {
delivery_settings?: string;
email?: string;
etag?: string;
@@ -632,16 +632,16 @@ declare namespace GoogleAppsScript {
status?: string;
type?: string;
}
export interface Members {
interface Members {
etag?: string;
kind?: string;
members?: AdminDirectory.Schema.Member[];
nextPageToken?: string;
}
export interface MembersHasMember {
interface MembersHasMember {
isMember?: boolean;
}
export interface MobileDevice {
interface MobileDevice {
adbStatus?: boolean;
applications?: AdminDirectory.Schema.MobileDeviceApplications[];
basebandVersion?: string;
@@ -683,23 +683,23 @@ declare namespace GoogleAppsScript {
userAgent?: string;
wifiMacAddress?: string;
}
export interface MobileDeviceAction {
interface MobileDeviceAction {
action?: string;
}
export interface MobileDeviceApplications {
interface MobileDeviceApplications {
displayName?: string;
packageName?: string;
permission?: string[];
versionCode?: number;
versionName?: string;
}
export interface MobileDevices {
interface MobileDevices {
etag?: string;
kind?: string;
mobiledevices?: AdminDirectory.Schema.MobileDevice[];
nextPageToken?: string;
}
export interface Notification {
interface Notification {
body?: string;
etag?: string;
fromAddress?: string;
@@ -709,14 +709,14 @@ declare namespace GoogleAppsScript {
sendTime?: string;
subject?: string;
}
export interface Notifications {
interface Notifications {
etag?: string;
items?: AdminDirectory.Schema.Notification[];
kind?: string;
nextPageToken?: string;
unreadNotificationsCount?: number;
}
export interface OrgUnit {
interface OrgUnit {
blockInheritance?: boolean;
description?: string;
etag?: string;
@@ -727,12 +727,12 @@ declare namespace GoogleAppsScript {
parentOrgUnitId?: string;
parentOrgUnitPath?: string;
}
export interface OrgUnits {
interface OrgUnits {
etag?: string;
kind?: string;
organizationUnits?: AdminDirectory.Schema.OrgUnit[];
}
export interface Privilege {
interface Privilege {
childPrivileges?: AdminDirectory.Schema.Privilege[];
etag?: string;
isOuScopable?: boolean;
@@ -741,12 +741,12 @@ declare namespace GoogleAppsScript {
serviceId?: string;
serviceName?: string;
}
export interface Privileges {
interface Privileges {
etag?: string;
items?: AdminDirectory.Schema.Privilege[];
kind?: string;
}
export interface Role {
interface Role {
etag?: string;
isSuperAdminRole?: boolean;
isSystemRole?: boolean;
@@ -756,7 +756,7 @@ declare namespace GoogleAppsScript {
roleName?: string;
rolePrivileges?: AdminDirectory.Schema.RoleRolePrivileges[];
}
export interface RoleAssignment {
interface RoleAssignment {
assignedTo?: string;
etag?: string;
kind?: string;
@@ -765,23 +765,23 @@ declare namespace GoogleAppsScript {
roleId?: string;
scopeType?: string;
}
export interface RoleAssignments {
interface RoleAssignments {
etag?: string;
items?: AdminDirectory.Schema.RoleAssignment[];
kind?: string;
nextPageToken?: string;
}
export interface RoleRolePrivileges {
interface RoleRolePrivileges {
privilegeName?: string;
serviceId?: string;
}
export interface Roles {
interface Roles {
etag?: string;
items?: AdminDirectory.Schema.Role[];
kind?: string;
nextPageToken?: string;
}
export interface Schema {
interface Schema {
displayName?: string;
etag?: string;
fields?: AdminDirectory.Schema.SchemaFieldSpec[];
@@ -789,7 +789,7 @@ declare namespace GoogleAppsScript {
schemaId?: string;
schemaName?: string;
}
export interface SchemaFieldSpec {
interface SchemaFieldSpec {
displayName?: string;
etag?: string;
fieldId?: string;
@@ -801,16 +801,16 @@ declare namespace GoogleAppsScript {
numericIndexingSpec?: AdminDirectory.Schema.SchemaFieldSpecNumericIndexingSpec;
readAccessType?: string;
}
export interface SchemaFieldSpecNumericIndexingSpec {
interface SchemaFieldSpecNumericIndexingSpec {
maxValue?: number;
minValue?: number;
}
export interface Schemas {
interface Schemas {
etag?: string;
kind?: string;
schemas?: AdminDirectory.Schema.Schema[];
}
export interface Token {
interface Token {
anonymous?: boolean;
clientId?: string;
displayText?: string;
@@ -820,25 +820,25 @@ declare namespace GoogleAppsScript {
scopes?: string[];
userKey?: string;
}
export interface Tokens {
interface Tokens {
etag?: string;
items?: AdminDirectory.Schema.Token[];
kind?: string;
}
export interface TrustedAppId {
interface TrustedAppId {
androidPackageName?: string;
certificateHashSHA1?: string;
certificateHashSHA256?: string;
etag?: string;
kind?: string;
}
export interface TrustedApps {
interface TrustedApps {
etag?: string;
kind?: string;
nextPageToken?: string;
trustedApps?: AdminDirectory.Schema.TrustedAppId[];
}
export interface User {
interface User {
addresses?: object;
agreedToTerms?: boolean;
aliases?: string[];
@@ -884,11 +884,11 @@ declare namespace GoogleAppsScript {
thumbnailPhotoUrl?: string;
websites?: object;
}
export interface UserAbout {
interface UserAbout {
contentType?: string;
value?: string;
}
export interface UserAddress {
interface UserAddress {
country?: string;
countryCode?: string;
customType?: string;
@@ -903,23 +903,23 @@ declare namespace GoogleAppsScript {
streetAddress?: string;
type?: string;
}
export interface UserEmail {
interface UserEmail {
address?: string;
customType?: string;
primary?: boolean;
type?: string;
}
export interface UserExternalId {
interface UserExternalId {
customType?: string;
type?: string;
value?: string;
}
export interface UserGender {
interface UserGender {
addressMeAs?: string;
customGender?: string;
type?: string;
}
export interface UserIm {
interface UserIm {
customProtocol?: string;
customType?: string;
im?: string;
@@ -927,16 +927,16 @@ declare namespace GoogleAppsScript {
protocol?: string;
type?: string;
}
export interface UserKeyword {
interface UserKeyword {
customType?: string;
type?: string;
value?: string;
}
export interface UserLanguage {
interface UserLanguage {
customLanguage?: string;
languageCode?: string;
}
export interface UserLocation {
interface UserLocation {
area?: string;
buildingId?: string;
customType?: string;
@@ -945,15 +945,15 @@ declare namespace GoogleAppsScript {
floorSection?: string;
type?: string;
}
export interface UserMakeAdmin {
interface UserMakeAdmin {
status?: boolean;
}
export interface UserName {
interface UserName {
familyName?: string;
fullName?: string;
givenName?: string;
}
export interface UserOrganization {
interface UserOrganization {
costCenter?: string;
customType?: string;
department?: string;
@@ -967,13 +967,13 @@ declare namespace GoogleAppsScript {
title?: string;
type?: string;
}
export interface UserPhone {
interface UserPhone {
customType?: string;
primary?: boolean;
type?: string;
value?: string;
}
export interface UserPhoto {
interface UserPhoto {
etag?: string;
height?: number;
id?: string;
@@ -983,7 +983,7 @@ declare namespace GoogleAppsScript {
primaryEmail?: string;
width?: number;
}
export interface UserPosixAccount {
interface UserPosixAccount {
accountId?: string;
gecos?: string;
gid?: string;
@@ -995,46 +995,46 @@ declare namespace GoogleAppsScript {
uid?: string;
username?: string;
}
export interface UserRelation {
interface UserRelation {
customType?: string;
type?: string;
value?: string;
}
export interface UserSshPublicKey {
interface UserSshPublicKey {
expirationTimeUsec?: string;
fingerprint?: string;
key?: string;
}
export interface UserUndelete {
interface UserUndelete {
orgUnitPath?: string;
}
export interface UserWebsite {
interface UserWebsite {
customType?: string;
primary?: boolean;
type?: string;
value?: string;
}
export interface Users {
interface Users {
etag?: string;
kind?: string;
nextPageToken?: string;
trigger_event?: string;
users?: AdminDirectory.Schema.User[];
}
export interface VerificationCode {
interface VerificationCode {
etag?: string;
kind?: string;
userId?: string;
verificationCode?: string;
}
export interface VerificationCodes {
interface VerificationCodes {
etag?: string;
items?: AdminDirectory.Schema.VerificationCode[];
kind?: string;
}
}
}
export interface AdminDirectory {
interface AdminDirectory {
Asps?: AdminDirectory.Collection.AspsCollection;
Channels?: AdminDirectory.Collection.ChannelsCollection;
Chromeosdevices?: AdminDirectory.Collection.ChromeosdevicesCollection;
types/google-apps-script/apis/docs_v1.d.ts
Vendored
+126 -126
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace Docs {
namespace Collection {
export interface DocumentsCollection {
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
@@ -37,99 +37,99 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface AutoText {
interface AutoText {
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
type?: string;
}
export interface Background {
interface Background {
color?: Docs.Schema.OptionalColor;
}
export interface BackgroundSuggestionState {
interface BackgroundSuggestionState {
backgroundColorSuggested?: boolean;
}
export interface BatchUpdateDocumentRequest {
interface BatchUpdateDocumentRequest {
requests?: Docs.Schema.Request[];
writeControl?: Docs.Schema.WriteControl;
}
export interface BatchUpdateDocumentResponse {
interface BatchUpdateDocumentResponse {
documentId?: string;
replies?: Docs.Schema.Response[];
writeControl?: Docs.Schema.WriteControl;
}
export interface Body {
interface Body {
content?: Docs.Schema.StructuralElement[];
}
export interface Bullet {
interface Bullet {
listId?: string;
nestingLevel?: number;
textStyle?: Docs.Schema.TextStyle;
}
export interface BulletSuggestionState {
interface BulletSuggestionState {
listIdSuggested?: boolean;
nestingLevelSuggested?: boolean;
textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState;
}
export interface Color {
interface Color {
rgbColor?: Docs.Schema.RgbColor;
}
export interface ColumnBreak {
interface ColumnBreak {
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface CreateNamedRangeRequest {
interface CreateNamedRangeRequest {
name?: string;
range?: Docs.Schema.Range;
}
export interface CreateNamedRangeResponse {
interface CreateNamedRangeResponse {
namedRangeId?: string;
}
export interface CreateParagraphBulletsRequest {
interface CreateParagraphBulletsRequest {
bulletPreset?: string;
range?: Docs.Schema.Range;
}
export interface CropProperties {
interface CropProperties {
angle?: number;
offsetBottom?: number;
offsetLeft?: number;
offsetRight?: number;
offsetTop?: number;
}
export interface CropPropertiesSuggestionState {
interface CropPropertiesSuggestionState {
angleSuggested?: boolean;
offsetBottomSuggested?: boolean;
offsetLeftSuggested?: boolean;
offsetRightSuggested?: boolean;
offsetTopSuggested?: boolean;
}
export interface DeleteContentRangeRequest {
interface DeleteContentRangeRequest {
range?: Docs.Schema.Range;
}
export interface DeleteNamedRangeRequest {
interface DeleteNamedRangeRequest {
name?: string;
namedRangeId?: string;
}
export interface DeleteParagraphBulletsRequest {
interface DeleteParagraphBulletsRequest {
range?: Docs.Schema.Range;
}
export interface DeletePositionedObjectRequest {
interface DeletePositionedObjectRequest {
objectId?: string;
}
export interface DeleteTableColumnRequest {
interface DeleteTableColumnRequest {
tableCellLocation?: Docs.Schema.TableCellLocation;
}
export interface DeleteTableRowRequest {
interface DeleteTableRowRequest {
tableCellLocation?: Docs.Schema.TableCellLocation;
}
export interface Dimension {
interface Dimension {
magnitude?: number;
unit?: string;
}
export interface Document {
interface Document {
body?: Docs.Schema.Body;
documentId?: string;
documentStyle?: Docs.Schema.DocumentStyle;
@@ -147,7 +147,7 @@ declare namespace GoogleAppsScript {
suggestionsViewMode?: string;
title?: string;
}
export interface DocumentStyle {
interface DocumentStyle {
background?: Docs.Schema.Background;
defaultFooterId?: string;
defaultHeaderId?: string;
@@ -164,7 +164,7 @@ declare namespace GoogleAppsScript {
useEvenPageHeaderFooter?: boolean;
useFirstPageHeaderFooter?: boolean;
}
export interface DocumentStyleSuggestionState {
interface DocumentStyleSuggestionState {
backgroundSuggestionState?: Docs.Schema.BackgroundSuggestionState;
defaultFooterIdSuggested?: boolean;
defaultHeaderIdSuggested?: boolean;
@@ -181,7 +181,7 @@ declare namespace GoogleAppsScript {
useEvenPageHeaderFooterSuggested?: boolean;
useFirstPageHeaderFooterSuggested?: boolean;
}
export interface EmbeddedObject {
interface EmbeddedObject {
description?: string;
embeddedDrawingProperties?: any;
embeddedObjectBorder?: Docs.Schema.EmbeddedObjectBorder;
@@ -194,19 +194,19 @@ declare namespace GoogleAppsScript {
size?: Docs.Schema.Size;
title?: string;
}
export interface EmbeddedObjectBorder {
interface EmbeddedObjectBorder {
color?: Docs.Schema.OptionalColor;
dashStyle?: string;
propertyState?: string;
width?: Docs.Schema.Dimension;
}
export interface EmbeddedObjectBorderSuggestionState {
interface EmbeddedObjectBorderSuggestionState {
colorSuggested?: boolean;
dashStyleSuggested?: boolean;
propertyStateSuggested?: boolean;
widthSuggested?: boolean;
}
export interface EmbeddedObjectSuggestionState {
interface EmbeddedObjectSuggestionState {
descriptionSuggested?: boolean;
embeddedDrawingPropertiesSuggestionState?: any;
embeddedObjectBorderSuggestionState?: Docs.Schema.EmbeddedObjectBorderSuggestionState;
@@ -219,22 +219,22 @@ declare namespace GoogleAppsScript {
sizeSuggestionState?: Docs.Schema.SizeSuggestionState;
titleSuggested?: boolean;
}
export interface EndOfSegmentLocation {
interface EndOfSegmentLocation {
segmentId?: string;
}
export interface Equation {
interface Equation {
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
}
export interface Footer {
interface Footer {
content?: Docs.Schema.StructuralElement[];
footerId?: string;
}
export interface Footnote {
interface Footnote {
content?: Docs.Schema.StructuralElement[];
footnoteId?: string;
}
export interface FootnoteReference {
interface FootnoteReference {
footnoteId?: string;
footnoteNumber?: string;
suggestedDeletionIds?: string[];
@@ -242,17 +242,17 @@ declare namespace GoogleAppsScript {
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface Header {
interface Header {
content?: Docs.Schema.StructuralElement[];
headerId?: string;
}
export interface HorizontalRule {
interface HorizontalRule {
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface ImageProperties {
interface ImageProperties {
angle?: number;
brightness?: number;
contentUri?: string;
@@ -261,7 +261,7 @@ declare namespace GoogleAppsScript {
sourceUri?: string;
transparency?: number;
}
export interface ImagePropertiesSuggestionState {
interface ImagePropertiesSuggestionState {
angleSuggested?: boolean;
brightnessSuggested?: boolean;
contentUriSuggested?: boolean;
@@ -270,110 +270,110 @@ declare namespace GoogleAppsScript {
sourceUriSuggested?: boolean;
transparencySuggested?: boolean;
}
export interface InlineObject {
interface InlineObject {
inlineObjectProperties?: Docs.Schema.InlineObjectProperties;
objectId?: string;
suggestedDeletionIds?: string[];
suggestedInlineObjectPropertiesChanges?: object;
suggestedInsertionId?: string;
}
export interface InlineObjectElement {
interface InlineObjectElement {
inlineObjectId?: string;
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface InlineObjectProperties {
interface InlineObjectProperties {
embeddedObject?: Docs.Schema.EmbeddedObject;
}
export interface InlineObjectPropertiesSuggestionState {
interface InlineObjectPropertiesSuggestionState {
embeddedObjectSuggestionState?: Docs.Schema.EmbeddedObjectSuggestionState;
}
export interface InsertInlineImageRequest {
interface InsertInlineImageRequest {
endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation;
location?: Docs.Schema.Location;
objectSize?: Docs.Schema.Size;
uri?: string;
}
export interface InsertInlineImageResponse {
interface InsertInlineImageResponse {
objectId?: string;
}
export interface InsertInlineSheetsChartResponse {
interface InsertInlineSheetsChartResponse {
objectId?: string;
}
export interface InsertPageBreakRequest {
interface InsertPageBreakRequest {
endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation;
location?: Docs.Schema.Location;
}
export interface InsertTableRequest {
interface InsertTableRequest {
columns?: number;
endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation;
location?: Docs.Schema.Location;
rows?: number;
}
export interface InsertTableRowRequest {
interface InsertTableRowRequest {
insertBelow?: boolean;
tableCellLocation?: Docs.Schema.TableCellLocation;
}
export interface InsertTextRequest {
interface InsertTextRequest {
endOfSegmentLocation?: Docs.Schema.EndOfSegmentLocation;
location?: Docs.Schema.Location;
text?: string;
}
export interface Link {
interface Link {
bookmarkId?: string;
headingId?: string;
url?: string;
}
export interface LinkedContentReference {
interface LinkedContentReference {
sheetsChartReference?: Docs.Schema.SheetsChartReference;
}
export interface LinkedContentReferenceSuggestionState {
interface LinkedContentReferenceSuggestionState {
sheetsChartReferenceSuggestionState?: Docs.Schema.SheetsChartReferenceSuggestionState;
}
export interface List {
interface List {
listProperties?: Docs.Schema.ListProperties;
suggestedDeletionIds?: string[];
suggestedInsertionId?: string;
suggestedListPropertiesChanges?: object;
}
export interface ListProperties {
interface ListProperties {
nestingLevels?: Docs.Schema.NestingLevel[];
}
export interface ListPropertiesSuggestionState {
interface ListPropertiesSuggestionState {
nestingLevelsSuggestionStates?: Docs.Schema.NestingLevelSuggestionState[];
}
export interface Location {
interface Location {
index?: number;
segmentId?: string;
}
export interface NamedRange {
interface NamedRange {
name?: string;
namedRangeId?: string;
ranges?: Docs.Schema.Range[];
}
export interface NamedRanges {
interface NamedRanges {
name?: string;
namedRanges?: Docs.Schema.NamedRange[];
}
export interface NamedStyle {
interface NamedStyle {
namedStyleType?: string;
paragraphStyle?: Docs.Schema.ParagraphStyle;
textStyle?: Docs.Schema.TextStyle;
}
export interface NamedStyleSuggestionState {
interface NamedStyleSuggestionState {
namedStyleType?: string;
paragraphStyleSuggestionState?: Docs.Schema.ParagraphStyleSuggestionState;
textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState;
}
export interface NamedStyles {
interface NamedStyles {
styles?: Docs.Schema.NamedStyle[];
}
export interface NamedStylesSuggestionState {
interface NamedStylesSuggestionState {
stylesSuggestionStates?: Docs.Schema.NamedStyleSuggestionState[];
}
export interface NestingLevel {
interface NestingLevel {
bulletAlignment?: string;
glyphFormat?: string;
glyphSymbol?: string;
@@ -383,7 +383,7 @@ declare namespace GoogleAppsScript {
startNumber?: number;
textStyle?: Docs.Schema.TextStyle;
}
export interface NestingLevelSuggestionState {
interface NestingLevelSuggestionState {
bulletAlignmentSuggested?: boolean;
glyphFormatSuggested?: boolean;
glyphSymbolSuggested?: boolean;
@@ -393,19 +393,19 @@ declare namespace GoogleAppsScript {
startNumberSuggested?: boolean;
textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState;
}
export interface ObjectReferences {
interface ObjectReferences {
objectIds?: string[];
}
export interface OptionalColor {
interface OptionalColor {
color?: Docs.Schema.Color;
}
export interface PageBreak {
interface PageBreak {
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface Paragraph {
interface Paragraph {
bullet?: Docs.Schema.Bullet;
elements?: Docs.Schema.ParagraphElement[];
paragraphStyle?: Docs.Schema.ParagraphStyle;
@@ -414,13 +414,13 @@ declare namespace GoogleAppsScript {
suggestedParagraphStyleChanges?: object;
suggestedPositionedObjectIds?: object;
}
export interface ParagraphBorder {
interface ParagraphBorder {
color?: Docs.Schema.OptionalColor;
dashStyle?: string;
padding?: Docs.Schema.Dimension;
width?: Docs.Schema.Dimension;
}
export interface ParagraphElement {
interface ParagraphElement {
autoText?: Docs.Schema.AutoText;
columnBreak?: Docs.Schema.ColumnBreak;
endIndex?: number;
@@ -432,7 +432,7 @@ declare namespace GoogleAppsScript {
startIndex?: number;
textRun?: Docs.Schema.TextRun;
}
export interface ParagraphStyle {
interface ParagraphStyle {
alignment?: string;
avoidWidowAndOrphan?: boolean;
borderBetween?: Docs.Schema.ParagraphBorder;
@@ -455,7 +455,7 @@ declare namespace GoogleAppsScript {
spacingMode?: string;
tabStops?: Docs.Schema.TabStop[];
}
export interface ParagraphStyleSuggestionState {
interface ParagraphStyleSuggestionState {
alignmentSuggested?: boolean;
avoidWidowAndOrphanSuggested?: boolean;
borderBetweenSuggested?: boolean;
@@ -477,44 +477,44 @@ declare namespace GoogleAppsScript {
spaceBelowSuggested?: boolean;
spacingModeSuggested?: boolean;
}
export interface PositionedObject {
interface PositionedObject {
objectId?: string;
positionedObjectProperties?: Docs.Schema.PositionedObjectProperties;
suggestedDeletionIds?: string[];
suggestedInsertionId?: string;
suggestedPositionedObjectPropertiesChanges?: object;
}
export interface PositionedObjectPositioning {
interface PositionedObjectPositioning {
layout?: string;
leftOffset?: Docs.Schema.Dimension;
topOffset?: Docs.Schema.Dimension;
}
export interface PositionedObjectPositioningSuggestionState {
interface PositionedObjectPositioningSuggestionState {
layoutSuggested?: boolean;
leftOffsetSuggested?: boolean;
topOffsetSuggested?: boolean;
}
export interface PositionedObjectProperties {
interface PositionedObjectProperties {
embeddedObject?: Docs.Schema.EmbeddedObject;
positioning?: Docs.Schema.PositionedObjectPositioning;
}
export interface PositionedObjectPropertiesSuggestionState {
interface PositionedObjectPropertiesSuggestionState {
embeddedObjectSuggestionState?: Docs.Schema.EmbeddedObjectSuggestionState;
positioningSuggestionState?: Docs.Schema.PositionedObjectPositioningSuggestionState;
}
export interface Range {
interface Range {
endIndex?: number;
segmentId?: string;
startIndex?: number;
}
export interface ReplaceAllTextRequest {
interface ReplaceAllTextRequest {
containsText?: Docs.Schema.SubstringMatchCriteria;
replaceText?: string;
}
export interface ReplaceAllTextResponse {
interface ReplaceAllTextResponse {
occurrencesChanged?: number;
}
export interface Request {
interface Request {
createNamedRange?: Docs.Schema.CreateNamedRangeRequest;
createParagraphBullets?: Docs.Schema.CreateParagraphBulletsRequest;
deleteContentRange?: Docs.Schema.DeleteContentRangeRequest;
@@ -532,54 +532,54 @@ declare namespace GoogleAppsScript {
updateParagraphStyle?: Docs.Schema.UpdateParagraphStyleRequest;
updateTextStyle?: Docs.Schema.UpdateTextStyleRequest;
}
export interface Response {
interface Response {
createNamedRange?: Docs.Schema.CreateNamedRangeResponse;
insertInlineImage?: Docs.Schema.InsertInlineImageResponse;
insertInlineSheetsChart?: Docs.Schema.InsertInlineSheetsChartResponse;
replaceAllText?: Docs.Schema.ReplaceAllTextResponse;
}
export interface RgbColor {
interface RgbColor {
blue?: number;
green?: number;
red?: number;
}
export interface SectionBreak {
interface SectionBreak {
sectionStyle?: Docs.Schema.SectionStyle;
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
}
export interface SectionColumnProperties {
interface SectionColumnProperties {
paddingEnd?: Docs.Schema.Dimension;
width?: Docs.Schema.Dimension;
}
export interface SectionStyle {
interface SectionStyle {
columnProperties?: Docs.Schema.SectionColumnProperties[];
columnSeparatorStyle?: string;
contentDirection?: string;
}
export interface Shading {
interface Shading {
backgroundColor?: Docs.Schema.OptionalColor;
}
export interface ShadingSuggestionState {
interface ShadingSuggestionState {
backgroundColorSuggested?: boolean;
}
export interface SheetsChartReference {
interface SheetsChartReference {
chartId?: number;
spreadsheetId?: string;
}
export interface SheetsChartReferenceSuggestionState {
interface SheetsChartReferenceSuggestionState {
chartIdSuggested?: boolean;
spreadsheetIdSuggested?: boolean;
}
export interface Size {
interface Size {
height?: Docs.Schema.Dimension;
width?: Docs.Schema.Dimension;
}
export interface SizeSuggestionState {
interface SizeSuggestionState {
heightSuggested?: boolean;
widthSuggested?: boolean;
}
export interface StructuralElement {
interface StructuralElement {
endIndex?: number;
paragraph?: Docs.Schema.Paragraph;
sectionBreak?: Docs.Schema.SectionBreak;
@@ -587,55 +587,55 @@ declare namespace GoogleAppsScript {
table?: Docs.Schema.Table;
tableOfContents?: Docs.Schema.TableOfContents;
}
export interface SubstringMatchCriteria {
interface SubstringMatchCriteria {
matchCase?: boolean;
text?: string;
}
export interface SuggestedBullet {
interface SuggestedBullet {
bullet?: Docs.Schema.Bullet;
bulletSuggestionState?: Docs.Schema.BulletSuggestionState;
}
export interface SuggestedDocumentStyle {
interface SuggestedDocumentStyle {
documentStyle?: Docs.Schema.DocumentStyle;
documentStyleSuggestionState?: Docs.Schema.DocumentStyleSuggestionState;
}
export interface SuggestedInlineObjectProperties {
interface SuggestedInlineObjectProperties {
inlineObjectProperties?: Docs.Schema.InlineObjectProperties;
inlineObjectPropertiesSuggestionState?: Docs.Schema.InlineObjectPropertiesSuggestionState;
}
export interface SuggestedListProperties {
interface SuggestedListProperties {
listProperties?: Docs.Schema.ListProperties;
listPropertiesSuggestionState?: Docs.Schema.ListPropertiesSuggestionState;
}
export interface SuggestedNamedStyles {
interface SuggestedNamedStyles {
namedStyles?: Docs.Schema.NamedStyles;
namedStylesSuggestionState?: Docs.Schema.NamedStylesSuggestionState;
}
export interface SuggestedParagraphStyle {
interface SuggestedParagraphStyle {
paragraphStyle?: Docs.Schema.ParagraphStyle;
paragraphStyleSuggestionState?: Docs.Schema.ParagraphStyleSuggestionState;
}
export interface SuggestedPositionedObjectProperties {
interface SuggestedPositionedObjectProperties {
positionedObjectProperties?: Docs.Schema.PositionedObjectProperties;
positionedObjectPropertiesSuggestionState?: Docs.Schema.PositionedObjectPropertiesSuggestionState;
}
export interface SuggestedTableCellStyle {
interface SuggestedTableCellStyle {
tableCellStyle?: Docs.Schema.TableCellStyle;
tableCellStyleSuggestionState?: Docs.Schema.TableCellStyleSuggestionState;
}
export interface SuggestedTableRowStyle {
interface SuggestedTableRowStyle {
tableRowStyle?: Docs.Schema.TableRowStyle;
tableRowStyleSuggestionState?: Docs.Schema.TableRowStyleSuggestionState;
}
export interface SuggestedTextStyle {
interface SuggestedTextStyle {
textStyle?: Docs.Schema.TextStyle;
textStyleSuggestionState?: Docs.Schema.TextStyleSuggestionState;
}
export interface TabStop {
interface TabStop {
alignment?: string;
offset?: Docs.Schema.Dimension;
}
export interface Table {
interface Table {
columns?: number;
rows?: number;
suggestedDeletionIds?: string[];
@@ -643,7 +643,7 @@ declare namespace GoogleAppsScript {
tableRows?: Docs.Schema.TableRow[];
tableStyle?: Docs.Schema.TableStyle;
}
export interface TableCell {
interface TableCell {
content?: Docs.Schema.StructuralElement[];
endIndex?: number;
startIndex?: number;
@@ -652,17 +652,17 @@ declare namespace GoogleAppsScript {
suggestedTableCellStyleChanges?: object;
tableCellStyle?: Docs.Schema.TableCellStyle;
}
export interface TableCellBorder {
interface TableCellBorder {
color?: Docs.Schema.OptionalColor;
dashStyle?: string;
width?: Docs.Schema.Dimension;
}
export interface TableCellLocation {
interface TableCellLocation {
columnIndex?: number;
rowIndex?: number;
tableStartLocation?: Docs.Schema.Location;
}
export interface TableCellStyle {
interface TableCellStyle {
backgroundColor?: Docs.Schema.OptionalColor;
borderBottom?: Docs.Schema.TableCellBorder;
borderLeft?: Docs.Schema.TableCellBorder;
@@ -676,7 +676,7 @@ declare namespace GoogleAppsScript {
paddingTop?: Docs.Schema.Dimension;
rowSpan?: number;
}
export interface TableCellStyleSuggestionState {
interface TableCellStyleSuggestionState {
backgroundColorSuggested?: boolean;
borderBottomSuggested?: boolean;
borderLeftSuggested?: boolean;
@@ -690,16 +690,16 @@ declare namespace GoogleAppsScript {
paddingTopSuggested?: boolean;
rowSpanSuggested?: boolean;
}
export interface TableColumnProperties {
interface TableColumnProperties {
width?: Docs.Schema.Dimension;
widthType?: string;
}
export interface TableOfContents {
interface TableOfContents {
content?: Docs.Schema.StructuralElement[];
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
}
export interface TableRow {
interface TableRow {
endIndex?: number;
startIndex?: number;
suggestedDeletionIds?: string[];
@@ -708,23 +708,23 @@ declare namespace GoogleAppsScript {
tableCells?: Docs.Schema.TableCell[];
tableRowStyle?: Docs.Schema.TableRowStyle;
}
export interface TableRowStyle {
interface TableRowStyle {
minRowHeight?: Docs.Schema.Dimension;
}
export interface TableRowStyleSuggestionState {
interface TableRowStyleSuggestionState {
minRowHeightSuggested?: boolean;
}
export interface TableStyle {
interface TableStyle {
tableColumnProperties?: Docs.Schema.TableColumnProperties[];
}
export interface TextRun {
interface TextRun {
content?: string;
suggestedDeletionIds?: string[];
suggestedInsertionIds?: string[];
suggestedTextStyleChanges?: object;
textStyle?: Docs.Schema.TextStyle;
}
export interface TextStyle {
interface TextStyle {
backgroundColor?: Docs.Schema.OptionalColor;
baselineOffset?: string;
bold?: boolean;
@@ -737,7 +737,7 @@ declare namespace GoogleAppsScript {
underline?: boolean;
weightedFontFamily?: Docs.Schema.WeightedFontFamily;
}
export interface TextStyleSuggestionState {
interface TextStyleSuggestionState {
backgroundColorSuggested?: boolean;
baselineOffsetSuggested?: boolean;
boldSuggested?: boolean;
@@ -750,27 +750,27 @@ declare namespace GoogleAppsScript {
underlineSuggested?: boolean;
weightedFontFamilySuggested?: boolean;
}
export interface UpdateParagraphStyleRequest {
interface UpdateParagraphStyleRequest {
fields?: string;
paragraphStyle?: Docs.Schema.ParagraphStyle;
range?: Docs.Schema.Range;
}
export interface UpdateTextStyleRequest {
interface UpdateTextStyleRequest {
fields?: string;
range?: Docs.Schema.Range;
textStyle?: Docs.Schema.TextStyle;
}
export interface WeightedFontFamily {
interface WeightedFontFamily {
fontFamily?: string;
weight?: number;
}
export interface WriteControl {
interface WriteControl {
requiredRevisionId?: string;
targetRevisionId?: string;
}
}
}
export interface Docs {
interface Docs {
Documents?: Docs.Collection.DocumentsCollection;
// Create a new instance of AutoText
newAutoText(): Docs.Schema.AutoText;
types/google-apps-script/apis/drive_v2.d.ts
Vendored
+76 -76
View File
@@ -7,13 +7,13 @@
declare namespace GoogleAppsScript {
namespace Drive {
namespace Collection {
export interface AboutCollection {
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;
}
export interface AppsCollection {
interface AppsCollection {
// Gets a specific app.
get(appId: string): Drive.Schema.App;
// Lists a user's installed apps.
@@ -21,7 +21,7 @@ declare namespace GoogleAppsScript {
// Lists a user's installed apps.
list(optionalArgs: object): Drive.Schema.AppList;
}
export interface ChangesCollection {
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.
@@ -39,11 +39,11 @@ declare namespace GoogleAppsScript {
// Subscribe to changes for a user.
watch(resource: Schema.Channel, optionalArgs: object): Drive.Schema.Channel;
}
export interface ChannelsCollection {
interface ChannelsCollection {
// Stop watching resources through this channel
stop(resource: Schema.Channel): void;
}
export interface ChildrenCollection {
interface ChildrenCollection {
// Gets a specific child reference.
get(folderId: string, childId: string): Drive.Schema.ChildReference;
// Inserts a file into a folder.
@@ -57,7 +57,7 @@ declare namespace GoogleAppsScript {
// Removes a child from a folder.
remove(folderId: string, childId: string): void;
}
export interface CommentsCollection {
interface CommentsCollection {
// Gets a comment by ID.
get(fileId: string, commentId: string): Drive.Schema.Comment;
// Gets a comment by ID.
@@ -75,7 +75,7 @@ declare namespace GoogleAppsScript {
// Updates an existing comment.
update(resource: Schema.Comment, fileId: string, commentId: string): Drive.Schema.Comment;
}
export interface DrivesCollection {
interface DrivesCollection {
// Gets a shared drive's metadata by ID.
get(driveId: string): Drive.Schema.Drive;
// Gets a shared drive's metadata by ID.
@@ -97,7 +97,7 @@ declare namespace GoogleAppsScript {
// Updates the metadata for a shared drive.
update(resource: Schema.Drive, driveId: string, optionalArgs: object): Drive.Schema.Drive;
}
export interface FilesCollection {
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.
@@ -155,7 +155,7 @@ declare namespace GoogleAppsScript {
// Subscribe to changes on a file
watch(resource: Schema.Channel, fileId: string, optionalArgs: object): Drive.Schema.Channel;
}
export interface ParentsCollection {
interface ParentsCollection {
// Gets a specific parent reference.
get(fileId: string, parentId: string): Drive.Schema.ParentReference;
// Adds a parent folder for a file.
@@ -167,7 +167,7 @@ declare namespace GoogleAppsScript {
// Removes a parent from a file.
remove(fileId: string, parentId: string): void;
}
export interface PermissionsCollection {
interface PermissionsCollection {
// Gets a permission by ID.
get(fileId: string, permissionId: string): Drive.Schema.Permission;
// Gets a permission by ID.
@@ -195,7 +195,7 @@ declare namespace GoogleAppsScript {
// Updates a permission.
update(resource: Schema.Permission, fileId: string, permissionId: string, optionalArgs: object): Drive.Schema.Permission;
}
export interface PropertiesCollection {
interface PropertiesCollection {
// Gets a property by its key.
get(fileId: string, propertyKey: string): Drive.Schema.Property;
// Gets a property by its key.
@@ -217,7 +217,7 @@ declare namespace GoogleAppsScript {
// Updates a property.
update(resource: Schema.Property, fileId: string, propertyKey: string, optionalArgs: object): Drive.Schema.Property;
}
export interface RealtimeCollection {
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.
@@ -229,7 +229,7 @@ declare namespace GoogleAppsScript {
// Overwrites the Realtime API data model associated with this file with the provided JSON data model.
update(fileId: string, mediaData: any, optionalArgs: object): void;
}
export interface RepliesCollection {
interface RepliesCollection {
// Gets a reply.
get(fileId: string, commentId: string, replyId: string): Drive.Schema.CommentReply;
// Gets a reply.
@@ -247,7 +247,7 @@ declare namespace GoogleAppsScript {
// Updates an existing reply.
update(resource: Schema.CommentReply, fileId: string, commentId: string, replyId: string): Drive.Schema.CommentReply;
}
export interface RevisionsCollection {
interface RevisionsCollection {
// Gets a specific revision.
get(fileId: string, revisionId: string): Drive.Schema.Revision;
// Lists a file's revisions.
@@ -261,7 +261,7 @@ declare namespace GoogleAppsScript {
// Updates a revision.
update(resource: Schema.Revision, fileId: string, revisionId: string): Drive.Schema.Revision;
}
export interface TeamdrivesCollection {
interface TeamdrivesCollection {
// Gets a Team Drive's metadata by ID.
get(teamDriveId: string): Drive.Schema.TeamDrive;
// Gets a Team Drive's metadata by ID.
@@ -281,7 +281,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface About {
interface About {
additionalRoleInfo?: Drive.Schema.AboutAdditionalRoleInfo[];
canCreateDrives?: boolean;
canCreateTeamDrives?: boolean;
@@ -311,45 +311,45 @@ declare namespace GoogleAppsScript {
teamDriveThemes?: Drive.Schema.AboutTeamDriveThemes[];
user?: Drive.Schema.User;
}
export interface AboutAdditionalRoleInfo {
interface AboutAdditionalRoleInfo {
roleSets?: Drive.Schema.AboutAdditionalRoleInfoRoleSets[];
type?: string;
}
export interface AboutAdditionalRoleInfoRoleSets {
interface AboutAdditionalRoleInfoRoleSets {
additionalRoles?: string[];
primaryRole?: string;
}
export interface AboutDriveThemes {
interface AboutDriveThemes {
backgroundImageLink?: string;
colorRgb?: string;
id?: string;
}
export interface AboutExportFormats {
interface AboutExportFormats {
source?: string;
targets?: string[];
}
export interface AboutFeatures {
interface AboutFeatures {
featureName?: string;
featureRate?: number;
}
export interface AboutImportFormats {
interface AboutImportFormats {
source?: string;
targets?: string[];
}
export interface AboutMaxUploadSizes {
interface AboutMaxUploadSizes {
size?: string;
type?: string;
}
export interface AboutQuotaBytesByService {
interface AboutQuotaBytesByService {
bytesUsed?: string;
serviceName?: string;
}
export interface AboutTeamDriveThemes {
interface AboutTeamDriveThemes {
backgroundImageLink?: string;
colorRgb?: string;
id?: string;
}
export interface App {
interface App {
authorized?: boolean;
createInFolderTemplate?: string;
createUrl?: string;
@@ -375,19 +375,19 @@ declare namespace GoogleAppsScript {
supportsOfflineCreate?: boolean;
useByDefault?: boolean;
}
export interface AppIcons {
interface AppIcons {
category?: string;
iconUrl?: string;
size?: number;
}
export interface AppList {
interface AppList {
defaultAppIds?: string[];
etag?: string;
items?: Drive.Schema.App[];
kind?: string;
selfLink?: string;
}
export interface Change {
interface Change {
deleted?: boolean;
drive?: Drive.Schema.Drive;
driveId?: string;
@@ -401,7 +401,7 @@ declare namespace GoogleAppsScript {
teamDriveId?: string;
type?: string;
}
export interface ChangeList {
interface ChangeList {
etag?: string;
items?: Drive.Schema.Change[];
kind?: string;
@@ -411,7 +411,7 @@ declare namespace GoogleAppsScript {
nextPageToken?: string;
selfLink?: string;
}
export interface Channel {
interface Channel {
address?: string;
expiration?: string;
id?: string;
@@ -423,7 +423,7 @@ declare namespace GoogleAppsScript {
token?: string;
type?: string;
}
export interface ChildList {
interface ChildList {
etag?: string;
items?: Drive.Schema.ChildReference[];
kind?: string;
@@ -431,13 +431,13 @@ declare namespace GoogleAppsScript {
nextPageToken?: string;
selfLink?: string;
}
export interface ChildReference {
interface ChildReference {
childLink?: string;
id?: string;
kind?: string;
selfLink?: string;
}
export interface Comment {
interface Comment {
anchor?: string;
author?: Drive.Schema.User;
commentId?: string;
@@ -454,18 +454,18 @@ declare namespace GoogleAppsScript {
selfLink?: string;
status?: string;
}
export interface CommentContext {
interface CommentContext {
type?: string;
value?: string;
}
export interface CommentList {
interface CommentList {
items?: Drive.Schema.Comment[];
kind?: string;
nextLink?: string;
nextPageToken?: string;
selfLink?: string;
}
export interface CommentReply {
interface CommentReply {
author?: Drive.Schema.User;
content?: string;
createdDate?: string;
@@ -476,14 +476,14 @@ declare namespace GoogleAppsScript {
replyId?: string;
verb?: string;
}
export interface CommentReplyList {
interface CommentReplyList {
items?: Drive.Schema.CommentReply[];
kind?: string;
nextLink?: string;
nextPageToken?: string;
selfLink?: string;
}
export interface Drive {
interface Drive {
backgroundImageFile?: Drive.Schema.DriveBackgroundImageFile;
backgroundImageLink?: string;
capabilities?: Drive.Schema.DriveCapabilities;
@@ -496,13 +496,13 @@ declare namespace GoogleAppsScript {
restrictions?: Drive.Schema.DriveRestrictions;
themeId?: string;
}
export interface DriveBackgroundImageFile {
interface DriveBackgroundImageFile {
id?: string;
width?: Number;
xCoordinate?: Number;
yCoordinate?: Number;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
}
export interface DriveCapabilities {
interface DriveCapabilities {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
@@ -522,18 +522,18 @@ declare namespace GoogleAppsScript {
canShare?: boolean;
canTrashChildren?: boolean;
}
export interface DriveList {
interface DriveList {
items?: Drive.Schema.Drive[];
kind?: string;
nextPageToken?: string;
}
export interface DriveRestrictions {
interface DriveRestrictions {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
driveMembersOnly?: boolean;
}
export interface File {
interface File {
alternateLink?: string;
appDataContents?: boolean;
canComment?: boolean;
@@ -603,7 +603,7 @@ declare namespace GoogleAppsScript {
webViewLink?: string;
writersCanShare?: boolean;
}
export interface FileCapabilities {
interface FileCapabilities {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermission?: boolean;
canChangeRestrictedDownload?: boolean;
@@ -634,7 +634,7 @@ declare namespace GoogleAppsScript {
canTrashChildren?: boolean;
canUntrash?: boolean;
}
export interface FileImageMediaMetadata {
interface FileImageMediaMetadata {
aperture?: number;
cameraMake?: string;
cameraModel?: string;
@@ -657,15 +657,15 @@ declare namespace GoogleAppsScript {
whiteBalance?: string;
width?: number;
}
export interface FileImageMediaMetadataLocation {
interface FileImageMediaMetadataLocation {
altitude?: number;
latitude?: number;
longitude?: number;
}
export interface FileIndexableText {
interface FileIndexableText {
text?: string;
}
export interface FileLabels {
interface FileLabels {
hidden?: boolean;
modified?: boolean;
restricted?: boolean;
@@ -673,7 +673,7 @@ declare namespace GoogleAppsScript {
trashed?: boolean;
viewed?: boolean;
}
export interface FileList {
interface FileList {
etag?: string;
incompleteSearch?: boolean;
items?: Drive.Schema.File[];
@@ -682,34 +682,34 @@ declare namespace GoogleAppsScript {
nextPageToken?: string;
selfLink?: string;
}
export interface FileThumbnail {
interface FileThumbnail {
image?: string;
mimeType?: string;
}
export interface FileVideoMediaMetadata {
interface FileVideoMediaMetadata {
durationMillis?: string;
height?: number;
width?: number;
}
export interface GeneratedIds {
interface GeneratedIds {
ids?: string[];
kind?: string;
space?: string;
}
export interface ParentList {
interface ParentList {
etag?: string;
items?: Drive.Schema.ParentReference[];
kind?: string;
selfLink?: string;
}
export interface ParentReference {
interface ParentReference {
id?: string;
isRoot?: boolean;
kind?: string;
parentLink?: string;
selfLink?: string;
}
export interface Permission {
interface Permission {
additionalRoles?: string[];
authKey?: string;
deleted?: boolean;
@@ -729,32 +729,32 @@ declare namespace GoogleAppsScript {
value?: string;
withLink?: boolean;
}
export interface PermissionId {
interface PermissionId {
id?: string;
kind?: string;
}
export interface PermissionList {
interface PermissionList {
etag?: string;
items?: Drive.Schema.Permission[];
kind?: string;
nextPageToken?: string;
selfLink?: string;
}
export interface PermissionPermissionDetails {
interface PermissionPermissionDetails {
additionalRoles?: string[];
inherited?: boolean;
inheritedFrom?: string;
permissionType?: string;
role?: string;
}
export interface PermissionTeamDrivePermissionDetails {
interface PermissionTeamDrivePermissionDetails {
additionalRoles?: string[];
inherited?: boolean;
inheritedFrom?: string;
role?: string;
teamDrivePermissionType?: string;
}
export interface Property {
interface Property {
etag?: string;
key?: string;
kind?: string;
@@ -762,13 +762,13 @@ declare namespace GoogleAppsScript {
value?: string;
visibility?: string;
}
export interface PropertyList {
interface PropertyList {
etag?: string;
items?: Drive.Schema.Property[];
kind?: string;
selfLink?: string;
}
export interface Revision {
interface Revision {
downloadUrl?: string;
etag?: string;
exportLinks?: object;
@@ -788,18 +788,18 @@ declare namespace GoogleAppsScript {
publishedOutsideDomain?: boolean;
selfLink?: string;
}
export interface RevisionList {
interface RevisionList {
etag?: string;
items?: Drive.Schema.Revision[];
kind?: string;
nextPageToken?: string;
selfLink?: string;
}
export interface StartPageToken {
interface StartPageToken {
kind?: string;
startPageToken?: string;
}
export interface TeamDrive {
interface TeamDrive {
backgroundImageFile?: Drive.Schema.TeamDriveBackgroundImageFile;
backgroundImageLink?: string;
capabilities?: Drive.Schema.TeamDriveCapabilities;
@@ -811,13 +811,13 @@ declare namespace GoogleAppsScript {
restrictions?: Drive.Schema.TeamDriveRestrictions;
themeId?: string;
}
export interface TeamDriveBackgroundImageFile {
interface TeamDriveBackgroundImageFile {
id?: string;
width?: number;
xCoordinate?: number;
yCoordinate?: number;
}
export interface TeamDriveCapabilities {
interface TeamDriveCapabilities {
canAddChildren?: boolean;
canChangeCopyRequiresWriterPermissionRestriction?: boolean;
canChangeDomainUsersOnlyRestriction?: boolean;
@@ -838,18 +838,18 @@ declare namespace GoogleAppsScript {
canShare?: boolean;
canTrashChildren?: boolean;
}
export interface TeamDriveList {
interface TeamDriveList {
items?: Drive.Schema.TeamDrive[];
kind?: string;
nextPageToken?: string;
}
export interface TeamDriveRestrictions {
interface TeamDriveRestrictions {
adminManagedRestrictions?: boolean;
copyRequiresWriterPermission?: boolean;
domainUsersOnly?: boolean;
teamMembersOnly?: boolean;
}
export interface User {
interface User {
displayName?: string;
emailAddress?: string;
isAuthenticatedUser?: boolean;
@@ -857,12 +857,12 @@ declare namespace GoogleAppsScript {
permissionId?: string;
picture?: Drive.Schema.UserPicture;
}
export interface UserPicture {
interface UserPicture {
url?: string;
}
}
}
export interface Drive {
interface Drive {
About?: Drive.Collection.AboutCollection;
Apps?: Drive.Collection.AppsCollection;
Changes?: Drive.Collection.ChangesCollection;
types/google-apps-script/apis/driveactivity_v2.d.ts
Vendored
+41 -41
View File
@@ -7,20 +7,20 @@
declare namespace GoogleAppsScript {
namespace DriveActivity {
namespace Collection {
export interface ActivityCollection {
interface ActivityCollection {
// Query past activity in Google Drive.
query(resource: Schema.QueryDriveActivityRequest): DriveActivity.Schema.QueryDriveActivityResponse;
}
}
namespace Schema {
export interface Action {
interface Action {
actor?: DriveActivity.Schema.Actor;
detail?: DriveActivity.Schema.ActionDetail;
target?: DriveActivity.Schema.Target;
timeRange?: DriveActivity.Schema.TimeRange;
timestamp?: string;
}
export interface ActionDetail {
interface ActionDetail {
comment?: DriveActivity.Schema.Comment;
create?: DriveActivity.Schema.Create;
delete?: DriveActivity.Schema.Delete;
@@ -33,48 +33,48 @@ declare namespace GoogleAppsScript {
restore?: DriveActivity.Schema.Restore;
settingsChange?: DriveActivity.Schema.SettingsChange;
}
export interface Actor {
interface Actor {
administrator?: string;
anonymous?: string;
impersonation?: DriveActivity.Schema.Impersonation;
system?: DriveActivity.Schema.SystemEvent;
user?: DriveActivity.Schema.User;
}
export interface ApplicationReference {
interface ApplicationReference {
type?: string;
}
export interface Assignment {
interface Assignment {
subtype?: string;
}
export interface Comment {
interface Comment {
assignment?: DriveActivity.Schema.Assignment;
mentionedUsers?: DriveActivity.Schema.User[];
post?: DriveActivity.Schema.Post;
suggestion?: DriveActivity.Schema.Suggestion;
}
export interface ConsolidationStrategy {
interface ConsolidationStrategy {
legacy?: any;
none?: any;
}
export interface Copy {
interface Copy {
originalObject?: DriveActivity.Schema.TargetReference;
}
export interface Create {
interface Create {
copy?: DriveActivity.Schema.Copy;
new?: any;
upload?: any;
}
export interface DataLeakPreventionChange {
interface DataLeakPreventionChange {
type?: string;
}
export interface Delete {
interface Delete {
type?: string;
}
export interface Domain {
interface Domain {
legacyId?: string;
name?: string;
}
export interface DriveActivity {
interface DriveActivity {
actions?: DriveActivity.Schema.Action[];
actors?: DriveActivity.Schema.Actor[];
primaryActionDetail?: DriveActivity.Schema.ActionDetail;
@@ -82,7 +82,7 @@ declare namespace GoogleAppsScript {
timeRange?: DriveActivity.Schema.TimeRange;
timestamp?: string;
}
export interface DriveItem {
interface DriveItem {
file?: any;
folder?: DriveActivity.Schema.Folder;
mimeType?: string;
@@ -90,42 +90,42 @@ declare namespace GoogleAppsScript {
owner?: DriveActivity.Schema.Owner;
title?: string;
}
export interface DriveItemReference {
interface DriveItemReference {
file?: any;
folder?: DriveActivity.Schema.Folder;
name?: string;
title?: string;
}
export interface FileComment {
interface FileComment {
legacyCommentId?: string;
legacyDiscussionId?: string;
linkToDiscussion?: string;
parent?: DriveActivity.Schema.DriveItem;
}
export interface Folder {
interface Folder {
type?: string;
}
export interface Group {
interface Group {
email?: string;
title?: string;
}
export interface Impersonation {
interface Impersonation {
impersonatedUser?: DriveActivity.Schema.User;
}
export interface KnownUser {
interface KnownUser {
isCurrentUser?: boolean;
personName?: string;
}
export interface Move {
interface Move {
addedParents?: DriveActivity.Schema.TargetReference[];
removedParents?: DriveActivity.Schema.TargetReference[];
}
export interface Owner {
interface Owner {
domain?: DriveActivity.Schema.Domain;
teamDrive?: DriveActivity.Schema.TeamDriveReference;
user?: DriveActivity.Schema.User;
}
export interface Permission {
interface Permission {
allowDiscovery?: boolean;
anyone?: any;
domain?: DriveActivity.Schema.Domain;
@@ -133,14 +133,14 @@ declare namespace GoogleAppsScript {
role?: string;
user?: DriveActivity.Schema.User;
}
export interface PermissionChange {
interface PermissionChange {
addedPermissions?: DriveActivity.Schema.Permission[];
removedPermissions?: DriveActivity.Schema.Permission[];
}
export interface Post {
interface Post {
subtype?: string;
}
export interface QueryDriveActivityRequest {
interface QueryDriveActivityRequest {
ancestorName?: string;
consolidationStrategy?: DriveActivity.Schema.ConsolidationStrategy;
filter?: string;
@@ -148,60 +148,60 @@ declare namespace GoogleAppsScript {
pageSize?: number;
pageToken?: string;
}
export interface QueryDriveActivityResponse {
interface QueryDriveActivityResponse {
activities?: DriveActivity.Schema.DriveActivity[];
nextPageToken?: string;
}
export interface Rename {
interface Rename {
newTitle?: string;
oldTitle?: string;
}
export interface Restore {
interface Restore {
type?: string;
}
export interface RestrictionChange {
interface RestrictionChange {
feature?: string;
newRestriction?: string;
}
export interface SettingsChange {
interface SettingsChange {
restrictionChanges?: DriveActivity.Schema.RestrictionChange[];
}
export interface Suggestion {
interface Suggestion {
subtype?: string;
}
export interface SystemEvent {
interface SystemEvent {
type?: string;
}
export interface Target {
interface Target {
driveItem?: DriveActivity.Schema.DriveItem;
fileComment?: any;
teamDrive?: DriveActivity.Schema.TeamDrive;
}
export interface TargetReference {
interface TargetReference {
driveItem?: DriveActivity.Schema.DriveItemReference;
teamDrive?: DriveActivity.Schema.TeamDriveReference;
}
export interface TeamDrive {
interface TeamDrive {
name?: string;
root?: DriveActivity.Schema.DriveItem;
title?: string;
}
export interface TeamDriveReference {
interface TeamDriveReference {
name?: string;
title?: string;
}
export interface TimeRange {
interface TimeRange {
endTime?: string;
startTime?: string;
}
export interface User {
interface User {
deletedUser?: any;
knownUser?: DriveActivity.Schema.KnownUser;
unknownUser?: any;
}
}
}
export interface DriveActivity {
interface DriveActivity {
Activity?: DriveActivity.Collection.ActivityCollection;
// Create a new instance of ConsolidationStrategy
newConsolidationStrategy(): DriveActivity.Schema.ConsolidationStrategy;
types/google-apps-script/apis/fusiontables_v2.d.ts
Vendored
+31 -31
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace FusionTables {
namespace Collection {
export interface ColumnCollection {
interface ColumnCollection {
// Retrieves a specific column by its ID.
get(tableId: string, columnId: string): FusionTables.Schema.Column;
// Adds a new column to the table.
@@ -23,7 +23,7 @@ declare namespace GoogleAppsScript {
// Updates the name or type of an existing column.
update(resource: Schema.Column, tableId: string, columnId: string): FusionTables.Schema.Column;
}
export interface QueryCollection {
interface QueryCollection {
// Executes a Fusion Tables SQL statement, which can be any of
// - SELECT
// - INSERT
@@ -53,7 +53,7 @@ declare namespace GoogleAppsScript {
// - DESCRIBE
sqlGet(sql: string, optionalArgs: object): FusionTables.Schema.Sqlresponse;
}
export interface StyleCollection {
interface StyleCollection {
// Gets a specific style.
get(tableId: string, styleId: number): FusionTables.Schema.StyleSetting;
// Adds a new style for the table.
@@ -69,7 +69,7 @@ declare namespace GoogleAppsScript {
// Updates an existing style.
update(resource: Schema.StyleSetting, tableId: string, styleId: number): FusionTables.Schema.StyleSetting;
}
export interface TableCollection {
interface TableCollection {
// Copies a table.
copy(tableId: string): FusionTables.Schema.Table;
// Copies a table.
@@ -113,7 +113,7 @@ declare namespace GoogleAppsScript {
// Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated.
update(resource: Schema.Table, tableId: string, optionalArgs: object): FusionTables.Schema.Table;
}
export interface TaskCollection {
interface TaskCollection {
// Retrieves a specific task by its ID.
get(tableId: string, taskId: string): FusionTables.Schema.Task;
// Retrieves a list of tasks.
@@ -123,7 +123,7 @@ declare namespace GoogleAppsScript {
// Deletes a specific task by its ID, unless that task has already started running.
remove(tableId: string, taskId: string): void;
}
export interface TemplateCollection {
interface TemplateCollection {
// Retrieves a specific template by its id
get(tableId: string, templateId: number): FusionTables.Schema.Template;
// Creates a new template for the table.
@@ -141,7 +141,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Bucket {
interface Bucket {
color?: string;
icon?: string;
max?: number;
@@ -149,7 +149,7 @@ declare namespace GoogleAppsScript {
opacity?: number;
weight?: number;
}
export interface Column {
interface Column {
baseColumn?: FusionTables.Schema.ColumnBaseColumn;
columnId?: number;
columnJsonSchema?: string;
@@ -163,49 +163,49 @@ declare namespace GoogleAppsScript {
validValues?: string[];
validateData?: boolean;
}
export interface ColumnBaseColumn {
interface ColumnBaseColumn {
columnId?: number;
tableIndex?: number;
}
export interface ColumnList {
interface ColumnList {
items?: FusionTables.Schema.Column[];
kind?: string;
nextPageToken?: string;
totalItems?: number;
}
export interface Geometry {
interface Geometry {
geometries?: object[];
geometry?: object;
type?: string;
}
export interface Import {
interface Import {
kind?: string;
numRowsReceived?: string;
}
export interface Line {
interface Line {
coordinates?: number[][];
type?: string;
}
export interface LineStyle {
interface LineStyle {
strokeColor?: string;
strokeColorStyler?: FusionTables.Schema.StyleFunction;
strokeOpacity?: number;
strokeWeight?: number;
strokeWeightStyler?: FusionTables.Schema.StyleFunction;
}
export interface Point {
interface Point {
coordinates?: number[];
type?: string;
}
export interface PointStyle {
interface PointStyle {
iconName?: string;
iconStyler?: FusionTables.Schema.StyleFunction;
}
export interface Polygon {
interface Polygon {
coordinates?: number[][][];
type?: string;
}
export interface PolygonStyle {
interface PolygonStyle {
fillColor?: string;
fillColorStyler?: FusionTables.Schema.StyleFunction;
fillOpacity?: number;
@@ -215,27 +215,27 @@ declare namespace GoogleAppsScript {
strokeWeight?: number;
strokeWeightStyler?: FusionTables.Schema.StyleFunction;
}
export interface Sqlresponse {
interface Sqlresponse {
columns?: string[];
kind?: string;
rows?: object[][];
}
export interface StyleFunction {
interface StyleFunction {
buckets?: FusionTables.Schema.Bucket[];
columnName?: string;
gradient?: FusionTables.Schema.StyleFunctionGradient;
kind?: string;
}
export interface StyleFunctionGradient {
interface StyleFunctionGradient {
colors?: FusionTables.Schema.StyleFunctionGradientColors[];
max?: number;
min?: number;
}
export interface StyleFunctionGradientColors {
interface StyleFunctionGradientColors {
color?: string;
opacity?: number;
}
export interface StyleSetting {
interface StyleSetting {
kind?: string;
markerOptions?: FusionTables.Schema.PointStyle;
name?: string;
@@ -244,13 +244,13 @@ declare namespace GoogleAppsScript {
styleId?: number;
tableId?: string;
}
export interface StyleSettingList {
interface StyleSettingList {
items?: FusionTables.Schema.StyleSetting[];
kind?: string;
nextPageToken?: string;
totalItems?: number;
}
export interface Table {
interface Table {
attribution?: string;
attributionLink?: string;
baseTableIds?: string[];
@@ -265,25 +265,25 @@ declare namespace GoogleAppsScript {
tablePropertiesJson?: string;
tablePropertiesJsonSchema?: string;
}
export interface TableList {
interface TableList {
items?: FusionTables.Schema.Table[];
kind?: string;
nextPageToken?: string;
}
export interface Task {
interface Task {
kind?: string;
progress?: string;
started?: boolean;
taskId?: string;
type?: string;
}
export interface TaskList {
interface TaskList {
items?: FusionTables.Schema.Task[];
kind?: string;
nextPageToken?: string;
totalItems?: number;
}
export interface Template {
interface Template {
automaticColumnNames?: string[];
body?: string;
kind?: string;
@@ -291,7 +291,7 @@ declare namespace GoogleAppsScript {
tableId?: string;
templateId?: number;
}
export interface TemplateList {
interface TemplateList {
items?: FusionTables.Schema.Template[];
kind?: string;
nextPageToken?: string;
@@ -299,7 +299,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface FusionTables {
interface FusionTables {
Column?: FusionTables.Collection.ColumnCollection;
Query?: FusionTables.Collection.QueryCollection;
Style?: FusionTables.Collection.StyleCollection;
types/google-apps-script/apis/gmail_v1.d.ts
Vendored
+56 -56
View File
@@ -9,14 +9,14 @@ declare namespace GoogleAppsScript {
namespace Collection {
namespace Users {
namespace Messages {
export interface AttachmentsCollection {
interface AttachmentsCollection {
// Gets the specified message attachment.
get(userId: string, messageId: string, id: string): Gmail.Schema.MessagePartBody;
}
}
namespace Settings {
namespace SendAs {
export interface SmimeInfoCollection {
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.
@@ -29,7 +29,7 @@ declare namespace GoogleAppsScript {
setDefault(userId: string, sendAsEmail: string, id: string): void;
}
}
export interface DelegatesCollection {
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.
@@ -48,7 +48,7 @@ declare namespace GoogleAppsScript {
// This method is only available to service account clients that have been delegated domain-wide authority.
remove(userId: string, delegateEmail: string): void;
}
export interface FiltersCollection {
interface FiltersCollection {
// Creates a filter.
create(resource: Schema.Filter, userId: string): Gmail.Schema.Filter;
// Gets a filter.
@@ -58,7 +58,7 @@ declare namespace GoogleAppsScript {
// Deletes a filter.
remove(userId: string, id: string): void;
}
export interface ForwardingAddressesCollection {
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;
@@ -70,7 +70,7 @@ declare namespace GoogleAppsScript {
// This method is only available to service account clients that have been delegated domain-wide authority.
remove(userId: string, forwardingEmail: string): void;
}
export interface SendAsCollection {
interface SendAsCollection {
SmimeInfo?: Gmail.Collection.Users.Settings.SendAs.SmimeInfoCollection;
// 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.
@@ -93,7 +93,7 @@ declare namespace GoogleAppsScript {
verify(userId: string, sendAsEmail: string): void;
}
}
export interface DraftsCollection {
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.
@@ -117,13 +117,13 @@ declare namespace GoogleAppsScript {
// Replaces a draft's content.
update(resource: Schema.Draft, userId: string, id: string, mediaData: any): Gmail.Schema.Draft;
}
export interface HistoryCollection {
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;
}
export interface LabelsCollection {
interface LabelsCollection {
// Creates a new label.
create(resource: Schema.Label, userId: string): Gmail.Schema.Label;
// Gets the specified label.
@@ -137,7 +137,7 @@ declare namespace GoogleAppsScript {
// Updates the specified label.
update(resource: Schema.Label, userId: string, id: string): Gmail.Schema.Label;
}
export interface MessagesCollection {
interface MessagesCollection {
Attachments?: Gmail.Collection.Users.Messages.AttachmentsCollection;
// 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;
@@ -176,7 +176,7 @@ declare namespace GoogleAppsScript {
// Removes the specified message from the trash.
untrash(userId: string, id: string): Gmail.Schema.Message;
}
export interface SettingsCollection {
interface SettingsCollection {
Delegates?: Gmail.Collection.Users.Settings.DelegatesCollection;
Filters?: Gmail.Collection.Users.Settings.FiltersCollection;
ForwardingAddresses?: Gmail.Collection.Users.Settings.ForwardingAddressesCollection;
@@ -199,7 +199,7 @@ declare namespace GoogleAppsScript {
// Updates vacation responder settings.
updateVacation(resource: Schema.VacationSettings, userId: string): Gmail.Schema.VacationSettings;
}
export interface ThreadsCollection {
interface ThreadsCollection {
// Gets the specified thread.
get(userId: string, id: string): Gmail.Schema.Thread;
// Gets the specified thread.
@@ -218,7 +218,7 @@ declare namespace GoogleAppsScript {
untrash(userId: string, id: string): Gmail.Schema.Thread;
}
}
export interface UsersCollection {
interface UsersCollection {
Drafts?: Gmail.Collection.Users.DraftsCollection;
History?: Gmail.Collection.Users.HistoryCollection;
Labels?: Gmail.Collection.Users.LabelsCollection;
@@ -234,38 +234,38 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface AutoForwarding {
interface AutoForwarding {
disposition?: string;
emailAddress?: string;
enabled?: boolean;
}
export interface BatchDeleteMessagesRequest {
interface BatchDeleteMessagesRequest {
ids?: string[];
}
export interface BatchModifyMessagesRequest {
interface BatchModifyMessagesRequest {
addLabelIds?: string[];
ids?: string[];
removeLabelIds?: string[];
}
export interface Delegate {
interface Delegate {
delegateEmail?: string;
verificationStatus?: string;
}
export interface Draft {
interface Draft {
id?: string;
message?: Gmail.Schema.Message;
}
export interface Filter {
interface Filter {
action?: Gmail.Schema.FilterAction;
criteria?: Gmail.Schema.FilterCriteria;
id?: string;
}
export interface FilterAction {
interface FilterAction {
addLabelIds?: string[];
forward?: string;
removeLabelIds?: string[];
}
export interface FilterCriteria {
interface FilterCriteria {
excludeChats?: boolean;
from?: string;
hasAttachment?: boolean;
@@ -276,11 +276,11 @@ declare namespace GoogleAppsScript {
subject?: string;
to?: string;
}
export interface ForwardingAddress {
interface ForwardingAddress {
forwardingEmail?: string;
verificationStatus?: string;
}
export interface History {
interface History {
id?: string;
labelsAdded?: Gmail.Schema.HistoryLabelAdded[];
labelsRemoved?: Gmail.Schema.HistoryLabelRemoved[];
@@ -288,27 +288,27 @@ declare namespace GoogleAppsScript {
messagesAdded?: Gmail.Schema.HistoryMessageAdded[];
messagesDeleted?: Gmail.Schema.HistoryMessageDeleted[];
}
export interface HistoryLabelAdded {
interface HistoryLabelAdded {
labelIds?: string[];
message?: Gmail.Schema.Message;
}
export interface HistoryLabelRemoved {
interface HistoryLabelRemoved {
labelIds?: string[];
message?: Gmail.Schema.Message;
}
export interface HistoryMessageAdded {
interface HistoryMessageAdded {
message?: Gmail.Schema.Message;
}
export interface HistoryMessageDeleted {
interface HistoryMessageDeleted {
message?: Gmail.Schema.Message;
}
export interface ImapSettings {
interface ImapSettings {
autoExpunge?: boolean;
enabled?: boolean;
expungeBehavior?: string;
maxFolderSize?: number;
}
export interface Label {
interface Label {
color?: Gmail.Schema.LabelColor;
id?: string;
labelListVisibility?: string;
@@ -320,49 +320,49 @@ declare namespace GoogleAppsScript {
threadsUnread?: number;
type?: string;
}
export interface LabelColor {
interface LabelColor {
backgroundColor?: string;
textColor?: string;
}
export interface ListDelegatesResponse {
interface ListDelegatesResponse {
delegates?: Gmail.Schema.Delegate[];
}
export interface ListDraftsResponse {
interface ListDraftsResponse {
drafts?: Gmail.Schema.Draft[];
nextPageToken?: string;
resultSizeEstimate?: number;
}
export interface ListFiltersResponse {
interface ListFiltersResponse {
filter?: Gmail.Schema.Filter[];
}
export interface ListForwardingAddressesResponse {
interface ListForwardingAddressesResponse {
forwardingAddresses?: Gmail.Schema.ForwardingAddress[];
}
export interface ListHistoryResponse {
interface ListHistoryResponse {
history?: Gmail.Schema.History[];
historyId?: string;
nextPageToken?: string;
}
export interface ListLabelsResponse {
interface ListLabelsResponse {
labels?: Gmail.Schema.Label[];
}
export interface ListMessagesResponse {
interface ListMessagesResponse {
messages?: Gmail.Schema.Message[];
nextPageToken?: string;
resultSizeEstimate?: number;
}
export interface ListSendAsResponse {
interface ListSendAsResponse {
sendAs?: Gmail.Schema.SendAs[];
}
export interface ListSmimeInfoResponse {
interface ListSmimeInfoResponse {
smimeInfo?: Gmail.Schema.SmimeInfo[];
}
export interface ListThreadsResponse {
interface ListThreadsResponse {
nextPageToken?: string;
resultSizeEstimate?: number;
threads?: Gmail.Schema.Thread[];
}
export interface Message {
interface Message {
historyId?: string;
id?: string;
internalDate?: string;
@@ -373,7 +373,7 @@ declare namespace GoogleAppsScript {
snippet?: string;
threadId?: string;
}
export interface MessagePart {
interface MessagePart {
body?: Gmail.Schema.MessagePartBody;
filename?: string;
headers?: Gmail.Schema.MessagePartHeader[];
@@ -381,34 +381,34 @@ declare namespace GoogleAppsScript {
partId?: string;
parts?: Gmail.Schema.MessagePart[];
}
export interface MessagePartBody {
interface MessagePartBody {
attachmentId?: string;
data?: string;
size?: number;
}
export interface MessagePartHeader {
interface MessagePartHeader {
name?: string;
value?: string;
}
export interface ModifyMessageRequest {
interface ModifyMessageRequest {
addLabelIds?: string[];
removeLabelIds?: string[];
}
export interface ModifyThreadRequest {
interface ModifyThreadRequest {
addLabelIds?: string[];
removeLabelIds?: string[];
}
export interface PopSettings {
interface PopSettings {
accessWindow?: string;
disposition?: string;
}
export interface Profile {
interface Profile {
emailAddress?: string;
historyId?: string;
messagesTotal?: number;
threadsTotal?: number;
}
export interface SendAs {
interface SendAs {
displayName?: string;
isDefault?: boolean;
isPrimary?: boolean;
@@ -419,7 +419,7 @@ declare namespace GoogleAppsScript {
treatAsAlias?: boolean;
verificationStatus?: string;
}
export interface SmimeInfo {
interface SmimeInfo {
encryptedKeyPassword?: string;
expiration?: string;
id?: string;
@@ -428,20 +428,20 @@ declare namespace GoogleAppsScript {
pem?: string;
pkcs12?: string;
}
export interface SmtpMsa {
interface SmtpMsa {
host?: string;
password?: string;
port?: number;
securityMode?: string;
username?: string;
}
export interface Thread {
interface Thread {
historyId?: string;
id?: string;
messages?: Gmail.Schema.Message[];
snippet?: string;
}
export interface VacationSettings {
interface VacationSettings {
enableAutoReply?: boolean;
endTime?: string;
responseBodyHtml?: string;
@@ -451,18 +451,18 @@ declare namespace GoogleAppsScript {
restrictToDomain?: boolean;
startTime?: string;
}
export interface WatchRequest {
interface WatchRequest {
labelFilterAction?: string;
labelIds?: string[];
topicName?: string;
}
export interface WatchResponse {
interface WatchResponse {
expiration?: string;
historyId?: string;
}
}
}
export interface Gmail {
interface Gmail {
Users?: Gmail.Collection.UsersCollection;
// Create a new instance of AutoForwarding
newAutoForwarding(): Gmail.Schema.AutoForwarding;
types/google-apps-script/apis/groupsmigration_v1.d.ts
Vendored
+3 -3
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace AdminGroupsMigration {
namespace Collection {
export interface ArchiveCollection {
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.
@@ -15,13 +15,13 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Groups {
interface Groups {
kind?: string;
responseCode?: string;
}
}
}
export interface AdminGroupsMigration {
interface AdminGroupsMigration {
Archive?: AdminGroupsMigration.Collection.ArchiveCollection;
}
}
types/google-apps-script/apis/groupssettings_v1.d.ts
Vendored
+3 -3
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace AdminGroupsSettings {
namespace Collection {
export interface GroupsCollection {
interface GroupsCollection {
// Gets one resource by id.
get(groupUniqueId: string): AdminGroupsSettings.Schema.Groups;
// Updates an existing resource. This method supports patch semantics.
@@ -17,7 +17,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Groups {
interface Groups {
allowExternalMembers?: string;
allowGoogleCommunication?: string;
allowWebPosting?: string;
@@ -82,7 +82,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface AdminGroupsSettings {
interface AdminGroupsSettings {
Groups?: AdminGroupsSettings.Collection.GroupsCollection;
// Create a new instance of Groups
newGroups(): AdminGroupsSettings.Schema.Groups;
types/google-apps-script/apis/licensing_v1.d.ts
Vendored
+5 -5
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace AdminLicenseManager {
namespace Collection {
export interface LicenseAssignmentsCollection {
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.
@@ -29,7 +29,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface LicenseAssignment {
interface LicenseAssignment {
etags?: string;
kind?: string;
productId?: string;
@@ -39,10 +39,10 @@ declare namespace GoogleAppsScript {
skuName?: string;
userId?: string;
}
export interface LicenseAssignmentInsert {
interface LicenseAssignmentInsert {
userId?: string;
}
export interface LicenseAssignmentList {
interface LicenseAssignmentList {
etag?: string;
items?: AdminLicenseManager.Schema.LicenseAssignment[];
kind?: string;
@@ -50,7 +50,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface AdminLicenseManager {
interface AdminLicenseManager {
LicenseAssignments?: AdminLicenseManager.Collection.LicenseAssignmentsCollection;
// Create a new instance of LicenseAssignment
newLicenseAssignment(): AdminLicenseManager.Schema.LicenseAssignment;
types/google-apps-script/apis/mirror_v1.d.ts
Vendored
+28 -28
View File
@@ -8,7 +8,7 @@ declare namespace GoogleAppsScript {
namespace Mirror {
namespace Collection {
namespace Timeline {
export interface AttachmentsCollection {
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.
@@ -21,11 +21,11 @@ declare namespace GoogleAppsScript {
remove(itemId: string, attachmentId: string): void;
}
}
export interface AccountsCollection {
interface AccountsCollection {
// Inserts a new account for a user
insert(resource: Schema.Account, userToken: string, accountType: string, accountName: string): Mirror.Schema.Account;
}
export interface ContactsCollection {
interface ContactsCollection {
// Gets a single contact by ID.
get(id: string): Mirror.Schema.Contact;
// Inserts a new contact.
@@ -39,17 +39,17 @@ declare namespace GoogleAppsScript {
// Updates a contact in place.
update(resource: Schema.Contact, id: string): Mirror.Schema.Contact;
}
export interface LocationsCollection {
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;
}
export interface SettingsCollection {
interface SettingsCollection {
// Gets a single setting by ID.
get(id: string): Mirror.Schema.Setting;
}
export interface SubscriptionsCollection {
interface SubscriptionsCollection {
// Creates a new subscription.
insert(resource: Schema.Subscription): Mirror.Schema.Subscription;
// Retrieves a list of subscriptions for the authenticated user and service.
@@ -59,7 +59,7 @@ declare namespace GoogleAppsScript {
// Updates an existing subscription in place.
update(resource: Schema.Subscription, id: string): Mirror.Schema.Subscription;
}
export interface TimelineCollection {
interface TimelineCollection {
Attachments?: Mirror.Collection.Timeline.AttachmentsCollection;
// Gets a single timeline item by ID.
get(id: string): Mirror.Schema.TimelineItem;
@@ -82,30 +82,30 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Account {
interface Account {
authTokens?: Mirror.Schema.AuthToken[];
features?: string[];
password?: string;
userData?: Mirror.Schema.UserData[];
}
export interface Attachment {
interface Attachment {
contentType?: string;
contentUrl?: string;
id?: string;
isProcessingContent?: boolean;
}
export interface AttachmentsListResponse {
interface AttachmentsListResponse {
items?: Mirror.Schema.Attachment[];
kind?: string;
}
export interface AuthToken {
interface AuthToken {
authToken?: string;
type?: string;
}
export interface Command {
interface Command {
type?: string;
}
export interface Contact {
interface Contact {
acceptCommands?: Mirror.Schema.Command[];
acceptTypes?: string[];
displayName?: string;
@@ -119,11 +119,11 @@ declare namespace GoogleAppsScript {
speakableName?: string;
type?: string;
}
export interface ContactsListResponse {
interface ContactsListResponse {
items?: Mirror.Schema.Contact[];
kind?: string;
}
export interface Location {
interface Location {
accuracy?: number;
address?: string;
displayName?: string;
@@ -133,11 +133,11 @@ declare namespace GoogleAppsScript {
longitude?: number;
timestamp?: string;
}
export interface LocationsListResponse {
interface LocationsListResponse {
items?: Mirror.Schema.Location[];
kind?: string;
}
export interface MenuItem {
interface MenuItem {
action?: string;
contextual_command?: string;
id?: string;
@@ -145,12 +145,12 @@ declare namespace GoogleAppsScript {
removeWhenSelected?: boolean;
values?: Mirror.Schema.MenuValue[];
}
export interface MenuValue {
interface MenuValue {
displayName?: string;
iconUrl?: string;
state?: string;
}
export interface Notification {
interface Notification {
collection?: string;
itemId?: string;
operation?: string;
@@ -158,16 +158,16 @@ declare namespace GoogleAppsScript {
userToken?: string;
verifyToken?: string;
}
export interface NotificationConfig {
interface NotificationConfig {
deliveryTime?: string;
level?: string;
}
export interface Setting {
interface Setting {
id?: string;
kind?: string;
value?: string;
}
export interface Subscription {
interface Subscription {
callbackUrl?: string;
collection?: string;
id?: string;
@@ -178,11 +178,11 @@ declare namespace GoogleAppsScript {
userToken?: string;
verifyToken?: string;
}
export interface SubscriptionsListResponse {
interface SubscriptionsListResponse {
items?: Mirror.Schema.Subscription[];
kind?: string;
}
export interface TimelineItem {
interface TimelineItem {
attachments?: Mirror.Schema.Attachment[];
bundleId?: string;
canonicalUrl?: string;
@@ -210,22 +210,22 @@ declare namespace GoogleAppsScript {
title?: string;
updated?: string;
}
export interface TimelineListResponse {
interface TimelineListResponse {
items?: Mirror.Schema.TimelineItem[];
kind?: string;
nextPageToken?: string;
}
export interface UserAction {
interface UserAction {
payload?: string;
type?: string;
}
export interface UserData {
interface UserData {
key?: string;
value?: string;
}
}
}
export interface Mirror {
interface Mirror {
Accounts?: Mirror.Collection.AccountsCollection;
Contacts?: Mirror.Collection.ContactsCollection;
Locations?: Mirror.Collection.LocationsCollection;
types/google-apps-script/apis/peopleapi_v1.d.ts
Vendored
+54 -54
View File
@@ -8,7 +8,7 @@ declare namespace GoogleAppsScript {
namespace People {
namespace Collection {
namespace ContactGroups {
export interface MembersCollection {
interface MembersCollection {
// Modify the members of a contact group owned by the authenticated user.
// <br>
// The only system contact groups that can have members added are
@@ -18,7 +18,7 @@ declare namespace GoogleAppsScript {
}
}
namespace People {
export interface ConnectionsCollection {
interface ConnectionsCollection {
// Provides a list of the authenticated user's contacts merged with any
// connected profiles.
// <br>
@@ -31,7 +31,7 @@ declare namespace GoogleAppsScript {
list(resourceName: string, optionalArgs: object): Schema.ListConnectionsResponse;
}
}
export interface ContactGroupsCollection {
interface ContactGroupsCollection {
Members?: Collection.ContactGroups.MembersCollection;
// Get a list of contact groups owned by the authenticated user by specifying
// a list of contact group resource names.
@@ -63,7 +63,7 @@ declare namespace GoogleAppsScript {
// user.
update(resource: Schema.UpdateContactGroupRequest, resourceName: string): Schema.ContactGroup;
}
export interface PeopleCollection {
interface PeopleCollection {
Connections?: Collection.People.ConnectionsCollection;
// Create a new contact and return the person resource for that contact.
createContact(resource: Schema.Person): Schema.Person;
@@ -120,7 +120,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Address {
interface Address {
city?: string;
country?: string;
countryCode?: string;
@@ -134,28 +134,28 @@ declare namespace GoogleAppsScript {
streetAddress?: string;
type?: string;
}
export interface AgeRangeType {
interface AgeRangeType {
ageRange?: string;
metadata?: People.Schema.FieldMetadata;
}
export interface BatchGetContactGroupsResponse {
interface BatchGetContactGroupsResponse {
responses?: People.Schema.ContactGroupResponse[];
}
export interface Biography {
interface Biography {
contentType?: string;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface Birthday {
interface Birthday {
date?: People.Schema.Date;
metadata?: People.Schema.FieldMetadata;
text?: string;
}
export interface BraggingRights {
interface BraggingRights {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface ContactGroup {
interface ContactGroup {
etag?: string;
formattedName?: string;
groupType?: string;
@@ -165,61 +165,61 @@ declare namespace GoogleAppsScript {
name?: string;
resourceName?: string;
}
export interface ContactGroupMembership {
interface ContactGroupMembership {
contactGroupId?: string;
}
export interface ContactGroupMetadata {
interface ContactGroupMetadata {
deleted?: boolean;
updateTime?: string;
}
export interface ContactGroupResponse {
interface ContactGroupResponse {
contactGroup?: People.Schema.ContactGroup;
requestedResourceName?: string;
status?: People.Schema.Status;
}
export interface CoverPhoto {
interface CoverPhoto {
default?: boolean;
metadata?: People.Schema.FieldMetadata;
url?: string;
}
export interface CreateContactGroupRequest {
interface CreateContactGroupRequest {
contactGroup?: People.Schema.ContactGroup;
}
export interface Date {
interface Date {
day?: number;
month?: number;
year?: number;
}
export interface DomainMembership {
interface DomainMembership {
inViewerDomain?: boolean;
}
export interface EmailAddress {
interface EmailAddress {
displayName?: string;
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
type?: string;
value?: string;
}
export interface Event {
interface Event {
date?: People.Schema.Date;
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
type?: string;
}
export interface FieldMetadata {
interface FieldMetadata {
primary?: boolean;
source?: People.Schema.Source;
verified?: boolean;
}
export interface Gender {
interface Gender {
formattedValue?: string;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface GetPeopleResponse {
interface GetPeopleResponse {
responses?: People.Schema.PersonResponse[];
}
export interface ImClient {
interface ImClient {
formattedProtocol?: string;
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
@@ -227,40 +227,40 @@ declare namespace GoogleAppsScript {
type?: string;
username?: string;
}
export interface Interest {
interface Interest {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface ListConnectionsResponse {
interface ListConnectionsResponse {
connections?: People.Schema.Person[];
nextPageToken?: string;
nextSyncToken?: string;
totalItems?: number;
totalPeople?: number;
}
export interface ListContactGroupsResponse {
interface ListContactGroupsResponse {
contactGroups?: People.Schema.ContactGroup[];
nextPageToken?: string;
nextSyncToken?: string;
totalItems?: number;
}
export interface Locale {
interface Locale {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface Membership {
interface Membership {
contactGroupMembership?: People.Schema.ContactGroupMembership;
domainMembership?: People.Schema.DomainMembership;
metadata?: People.Schema.FieldMetadata;
}
export interface ModifyContactGroupMembersRequest {
interface ModifyContactGroupMembersRequest {
resourceNamesToAdd?: string[];
resourceNamesToRemove?: string[];
}
export interface ModifyContactGroupMembersResponse {
interface ModifyContactGroupMembersResponse {
notFoundResourceNames?: string[];
}
export interface Name {
interface Name {
displayName?: string;
displayNameLastFirst?: string;
familyName?: string;
@@ -276,16 +276,16 @@ declare namespace GoogleAppsScript {
phoneticHonorificSuffix?: string;
phoneticMiddleName?: string;
}
export interface Nickname {
interface Nickname {
metadata?: People.Schema.FieldMetadata;
type?: string;
value?: string;
}
export interface Occupation {
interface Occupation {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface Organization {
interface Organization {
current?: boolean;
department?: string;
domain?: string;
@@ -301,7 +301,7 @@ declare namespace GoogleAppsScript {
title?: string;
type?: string;
}
export interface Person {
interface Person {
addresses?: People.Schema.Address[];
ageRange?: string;
ageRanges?: People.Schema.AgeRangeType[];
@@ -335,99 +335,99 @@ declare namespace GoogleAppsScript {
urls?: People.Schema.Url[];
userDefined?: People.Schema.UserDefined[];
}
export interface PersonMetadata {
interface PersonMetadata {
deleted?: boolean;
linkedPeopleResourceNames?: string[];
objectType?: string;
previousResourceNames?: string[];
sources?: People.Schema.Source[];
}
export interface PersonResponse {
interface PersonResponse {
httpStatusCode?: number;
person?: People.Schema.Person;
requestedResourceName?: string;
status?: People.Schema.Status;
}
export interface PhoneNumber {
interface PhoneNumber {
canonicalForm?: string;
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
type?: string;
value?: string;
}
export interface Photo {
interface Photo {
default?: boolean;
metadata?: People.Schema.FieldMetadata;
url?: string;
}
export interface ProfileMetadata {
interface ProfileMetadata {
objectType?: string;
userTypes?: string[];
}
export interface Relation {
interface Relation {
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
person?: string;
type?: string;
}
export interface RelationshipInterest {
interface RelationshipInterest {
formattedValue?: string;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface RelationshipStatus {
interface RelationshipStatus {
formattedValue?: string;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface Residence {
interface Residence {
current?: boolean;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface SipAddress {
interface SipAddress {
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
type?: string;
value?: string;
}
export interface Skill {
interface Skill {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface Source {
interface Source {
etag?: string;
id?: string;
profileMetadata?: People.Schema.ProfileMetadata;
type?: string;
updateTime?: string;
}
export interface Status {
interface Status {
code?: number;
details?: object[];
message?: string;
}
export interface Tagline {
interface Tagline {
metadata?: People.Schema.FieldMetadata;
value?: string;
}
export interface UpdateContactGroupRequest {
interface UpdateContactGroupRequest {
contactGroup?: People.Schema.ContactGroup;
}
export interface Url {
interface Url {
formattedType?: string;
metadata?: People.Schema.FieldMetadata;
type?: string;
value?: string;
}
export interface UserDefined {
interface UserDefined {
key?: string;
metadata?: People.Schema.FieldMetadata;
value?: string;
}
}
}
export interface People {
interface People {
ContactGroups?: People.Collection.ContactGroupsCollection;
People?: People.Collection.PeopleCollection;
// Create a new instance of Address
types/google-apps-script/apis/reports_v1.d.ts
Vendored
+19 -19
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace AdminReports {
namespace Collection {
export interface ActivitiesCollection {
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.
@@ -17,23 +17,23 @@ declare namespace GoogleAppsScript {
// Push changes to activities
watch(resource: Schema.Channel, userKey: string, applicationName: string, optionalArgs: object): AdminReports.Schema.Channel;
}
export interface ChannelsCollection {
interface ChannelsCollection {
// Stop watching resources through this channel
stop(resource: Schema.Channel): void;
}
export interface CustomerUsageReportsCollection {
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;
}
export interface EntityUsageReportsCollection {
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;
}
export interface UserUsageReportCollection {
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.
@@ -41,13 +41,13 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Activities {
interface Activities {
etag?: string;
items?: AdminReports.Schema.Activity[];
kind?: string;
nextPageToken?: string;
}
export interface Activity {
interface Activity {
actor?: AdminReports.Schema.ActivityActor;
etag?: string;
events?: AdminReports.Schema.ActivityEvents[];
@@ -56,18 +56,18 @@ declare namespace GoogleAppsScript {
kind?: string;
ownerDomain?: string;
}
export interface ActivityActor {
interface ActivityActor {
callerType?: string;
email?: string;
key?: string;
profileId?: string;
}
export interface ActivityEvents {
interface ActivityEvents {
name?: string;
parameters?: AdminReports.Schema.ActivityEventsParameters[];
type?: string;
}
export interface ActivityEventsParameters {
interface ActivityEventsParameters {
boolValue?: boolean;
intValue?: string;
multiIntValue?: string[];
@@ -75,13 +75,13 @@ declare namespace GoogleAppsScript {
name?: string;
value?: string;
}
export interface ActivityId {
interface ActivityId {
applicationName?: string;
customerId?: string;
time?: string;
uniqueQualifier?: string;
}
export interface Channel {
interface Channel {
address?: string;
expiration?: string;
id?: string;
@@ -93,21 +93,21 @@ declare namespace GoogleAppsScript {
token?: string;
type?: string;
}
export interface UsageReport {
interface UsageReport {
date?: string;
entity?: AdminReports.Schema.UsageReportEntity;
etag?: string;
kind?: string;
parameters?: AdminReports.Schema.UsageReportParameters[];
}
export interface UsageReportEntity {
interface UsageReportEntity {
customerId?: string;
entityId?: string;
profileId?: string;
type?: string;
userEmail?: string;
}
export interface UsageReportParameters {
interface UsageReportParameters {
boolValue?: boolean;
datetimeValue?: string;
intValue?: string;
@@ -115,25 +115,25 @@ declare namespace GoogleAppsScript {
name?: string;
stringValue?: string;
}
export interface UsageReports {
interface UsageReports {
etag?: string;
kind?: string;
nextPageToken?: string;
usageReports?: AdminReports.Schema.UsageReport[];
warnings?: AdminReports.Schema.UsageReportsWarnings[];
}
export interface UsageReportsWarnings {
interface UsageReportsWarnings {
code?: string;
data?: AdminReports.Schema.UsageReportsWarningsData[];
message?: string;
}
export interface UsageReportsWarningsData {
interface UsageReportsWarningsData {
key?: string;
value?: string;
}
}
}
export interface AdminReports {
interface AdminReports {
Activities?: AdminReports.Collection.ActivitiesCollection;
Channels?: AdminReports.Collection.ChannelsCollection;
CustomerUsageReports?: AdminReports.Collection.CustomerUsageReportsCollection;
types/google-apps-script/apis/reseller_v1.d.ts
Vendored
+17 -17
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace AdminReseller {
namespace Collection {
export interface CustomersCollection {
interface CustomersCollection {
// Get a customer account.
get(customerId: string): AdminReseller.Schema.Customer;
// Order a new customer's account.
@@ -19,7 +19,7 @@ declare namespace GoogleAppsScript {
// Update a customer account's settings.
update(resource: Schema.Customer, customerId: string): AdminReseller.Schema.Customer;
}
export interface ResellernotifyCollection {
interface ResellernotifyCollection {
// Returns all the details of the watch corresponding to the reseller.
getwatchdetails(): AdminReseller.Schema.ResellernotifyGetwatchdetailsResponse;
// Registers a Reseller for receiving notifications.
@@ -31,7 +31,7 @@ declare namespace GoogleAppsScript {
// Unregisters a Reseller for receiving notifications.
unregister(optionalArgs: object): AdminReseller.Schema.ResellernotifyResource;
}
export interface SubscriptionsCollection {
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.
@@ -59,7 +59,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Address {
interface Address {
addressLine1?: string;
addressLine2?: string;
addressLine3?: string;
@@ -71,14 +71,14 @@ declare namespace GoogleAppsScript {
postalCode?: string;
region?: string;
}
export interface ChangePlanRequest {
interface ChangePlanRequest {
dealCode?: string;
kind?: string;
planName?: string;
purchaseOrderId?: string;
seats?: AdminReseller.Schema.Seats;
}
export interface Customer {
interface Customer {
alternateEmail?: string;
customerDomain?: string;
customerDomainVerified?: boolean;
@@ -88,24 +88,24 @@ declare namespace GoogleAppsScript {
postalAddress?: AdminReseller.Schema.Address;
resourceUiUrl?: string;
}
export interface RenewalSettings {
interface RenewalSettings {
kind?: string;
renewalType?: string;
}
export interface ResellernotifyGetwatchdetailsResponse {
interface ResellernotifyGetwatchdetailsResponse {
serviceAccountEmailAddresses?: string[];
topicName?: string;
}
export interface ResellernotifyResource {
interface ResellernotifyResource {
topicName?: string;
}
export interface Seats {
interface Seats {
kind?: string;
licensedNumberOfSeats?: number;
maximumNumberOfSeats?: number;
numberOfSeats?: number;
}
export interface Subscription {
interface Subscription {
billingMethod?: string;
creationTime?: string;
customerDomain?: string;
@@ -125,31 +125,31 @@ declare namespace GoogleAppsScript {
transferInfo?: AdminReseller.Schema.SubscriptionTransferInfo;
trialSettings?: AdminReseller.Schema.SubscriptionTrialSettings;
}
export interface SubscriptionPlan {
interface SubscriptionPlan {
commitmentInterval?: AdminReseller.Schema.SubscriptionPlanCommitmentInterval;
isCommitmentPlan?: boolean;
planName?: string;
}
export interface SubscriptionPlanCommitmentInterval {
interface SubscriptionPlanCommitmentInterval {
endTime?: string;
startTime?: string;
}
export interface SubscriptionTransferInfo {
interface SubscriptionTransferInfo {
minimumTransferableSeats?: number;
transferabilityExpirationTime?: string;
}
export interface SubscriptionTrialSettings {
interface SubscriptionTrialSettings {
isInTrial?: boolean;
trialEndTime?: string;
}
export interface Subscriptions {
interface Subscriptions {
kind?: string;
nextPageToken?: string;
subscriptions?: AdminReseller.Schema.Subscription[];
}
}
}
export interface AdminReseller {
interface AdminReseller {
Customers?: AdminReseller.Collection.CustomersCollection;
Resellernotify?: AdminReseller.Collection.ResellernotifyCollection;
Subscriptions?: AdminReseller.Collection.SubscriptionsCollection;
types/google-apps-script/apis/sheets_v4.d.ts
Vendored
+190 -190
View File
File diff suppressed because it is too large Load Diff
types/google-apps-script/apis/slides_v1.d.ts
Vendored
+135 -135
View File
@@ -8,7 +8,7 @@ declare namespace GoogleAppsScript {
namespace Slides {
namespace Collection {
namespace Presentations {
export interface PagesCollection {
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
@@ -23,7 +23,7 @@ declare namespace GoogleAppsScript {
getThumbnail(presentationId: string, pageObjectId: string, optionalArgs: object): Slides.Schema.Thumbnail;
}
}
export interface PresentationsCollection {
interface PresentationsCollection {
Pages?: Slides.Collection.Presentations.PagesCollection;
// Applies one or more updates to the presentation.
// Each request is validated before
@@ -54,7 +54,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface AffineTransform {
interface AffineTransform {
scaleX?: number;
scaleY?: number;
shearX?: number;
@@ -63,157 +63,157 @@ declare namespace GoogleAppsScript {
translateY?: number;
unit?: string;
}
export interface AutoText {
interface AutoText {
content?: string;
style?: Slides.Schema.TextStyle;
type?: string;
}
export interface BatchUpdatePresentationRequest {
interface BatchUpdatePresentationRequest {
requests?: Slides.Schema.Request[];
writeControl?: Slides.Schema.WriteControl;
}
export interface BatchUpdatePresentationResponse {
interface BatchUpdatePresentationResponse {
presentationId?: string;
replies?: Slides.Schema.Response[];
writeControl?: Slides.Schema.WriteControl;
}
export interface Bullet {
interface Bullet {
bulletStyle?: Slides.Schema.TextStyle;
glyph?: string;
listId?: string;
nestingLevel?: number;
}
export interface ColorScheme {
interface ColorScheme {
colors?: Slides.Schema.ThemeColorPair[];
}
export interface ColorStop {
interface ColorStop {
alpha?: number;
color?: Slides.Schema.OpaqueColor;
position?: number;
}
export interface CreateImageRequest {
interface CreateImageRequest {
elementProperties?: Slides.Schema.PageElementProperties;
objectId?: string;
url?: string;
}
export interface CreateImageResponse {
interface CreateImageResponse {
objectId?: string;
}
export interface CreateLineRequest {
interface CreateLineRequest {
category?: string;
elementProperties?: Slides.Schema.PageElementProperties;
lineCategory?: string;
objectId?: string;
}
export interface CreateLineResponse {
interface CreateLineResponse {
objectId?: string;
}
export interface CreateParagraphBulletsRequest {
interface CreateParagraphBulletsRequest {
bulletPreset?: string;
cellLocation?: Slides.Schema.TableCellLocation;
objectId?: string;
textRange?: Slides.Schema.Range;
}
export interface CreateShapeRequest {
interface CreateShapeRequest {
elementProperties?: Slides.Schema.PageElementProperties;
objectId?: string;
shapeType?: string;
}
export interface CreateShapeResponse {
interface CreateShapeResponse {
objectId?: string;
}
export interface CreateSheetsChartRequest {
interface CreateSheetsChartRequest {
chartId?: number;
elementProperties?: Slides.Schema.PageElementProperties;
linkingMode?: string;
objectId?: string;
spreadsheetId?: string;
}
export interface CreateSheetsChartResponse {
interface CreateSheetsChartResponse {
objectId?: string;
}
export interface CreateSlideRequest {
interface CreateSlideRequest {
insertionIndex?: number;
objectId?: string;
placeholderIdMappings?: Slides.Schema.LayoutPlaceholderIdMapping[];
slideLayoutReference?: Slides.Schema.LayoutReference;
}
export interface CreateSlideResponse {
interface CreateSlideResponse {
objectId?: string;
}
export interface CreateTableRequest {
interface CreateTableRequest {
columns?: number;
elementProperties?: Slides.Schema.PageElementProperties;
objectId?: string;
rows?: number;
}
export interface CreateTableResponse {
interface CreateTableResponse {
objectId?: string;
}
export interface CreateVideoRequest {
interface CreateVideoRequest {
elementProperties?: Slides.Schema.PageElementProperties;
id?: string;
objectId?: string;
source?: string;
}
export interface CreateVideoResponse {
interface CreateVideoResponse {
objectId?: string;
}
export interface CropProperties {
interface CropProperties {
angle?: number;
bottomOffset?: number;
leftOffset?: number;
rightOffset?: number;
topOffset?: number;
}
export interface DeleteObjectRequest {
interface DeleteObjectRequest {
objectId?: string;
}
export interface DeleteParagraphBulletsRequest {
interface DeleteParagraphBulletsRequest {
cellLocation?: Slides.Schema.TableCellLocation;
objectId?: string;
textRange?: Slides.Schema.Range;
}
export interface DeleteTableColumnRequest {
interface DeleteTableColumnRequest {
cellLocation?: Slides.Schema.TableCellLocation;
tableObjectId?: string;
}
export interface DeleteTableRowRequest {
interface DeleteTableRowRequest {
cellLocation?: Slides.Schema.TableCellLocation;
tableObjectId?: string;
}
export interface DeleteTextRequest {
interface DeleteTextRequest {
cellLocation?: Slides.Schema.TableCellLocation;
objectId?: string;
textRange?: Slides.Schema.Range;
}
export interface Dimension {
interface Dimension {
magnitude?: number;
unit?: string;
}
export interface DuplicateObjectRequest {
interface DuplicateObjectRequest {
objectId?: string;
objectIds?: object;
}
export interface DuplicateObjectResponse {
interface DuplicateObjectResponse {
objectId?: string;
}
export interface Group {
interface Group {
children?: Slides.Schema.PageElement[];
}
export interface GroupObjectsRequest {
interface GroupObjectsRequest {
childrenObjectIds?: string[];
groupObjectId?: string;
}
export interface GroupObjectsResponse {
interface GroupObjectsResponse {
objectId?: string;
}
export interface Image {
interface Image {
contentUrl?: string;
imageProperties?: Slides.Schema.ImageProperties;
sourceUrl?: string;
}
export interface ImageProperties {
interface ImageProperties {
brightness?: number;
contrast?: number;
cropProperties?: Slides.Schema.CropProperties;
@@ -223,51 +223,51 @@ declare namespace GoogleAppsScript {
shadow?: Slides.Schema.Shadow;
transparency?: number;
}
export interface InsertTableColumnsRequest {
interface InsertTableColumnsRequest {
cellLocation?: Slides.Schema.TableCellLocation;
insertRight?: boolean;
number?: number;
tableObjectId?: string;
}
export interface InsertTableRowsRequest {
interface InsertTableRowsRequest {
cellLocation?: Slides.Schema.TableCellLocation;
insertBelow?: boolean;
number?: number;
tableObjectId?: string;
}
export interface InsertTextRequest {
interface InsertTextRequest {
cellLocation?: Slides.Schema.TableCellLocation;
insertionIndex?: number;
objectId?: string;
text?: string;
}
export interface LayoutPlaceholderIdMapping {
interface LayoutPlaceholderIdMapping {
layoutPlaceholder?: Slides.Schema.Placeholder;
layoutPlaceholderObjectId?: string;
objectId?: string;
}
export interface LayoutProperties {
interface LayoutProperties {
displayName?: string;
masterObjectId?: string;
name?: string;
}
export interface LayoutReference {
interface LayoutReference {
layoutId?: string;
predefinedLayout?: string;
}
export interface Line {
interface Line {
lineCategory?: string;
lineProperties?: Slides.Schema.LineProperties;
lineType?: string;
}
export interface LineConnection {
interface LineConnection {
connectedObjectId?: string;
connectionSiteIndex?: number;
}
export interface LineFill {
interface LineFill {
solidFill?: Slides.Schema.SolidFill;
}
export interface LineProperties {
interface LineProperties {
dashStyle?: string;
endArrow?: string;
endConnection?: Slides.Schema.LineConnection;
@@ -277,46 +277,46 @@ declare namespace GoogleAppsScript {
startConnection?: Slides.Schema.LineConnection;
weight?: Slides.Schema.Dimension;
}
export interface Link {
interface Link {
pageObjectId?: string;
relativeLink?: string;
slideIndex?: number;
url?: string;
}
export interface List {
interface List {
listId?: string;
nestingLevel?: object;
}
export interface MasterProperties {
interface MasterProperties {
displayName?: string;
}
export interface MergeTableCellsRequest {
interface MergeTableCellsRequest {
objectId?: string;
tableRange?: Slides.Schema.TableRange;
}
export interface NestingLevel {
interface NestingLevel {
bulletStyle?: Slides.Schema.TextStyle;
}
export interface NotesProperties {
interface NotesProperties {
speakerNotesObjectId?: string;
}
export interface OpaqueColor {
interface OpaqueColor {
rgbColor?: Slides.Schema.RgbColor;
themeColor?: string;
}
export interface OptionalColor {
interface OptionalColor {
opaqueColor?: Slides.Schema.OpaqueColor;
}
export interface Outline {
interface Outline {
dashStyle?: string;
outlineFill?: Slides.Schema.OutlineFill;
propertyState?: string;
weight?: Slides.Schema.Dimension;
}
export interface OutlineFill {
interface OutlineFill {
solidFill?: Slides.Schema.SolidFill;
}
export interface Page {
interface Page {
layoutProperties?: Slides.Schema.LayoutProperties;
masterProperties?: Slides.Schema.MasterProperties;
notesProperties?: Slides.Schema.NotesProperties;
@@ -327,12 +327,12 @@ declare namespace GoogleAppsScript {
revisionId?: string;
slideProperties?: Slides.Schema.SlideProperties;
}
export interface PageBackgroundFill {
interface PageBackgroundFill {
propertyState?: string;
solidFill?: Slides.Schema.SolidFill;
stretchedPictureFill?: Slides.Schema.StretchedPictureFill;
}
export interface PageElement {
interface PageElement {
description?: string;
elementGroup?: Slides.Schema.Group;
image?: Slides.Schema.Image;
@@ -347,20 +347,20 @@ declare namespace GoogleAppsScript {
video?: Slides.Schema.Video;
wordArt?: Slides.Schema.WordArt;
}
export interface PageElementProperties {
interface PageElementProperties {
pageObjectId?: string;
size?: Slides.Schema.Size;
transform?: Slides.Schema.AffineTransform;
}
export interface PageProperties {
interface PageProperties {
colorScheme?: Slides.Schema.ColorScheme;
pageBackgroundFill?: Slides.Schema.PageBackgroundFill;
}
export interface ParagraphMarker {
interface ParagraphMarker {
bullet?: Slides.Schema.Bullet;
style?: Slides.Schema.ParagraphStyle;
}
export interface ParagraphStyle {
interface ParagraphStyle {
alignment?: string;
direction?: string;
indentEnd?: Slides.Schema.Dimension;
@@ -371,12 +371,12 @@ declare namespace GoogleAppsScript {
spaceBelow?: Slides.Schema.Dimension;
spacingMode?: string;
}
export interface Placeholder {
interface Placeholder {
index?: number;
parentObjectId?: string;
type?: string;
}
export interface Presentation {
interface Presentation {
layouts?: Slides.Schema.Page[];
locale?: string;
masters?: Slides.Schema.Page[];
@@ -387,52 +387,52 @@ declare namespace GoogleAppsScript {
slides?: Slides.Schema.Page[];
title?: string;
}
export interface Range {
interface Range {
endIndex?: number;
startIndex?: number;
type?: string;
}
export interface Recolor {
interface Recolor {
name?: string;
recolorStops?: Slides.Schema.ColorStop[];
}
export interface RefreshSheetsChartRequest {
interface RefreshSheetsChartRequest {
objectId?: string;
}
export interface ReplaceAllShapesWithImageRequest {
interface ReplaceAllShapesWithImageRequest {
containsText?: Slides.Schema.SubstringMatchCriteria;
imageReplaceMethod?: string;
imageUrl?: string;
pageObjectIds?: string[];
replaceMethod?: string;
}
export interface ReplaceAllShapesWithImageResponse {
interface ReplaceAllShapesWithImageResponse {
occurrencesChanged?: number;
}
export interface ReplaceAllShapesWithSheetsChartRequest {
interface ReplaceAllShapesWithSheetsChartRequest {
chartId?: number;
containsText?: Slides.Schema.SubstringMatchCriteria;
linkingMode?: string;
pageObjectIds?: string[];
spreadsheetId?: string;
}
export interface ReplaceAllShapesWithSheetsChartResponse {
interface ReplaceAllShapesWithSheetsChartResponse {
occurrencesChanged?: number;
}
export interface ReplaceAllTextRequest {
interface ReplaceAllTextRequest {
containsText?: Slides.Schema.SubstringMatchCriteria;
pageObjectIds?: string[];
replaceText?: string;
}
export interface ReplaceAllTextResponse {
interface ReplaceAllTextResponse {
occurrencesChanged?: number;
}
export interface ReplaceImageRequest {
interface ReplaceImageRequest {
imageObjectId?: string;
imageReplaceMethod?: string;
url?: string;
}
export interface Request {
interface Request {
createImage?: Slides.Schema.CreateImageRequest;
createLine?: Slides.Schema.CreateLineRequest;
createParagraphBullets?: Slides.Schema.CreateParagraphBulletsRequest;
@@ -477,10 +477,10 @@ declare namespace GoogleAppsScript {
updateTextStyle?: Slides.Schema.UpdateTextStyleRequest;
updateVideoProperties?: Slides.Schema.UpdateVideoPropertiesRequest;
}
export interface RerouteLineRequest {
interface RerouteLineRequest {
objectId?: string;
}
export interface Response {
interface Response {
createImage?: Slides.Schema.CreateImageResponse;
createLine?: Slides.Schema.CreateLineResponse;
createShape?: Slides.Schema.CreateShapeResponse;
@@ -494,12 +494,12 @@ declare namespace GoogleAppsScript {
replaceAllShapesWithSheetsChart?: Slides.Schema.ReplaceAllShapesWithSheetsChartResponse;
replaceAllText?: Slides.Schema.ReplaceAllTextResponse;
}
export interface RgbColor {
interface RgbColor {
blue?: number;
green?: number;
red?: number;
}
export interface Shadow {
interface Shadow {
alignment?: string;
alpha?: number;
blurRadius?: Slides.Schema.Dimension;
@@ -509,54 +509,54 @@ declare namespace GoogleAppsScript {
transform?: Slides.Schema.AffineTransform;
type?: string;
}
export interface Shape {
interface Shape {
placeholder?: Slides.Schema.Placeholder;
shapeProperties?: Slides.Schema.ShapeProperties;
shapeType?: string;
text?: Slides.Schema.TextContent;
}
export interface ShapeBackgroundFill {
interface ShapeBackgroundFill {
propertyState?: string;
solidFill?: Slides.Schema.SolidFill;
}
export interface ShapeProperties {
interface ShapeProperties {
contentAlignment?: string;
link?: Slides.Schema.Link;
outline?: Slides.Schema.Outline;
shadow?: Slides.Schema.Shadow;
shapeBackgroundFill?: Slides.Schema.ShapeBackgroundFill;
}
export interface SheetsChart {
interface SheetsChart {
chartId?: number;
contentUrl?: string;
sheetsChartProperties?: Slides.Schema.SheetsChartProperties;
spreadsheetId?: string;
}
export interface SheetsChartProperties {
interface SheetsChartProperties {
chartImageProperties?: Slides.Schema.ImageProperties;
}
export interface Size {
interface Size {
height?: Slides.Schema.Dimension;
width?: Slides.Schema.Dimension;
}
export interface SlideProperties {
interface SlideProperties {
layoutObjectId?: string;
masterObjectId?: string;
notesPage?: Slides.Schema.Page;
}
export interface SolidFill {
interface SolidFill {
alpha?: number;
color?: Slides.Schema.OpaqueColor;
}
export interface StretchedPictureFill {
interface StretchedPictureFill {
contentUrl?: string;
size?: Slides.Schema.Size;
}
export interface SubstringMatchCriteria {
interface SubstringMatchCriteria {
matchCase?: boolean;
text?: string;
}
export interface Table {
interface Table {
columns?: number;
horizontalBorderRows?: Slides.Schema.TableBorderRow[];
rows?: number;
@@ -564,72 +564,72 @@ declare namespace GoogleAppsScript {
tableRows?: Slides.Schema.TableRow[];
verticalBorderRows?: Slides.Schema.TableBorderRow[];
}
export interface TableBorderCell {
interface TableBorderCell {
location?: Slides.Schema.TableCellLocation;
tableBorderProperties?: Slides.Schema.TableBorderProperties;
}
export interface TableBorderFill {
interface TableBorderFill {
solidFill?: Slides.Schema.SolidFill;
}
export interface TableBorderProperties {
interface TableBorderProperties {
dashStyle?: string;
tableBorderFill?: Slides.Schema.TableBorderFill;
weight?: Slides.Schema.Dimension;
}
export interface TableBorderRow {
interface TableBorderRow {
tableBorderCells?: Slides.Schema.TableBorderCell[];
}
export interface TableCell {
interface TableCell {
columnSpan?: number;
location?: Slides.Schema.TableCellLocation;
rowSpan?: number;
tableCellProperties?: Slides.Schema.TableCellProperties;
text?: Slides.Schema.TextContent;
}
export interface TableCellBackgroundFill {
interface TableCellBackgroundFill {
propertyState?: string;
solidFill?: Slides.Schema.SolidFill;
}
export interface TableCellLocation {
interface TableCellLocation {
columnIndex?: number;
rowIndex?: number;
}
export interface TableCellProperties {
interface TableCellProperties {
contentAlignment?: string;
tableCellBackgroundFill?: Slides.Schema.TableCellBackgroundFill;
}
export interface TableColumnProperties {
interface TableColumnProperties {
columnWidth?: Slides.Schema.Dimension;
}
export interface TableRange {
interface TableRange {
columnSpan?: number;
location?: Slides.Schema.TableCellLocation;
rowSpan?: number;
}
export interface TableRow {
interface TableRow {
rowHeight?: Slides.Schema.Dimension;
tableCells?: Slides.Schema.TableCell[];
tableRowProperties?: Slides.Schema.TableRowProperties;
}
export interface TableRowProperties {
interface TableRowProperties {
minRowHeight?: Slides.Schema.Dimension;
}
export interface TextContent {
interface TextContent {
lists?: object;
textElements?: Slides.Schema.TextElement[];
}
export interface TextElement {
interface TextElement {
autoText?: Slides.Schema.AutoText;
endIndex?: number;
paragraphMarker?: Slides.Schema.ParagraphMarker;
startIndex?: number;
textRun?: Slides.Schema.TextRun;
}
export interface TextRun {
interface TextRun {
content?: string;
style?: Slides.Schema.TextStyle;
}
export interface TextStyle {
interface TextStyle {
backgroundColor?: Slides.Schema.OptionalColor;
baselineOffset?: string;
bold?: boolean;
@@ -643,134 +643,134 @@ declare namespace GoogleAppsScript {
underline?: boolean;
weightedFontFamily?: Slides.Schema.WeightedFontFamily;
}
export interface ThemeColorPair {
interface ThemeColorPair {
color?: Slides.Schema.RgbColor;
type?: string;
}
export interface Thumbnail {
interface Thumbnail {
contentUrl?: string;
height?: number;
width?: number;
}
export interface UngroupObjectsRequest {
interface UngroupObjectsRequest {
objectIds?: string[];
}
export interface UnmergeTableCellsRequest {
interface UnmergeTableCellsRequest {
objectId?: string;
tableRange?: Slides.Schema.TableRange;
}
export interface UpdateImagePropertiesRequest {
interface UpdateImagePropertiesRequest {
fields?: string;
imageProperties?: Slides.Schema.ImageProperties;
objectId?: string;
}
export interface UpdateLineCategoryRequest {
interface UpdateLineCategoryRequest {
lineCategory?: string;
objectId?: string;
}
export interface UpdateLinePropertiesRequest {
interface UpdateLinePropertiesRequest {
fields?: string;
lineProperties?: Slides.Schema.LineProperties;
objectId?: string;
}
export interface UpdatePageElementAltTextRequest {
interface UpdatePageElementAltTextRequest {
description?: string;
objectId?: string;
title?: string;
}
export interface UpdatePageElementTransformRequest {
interface UpdatePageElementTransformRequest {
applyMode?: string;
objectId?: string;
transform?: Slides.Schema.AffineTransform;
}
export interface UpdatePageElementsZOrderRequest {
interface UpdatePageElementsZOrderRequest {
operation?: string;
pageElementObjectIds?: string[];
}
export interface UpdatePagePropertiesRequest {
interface UpdatePagePropertiesRequest {
fields?: string;
objectId?: string;
pageProperties?: Slides.Schema.PageProperties;
}
export interface UpdateParagraphStyleRequest {
interface UpdateParagraphStyleRequest {
cellLocation?: Slides.Schema.TableCellLocation;
fields?: string;
objectId?: string;
style?: Slides.Schema.ParagraphStyle;
textRange?: Slides.Schema.Range;
}
export interface UpdateShapePropertiesRequest {
interface UpdateShapePropertiesRequest {
fields?: string;
objectId?: string;
shapeProperties?: Slides.Schema.ShapeProperties;
}
export interface UpdateSlidesPositionRequest {
interface UpdateSlidesPositionRequest {
insertionIndex?: number;
slideObjectIds?: string[];
}
export interface UpdateTableBorderPropertiesRequest {
interface UpdateTableBorderPropertiesRequest {
borderPosition?: string;
fields?: string;
objectId?: string;
tableBorderProperties?: Slides.Schema.TableBorderProperties;
tableRange?: Slides.Schema.TableRange;
}
export interface UpdateTableCellPropertiesRequest {
interface UpdateTableCellPropertiesRequest {
fields?: string;
objectId?: string;
tableCellProperties?: Slides.Schema.TableCellProperties;
tableRange?: Slides.Schema.TableRange;
}
export interface UpdateTableColumnPropertiesRequest {
interface UpdateTableColumnPropertiesRequest {
columnIndices?: number[];
fields?: string;
objectId?: string;
tableColumnProperties?: Slides.Schema.TableColumnProperties;
}
export interface UpdateTableRowPropertiesRequest {
interface UpdateTableRowPropertiesRequest {
fields?: string;
objectId?: string;
rowIndices?: number[];
tableRowProperties?: Slides.Schema.TableRowProperties;
}
export interface UpdateTextStyleRequest {
interface UpdateTextStyleRequest {
cellLocation?: Slides.Schema.TableCellLocation;
fields?: string;
objectId?: string;
style?: Slides.Schema.TextStyle;
textRange?: Slides.Schema.Range;
}
export interface UpdateVideoPropertiesRequest {
interface UpdateVideoPropertiesRequest {
fields?: string;
objectId?: string;
videoProperties?: Slides.Schema.VideoProperties;
}
export interface Video {
interface Video {
id?: string;
source?: string;
url?: string;
videoProperties?: Slides.Schema.VideoProperties;
}
export interface VideoProperties {
interface VideoProperties {
autoPlay?: boolean;
end?: number;
mute?: boolean;
outline?: Slides.Schema.Outline;
start?: number;
}
export interface WeightedFontFamily {
interface WeightedFontFamily {
fontFamily?: string;
weight?: number;
}
export interface WordArt {
interface WordArt {
renderedText?: string;
}
export interface WriteControl {
interface WriteControl {
requiredRevisionId?: string;
}
}
}
export interface Slides {
interface Slides {
Presentations?: Slides.Collection.PresentationsCollection;
// Create a new instance of AffineTransform
newAffineTransform(): Slides.Schema.AffineTransform;
types/google-apps-script/apis/tagmanager_v2.d.ts
Vendored
+68 -68
View File
@@ -10,7 +10,7 @@ declare namespace GoogleAppsScript {
namespace Accounts {
namespace Containers {
namespace Workspaces {
export interface Built_in_variablesCollection {
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.
@@ -28,7 +28,7 @@ declare namespace GoogleAppsScript {
// Reverts changes to a GTM Built-In Variables in a GTM Workspace.
revert(path: string, optionalArgs: object): TagManager.Schema.RevertBuiltInVariableResponse;
}
export interface FoldersCollection {
interface FoldersCollection {
// Creates a GTM Folder.
create(resource: Schema.Folder, parent: string): TagManager.Schema.Folder;
// List all entities in a GTM Folder.
@@ -56,7 +56,7 @@ declare namespace GoogleAppsScript {
// Updates a GTM Folder.
update(resource: Schema.Folder, path: string, optionalArgs: object): TagManager.Schema.Folder;
}
export interface TagsCollection {
interface TagsCollection {
// Creates a GTM Tag.
create(resource: Schema.Tag, parent: string): TagManager.Schema.Tag;
// Gets a GTM Tag.
@@ -76,7 +76,7 @@ declare namespace GoogleAppsScript {
// Updates a GTM Tag.
update(resource: Schema.Tag, path: string, optionalArgs: object): TagManager.Schema.Tag;
}
export interface TriggersCollection {
interface TriggersCollection {
// Creates a GTM Trigger.
create(resource: Schema.Trigger, parent: string): TagManager.Schema.Trigger;
// Gets a GTM Trigger.
@@ -96,7 +96,7 @@ declare namespace GoogleAppsScript {
// Updates a GTM Trigger.
update(resource: Schema.Trigger, path: string, optionalArgs: object): TagManager.Schema.Trigger;
}
export interface VariablesCollection {
interface VariablesCollection {
// Creates a GTM Variable.
create(resource: Schema.Variable, parent: string): TagManager.Schema.Variable;
// Gets a GTM Variable.
@@ -116,7 +116,7 @@ declare namespace GoogleAppsScript {
// Updates a GTM Variable.
update(resource: Schema.Variable, path: string, optionalArgs: object): TagManager.Schema.Variable;
}
export interface ZonesCollection {
interface ZonesCollection {
// Creates a GTM Zone.
create(resource: Schema.Zone, parent: string): TagManager.Schema.Zone;
// Gets a GTM Zone.
@@ -137,7 +137,7 @@ declare namespace GoogleAppsScript {
update(resource: Schema.Zone, path: string, optionalArgs: object): TagManager.Schema.Zone;
}
}
export interface EnvironmentsCollection {
interface EnvironmentsCollection {
// Creates a GTM Environment.
create(resource: Schema.Environment, parent: string): TagManager.Schema.Environment;
// Gets a GTM Environment.
@@ -155,7 +155,7 @@ declare namespace GoogleAppsScript {
// Updates a GTM Environment.
update(resource: Schema.Environment, path: string, optionalArgs: object): TagManager.Schema.Environment;
}
export interface Version_headersCollection {
interface Version_headersCollection {
// Gets the latest container version header
latest(parent: string): TagManager.Schema.ContainerVersionHeader;
// Lists all Container Versions of a GTM Container.
@@ -163,7 +163,7 @@ declare namespace GoogleAppsScript {
// Lists all Container Versions of a GTM Container.
list(parent: string, optionalArgs: object): TagManager.Schema.ListContainerVersionsResponse;
}
export interface VersionsCollection {
interface VersionsCollection {
// Gets a Container Version.
get(path: string): TagManager.Schema.ContainerVersion;
// Gets a Container Version.
@@ -185,7 +185,7 @@ declare namespace GoogleAppsScript {
// Updates a Container Version.
update(resource: Schema.ContainerVersion, path: string, optionalArgs: object): TagManager.Schema.ContainerVersion;
}
export interface WorkspacesCollection {
interface WorkspacesCollection {
Built_in_variables?: TagManager.Collection.Accounts.Containers.Workspaces.Built_in_variablesCollection;
Folders?: TagManager.Collection.Accounts.Containers.Workspaces.FoldersCollection;
Tags?: TagManager.Collection.Accounts.Containers.Workspaces.TagsCollection;
@@ -220,7 +220,7 @@ declare namespace GoogleAppsScript {
update(resource: Schema.Workspace, path: string, optionalArgs: object): TagManager.Schema.Workspace;
}
}
export interface ContainersCollection {
interface ContainersCollection {
Environments?: TagManager.Collection.Accounts.Containers.EnvironmentsCollection;
Version_headers?: TagManager.Collection.Accounts.Containers.Version_headersCollection;
Versions?: TagManager.Collection.Accounts.Containers.VersionsCollection;
@@ -240,7 +240,7 @@ declare namespace GoogleAppsScript {
// Updates a Container.
update(resource: Schema.Container, path: string, optionalArgs: object): TagManager.Schema.Container;
}
export interface User_permissionsCollection {
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.
@@ -255,7 +255,7 @@ declare namespace GoogleAppsScript {
update(resource: Schema.UserPermission, path: string): TagManager.Schema.UserPermission;
}
}
export interface AccountsCollection {
interface AccountsCollection {
Containers?: TagManager.Collection.Accounts.ContainersCollection;
User_permissions?: TagManager.Collection.Accounts.User_permissionsCollection;
// Gets a GTM Account.
@@ -271,7 +271,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Account {
interface Account {
accountId?: string;
fingerprint?: string;
name?: string;
@@ -279,10 +279,10 @@ declare namespace GoogleAppsScript {
shareData?: boolean;
tagManagerUrl?: string;
}
export interface AccountAccess {
interface AccountAccess {
permission?: string;
}
export interface BuiltInVariable {
interface BuiltInVariable {
accountId?: string;
containerId?: string;
name?: string;
@@ -290,11 +290,11 @@ declare namespace GoogleAppsScript {
type?: string;
workspaceId?: string;
}
export interface Condition {
interface Condition {
parameter?: TagManager.Schema.Parameter[];
type?: string;
}
export interface Container {
interface Container {
accountId?: string;
containerId?: string;
domainName?: string[];
@@ -306,11 +306,11 @@ declare namespace GoogleAppsScript {
tagManagerUrl?: string;
usageContext?: string[];
}
export interface ContainerAccess {
interface ContainerAccess {
containerId?: string;
permission?: string;
}
export interface ContainerVersion {
interface ContainerVersion {
accountId?: string;
builtInVariable?: TagManager.Schema.BuiltInVariable[];
container?: TagManager.Schema.Container;
@@ -329,7 +329,7 @@ declare namespace GoogleAppsScript {
variable?: TagManager.Schema.Variable[];
zone?: TagManager.Schema.Zone[];
}
export interface ContainerVersionHeader {
interface ContainerVersionHeader {
accountId?: string;
containerId?: string;
containerVersionId?: string;
@@ -344,20 +344,20 @@ declare namespace GoogleAppsScript {
numZones?: string;
path?: string;
}
export interface CreateBuiltInVariableResponse {
interface CreateBuiltInVariableResponse {
builtInVariable?: TagManager.Schema.BuiltInVariable[];
}
export interface CreateContainerVersionRequestVersionOptions {
interface CreateContainerVersionRequestVersionOptions {
name?: string;
notes?: string;
}
export interface CreateContainerVersionResponse {
interface CreateContainerVersionResponse {
compilerError?: boolean;
containerVersion?: TagManager.Schema.ContainerVersion;
newWorkspacePath?: string;
syncStatus?: TagManager.Schema.SyncStatus;
}
export interface CustomTemplate {
interface CustomTemplate {
accountId?: string;
containerId?: string;
fingerprint?: string;
@@ -368,14 +368,14 @@ declare namespace GoogleAppsScript {
templateId?: string;
workspaceId?: string;
}
export interface Entity {
interface Entity {
changeStatus?: string;
folder?: TagManager.Schema.Folder;
tag?: TagManager.Schema.Tag;
trigger?: TagManager.Schema.Trigger;
variable?: TagManager.Schema.Variable;
}
export interface Environment {
interface Environment {
accountId?: string;
authorizationCode?: string;
authorizationTimestamp?: TagManager.Schema.Timestamp;
@@ -392,7 +392,7 @@ declare namespace GoogleAppsScript {
url?: string;
workspaceId?: string;
}
export interface Folder {
interface Folder {
accountId?: string;
containerId?: string;
fingerprint?: string;
@@ -403,115 +403,115 @@ declare namespace GoogleAppsScript {
tagManagerUrl?: string;
workspaceId?: string;
}
export interface FolderEntities {
interface FolderEntities {
nextPageToken?: string;
tag?: TagManager.Schema.Tag[];
trigger?: TagManager.Schema.Trigger[];
variable?: TagManager.Schema.Variable[];
}
export interface GetWorkspaceStatusResponse {
interface GetWorkspaceStatusResponse {
mergeConflict?: TagManager.Schema.MergeConflict[];
workspaceChange?: TagManager.Schema.Entity[];
}
export interface ListAccountsResponse {
interface ListAccountsResponse {
account?: TagManager.Schema.Account[];
nextPageToken?: string;
}
export interface ListContainerVersionsResponse {
interface ListContainerVersionsResponse {
containerVersionHeader?: TagManager.Schema.ContainerVersionHeader[];
nextPageToken?: string;
}
export interface ListContainersResponse {
interface ListContainersResponse {
container?: TagManager.Schema.Container[];
nextPageToken?: string;
}
export interface ListEnabledBuiltInVariablesResponse {
interface ListEnabledBuiltInVariablesResponse {
builtInVariable?: TagManager.Schema.BuiltInVariable[];
nextPageToken?: string;
}
export interface ListEnvironmentsResponse {
interface ListEnvironmentsResponse {
environment?: TagManager.Schema.Environment[];
nextPageToken?: string;
}
export interface ListFoldersResponse {
interface ListFoldersResponse {
folder?: TagManager.Schema.Folder[];
nextPageToken?: string;
}
export interface ListTagsResponse {
interface ListTagsResponse {
nextPageToken?: string;
tag?: TagManager.Schema.Tag[];
}
export interface ListTriggersResponse {
interface ListTriggersResponse {
nextPageToken?: string;
trigger?: TagManager.Schema.Trigger[];
}
export interface ListUserPermissionsResponse {
interface ListUserPermissionsResponse {
nextPageToken?: string;
userPermission?: TagManager.Schema.UserPermission[];
}
export interface ListVariablesResponse {
interface ListVariablesResponse {
nextPageToken?: string;
variable?: TagManager.Schema.Variable[];
}
export interface ListWorkspacesResponse {
interface ListWorkspacesResponse {
nextPageToken?: string;
workspace?: TagManager.Schema.Workspace[];
}
export interface ListZonesResponse {
interface ListZonesResponse {
nextPageToken?: string;
zone?: TagManager.Schema.Zone[];
}
export interface MergeConflict {
interface MergeConflict {
entityInBaseVersion?: TagManager.Schema.Entity;
entityInWorkspace?: TagManager.Schema.Entity;
}
export interface Parameter {
interface Parameter {
key?: string;
list?: TagManager.Schema.Parameter[];
map?: TagManager.Schema.Parameter[];
type?: string;
value?: string;
}
export interface PublishContainerVersionResponse {
interface PublishContainerVersionResponse {
compilerError?: boolean;
containerVersion?: TagManager.Schema.ContainerVersion;
}
export interface QuickPreviewResponse {
interface QuickPreviewResponse {
compilerError?: boolean;
containerVersion?: TagManager.Schema.ContainerVersion;
syncStatus?: TagManager.Schema.SyncStatus;
}
export interface RevertBuiltInVariableResponse {
interface RevertBuiltInVariableResponse {
enabled?: boolean;
}
export interface RevertFolderResponse {
interface RevertFolderResponse {
folder?: TagManager.Schema.Folder;
}
export interface RevertTagResponse {
interface RevertTagResponse {
tag?: TagManager.Schema.Tag;
}
export interface RevertTriggerResponse {
interface RevertTriggerResponse {
trigger?: TagManager.Schema.Trigger;
}
export interface RevertVariableResponse {
interface RevertVariableResponse {
variable?: TagManager.Schema.Variable;
}
export interface RevertZoneResponse {
interface RevertZoneResponse {
zone?: TagManager.Schema.Zone;
}
export interface SetupTag {
interface SetupTag {
stopOnSetupFailure?: boolean;
tagName?: string;
}
export interface SyncStatus {
interface SyncStatus {
mergeConflict?: boolean;
syncError?: boolean;
}
export interface SyncWorkspaceResponse {
interface SyncWorkspaceResponse {
mergeConflict?: TagManager.Schema.MergeConflict[];
syncStatus?: TagManager.Schema.SyncStatus;
}
export interface Tag {
interface Tag {
accountId?: string;
blockingRuleId?: string[];
blockingTriggerId?: string[];
@@ -537,15 +537,15 @@ declare namespace GoogleAppsScript {
type?: string;
workspaceId?: string;
}
export interface TeardownTag {
interface TeardownTag {
stopTeardownOnFailure?: boolean;
tagName?: string;
}
export interface Timestamp {
interface Timestamp {
nanos?: number;
seconds?: string;
}
export interface Trigger {
interface Trigger {
accountId?: string;
autoEventFilter?: TagManager.Schema.Condition[];
checkValidation?: TagManager.Schema.Parameter;
@@ -579,14 +579,14 @@ declare namespace GoogleAppsScript {
waitForTagsTimeout?: TagManager.Schema.Parameter;
workspaceId?: string;
}
export interface UserPermission {
interface UserPermission {
accountAccess?: TagManager.Schema.AccountAccess;
accountId?: string;
containerAccess?: TagManager.Schema.ContainerAccess[];
emailAddress?: string;
path?: string;
}
export interface Variable {
interface Variable {
accountId?: string;
containerId?: string;
disablingTriggerId?: string[];
@@ -605,14 +605,14 @@ declare namespace GoogleAppsScript {
variableId?: string;
workspaceId?: string;
}
export interface VariableFormatValue {
interface VariableFormatValue {
caseConversionType?: string;
convertFalseToValue?: TagManager.Schema.Parameter;
convertNullToValue?: TagManager.Schema.Parameter;
convertTrueToValue?: TagManager.Schema.Parameter;
convertUndefinedToValue?: TagManager.Schema.Parameter;
}
export interface Workspace {
interface Workspace {
accountId?: string;
containerId?: string;
description?: string;
@@ -622,7 +622,7 @@ declare namespace GoogleAppsScript {
tagManagerUrl?: string;
workspaceId?: string;
}
export interface Zone {
interface Zone {
accountId?: string;
boundary?: TagManager.Schema.ZoneBoundary;
childContainer?: TagManager.Schema.ZoneChildContainer[];
@@ -636,21 +636,21 @@ declare namespace GoogleAppsScript {
workspaceId?: string;
zoneId?: string;
}
export interface ZoneBoundary {
interface ZoneBoundary {
condition?: TagManager.Schema.Condition[];
customEvaluationTriggerId?: string[];
}
export interface ZoneChildContainer {
interface ZoneChildContainer {
nickname?: string;
publicId?: string;
}
export interface ZoneTypeRestriction {
interface ZoneTypeRestriction {
enable?: boolean;
whitelistedTypeId?: string[];
}
}
}
export interface TagManager {
interface TagManager {
Accounts?: TagManager.Collection.AccountsCollection;
// Create a new instance of Account
newAccount(): TagManager.Schema.Account;
types/google-apps-script/apis/tasks_v1.d.ts
Vendored
+8 -8
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace Tasks {
namespace Collection {
export interface TasklistsCollection {
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.
@@ -23,7 +23,7 @@ declare namespace GoogleAppsScript {
// Updates the authenticated user's specified task list.
update(resource: Schema.TaskList, tasklist: string): Tasks.Schema.TaskList;
}
export interface TasksCollection {
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.
@@ -49,7 +49,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface Task {
interface Task {
completed?: string;
deleted?: boolean;
due?: string;
@@ -66,12 +66,12 @@ declare namespace GoogleAppsScript {
title?: string;
updated?: string;
}
export interface TaskLinks {
interface TaskLinks {
description?: string;
link?: string;
type?: string;
}
export interface TaskList {
interface TaskList {
etag?: string;
id?: string;
kind?: string;
@@ -79,13 +79,13 @@ declare namespace GoogleAppsScript {
title?: string;
updated?: string;
}
export interface TaskLists {
interface TaskLists {
etag?: string;
items?: Tasks.Schema.TaskList[];
kind?: string;
nextPageToken?: string;
}
export interface Tasks {
interface Tasks {
etag?: string;
items?: Tasks.Schema.Task[];
kind?: string;
@@ -93,7 +93,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface Tasks {
interface Tasks {
Tasklists?: Tasks.Collection.TasklistsCollection;
Tasks?: Tasks.Collection.TasksCollection;
// Create a new instance of Task
types/google-apps-script/apis/urlshortener_v1.d.ts
Vendored
+7 -7
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace UrlShortener {
namespace Collection {
export interface UrlCollection {
interface UrlCollection {
// Expands a short URL or gets creation time and analytics.
get(shortUrl: string): UrlShortener.Schema.Url;
// Expands a short URL or gets creation time and analytics.
@@ -21,7 +21,7 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface AnalyticsSnapshot {
interface AnalyticsSnapshot {
browsers?: UrlShortener.Schema.StringCount[];
countries?: UrlShortener.Schema.StringCount[];
longUrlClicks?: string;
@@ -29,18 +29,18 @@ declare namespace GoogleAppsScript {
referrers?: UrlShortener.Schema.StringCount[];
shortUrlClicks?: string;
}
export interface AnalyticsSummary {
interface AnalyticsSummary {
allTime?: UrlShortener.Schema.AnalyticsSnapshot;
day?: UrlShortener.Schema.AnalyticsSnapshot;
month?: UrlShortener.Schema.AnalyticsSnapshot;
twoHours?: UrlShortener.Schema.AnalyticsSnapshot;
week?: UrlShortener.Schema.AnalyticsSnapshot;
}
export interface StringCount {
interface StringCount {
count?: string;
id?: string;
}
export interface Url {
interface Url {
analytics?: UrlShortener.Schema.AnalyticsSummary;
created?: string;
id?: string;
@@ -48,7 +48,7 @@ declare namespace GoogleAppsScript {
longUrl?: string;
status?: string;
}
export interface UrlHistory {
interface UrlHistory {
items?: UrlShortener.Schema.Url[];
itemsPerPage?: number;
kind?: string;
@@ -57,7 +57,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface UrlShortener {
interface UrlShortener {
Url?: UrlShortener.Collection.UrlCollection;
// Create a new instance of AnalyticsSnapshot
newAnalyticsSnapshot(): UrlShortener.Schema.AnalyticsSnapshot;
types/google-apps-script/apis/youtube_v3.d.ts
Vendored
+202 -202
View File
File diff suppressed because it is too large Load Diff
types/google-apps-script/apis/youtubeanalytics_v2.d.ts
Vendored
+16 -16
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace YouTubeAnalytics {
namespace Collection {
export interface GroupItemsCollection {
interface GroupItemsCollection {
// Creates a group item.
insert(resource: Schema.GroupItem): YouTubeAnalytics.Schema.GroupItem;
// Creates a group item.
@@ -21,7 +21,7 @@ declare namespace GoogleAppsScript {
// Removes an item from a group.
remove(optionalArgs: object): YouTubeAnalytics.Schema.EmptyResponse;
}
export interface GroupsCollection {
interface GroupsCollection {
// Creates a group.
insert(resource: Schema.Group): YouTubeAnalytics.Schema.Group;
// Creates a group.
@@ -43,7 +43,7 @@ declare namespace GoogleAppsScript {
// Modifies a group. For example, you could change a group's title.
update(resource: Schema.Group, optionalArgs: object): YouTubeAnalytics.Schema.Group;
}
export interface ReportsCollection {
interface ReportsCollection {
// Retrieve your YouTube Analytics reports.
query(): YouTubeAnalytics.Schema.QueryResponse;
// Retrieve your YouTube Analytics reports.
@@ -51,10 +51,10 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface EmptyResponse {
interface EmptyResponse {
errors?: YouTubeAnalytics.Schema.Errors;
}
export interface ErrorProto {
interface ErrorProto {
argument?: string[];
code?: string;
debugInfo?: string;
@@ -63,12 +63,12 @@ declare namespace GoogleAppsScript {
location?: string;
locationType?: string;
}
export interface Errors {
interface Errors {
code?: string;
error?: YouTubeAnalytics.Schema.ErrorProto[];
requestId?: string;
}
export interface Group {
interface Group {
contentDetails?: YouTubeAnalytics.Schema.GroupContentDetails;
errors?: YouTubeAnalytics.Schema.Errors;
etag?: string;
@@ -76,11 +76,11 @@ declare namespace GoogleAppsScript {
kind?: string;
snippet?: YouTubeAnalytics.Schema.GroupSnippet;
}
export interface GroupContentDetails {
interface GroupContentDetails {
itemCount?: string;
itemType?: string;
}
export interface GroupItem {
interface GroupItem {
errors?: YouTubeAnalytics.Schema.Errors;
etag?: string;
groupId?: string;
@@ -88,41 +88,41 @@ declare namespace GoogleAppsScript {
kind?: string;
resource?: YouTubeAnalytics.Schema.GroupItemResource;
}
export interface GroupItemResource {
interface GroupItemResource {
id?: string;
kind?: string;
}
export interface GroupSnippet {
interface GroupSnippet {
publishedAt?: string;
title?: string;
}
export interface ListGroupItemsResponse {
interface ListGroupItemsResponse {
errors?: YouTubeAnalytics.Schema.Errors;
etag?: string;
items?: YouTubeAnalytics.Schema.GroupItem[];
kind?: string;
}
export interface ListGroupsResponse {
interface ListGroupsResponse {
errors?: YouTubeAnalytics.Schema.Errors;
etag?: string;
items?: YouTubeAnalytics.Schema.Group[];
kind?: string;
nextPageToken?: string;
}
export interface QueryResponse {
interface QueryResponse {
columnHeaders?: YouTubeAnalytics.Schema.ResultTableColumnHeader[];
errors?: YouTubeAnalytics.Schema.Errors;
kind?: string;
rows?: any[][];
}
export interface ResultTableColumnHeader {
interface ResultTableColumnHeader {
columnType?: string;
dataType?: string;
name?: string;
}
}
}
export interface YouTubeAnalytics {
interface YouTubeAnalytics {
GroupItems?: YouTubeAnalytics.Collection.GroupItemsCollection;
Groups?: YouTubeAnalytics.Collection.GroupsCollection;
Reports?: YouTubeAnalytics.Collection.ReportsCollection;
types/google-apps-script/apis/youtubepartner_v1.d.ts
Vendored
+122 -122
View File
@@ -7,7 +7,7 @@
declare namespace GoogleAppsScript {
namespace YoutubePartner {
namespace Collection {
export interface AssetLabelsCollection {
interface AssetLabelsCollection {
// Insert an asset label for an owner.
insert(resource: Schema.AssetLabel): YoutubePartner.Schema.AssetLabel;
// Insert an asset label for an owner.
@@ -17,7 +17,7 @@ declare namespace GoogleAppsScript {
// Retrieves a list of all asset labels for an owner.
list(optionalArgs: object): YoutubePartner.Schema.AssetLabelListResponse;
}
export interface AssetMatchPolicyCollection {
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.
@@ -31,7 +31,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface AssetRelationshipsCollection {
interface AssetRelationshipsCollection {
// Creates a relationship that links two assets.
insert(resource: Schema.AssetRelationship): YoutubePartner.Schema.AssetRelationship;
// Creates a relationship that links two assets.
@@ -45,19 +45,19 @@ declare namespace GoogleAppsScript {
// Deletes a relationship between two assets.
remove(assetRelationshipId: string, optionalArgs: object): void;
}
export interface AssetSearchCollection {
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;
}
export interface AssetSharesCollection {
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;
}
export interface AssetsCollection {
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.
@@ -81,7 +81,7 @@ declare namespace GoogleAppsScript {
// Updates the metadata for the specified asset.
update(resource: Schema.Asset, assetId: string, optionalArgs: object): YoutubePartner.Schema.Asset;
}
export interface CampaignsCollection {
interface CampaignsCollection {
// Retrieves a particular campaign for an owner.
get(campaignId: string): YoutubePartner.Schema.Campaign;
// Retrieves a particular campaign for an owner.
@@ -107,19 +107,19 @@ declare namespace GoogleAppsScript {
// Update the data for a specific campaign.
update(resource: Schema.Campaign, campaignId: string, optionalArgs: object): YoutubePartner.Schema.Campaign;
}
export interface ClaimHistoryCollection {
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;
}
export interface ClaimSearchCollection {
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;
}
export interface ClaimsCollection {
interface ClaimsCollection {
// Retrieves a specific claim by ID.
get(claimId: string): YoutubePartner.Schema.Claim;
// Retrieves a specific claim by ID.
@@ -145,7 +145,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface ContentOwnerAdvertisingOptionsCollection {
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.
@@ -159,7 +159,7 @@ declare namespace GoogleAppsScript {
// Updates advertising options for the content owner associated with the authenticated API user.
update(resource: Schema.ContentOwnerAdvertisingOption, optionalArgs: object): YoutubePartner.Schema.ContentOwnerAdvertisingOption;
}
export interface ContentOwnersCollection {
interface ContentOwnersCollection {
// Retrieves information about the specified content owner.
get(contentOwnerId: string): YoutubePartner.Schema.ContentOwner;
// Retrieves information about the specified content owner.
@@ -169,19 +169,19 @@ declare namespace GoogleAppsScript {
// Retrieves a list of content owners that match the request criteria.
list(optionalArgs: object): YoutubePartner.Schema.ContentOwnerListResponse;
}
export interface LiveCuepointsCollection {
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;
}
export interface MetadataHistoryCollection {
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;
}
export interface OrdersCollection {
interface OrdersCollection {
// Retrieve the details of an existing order.
get(orderId: string): YoutubePartner.Schema.Order;
// Retrieve the details of an existing order.
@@ -207,7 +207,7 @@ declare namespace GoogleAppsScript {
// Update the values in an existing order.
update(resource: Schema.Order, orderId: string, optionalArgs: object): YoutubePartner.Schema.Order;
}
export interface OwnershipCollection {
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.
@@ -221,13 +221,13 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface OwnershipHistoryCollection {
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;
}
export interface PackageCollection {
interface PackageCollection {
// Retrieves information for the specified package.
get(packageId: string): YoutubePartner.Schema.Package;
// Retrieves information for the specified package.
@@ -237,7 +237,7 @@ declare namespace GoogleAppsScript {
// Inserts a metadata-only package.
insert(resource: Schema.Package, optionalArgs: object): YoutubePartner.Schema.PackageInsertResponse;
}
export interface PoliciesCollection {
interface PoliciesCollection {
// Retrieves the specified saved policy.
get(policyId: string): YoutubePartner.Schema.Policy;
// Retrieves the specified saved policy.
@@ -259,7 +259,7 @@ declare namespace GoogleAppsScript {
// Updates the specified saved policy.
update(resource: Schema.Policy, policyId: string, optionalArgs: object): YoutubePartner.Schema.Policy;
}
export interface PublishersCollection {
interface PublishersCollection {
// Retrieves information about the specified publisher.
get(publisherId: string): YoutubePartner.Schema.Publisher;
// Retrieves information about the specified publisher.
@@ -269,7 +269,7 @@ declare namespace GoogleAppsScript {
// 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;
}
export interface ReferenceConflictsCollection {
interface ReferenceConflictsCollection {
// Retrieves information about the specified reference conflict.
get(referenceConflictId: string): YoutubePartner.Schema.ReferenceConflict;
// Retrieves information about the specified reference conflict.
@@ -279,7 +279,7 @@ declare namespace GoogleAppsScript {
// Retrieves a list of unresolved reference conflicts.
list(optionalArgs: object): YoutubePartner.Schema.ReferenceConflictListResponse;
}
export interface ReferencesCollection {
interface ReferencesCollection {
// Retrieves information about the specified reference.
get(referenceId: string): YoutubePartner.Schema.Reference;
// Retrieves information about the specified reference.
@@ -309,19 +309,19 @@ declare namespace GoogleAppsScript {
// Updates a reference.
update(resource: Schema.Reference, referenceId: string, optionalArgs: object): YoutubePartner.Schema.Reference;
}
export interface SpreadsheetTemplateCollection {
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;
}
export interface UploaderCollection {
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;
}
export interface ValidatorCollection {
interface ValidatorCollection {
// Validate a metadata file.
validate(resource: Schema.ValidateRequest): YoutubePartner.Schema.ValidateResponse;
// Validate a metadata file.
@@ -335,7 +335,7 @@ declare namespace GoogleAppsScript {
// Get the asynchronous validation status.
validateAsyncStatus(resource: Schema.ValidateStatusRequest, optionalArgs: object): YoutubePartner.Schema.ValidateStatusResponse;
}
export interface VideoAdvertisingOptionsCollection {
interface VideoAdvertisingOptionsCollection {
// Retrieves advertising settings for the specified video.
get(videoId: string): YoutubePartner.Schema.VideoAdvertisingOption;
// Retrieves advertising settings for the specified video.
@@ -353,7 +353,7 @@ declare namespace GoogleAppsScript {
// Updates the advertising settings for the specified video.
update(resource: Schema.VideoAdvertisingOption, videoId: string, optionalArgs: object): YoutubePartner.Schema.VideoAdvertisingOption;
}
export interface WhitelistsCollection {
interface WhitelistsCollection {
// Retrieves a specific whitelisted channel by ID.
get(id: string): YoutubePartner.Schema.Whitelist;
// Retrieves a specific whitelisted channel by ID.
@@ -373,22 +373,22 @@ declare namespace GoogleAppsScript {
}
}
namespace Schema {
export interface AdBreak {
interface AdBreak {
midrollSeconds?: number;
position?: string;
slot?: YoutubePartner.Schema.AdSlot[];
}
export interface AdSlot {
interface AdSlot {
id?: string;
type?: string;
}
export interface AllowedAdvertisingOptions {
interface AllowedAdvertisingOptions {
adsOnEmbeds?: boolean;
kind?: string;
licAdFormats?: string[];
ugcAdFormats?: string[];
}
export interface Asset {
interface Asset {
aliasId?: string[];
id?: string;
kind?: string;
@@ -407,53 +407,53 @@ declare namespace GoogleAppsScript {
timeCreated?: string;
type?: string;
}
export interface AssetLabel {
interface AssetLabel {
kind?: string;
labelName?: string;
}
export interface AssetLabelListResponse {
interface AssetLabelListResponse {
items?: YoutubePartner.Schema.AssetLabel[];
kind?: string;
}
export interface AssetListResponse {
interface AssetListResponse {
items?: YoutubePartner.Schema.Asset[];
kind?: string;
}
export interface AssetMatchPolicy {
interface AssetMatchPolicy {
kind?: string;
policyId?: string;
rules?: YoutubePartner.Schema.PolicyRule[];
}
export interface AssetRelationship {
interface AssetRelationship {
childAssetId?: string;
id?: string;
kind?: string;
parentAssetId?: string;
}
export interface AssetRelationshipListResponse {
interface AssetRelationshipListResponse {
items?: YoutubePartner.Schema.AssetRelationship[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface AssetSearchResponse {
interface AssetSearchResponse {
items?: YoutubePartner.Schema.AssetSnippet[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface AssetShare {
interface AssetShare {
kind?: string;
shareId?: string;
viewId?: string;
}
export interface AssetShareListResponse {
interface AssetShareListResponse {
items?: YoutubePartner.Schema.AssetShare[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface AssetSnippet {
interface AssetSnippet {
customId?: string;
id?: string;
isrc?: string;
@@ -463,7 +463,7 @@ declare namespace GoogleAppsScript {
title?: string;
type?: string;
}
export interface Campaign {
interface Campaign {
campaignData?: YoutubePartner.Schema.CampaignData;
id?: string;
kind?: string;
@@ -471,26 +471,26 @@ declare namespace GoogleAppsScript {
timeCreated?: string;
timeLastModified?: string;
}
export interface CampaignData {
interface CampaignData {
campaignSource?: YoutubePartner.Schema.CampaignSource;
expireTime?: string;
name?: string;
promotedContent?: YoutubePartner.Schema.PromotedContent[];
startTime?: string;
}
export interface CampaignList {
interface CampaignList {
items?: YoutubePartner.Schema.Campaign[];
kind?: string;
}
export interface CampaignSource {
interface CampaignSource {
sourceType?: string;
sourceValue?: string[];
}
export interface CampaignTargetLink {
interface CampaignTargetLink {
targetId?: string;
targetType?: string;
}
export interface Claim {
interface Claim {
appliedPolicy?: YoutubePartner.Schema.Policy;
assetId?: string;
blockOutsideOwnership?: boolean;
@@ -505,7 +505,7 @@ declare namespace GoogleAppsScript {
timeCreated?: string;
videoId?: string;
}
export interface ClaimEvent {
interface ClaimEvent {
kind?: string;
reason?: string;
source?: YoutubePartner.Schema.ClaimEventSource;
@@ -513,56 +513,56 @@ declare namespace GoogleAppsScript {
type?: string;
typeDetails?: YoutubePartner.Schema.ClaimEventTypeDetails;
}
export interface ClaimEventSource {
interface ClaimEventSource {
contentOwnerId?: string;
type?: string;
userEmail?: string;
}
export interface ClaimEventTypeDetails {
interface ClaimEventTypeDetails {
appealExplanation?: string;
disputeNotes?: string;
disputeReason?: string;
updateStatus?: string;
}
export interface ClaimHistory {
interface ClaimHistory {
event?: YoutubePartner.Schema.ClaimEvent[];
id?: string;
kind?: string;
uploaderChannelId?: string;
}
export interface ClaimListResponse {
interface ClaimListResponse {
items?: YoutubePartner.Schema.Claim[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
previousPageToken?: string;
}
export interface ClaimMatchInfo {
interface ClaimMatchInfo {
longestMatch?: YoutubePartner.Schema.ClaimMatchInfoLongestMatch;
matchSegments?: YoutubePartner.Schema.MatchSegment[];
referenceId?: string;
totalMatch?: YoutubePartner.Schema.ClaimMatchInfoTotalMatch;
}
export interface ClaimMatchInfoLongestMatch {
interface ClaimMatchInfoLongestMatch {
durationSecs?: string;
referenceOffset?: string;
userVideoOffset?: string;
}
export interface ClaimMatchInfoTotalMatch {
interface ClaimMatchInfoTotalMatch {
referenceDurationSecs?: string;
userVideoDurationSecs?: string;
}
export interface ClaimOrigin {
interface ClaimOrigin {
source?: string;
}
export interface ClaimSearchResponse {
interface ClaimSearchResponse {
items?: YoutubePartner.Schema.ClaimSnippet[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
previousPageToken?: string;
}
export interface ClaimSnippet {
interface ClaimSnippet {
assetId?: string;
contentType?: string;
id?: string;
@@ -577,16 +577,16 @@ declare namespace GoogleAppsScript {
videoTitle?: string;
videoViews?: string;
}
export interface ClaimSnippetOrigin {
interface ClaimSnippetOrigin {
source?: string;
}
export interface ClaimedVideoDefaults {
interface ClaimedVideoDefaults {
autoGeneratedBreaks?: boolean;
channelOverride?: boolean;
kind?: string;
newVideoDefaults?: string[];
}
export interface Conditions {
interface Conditions {
contentMatchType?: string[];
matchDuration?: YoutubePartner.Schema.IntervalCondition[];
matchPercent?: YoutubePartner.Schema.IntervalCondition[];
@@ -594,11 +594,11 @@ declare namespace GoogleAppsScript {
referencePercent?: YoutubePartner.Schema.IntervalCondition[];
requiredTerritories?: YoutubePartner.Schema.TerritoryCondition;
}
export interface ConflictingOwnership {
interface ConflictingOwnership {
owner?: string;
ratio?: number;
}
export interface ContentOwner {
interface ContentOwner {
conflictNotificationEmail?: string;
displayName?: string;
disputeNotificationEmails?: string[];
@@ -607,58 +607,58 @@ declare namespace GoogleAppsScript {
kind?: string;
primaryNotificationEmails?: string[];
}
export interface ContentOwnerAdvertisingOption {
interface ContentOwnerAdvertisingOption {
allowedOptions?: YoutubePartner.Schema.AllowedAdvertisingOptions;
claimedVideoOptions?: YoutubePartner.Schema.ClaimedVideoDefaults;
id?: string;
kind?: string;
}
export interface ContentOwnerListResponse {
interface ContentOwnerListResponse {
items?: YoutubePartner.Schema.ContentOwner[];
kind?: string;
}
export interface CountriesRestriction {
interface CountriesRestriction {
adFormats?: string[];
territories?: string[];
}
export interface CuepointSettings {
interface CuepointSettings {
cueType?: string;
durationSecs?: number;
offsetTimeMs?: string;
walltime?: string;
}
export interface Date {
interface Date {
day?: number;
month?: number;
year?: number;
}
export interface DateRange {
interface DateRange {
end?: YoutubePartner.Schema.Date;
kind?: string;
start?: YoutubePartner.Schema.Date;
}
export interface ExcludedInterval {
interface ExcludedInterval {
high?: number;
low?: number;
origin?: string;
timeCreated?: string;
}
export interface IntervalCondition {
interface IntervalCondition {
high?: number;
low?: number;
}
export interface LiveCuepoint {
interface LiveCuepoint {
broadcastId?: string;
id?: string;
kind?: string;
settings?: YoutubePartner.Schema.CuepointSettings;
}
export interface MatchSegment {
interface MatchSegment {
channel?: string;
reference_segment?: YoutubePartner.Schema.Segment;
video_segment?: YoutubePartner.Schema.Segment;
}
export interface Metadata {
interface Metadata {
actor?: string[];
album?: string;
artist?: string[];
@@ -699,17 +699,17 @@ declare namespace GoogleAppsScript {
upc?: string;
writer?: string[];
}
export interface MetadataHistory {
interface MetadataHistory {
kind?: string;
metadata?: YoutubePartner.Schema.Metadata;
origination?: YoutubePartner.Schema.Origination;
timeProvided?: string;
}
export interface MetadataHistoryListResponse {
interface MetadataHistoryListResponse {
items?: YoutubePartner.Schema.MetadataHistory[];
kind?: string;
}
export interface Order {
interface Order {
availGroupId?: string;
channelId?: string;
contentType?: string;
@@ -731,29 +731,29 @@ declare namespace GoogleAppsScript {
videoId?: string;
vodDates?: YoutubePartner.Schema.DateRange;
}
export interface OrderListResponse {
interface OrderListResponse {
items?: YoutubePartner.Schema.Order[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
previousPageToken?: string;
}
export interface Origination {
interface Origination {
owner?: string;
source?: string;
}
export interface OwnershipConflicts {
interface OwnershipConflicts {
general?: YoutubePartner.Schema.TerritoryConflicts[];
kind?: string;
mechanical?: YoutubePartner.Schema.TerritoryConflicts[];
performance?: YoutubePartner.Schema.TerritoryConflicts[];
synchronization?: YoutubePartner.Schema.TerritoryConflicts[];
}
export interface OwnershipHistoryListResponse {
interface OwnershipHistoryListResponse {
items?: YoutubePartner.Schema.RightsOwnershipHistory[];
kind?: string;
}
export interface Package {
interface Package {
content?: string;
customIds?: string[];
id?: string;
@@ -766,18 +766,18 @@ declare namespace GoogleAppsScript {
type?: string;
uploaderName?: string;
}
export interface PackageInsertResponse {
interface PackageInsertResponse {
errors?: YoutubePartner.Schema.ValidateError[];
kind?: string;
resource?: YoutubePartner.Schema.Package;
status?: string;
}
export interface PageInfo {
interface PageInfo {
resultsPerPage?: number;
startIndex?: number;
totalResults?: number;
}
export interface Policy {
interface Policy {
description?: string;
id?: string;
kind?: string;
@@ -785,36 +785,36 @@ declare namespace GoogleAppsScript {
rules?: YoutubePartner.Schema.PolicyRule[];
timeUpdated?: string;
}
export interface PolicyList {
interface PolicyList {
items?: YoutubePartner.Schema.Policy[];
kind?: string;
}
export interface PolicyRule {
interface PolicyRule {
action?: string;
conditions?: YoutubePartner.Schema.Conditions;
subaction?: string[];
}
export interface PromotedContent {
interface PromotedContent {
link?: YoutubePartner.Schema.CampaignTargetLink[];
}
export interface Publisher {
interface Publisher {
caeNumber?: string;
id?: string;
ipiNumber?: string;
kind?: string;
name?: string;
}
export interface PublisherList {
interface PublisherList {
items?: YoutubePartner.Schema.Publisher[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface Rating {
interface Rating {
rating?: string;
ratingSystem?: string;
}
export interface Reference {
interface Reference {
assetId?: string;
audioswapEnabled?: boolean;
claimId?: string;
@@ -833,7 +833,7 @@ declare namespace GoogleAppsScript {
urgent?: boolean;
videoId?: string;
}
export interface ReferenceConflict {
interface ReferenceConflict {
conflictingReferenceId?: string;
expiryTime?: string;
id?: string;
@@ -842,25 +842,25 @@ declare namespace GoogleAppsScript {
originalReferenceId?: string;
status?: string;
}
export interface ReferenceConflictListResponse {
interface ReferenceConflictListResponse {
items?: YoutubePartner.Schema.ReferenceConflict[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface ReferenceConflictMatch {
interface ReferenceConflictMatch {
conflicting_reference_offset_ms?: string;
length_ms?: string;
original_reference_offset_ms?: string;
type?: string;
}
export interface ReferenceListResponse {
interface ReferenceListResponse {
items?: YoutubePartner.Schema.Reference[];
kind?: string;
nextPageToken?: string;
pageInfo?: YoutubePartner.Schema.PageInfo;
}
export interface Requirements {
interface Requirements {
caption?: boolean;
hdTranscode?: boolean;
posterArt?: boolean;
@@ -868,84 +868,84 @@ declare namespace GoogleAppsScript {
spotlightReview?: boolean;
trailer?: boolean;
}
export interface RightsOwnership {
interface RightsOwnership {
general?: YoutubePartner.Schema.TerritoryOwners[];
kind?: string;
mechanical?: YoutubePartner.Schema.TerritoryOwners[];
performance?: YoutubePartner.Schema.TerritoryOwners[];
synchronization?: YoutubePartner.Schema.TerritoryOwners[];
}
export interface RightsOwnershipHistory {
interface RightsOwnershipHistory {
kind?: string;
origination?: YoutubePartner.Schema.Origination;
ownership?: YoutubePartner.Schema.RightsOwnership;
timeProvided?: string;
}
export interface Segment {
interface Segment {
duration?: string;
kind?: string;
start?: string;
}
export interface ShowDetails {
interface ShowDetails {
episodeNumber?: string;
episodeTitle?: string;
seasonNumber?: string;
title?: string;
}
export interface SpreadsheetTemplate {
interface SpreadsheetTemplate {
kind?: string;
status?: string;
templateContent?: string;
templateName?: string;
templateType?: string;
}
export interface SpreadsheetTemplateListResponse {
interface SpreadsheetTemplateListResponse {
items?: YoutubePartner.Schema.SpreadsheetTemplate[];
kind?: string;
status?: string;
}
export interface StateCompleted {
interface StateCompleted {
state?: string;
timeCompleted?: string;
}
export interface StatusReport {
interface StatusReport {
statusContent?: string;
statusFileName?: string;
}
export interface TerritoryCondition {
interface TerritoryCondition {
territories?: string[];
type?: string;
}
export interface TerritoryConflicts {
interface TerritoryConflicts {
conflictingOwnership?: YoutubePartner.Schema.ConflictingOwnership[];
territory?: string;
}
export interface TerritoryOwners {
interface TerritoryOwners {
owner?: string;
publisher?: string;
ratio?: number;
territories?: string[];
type?: string;
}
export interface Uploader {
interface Uploader {
kind?: string;
uploaderName?: string;
}
export interface UploaderListResponse {
interface UploaderListResponse {
items?: YoutubePartner.Schema.Uploader[];
kind?: string;
}
export interface ValidateAsyncRequest {
interface ValidateAsyncRequest {
content?: string;
kind?: string;
uploaderName?: string;
}
export interface ValidateAsyncResponse {
interface ValidateAsyncResponse {
kind?: string;
status?: string;
validationId?: string;
}
export interface ValidateError {
interface ValidateError {
columnName?: string;
columnNumber?: number;
lineNumber?: number;
@@ -953,29 +953,29 @@ declare namespace GoogleAppsScript {
messageCode?: number;
severity?: string;
}
export interface ValidateRequest {
interface ValidateRequest {
content?: string;
kind?: string;
locale?: string;
uploaderName?: string;
}
export interface ValidateResponse {
interface ValidateResponse {
errors?: YoutubePartner.Schema.ValidateError[];
kind?: string;
status?: string;
}
export interface ValidateStatusRequest {
interface ValidateStatusRequest {
kind?: string;
locale?: string;
validationId?: string;
}
export interface ValidateStatusResponse {
interface ValidateStatusResponse {
errors?: YoutubePartner.Schema.ValidateError[];
isMetadataOnly?: boolean;
kind?: string;
status?: string;
}
export interface VideoAdvertisingOption {
interface VideoAdvertisingOption {
adBreaks?: YoutubePartner.Schema.AdBreak[];
adFormats?: string[];
autoGeneratedBreaks?: boolean;
@@ -986,19 +986,19 @@ declare namespace GoogleAppsScript {
tpTargetingUrl?: string;
tpUrlParameters?: string;
}
export interface VideoAdvertisingOptionGetEnabledAdsResponse {
interface VideoAdvertisingOptionGetEnabledAdsResponse {
adBreaks?: YoutubePartner.Schema.AdBreak[];
adsOnEmbeds?: boolean;
countriesRestriction?: YoutubePartner.Schema.CountriesRestriction[];
id?: string;
kind?: string;
}
export interface Whitelist {
interface Whitelist {
id?: string;
kind?: string;
title?: string;
}
export interface WhitelistListResponse {
interface WhitelistListResponse {
items?: YoutubePartner.Schema.Whitelist[];
kind?: string;
nextPageToken?: string;
@@ -1006,7 +1006,7 @@ declare namespace GoogleAppsScript {
}
}
}
export interface YoutubePartner {
interface YoutubePartner {
AssetLabels?: YoutubePartner.Collection.AssetLabelsCollection;
AssetMatchPolicy?: YoutubePartner.Collection.AssetMatchPolicyCollection;
AssetRelationships?: YoutubePartner.Collection.AssetRelationshipsCollection;
types/google-apps-script/google-apps-script-events.d.ts
Vendored
+38 -35
View File
@@ -13,20 +13,20 @@ declare namespace GoogleAppsScript {
* Google Apps Script Events
* @see https://developers.google.com/apps-script/guides/triggers/events
*/
export module Events {
namespace Events {
// Internal interfaces
interface AppsScriptEvent {
authMode: Script.AuthMode,
triggerUid: string,
user: Base.User,
authMode: Script.AuthMode;
triggerUid: string;
user: Base.User;
}
interface AppsScriptHttpRequestEvent {
parameter: object,
contextPath: string,
contentLength: number,
queryString: string,
parameters: object,
parameter: object;
contextPath: string;
contentLength: number;
queryString: string;
parameters: object;
}
interface AppsScriptHttpRequestEventPostData {
@@ -37,53 +37,56 @@ declare namespace GoogleAppsScript {
}
// External interfaces
export interface SheetsOnOpen extends AppsScriptEvent {
source: Spreadsheet.Spreadsheet,
interface SheetsOnOpen extends AppsScriptEvent {
source: Spreadsheet.Spreadsheet;
}
enum SheetsOnChangeChangeType { EDIT, INSERT_ROW, INSERT_COLUMN, REMOVE_ROW, REMOVE_COLUMN, INSERT_GRID, REMOVE_GRID, FORMAT, OTHER }
export interface SheetsOnChange extends AppsScriptEvent {
changeType: SheetsOnChangeChangeType,
interface SheetsOnChange extends AppsScriptEvent {
changeType: SheetsOnChangeChangeType;
}
export interface SheetsOnEdit extends AppsScriptEvent {
oldValue: string,
range: Spreadsheet.Range,
source: Spreadsheet.Spreadsheet,
value: string,
interface SheetsOnEdit extends AppsScriptEvent {
oldValue: string;
range: Spreadsheet.Range;
source: Spreadsheet.Spreadsheet;
value: string;
}
export interface FormsOnSubmit extends AppsScriptEvent {
namedValues: { [key: string]: string[]; },
range: Spreadsheet.Range,
values: string[],
interface FormsOnSubmit extends AppsScriptEvent {
namedValues: { [key: string]: string[]; };
range: Spreadsheet.Range;
values: string[];
}
export interface DocsOnOpen extends AppsScriptEvent {
source: Document.Document,
interface DocsOnOpen extends AppsScriptEvent {
source: Document.Document;
}
export interface SlidesOnOpen extends AppsScriptEvent {
source: Slides.Presentation,
interface SlidesOnOpen extends AppsScriptEvent {
source: Slides.Presentation;
}
export interface FormsOnOpen extends AppsScriptEvent {
source: Forms.Form,
interface FormsOnOpen extends AppsScriptEvent {
source: Forms.Form;
}
// TODO: Is there a `user` attribute?
export interface CalendarEventUpdated extends AppsScriptEvent {
calendarId: string,
interface CalendarEventUpdated extends AppsScriptEvent {
calendarId: string;
}
export interface AddonOnInstall {
authMode: Script.AuthMode,
interface AddonOnInstall {
authMode: Script.AuthMode;
}
export interface DoGet extends AppsScriptHttpRequestEvent {}
// tslint:disable-next-line: no-empty-interface
interface DoGet extends AppsScriptHttpRequestEvent {
// TODO: no-empty-interface
}
export interface DoPost extends AppsScriptHttpRequestEvent {
postData: AppsScriptHttpRequestEventPostData,
interface DoPost extends AppsScriptHttpRequestEvent {
postData: AppsScriptHttpRequestEventPostData;
}
}
}
types/google-apps-script/google-apps-script-tests.ts
+5 -3
View File
@@ -1,3 +1,5 @@
// tslint:disable: no-var-keyword prefer-const object-literal-shorthand
// from https://developers.google.com/apps-script/overview
function createAndSendDocument() {
// Create a new Google Doc named 'Hello, world!'
@@ -105,7 +107,7 @@ function doGet(e: GoogleAppsScript.Events.DoGet) {
}
// Base Service
function createFileFromBlob(blob: GoogleAppsScript.Base.Blob){
function createFileFromBlob(blob: GoogleAppsScript.Base.Blob) {
const file: GoogleAppsScript.Drive.File = DriveApp.createFile(blob);
}
@@ -117,7 +119,7 @@ console.error("error");
console.log("Console can use %s and %d format string.", "hello", 2);
// Data Studio Request
const request : GoogleAppsScript.Data_Studio.Request<any> = {
const request: GoogleAppsScript.Data_Studio.Request<any> = {
configParams: {
my_param: 'my_param_value'
},
@@ -145,4 +147,4 @@ const request : GoogleAppsScript.Data_Studio.Request<any> = {
}
]
]
}
};
types/google-apps-script/google-apps-script.base.d.ts
Vendored
+36 -21
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,11 +6,11 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Base {
namespace Base {
/**
* A data interchange object for Apps Script services.
*/
export interface Blob extends BlobSource {
interface Blob extends BlobSource {
copyBlob(): Blob;
getAs(contentType: string): Blob;
getBytes(): Byte[];
@@ -39,7 +39,7 @@ declare namespace GoogleAppsScript {
*
* BlobA data interchange object for Apps Script services.
*
* ChartA Chart object, which can be embedded into documents, UI elements, or used as a static image.
* ChartA Chart object, which can be converted to a static image.
*
* DocumentA document, containing rich text and elements such as tables and lists.
*
@@ -69,7 +69,7 @@ declare namespace GoogleAppsScript {
*
* StaticMapAllows for the creation and decoration of static map images.
*/
export interface BlobSource {
interface BlobSource {
getAs(contentType: string): Blob;
getBlob(): Blob;
}
@@ -83,7 +83,7 @@ declare namespace GoogleAppsScript {
*
* ButtonSet
*/
export interface Browser {
interface Browser {
Buttons: typeof ButtonSet;
inputBox(prompt: string): string;
inputBox(prompt: string, buttons: ButtonSet): string;
@@ -109,7 +109,7 @@ declare namespace GoogleAppsScript {
* Logger.log('The user clicked "No" or the dialog\'s close button.');
* }
*/
export enum Button { CLOSE, OK, CANCEL, YES, NO }
enum Button { CLOSE, OK, CANCEL, YES, NO }
/**
* An enum representing predetermined, localized sets of one or more dialog buttons that can be
@@ -127,12 +127,17 @@ declare namespace GoogleAppsScript {
* Logger.log('The user clicked "No" or the dialog\'s close button.');
* }
*/
export enum ButtonSet { OK, OK_CANCEL, YES_NO, YES_NO_CANCEL }
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.
*/
export interface Logger {
interface Logger {
clear(): void;
getLog(): string;
log(data: any): Logger;
@@ -156,7 +161,7 @@ declare namespace GoogleAppsScript {
* .addToUi();
* }
*/
export interface Menu {
interface Menu {
addItem(caption: string, functionName: string): Menu;
addSeparator(): Menu;
addSubMenu(menu: Menu): Menu;
@@ -183,12 +188,12 @@ declare namespace GoogleAppsScript {
* Logger.log(png.getSize());
* }
*/
export enum MimeType { GOOGLE_APPS_SCRIPT, GOOGLE_DRAWINGS, GOOGLE_DOCS, GOOGLE_FORMS, GOOGLE_SHEETS, GOOGLE_SITES, GOOGLE_SLIDES, FOLDER, BMP, GIF, JPEG, PNG, SVG, PDF, CSS, CSV, HTML, JAVASCRIPT, PLAIN_TEXT, RTF, OPENDOCUMENT_GRAPHICS, OPENDOCUMENT_PRESENTATION, OPENDOCUMENT_SPREADSHEET, OPENDOCUMENT_TEXT, MICROSOFT_EXCEL, MICROSOFT_EXCEL_LEGACY, MICROSOFT_POWERPOINT, MICROSOFT_POWERPOINT_LEGACY, MICROSOFT_WORD, MICROSOFT_WORD_LEGACY, ZIP }
enum MimeType { GOOGLE_APPS_SCRIPT, GOOGLE_DRAWINGS, GOOGLE_DOCS, GOOGLE_FORMS, GOOGLE_SHEETS, GOOGLE_SITES, GOOGLE_SLIDES, FOLDER, BMP, GIF, JPEG, PNG, SVG, PDF, CSS, CSV, HTML, JAVASCRIPT, PLAIN_TEXT, RTF, OPENDOCUMENT_GRAPHICS, OPENDOCUMENT_PRESENTATION, OPENDOCUMENT_SPREADSHEET, OPENDOCUMENT_TEXT, MICROSOFT_EXCEL, MICROSOFT_EXCEL_LEGACY, MICROSOFT_POWERPOINT, MICROSOFT_POWERPOINT_LEGACY, MICROSOFT_WORD, MICROSOFT_WORD_LEGACY, ZIP }
/**
* An enum representing the months of the year.
*/
export enum Month { JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER }
enum Month { JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER }
/**
* A response to a prompt dialog displayed in the
@@ -209,16 +214,27 @@ declare namespace GoogleAppsScript {
* Logger.log('The user clicked the close button in the dialog\'s title bar.');
* }
*/
export interface PromptResponse {
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.
*/
export interface Session {
interface Session {
getActiveUser(): User;
getActiveUserLocale(): string;
getEffectiveUser(): User;
@@ -249,7 +265,7 @@ declare namespace GoogleAppsScript {
* Logger.log('The user clicked the close button in the dialog\'s title bar.');
* }
*/
export interface Ui {
interface Ui {
Button: typeof Button;
ButtonSet: typeof ButtonSet;
alert(prompt: string): Button;
@@ -270,7 +286,7 @@ declare namespace GoogleAppsScript {
/**
* Representation of a user, suitable for scripting.
*/
export interface User {
interface User {
getEmail(): string;
/** @deprecated DO NOT USE */
getUserLoginId(): string;
@@ -279,7 +295,7 @@ declare namespace GoogleAppsScript {
/**
* An enum representing the days of the week.
*/
export enum Weekday { SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY }
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
@@ -310,7 +326,7 @@ declare namespace GoogleAppsScript {
* console.timeEnd(label); // Stops the timer, logs execution duration.
* }
*/
export interface console {
interface console {
error(): void;
error(formatOrObject: object | string, ...values: any[]): void;
info(): void;
@@ -328,7 +344,7 @@ declare namespace GoogleAppsScript {
* @see https://github.com/microsoft/TypeScript/blob/master/lib/lib.es5.d.ts
* Enables basic storage and retrieval of dates and times.
*/
export interface Date {
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. */
@@ -504,8 +520,7 @@ declare namespace GoogleAppsScript {
UTC(year: number, month: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): number;
now(): number;
}
export const Date: DateConstructor;
const Date: DateConstructor;
}
}
types/google-apps-script/google-apps-script.cache.d.ts
Vendored
+4 -5
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Cache {
namespace Cache {
/**
* A reference to a particular cache.
*
@@ -27,7 +27,7 @@ declare namespace GoogleAppsScript {
* return contents;
* }
*/
export interface Cache {
interface Cache {
get(key: string): string | null;
getAll(keys: string[]): { [key: string]: any };
put(key: string, value: string): void;
@@ -48,12 +48,11 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface CacheService {
interface CacheService {
getDocumentCache(): Cache | null;
getScriptCache(): Cache | null;
getUserCache(): Cache | null;
}
}
}
types/google-apps-script/google-apps-script.calendar.d.ts
Vendored
+59 -60
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,31 +7,31 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Calendar {
namespace Calendar {
/**
* Represents a calendar that the user owns or is subscribed to.
*/
export interface Calendar {
createAllDayEvent(title: string, date: Date): CalendarEvent;
createAllDayEvent(title: string, startDate: Date, endDate: Date): CalendarEvent;
createAllDayEvent(title: string, startDate: Date, endDate: Date, options: { [key: string]: any }): CalendarEvent;
createAllDayEvent(title: string, date: Date, options: { [key: string]: any }): CalendarEvent;
createAllDayEventSeries(title: string, startDate: Date, recurrence: EventRecurrence): CalendarEventSeries;
createAllDayEventSeries(title: string, startDate: Date, recurrence: EventRecurrence, options: { [key: string]: any }): CalendarEventSeries;
createEvent(title: string, startTime: Date, endTime: Date): CalendarEvent;
createEvent(title: string, startTime: Date, endTime: Date, options: { [key: string]: any }): CalendarEvent;
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: Date, endTime: Date, recurrence: EventRecurrence): CalendarEventSeries;
createEventSeries(title: string, startTime: Date, endTime: Date, recurrence: EventRecurrence, options: { [key: string]: any }): CalendarEventSeries;
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: Date, endTime: Date): CalendarEvent[];
getEvents(startTime: Date, endTime: Date, options: { [key: string]: any }): CalendarEvent[];
getEventsForDay(date: Date): CalendarEvent[];
getEventsForDay(date: Date, options: { [key: string]: any }): CalendarEvent[];
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;
@@ -53,26 +53,26 @@ declare namespace GoogleAppsScript {
* to the user's default calendar, as well as the ability to retrieve additional calendars that the
* user owns or is subscribed to.
*/
export interface CalendarApp {
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: Date): CalendarEvent;
createAllDayEvent(title: string, startDate: Date, endDate: Date): CalendarEvent;
createAllDayEvent(title: string, startDate: Date, endDate: Date, options: { [key: string]: any }): CalendarEvent;
createAllDayEvent(title: string, date: Date, options: { [key: string]: any }): CalendarEvent;
createAllDayEventSeries(title: string, startDate: Date, recurrence: EventRecurrence): CalendarEventSeries;
createAllDayEventSeries(title: string, startDate: Date, recurrence: EventRecurrence, options: { [key: string]: any }): CalendarEventSeries;
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: Date, endTime: Date): CalendarEvent;
createEvent(title: string, startTime: Date, endTime: Date, options: { [key: string]: any }): CalendarEvent;
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: Date, endTime: Date, recurrence: EventRecurrence): CalendarEventSeries;
createEventSeries(title: string, startTime: Date, endTime: Date, recurrence: EventRecurrence, options: { [key: string]: any }): CalendarEventSeries;
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;
@@ -82,10 +82,10 @@ declare namespace GoogleAppsScript {
getDescription(): string;
getEventById(iCalId: string): CalendarEvent;
getEventSeriesById(iCalId: string): CalendarEventSeries;
getEvents(startTime: Date, endTime: Date): CalendarEvent[];
getEvents(startTime: Date, endTime: Date, options: { [key: string]: any }): CalendarEvent[];
getEventsForDay(date: Date): CalendarEvent[];
getEventsForDay(date: Date, options: { [key: string]: any }): CalendarEvent[];
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;
@@ -109,7 +109,7 @@ declare namespace GoogleAppsScript {
/**
* Represents a single calendar event.
*/
export interface CalendarEvent {
interface CalendarEvent {
addEmailReminder(minutesBefore: Integer): CalendarEvent;
addGuest(email: string): CalendarEvent;
addPopupReminder(minutesBefore: Integer): CalendarEvent;
@@ -117,27 +117,27 @@ declare namespace GoogleAppsScript {
anyoneCanAddSelf(): boolean;
deleteEvent(): void;
deleteTag(key: string): CalendarEvent;
getAllDayEndDate(): Date;
getAllDayStartDate(): Date;
getAllDayEndDate(): Base.Date;
getAllDayStartDate(): Base.Date;
getAllTagKeys(): string[];
getColor(): string;
getCreators(): string[];
getDateCreated(): Date;
getDateCreated(): Base.Date;
getDescription(): string;
getEmailReminders(): Integer[];
getEndTime(): Date;
getEndTime(): Base.Date;
getEventSeries(): CalendarEventSeries;
getGuestByEmail(email: string): EventGuest;
getGuestList(): EventGuest[];
getGuestList(includeOwner: boolean): EventGuest[];
getId(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getLocation(): string;
getMyStatus(): GuestStatus;
getOriginalCalendarId(): string;
getPopupReminders(): Integer[];
getSmsReminders(): Integer[];
getStartTime(): Date;
getStartTime(): Base.Date;
getTag(key: string): string;
getTitle(): string;
getVisibility(): Visibility;
@@ -150,8 +150,8 @@ declare namespace GoogleAppsScript {
removeAllReminders(): CalendarEvent;
removeGuest(email: string): CalendarEvent;
resetRemindersToDefault(): CalendarEvent;
setAllDayDate(date: Date): CalendarEvent;
setAllDayDates(startDate: Date, endDate: Date): 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;
@@ -161,7 +161,7 @@ declare namespace GoogleAppsScript {
setLocation(location: string): CalendarEvent;
setMyStatus(status: GuestStatus): CalendarEvent;
setTag(key: string, value: string): CalendarEvent;
setTime(startTime: Date, endTime: Date): CalendarEvent;
setTime(startTime: Base.Date, endTime: Base.Date): CalendarEvent;
setTitle(title: string): CalendarEvent;
setVisibility(visibility: Visibility): CalendarEvent;
}
@@ -169,7 +169,7 @@ declare namespace GoogleAppsScript {
/**
* Represents a series of events (a recurring event).
*/
export interface CalendarEventSeries {
interface CalendarEventSeries {
addEmailReminder(minutesBefore: Integer): CalendarEventSeries;
addGuest(email: string): CalendarEventSeries;
addPopupReminder(minutesBefore: Integer): CalendarEventSeries;
@@ -180,14 +180,14 @@ declare namespace GoogleAppsScript {
getAllTagKeys(): string[];
getColor(): string;
getCreators(): string[];
getDateCreated(): Date;
getDateCreated(): Base.Date;
getDescription(): string;
getEmailReminders(): Integer[];
getGuestByEmail(email: string): EventGuest;
getGuestList(): EventGuest[];
getGuestList(includeOwner: boolean): EventGuest[];
getId(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getLocation(): string;
getMyStatus(): GuestStatus;
getOriginalCalendarId(): string;
@@ -211,8 +211,8 @@ declare namespace GoogleAppsScript {
setGuestsCanSeeGuests(guestsCanSeeGuests: boolean): CalendarEventSeries;
setLocation(location: string): CalendarEventSeries;
setMyStatus(status: GuestStatus): CalendarEventSeries;
setRecurrence(recurrence: EventRecurrence, startDate: Date): CalendarEventSeries;
setRecurrence(recurrence: EventRecurrence, startTime: Date, endTime: Date): 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;
@@ -221,17 +221,17 @@ declare namespace GoogleAppsScript {
/**
* An enum representing the named colors available in the Calendar service.
*/
export 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 }
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.
*/
export enum EventColor { PALE_BLUE, PALE_GREEN, MAUVE, PALE_RED, YELLOW, ORANGE, CYAN, GRAY, BLUE, GREEN, RED }
enum EventColor { PALE_BLUE, PALE_GREEN, MAUVE, PALE_RED, YELLOW, ORANGE, CYAN, GRAY, BLUE, GREEN, RED }
/**
* Represents a guest of an event.
*/
export interface EventGuest {
interface EventGuest {
getAdditionalGuests(): Integer;
getEmail(): string;
getGuestStatus(): GuestStatus;
@@ -243,11 +243,11 @@ declare namespace GoogleAppsScript {
/**
* Represents the recurrence settings for an event series.
*/
export interface EventRecurrence {
interface EventRecurrence {
addDailyExclusion(): RecurrenceRule;
addDailyRule(): RecurrenceRule;
addDate(date: Date): EventRecurrence;
addDateExclusion(date: Date): EventRecurrence;
addDate(date: Base.Date): EventRecurrence;
addDateExclusion(date: Base.Date): EventRecurrence;
addMonthlyExclusion(): RecurrenceRule;
addMonthlyRule(): RecurrenceRule;
addWeeklyExclusion(): RecurrenceRule;
@@ -260,7 +260,7 @@ declare namespace GoogleAppsScript {
/**
* An enum representing the statuses a guest can have for an event.
*/
export enum GuestStatus { INVITED, MAYBE, NO, OWNER, YES }
enum GuestStatus { INVITED, MAYBE, NO, OWNER, YES }
/**
* Represents a recurrence rule for an event series.
@@ -273,11 +273,11 @@ declare namespace GoogleAppsScript {
* times(times)
* interval(interval)
*/
export interface RecurrenceRule {
interface RecurrenceRule {
addDailyExclusion(): RecurrenceRule;
addDailyRule(): RecurrenceRule;
addDate(date: Date): EventRecurrence;
addDateExclusion(date: Date): EventRecurrence;
addDate(date: Base.Date): EventRecurrence;
addDateExclusion(date: Base.Date): EventRecurrence;
addMonthlyExclusion(): RecurrenceRule;
addMonthlyRule(): RecurrenceRule;
addWeeklyExclusion(): RecurrenceRule;
@@ -297,15 +297,14 @@ declare namespace GoogleAppsScript {
onlyOnYearDays(days: Integer[]): RecurrenceRule;
setTimeZone(timeZone: string): EventRecurrence;
times(times: Integer): RecurrenceRule;
until(endDate: Date): RecurrenceRule;
until(endDate: Base.Date): RecurrenceRule;
weekStartsOn(day: Base.Weekday): RecurrenceRule;
}
/**
* An enum representing the visibility of an event.
*/
export enum Visibility { CONFIDENTIAL, DEFAULT, PRIVATE, PUBLIC }
enum Visibility { CONFIDENTIAL, DEFAULT, PRIVATE, PUBLIC }
}
}
types/google-apps-script/google-apps-script.card-service.d.ts
Vendored
+49 -48
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.gmail.d.ts" />
declare namespace GoogleAppsScript {
export module Card_Service {
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.
@@ -17,7 +17,7 @@ declare namespace GoogleAppsScript {
* .setFunctionName("handleImageClick")
* .setParameters({imageSrc: 'carImage'}));
*/
export interface Action {
interface Action {
setFunctionName(functionName: string): Action;
setLoadIndicator(loadIndicator: LoadIndicator): Action;
setParameters(parameters: { [key: string]: string }): Action;
@@ -52,14 +52,14 @@ declare namespace GoogleAppsScript {
* .setStateChanged(true)
* .build();
*/
export interface ActionResponse {
interface ActionResponse {
printJson(): string;
}
/**
* A builder for ActionResponse objects.
*/
export interface ActionResponseBuilder {
interface ActionResponseBuilder {
build(): ActionResponse;
setNavigation(navigation: Navigation): ActionResponseBuilder;
setNotification(notification: Notification): ActionResponseBuilder;
@@ -73,7 +73,7 @@ declare namespace GoogleAppsScript {
* CardService.newAuthorizationAction()
* .setAuthorizationUrl("http://google.com/");
*/
export interface AuthorizationAction {
interface AuthorizationAction {
setAuthorizationUrl(authorizationUrl: string): AuthorizationAction;
}
@@ -85,7 +85,7 @@ declare namespace GoogleAppsScript {
* .setResourceDisplayName("Example Resource")
* .throwException();
*/
export interface AuthorizationException {
interface AuthorizationException {
printJson(): string;
setAuthorizationUrl(authUrl: string): AuthorizationException;
setCustomUiCallback(callback: string): AuthorizationException;
@@ -96,7 +96,7 @@ declare namespace GoogleAppsScript {
/**
* A base class for all buttons.
*/
export interface Button {
interface Button {
setAuthorizationAction(action: AuthorizationAction): Button;
setComposeAction(action: Action, composedEmailType: ComposedEmailType): Button;
setOnClickAction(action: Action): Button;
@@ -117,7 +117,7 @@ declare namespace GoogleAppsScript {
* .addButton(textButton)
* .addButton(imageButton);
*/
export interface ButtonSet {
interface ButtonSet {
addButton(button: Button): ButtonSet;
}
@@ -134,7 +134,7 @@ declare namespace GoogleAppsScript {
* .addSection(cardSection)
* .build();
*/
export interface Card {
interface Card {
printJson(): string;
}
@@ -148,7 +148,7 @@ declare namespace GoogleAppsScript {
* .setText("Card action")
* .setOnClickAction(action);
*/
export interface CardAction {
interface CardAction {
setAuthorizationAction(action: AuthorizationAction): CardAction;
setComposeAction(action: Action, composedEmailType: ComposedEmailType): CardAction;
setOnClickAction(action: Action): CardAction;
@@ -160,7 +160,7 @@ declare namespace GoogleAppsScript {
/**
* A builder for Card objects.
*/
export interface CardBuilder {
interface CardBuilder {
addCardAction(cardAction: CardAction): CardBuilder;
addSection(section: CardSection): CardBuilder;
build(): Card;
@@ -177,7 +177,7 @@ declare namespace GoogleAppsScript {
* .setImageStyle(CardService.ImageStyle.CIRCLE)
* .setImageUrl("https://image.png");
*/
export interface CardHeader {
interface CardHeader {
setImageAltText(imageAltText: string): CardHeader;
setImageStyle(imageStyle: ImageStyle): CardHeader;
setImageUrl(imageUrl: string): CardHeader;
@@ -198,7 +198,7 @@ declare namespace GoogleAppsScript {
* .addWidget(image)
* .addWidget(textParagraph);
*/
export interface CardSection {
interface CardSection {
addWidget(widget: Widget): CardSection;
setCollapsible(collapsible: boolean): CardSection;
setHeader(header: string): CardSection;
@@ -249,7 +249,7 @@ declare namespace GoogleAppsScript {
* .build();
* }
*/
export interface CardService {
interface CardService {
ComposedEmailType: typeof ComposedEmailType;
ContentType: typeof ContentType;
Icon: typeof Icon;
@@ -300,7 +300,7 @@ declare namespace GoogleAppsScript {
* .setGmailDraft(GmailApp.createDraft("recipient", "subject", "body"))
* .build();
*/
export interface ComposeActionResponse {
interface ComposeActionResponse {
printJson(): string;
}
@@ -312,7 +312,7 @@ declare namespace GoogleAppsScript {
* this builder creates responses to an Action that composes draft messages when a specific
* UI element is selected.
*/
export interface ComposeActionResponseBuilder {
interface ComposeActionResponseBuilder {
build(): ComposeActionResponse;
setGmailDraft(draft: Gmail.GmailDraft): ComposeActionResponseBuilder;
}
@@ -320,24 +320,24 @@ declare namespace GoogleAppsScript {
/**
* An enum value that specifies whether the composed email is a standalone or reply draft.
*/
export enum ComposedEmailType { REPLY_AS_DRAFT, STANDALONE_DRAFT }
enum ComposedEmailType { REPLY_AS_DRAFT, STANDALONE_DRAFT }
/**
* An enum value that specifies the content type of the content generated by a UpdateDraftActionResponse.
*/
export enum ContentType { TEXT, MUTABLE_HTML, IMMUTABLE_HTML }
enum ContentType { TEXT, MUTABLE_HTML, IMMUTABLE_HTML }
/**
* Predefined icons that can be used in various UI objects, such as ImageButton or KeyValue widgets.
*/
export 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 }
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 a single image.
*
* var image = CardService.newImage().setAltText("A nice image").setImageUrl("https://image.png");
*/
export interface Image {
interface Image {
setAltText(altText: string): Image;
setAuthorizationAction(action: AuthorizationAction): Image;
setComposeAction(action: Action, composedEmailType: ComposedEmailType): Image;
@@ -356,7 +356,7 @@ declare namespace GoogleAppsScript {
* .setOpenLink(CardService.newOpenLink()
* .setUrl("https://airplane.com"));
*/
export interface ImageButton {
interface ImageButton {
setAltText(altText: string): ImageButton;
setAuthorizationAction(action: AuthorizationAction): ImageButton;
setComposeAction(action: Action, composedEmailType: ComposedEmailType): ImageButton;
@@ -370,7 +370,7 @@ declare namespace GoogleAppsScript {
/**
* An enum that defines an image cropping style.
*/
export enum ImageStyle { SQUARE, CIRCLE }
enum ImageStyle { SQUARE, CIRCLE }
/**
* A widget that displays one or more "keys" around a text "value". The possible keys include an
@@ -392,7 +392,7 @@ declare namespace GoogleAppsScript {
* .setMultiline(true)
* .setBottomLabel("Bottom label - single line");
*/
export interface KeyValue {
interface KeyValue {
setAuthorizationAction(action: AuthorizationAction): KeyValue;
setBottomLabel(text: string): KeyValue;
setButton(button: Button): KeyValue;
@@ -412,12 +412,12 @@ declare namespace GoogleAppsScript {
/**
* An enum type that specifies the type of loading or progress indicator to display while an Action is being processed.
*/
export enum LoadIndicator { SPINNER, NONE }
enum LoadIndicator { SPINNER, NONE }
/**
* A helper object that controls card navigation. See the card navigation guide for more details.
*/
export interface Navigation {
interface Navigation {
popCard(): Navigation;
popToNamedCard(cardName: string): Navigation;
popToRoot(): Navigation;
@@ -441,7 +441,7 @@ declare namespace GoogleAppsScript {
* .build();
* }
*/
export interface Notification {
interface Notification {
setText(text: string): Notification;
}
@@ -452,7 +452,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export enum OnClose { NOTHING, RELOAD_ADD_ON }
enum OnClose { NOTHING, RELOAD_ADD_ON }
/**
* An enum that specifies how to open a URL.
@@ -464,7 +464,7 @@ declare namespace GoogleAppsScript {
* Using OnClose may cause OpenAs to be ignored; if the client platform cannot
* support both selected values together, OnClose takes precedence.
*/
export enum OpenAs { FULL_SIZE, OVERLAY }
enum OpenAs { FULL_SIZE, OVERLAY }
/**
* Represents an action to open a link with some options.
@@ -487,7 +487,7 @@ declare namespace GoogleAppsScript {
* .setOnClose(CardService.OnClose.NOTHING));
* .build();
*/
export interface OpenLink {
interface OpenLink {
setOnClose(onClose: OnClose): OpenLink;
setOpenAs(openAs: OpenAs): OpenLink;
setUrl(url: string): OpenLink;
@@ -514,7 +514,7 @@ declare namespace GoogleAppsScript {
* .addItem("radio button two title", "radio_two_value", true)
* .addItem("radio button three title", "radio_three_value", false);
*/
export interface SelectionInput {
interface SelectionInput {
addItem(text: any, value: any, selected: boolean): SelectionInput;
setFieldName(fieldName: string): SelectionInput;
setOnChangeAction(action: Action): SelectionInput;
@@ -525,7 +525,7 @@ declare namespace GoogleAppsScript {
/**
* Type of selection input.
*/
export enum SelectionInputType { CHECK_BOX, RADIO_BUTTON, DROPDOWN }
enum SelectionInputType { CHECK_BOX, RADIO_BUTTON, DROPDOWN }
/**
* Autocomplete suggestions to supplement a TextInput widget.
@@ -535,7 +535,7 @@ declare namespace GoogleAppsScript {
* .addSuggestion("First suggestion")
* .addSuggestion("Second suggestion"))
*/
export interface Suggestions {
interface Suggestions {
addSuggestion(suggestion: string): Suggestions;
addSuggestions(suggestions: string[]): Suggestions;
}
@@ -550,14 +550,14 @@ declare namespace GoogleAppsScript {
* .addSuggestion("Second suggestion"))
* .build();
*/
export interface SuggestionsResponse {
interface SuggestionsResponse {
printJson(): string;
}
/**
* A builder for SuggestionsResponse objects.
*/
export interface SuggestionsResponseBuilder {
interface SuggestionsResponseBuilder {
build(): SuggestionsResponse;
setSuggestions(suggestions: Suggestions): SuggestionsResponseBuilder;
}
@@ -574,7 +574,7 @@ declare namespace GoogleAppsScript {
* .setOnChangeAction(CardService.newAction()
* .setFunctionName("handleSwitchChange")));
*/
export interface Switch {
interface Switch {
setFieldName(fieldName: string): Switch;
setOnChangeAction(action: Action): Switch;
setSelected(selected: boolean): Switch;
@@ -590,7 +590,7 @@ declare namespace GoogleAppsScript {
* .setOpenLink(CardService.newOpenLink()
* .setUrl("https://www.google.com"));
*/
export interface TextButton {
interface TextButton {
setAuthorizationAction(action: AuthorizationAction): TextButton;
setBackgroundColor(backgroundColor: string): TextButton;
setComposeAction(action: Action, composedEmailType: ComposedEmailType): TextButton;
@@ -609,7 +609,7 @@ declare namespace GoogleAppsScript {
* FILLED buttons have a background color you can set with
* TextButton.setBackgroundColor(backgroundColor).
*/
export enum TextButtonStyle { TEXT, FILLED }
enum TextButtonStyle { TEXT, FILLED }
/**
* A input field widget that accepts text input.
@@ -619,7 +619,7 @@ declare namespace GoogleAppsScript {
* .setTitle("Text input title")
* .setHint("Text input hint");
*/
export interface TextInput {
interface TextInput {
setFieldName(fieldName: string): TextInput;
setHint(hint: string): TextInput;
setMultiline(multiline: boolean): TextInput;
@@ -636,7 +636,7 @@ declare namespace GoogleAppsScript {
* var textParagraph = CardService.newTextParagraph()
* .setText("This is a text paragraph widget. Multiple lines are allowed if needed.");
*/
export interface TextParagraph {
interface TextParagraph {
setText(text: string): TextParagraph;
}
@@ -660,14 +660,14 @@ declare namespace GoogleAppsScript {
* cardBuilder2.build();
* ]).build();
*/
export interface UniversalActionResponse {
interface UniversalActionResponse {
printJson(): string;
}
/**
* A builder for the UniversalActionResponse objects.
*/
export interface UniversalActionResponseBuilder {
interface UniversalActionResponseBuilder {
build(): UniversalActionResponse;
displayAddOnCards(cardObjects: Card[]): UniversalActionResponseBuilder;
setOpenLink(openLink: OpenLink): UniversalActionResponseBuilder;
@@ -709,14 +709,14 @@ declare namespace GoogleAppsScript {
* .setUpdateType(UpdateDraftBodyType.IN_PLACE_INSERT))
* .build();
*/
export interface UpdateDraftActionResponse {
interface UpdateDraftActionResponse {
printJson(): string;
}
/**
* A builder for UpdateDraftActionResponse objects.
*/
export interface UpdateDraftActionResponseBuilder {
interface UpdateDraftActionResponseBuilder {
build(): UpdateDraftActionResponse;
setUpdateDraftBodyAction(updateDraftBodyAction: UpdateDraftBodyAction): UpdateDraftActionResponseBuilder;
}
@@ -724,7 +724,7 @@ declare namespace GoogleAppsScript {
/**
* Represents an action that updates the email draft body.
*/
export interface UpdateDraftBodyAction {
interface UpdateDraftBodyAction {
addUpdateContent(content: string, contentType: ContentType): UpdateDraftBodyAction;
setUpdateType(updateType: UpdateDraftBodyType): UpdateDraftBodyAction;
}
@@ -732,14 +732,15 @@ declare namespace GoogleAppsScript {
/**
* An enum value that specifies the type of an UpdateDraftBodyAction.
*/
export enum UpdateDraftBodyType { IN_PLACE_INSERT }
enum UpdateDraftBodyType { IN_PLACE_INSERT }
/**
* Base class for all widgets that can be added to a Card.
*/
export interface Widget {
// tslint:disable-next-line: no-empty-interface
interface Widget {
// tslint:disable-next-line: no-empty-interface
}
}
}
types/google-apps-script/google-apps-script.charts.d.ts
Vendored
+37 -146
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Charts {
namespace Charts {
/**
* Builder for area charts. For more details, see the Google Charts documentation.
*
@@ -42,7 +42,7 @@ declare namespace GoogleAppsScript {
* .setDataTable(sampleData)
* .build();
*/
export interface AreaChartBuilder {
interface AreaChartBuilder {
build(): Chart;
reverseCategories(): AreaChartBuilder;
setBackgroundColor(cssValue: string): AreaChartBuilder;
@@ -89,7 +89,7 @@ declare namespace GoogleAppsScript {
*
* var chart = chartBuilder.build();
*/
export interface BarChartBuilder {
interface BarChartBuilder {
build(): Chart;
reverseCategories(): BarChartBuilder;
reverseDirection(): BarChartBuilder;
@@ -117,55 +117,24 @@ declare namespace GoogleAppsScript {
}
/**
* A builder for category filter controls.
*
* A category filter is a picker to choose one or more between a set of defined values. Given a
* column of type string, this control filters out the rows that don't match any of the picked
* values.
*
* For more details, see the Gviz
* documentation.
* A Chart object, which can be converted to a static image. For charts embedded in spreadsheets,
* see EmbeddedChart.
*/
export interface CategoryFilterBuilder {
build(): Control;
setAllowMultiple(allowMultiple: boolean): CategoryFilterBuilder;
setAllowNone(allowNone: boolean): CategoryFilterBuilder;
setAllowTyping(allowTyping: boolean): CategoryFilterBuilder;
setCaption(caption: string): CategoryFilterBuilder;
setDataTable(tableBuilder: DataTableBuilder): CategoryFilterBuilder;
setDataTable(table: DataTableSource): CategoryFilterBuilder;
setFilterColumnIndex(columnIndex: Integer): CategoryFilterBuilder;
setFilterColumnLabel(columnLabel: string): CategoryFilterBuilder;
setLabel(label: string): CategoryFilterBuilder;
setLabelSeparator(labelSeparator: string): CategoryFilterBuilder;
setLabelStacking(orientation: Orientation): CategoryFilterBuilder;
setSelectedValuesLayout(layout: PickerValuesLayout): CategoryFilterBuilder;
setSortValues(sortValues: boolean): CategoryFilterBuilder;
setValues(values: string[]): CategoryFilterBuilder;
}
/**
* A Chart object, which can be embedded into documents, UI elements, or used as a static image. For
* charts embedded in spreadsheets, see EmbeddedChart.
*/
export interface Chart {
interface Chart {
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
getId(): string;
getOptions(): ChartOptions;
getType(): string;
setId(id: string): Chart;
}
/**
* An enumeration of how hidden dimensions in a source are expressed in a chart.
*/
export enum ChartHiddenDimensionStrategy { IGNORE_BOTH, IGNORE_ROWS, IGNORE_COLUMNS, SHOW_BOTH }
enum ChartHiddenDimensionStrategy { IGNORE_BOTH, IGNORE_ROWS, IGNORE_COLUMNS, SHOW_BOTH }
/**
* An enumeration of how multiple ranges in the source are expressed in a chart.
*/
export enum ChartMergeStrategy { MERGE_COLUMNS, MERGE_ROWS }
enum ChartMergeStrategy { MERGE_COLUMNS, MERGE_ROWS }
/**
* Exposes options currently configured for a Chart, such as height, color, etc.
@@ -176,14 +145,14 @@ declare namespace GoogleAppsScript {
*
* These options are immutable.
*/
export interface ChartOptions {
interface ChartOptions {
get(option: string): any;
}
/**
* Chart types supported by the Charts service.
*/
export enum ChartType { TIMELINE, AREA, BAR, BUBBLE, CANDLESTICK, COLUMN, COMBO, GAUGE, GEO, HISTOGRAM, RADAR, LINE, ORG, PIE, SCATTER, SPARKLINE, STEPPED_AREA, TABLE, TREEMAP, WATERFALL }
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.
@@ -218,29 +187,22 @@ declare namespace GoogleAppsScript {
* return htmlOutput;
* }
*/
export interface Charts {
interface Charts {
ChartHiddenDimensionStrategy: typeof ChartHiddenDimensionStrategy;
ChartMergeStrategy: typeof ChartMergeStrategy;
ChartType: typeof ChartType;
ColumnType: typeof ColumnType;
CurveStyle: typeof CurveStyle;
MatchType: typeof MatchType;
Orientation: typeof Orientation;
PickerValuesLayout: typeof PickerValuesLayout;
PointStyle: typeof PointStyle;
Position: typeof Position;
newAreaChart(): AreaChartBuilder;
newBarChart(): BarChartBuilder;
newCategoryFilter(): CategoryFilterBuilder;
newColumnChart(): ColumnChartBuilder;
newDashboardPanel(): DashboardPanelBuilder;
newDataTable(): DataTableBuilder;
newDataViewDefinition(): DataViewDefinitionBuilder;
newLineChart(): LineChartBuilder;
newNumberRangeFilter(): NumberRangeFilterBuilder;
newPieChart(): PieChartBuilder;
newScatterChart(): ScatterChartBuilder;
newStringFilter(): StringFilterBuilder;
newTableChart(): TableChartBuilder;
newTextStyle(): TextStyleBuilder;
}
@@ -273,7 +235,7 @@ declare namespace GoogleAppsScript {
* .setDataTable(sampleData)
* .build();
*/
export interface ColumnChartBuilder {
interface ColumnChartBuilder {
build(): Chart;
reverseCategories(): ColumnChartBuilder;
setBackgroundColor(cssValue: string): ColumnChartBuilder;
@@ -302,77 +264,21 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of the valid data types for columns in a DataTable.
*/
export enum ColumnType { DATE, NUMBER, STRING }
/**
* A user interface control object, that drives the data displayed by a DashboardPanel.
*
* A control can be embedded in a UI application. Controls are user interface widgets (category
* pickers, range sliders, autocompleters, etc.) users interact with in order to drive the data
* managed by a dashboard and the charts that are part of it. Controls collect user input and use
* the information to decide which of the data the dashboard is managing should be made available to
* the charts that are part of it. Given a data table, a control filters out the data that doesn't
* comply with the conditions implied by its current state, and exposes the filtered data table as
* an output.
*
* For more details, see the Gviz documentation.
*/
export interface Control {
getId(): string;
getType(): string;
setId(id: string): Control;
}
enum ColumnType { DATE, NUMBER, STRING }
/**
* An enumeration of the styles for curves in a chart.
*/
export enum CurveStyle { NORMAL, SMOOTH }
/**
* A dashboard is a visual structure that enables the organization and management of multiple charts
* that share the same underlying data.
*
* Controls are user interface widgets (category pickers, range sliders, autocompleters, etc.)
* users interact with in order to drive the data managed by a dashboard and the charts that are
* part of it. For example, a string filter control is a simple text input field that lets the user
* filter data via string matching. Given a column and matching options, the control filters out the
* rows that don't match the term that's in the input field.
*
* The Gviz API defines a dashboard as a set of charts and controls bound together. The bindings
* between the different components define the data flow, the state of the controls filters views of
* the data which propagate in the dashboard and are eventually visualized with charts. For more
* details, see the Gviz documentation.
*
* The dashboard panel has two purposes, one is being a container for the charts and controls
* objects that compose the dashboard, and the other is holding the data and use as an interface for
* binding controls to charts.
*/
export interface DashboardPanel {
getId(): string;
getType(): string;
setId(id: string): DashboardPanel;
}
/**
* A builder for a dashboard panel object. For an example of how to use DashboardPanelBuilder, refer to DashboardPanel.
*
* For more details, see the Gviz
* documentation.
*/
export interface DashboardPanelBuilder {
bind(control: Control, chart: Chart, controls: Control[], charts: Chart[]): DashboardPanelBuilder;
bind(control: Control, chart: Chart, controls: Control[], charts: Chart[]): DashboardPanelBuilder;
build(): DashboardPanel;
setDataTable(tableBuilder: DataTableBuilder): DashboardPanelBuilder;
setDataTable(source: DataTableSource): DashboardPanelBuilder;
}
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.
*/
export interface DataTable {
// tslint:disable-next-line: no-empty-interface
interface DataTable {
// tslint:disable-next-line: no-empty-interface
}
/**
@@ -390,7 +296,7 @@ declare namespace GoogleAppsScript {
* .addRow(["May", 30, 4])
* .build();
*/
export interface DataTableBuilder {
interface DataTableBuilder {
addColumn(type: ColumnType, label: string): DataTableBuilder;
addRow(values: any[]): DataTableBuilder;
build(): DataTable;
@@ -407,7 +313,7 @@ declare namespace GoogleAppsScript {
*
* RangeAccess and modify spreadsheet ranges.
*/
export interface DataTableSource {
interface DataTableSource {
getDataTable(): DataTable;
}
@@ -420,7 +326,9 @@ declare namespace GoogleAppsScript {
* consideration when drawing the chart. See DataViewDefinitionBuilder for an example on how
* to define and use a DataViewDefinition.
*/
export interface DataViewDefinition {
// tslint:disable-next-line: no-empty-interface
interface DataViewDefinition {
// tslint:disable-next-line: no-empty-interface
}
/**
@@ -464,7 +372,7 @@ declare namespace GoogleAppsScript {
* return htmlOutput;
* }
*/
export interface DataViewDefinitionBuilder {
interface DataViewDefinitionBuilder {
build(): DataViewDefinition;
setColumns(columns: any[]): DataViewDefinitionBuilder;
}
@@ -489,7 +397,7 @@ declare namespace GoogleAppsScript {
*
* var chart = chartBuilder.build();
*/
export interface LineChartBuilder {
interface LineChartBuilder {
build(): Chart;
reverseCategories(): LineChartBuilder;
setBackgroundColor(cssValue: string): LineChartBuilder;
@@ -531,7 +439,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export enum MatchType { EXACT, PREFIX, ANY }
enum MatchType { EXACT, PREFIX, ANY }
/**
* A builder for number range filter controls.
@@ -543,15 +451,7 @@ declare namespace GoogleAppsScript {
* For more details, see the Gviz
* documentation.
*/
export interface NumberRangeFilterBuilder {
build(): Control;
setDataTable(tableBuilder: DataTableBuilder): NumberRangeFilterBuilder;
setDataTable(table: DataTableSource): NumberRangeFilterBuilder;
setFilterColumnIndex(columnIndex: Integer): NumberRangeFilterBuilder;
setFilterColumnLabel(columnLabel: string): NumberRangeFilterBuilder;
setLabel(label: string): NumberRangeFilterBuilder;
setLabelSeparator(labelSeparator: string): NumberRangeFilterBuilder;
setLabelStacking(orientation: Orientation): NumberRangeFilterBuilder;
interface NumberRangeFilterBuilder {
setMaxValue(maxValue: Integer): NumberRangeFilterBuilder;
setMinValue(minValue: Integer): NumberRangeFilterBuilder;
setOrientation(orientation: Orientation): NumberRangeFilterBuilder;
@@ -562,12 +462,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of the orientation of an object.
*/
export enum Orientation { HORIZONTAL, VERTICAL }
enum Orientation { HORIZONTAL, VERTICAL }
/**
* An enumeration of how to display selected values in picker widget.
*/
export enum PickerValuesLayout { ASIDE, BELOW, BELOW_WRAPPING, BELOW_STACKED }
enum PickerValuesLayout { ASIDE, BELOW, BELOW_WRAPPING, BELOW_STACKED }
/**
* A builder for pie charts. For more details, see the Google Charts documentation.
@@ -586,7 +486,7 @@ declare namespace GoogleAppsScript {
*
* var chart = chartBuilder.build();
*/
export interface PieChartBuilder {
interface PieChartBuilder {
build(): Chart;
reverseCategories(): PieChartBuilder;
set3D(): PieChartBuilder;
@@ -607,12 +507,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of the styles of points in a line.
*/
export enum PointStyle { NONE, TINY, MEDIUM, LARGE, HUGE }
enum PointStyle { NONE, TINY, MEDIUM, LARGE, HUGE }
/**
* An enumeration of legend positions within a chart.
*/
export enum Position { TOP, RIGHT, BOTTOM, NONE }
enum Position { TOP, RIGHT, BOTTOM, NONE }
/**
* Builder for scatter charts. For more details, see the Google Charts documentation.
@@ -633,7 +533,7 @@ declare namespace GoogleAppsScript {
*
* var chart = chartBuilder.build();
*/
export interface ScatterChartBuilder {
interface ScatterChartBuilder {
build(): Chart;
setBackgroundColor(cssValue: string): ScatterChartBuilder;
setColors(cssValues: string[]): ScatterChartBuilder;
@@ -670,16 +570,8 @@ declare namespace GoogleAppsScript {
* For more details, see the Gviz
* documentation.
*/
export interface StringFilterBuilder {
build(): Control;
interface StringFilterBuilder {
setCaseSensitive(caseSensitive: boolean): StringFilterBuilder;
setDataTable(tableBuilder: DataTableBuilder): StringFilterBuilder;
setDataTable(table: DataTableSource): StringFilterBuilder;
setFilterColumnIndex(columnIndex: Integer): StringFilterBuilder;
setFilterColumnLabel(columnLabel: string): StringFilterBuilder;
setLabel(label: string): StringFilterBuilder;
setLabelSeparator(labelSeparator: string): StringFilterBuilder;
setLabelStacking(orientation: Orientation): StringFilterBuilder;
setMatchType(matchType: MatchType): StringFilterBuilder;
setRealtimeTrigger(realtimeTrigger: boolean): StringFilterBuilder;
}
@@ -700,7 +592,7 @@ declare namespace GoogleAppsScript {
*
* var chart = chartBuilder.build();
*/
export interface TableChartBuilder {
interface TableChartBuilder {
build(): Chart;
enablePaging(enablePaging: boolean): TableChartBuilder;
enablePaging(pageSize: Integer): TableChartBuilder;
@@ -751,7 +643,7 @@ declare namespace GoogleAppsScript {
* .setDataTable(sampleData)
* .build();
*/
export interface TextStyle {
interface TextStyle {
getColor(): string;
getFontName(): string;
getFontSize(): number;
@@ -769,13 +661,12 @@ declare namespace GoogleAppsScript {
* .setColor('#0000FF').setFontName('Ariel').setFontSize(26);
* var style = textStyleBuilder.build();
*/
export interface TextStyleBuilder {
interface TextStyleBuilder {
build(): TextStyle;
setColor(cssValue: string): TextStyleBuilder;
setFontName(fontName: string): TextStyleBuilder;
setFontSize(fontSize: number): TextStyleBuilder;
}
}
}
types/google-apps-script/google-apps-script.contacts.d.ts
Vendored
+42 -42
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,14 +7,14 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Contacts {
namespace Contacts {
/**
* Address field in a contact.
*/
export interface AddressField {
interface AddressField {
deleteAddressField(): void;
getAddress(): string;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
isPrimary(): boolean;
setAddress(address: string): AddressField;
setAsPrimary(): AddressField;
@@ -25,7 +25,7 @@ declare namespace GoogleAppsScript {
/**
* Company field in a Contact.
*/
export interface CompanyField {
interface CompanyField {
deleteCompanyField(): void;
getCompanyName(): string;
getJobTitle(): string;
@@ -38,47 +38,47 @@ declare namespace GoogleAppsScript {
/**
* A Contact contains the name, address, and various contact details of a contact.
*/
export interface Contact {
addAddress(label: typeof ContactsApp.Field|string, address: string): AddressField;
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;
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;
addUrl(label: typeof ContactsApp.Field | string, url: string): UrlField;
deleteContact(): void;
getAddresses(): AddressField[];
getAddresses(label: typeof ContactsApp.Field|string): AddressField[];
getAddresses(label: typeof ContactsApp.Field | string): AddressField[];
getCompanies(): CompanyField[];
getContactGroups(): ContactGroup[];
getCustomFields(): CustomField[];
getCustomFields(label: typeof ContactsApp.ExtendedField|string): CustomField[];
getCustomFields(label: typeof ContactsApp.ExtendedField | string): CustomField[];
getDates(): DateField[];
getDates(label: typeof ContactsApp.Field|string): DateField[];
getDates(label: typeof ContactsApp.Field | string): DateField[];
getEmails(): EmailField[];
getEmails(label: typeof ContactsApp.Field|string): EmailField[];
getEmails(label: typeof ContactsApp.Field | string): EmailField[];
getFamilyName(): string;
getFullName(): string;
getGivenName(): string;
getIMs(): IMField[];
getIMs(label: typeof ContactsApp.Field|string): IMField[];
getIMs(label: typeof ContactsApp.Field | string): IMField[];
getId(): string;
getInitials(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getMaidenName(): string;
getMiddleName(): string;
getNickname(): string;
getNotes(): string;
getPhones(): PhoneField[];
getPhones(label: typeof ContactsApp.Field|string): 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[];
getUrls(label: typeof ContactsApp.Field | string): UrlField[];
removeFromGroup(group: ContactGroup): Contact;
setFamilyName(familyName: string): Contact;
setFullName(fullName: string): Contact;
@@ -140,7 +140,7 @@ declare namespace GoogleAppsScript {
/**
* A ContactGroup is is a group of contacts.
*/
export interface ContactGroup {
interface ContactGroup {
addContact(contact: Contact): ContactGroup;
deleteGroup(): void;
getContacts(): Contact[];
@@ -159,7 +159,7 @@ declare namespace GoogleAppsScript {
* This class allows users to access their own Google Contacts and create, remove, and update
* contacts listed therein.
*/
export interface ContactsApp {
interface ContactsApp {
ExtendedField: typeof ExtendedField;
Field: typeof Field;
Gender: typeof Gender;
@@ -180,7 +180,7 @@ declare namespace GoogleAppsScript {
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[];
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[];
@@ -213,9 +213,9 @@ declare namespace GoogleAppsScript {
/**
* A custom field in a Contact.
*/
export interface CustomField {
interface CustomField {
deleteCustomField(): void;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
getValue(): any;
setLabel(field: ExtendedField): CustomField;
setLabel(label: string): CustomField;
@@ -229,10 +229,10 @@ declare namespace GoogleAppsScript {
* JavaScript's standard
* Date object.
*/
export interface DateField {
interface DateField {
deleteDateField(): void;
getDay(): Integer;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
getMonth(): Base.Month;
getYear(): Integer;
setDate(month: Base.Month, day: Integer): DateField;
@@ -244,11 +244,11 @@ declare namespace GoogleAppsScript {
/**
* An email field in a Contact.
*/
export interface EmailField {
interface EmailField {
deleteEmailField(): void;
getAddress(): string;
getDisplayName(): string;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
isPrimary(): boolean;
setAddress(address: string): EmailField;
setAsPrimary(): EmailField;
@@ -260,25 +260,26 @@ declare namespace GoogleAppsScript {
/**
* An enum for extended contacts fields.
*/
export enum ExtendedField { HOBBY, MILEAGE, LANGUAGE, GENDER, BILLING_INFORMATION, DIRECTORY_SERVER, SENSITIVITY, PRIORITY, HOME, WORK, USER, OTHER }
enum ExtendedField { HOBBY, MILEAGE, LANGUAGE, GENDER, BILLING_INFORMATION, DIRECTORY_SERVER, SENSITIVITY, PRIORITY, HOME, WORK, USER, OTHER }
/**
* An enum for contacts fields.
*/
export 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 }
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.
*/
export enum Gender { MALE, FEMALE }
enum Gender { MALE, FEMALE }
/**
* An instant messaging field in a Contact.
*/
export interface IMField {
// tslint:disable-next-line: interface-name
interface IMField {
deleteIMField(): void;
getAddress(): string;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
isPrimary(): boolean;
setAddress(address: string): IMField;
setAsPrimary(): IMField;
@@ -289,9 +290,9 @@ declare namespace GoogleAppsScript {
/**
* A phone number field in a Contact.
*/
export interface PhoneField {
interface PhoneField {
deletePhoneField(): void;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
getPhoneNumber(): string;
isPrimary(): boolean;
setAsPrimary(): PhoneField;
@@ -303,27 +304,26 @@ declare namespace GoogleAppsScript {
/**
* An enum for contact priority.
*/
export enum Priority { HIGH, LOW, NORMAL }
enum Priority { HIGH, LOW, NORMAL }
/**
* An enum for contact sensitivity.
*/
export enum Sensitivity { CONFIDENTIAL, NORMAL, PERSONAL, PRIVATE }
enum Sensitivity { CONFIDENTIAL, NORMAL, PERSONAL, PRIVATE }
/**
* A URL field in a Contact.
*/
export interface UrlField {
interface UrlField {
deleteUrlField(): void;
getAddress(): string;
getLabel(): Field|ExtendedField|string;
getLabel(): Field | ExtendedField | string;
isPrimary(): boolean;
setAddress(address: string): UrlField;
setAsPrimary(): UrlField;
setLabel(field: Field): UrlField;
setLabel(label: string): UrlField;
}
}
}
types/google-apps-script/google-apps-script.content.d.ts
Vendored
+5 -6
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2018-07-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Content {
namespace Content {
/**
* Service for returning text content from a script.
*
@@ -16,7 +16,7 @@ declare namespace GoogleAppsScript {
* return ContentService.createTextOutput("Hello World");
* }
*/
export interface ContentService {
interface ContentService {
MimeType: typeof MimeType;
createTextOutput(): TextOutput;
createTextOutput(content: string): TextOutput;
@@ -25,7 +25,7 @@ declare namespace GoogleAppsScript {
/**
* An enum for mime types that can be served from a script.
*/
export enum MimeType { ATOM, CSV, ICAL, JAVASCRIPT, JSON, RSS, TEXT, VCARD, XML }
enum MimeType { ATOM, CSV, ICAL, JAVASCRIPT, JSON, RSS, TEXT, VCARD, XML }
/**
* A TextOutput object that can be served from a script.
@@ -42,7 +42,7 @@ declare namespace GoogleAppsScript {
*
* ContentService
*/
export interface TextOutput {
interface TextOutput {
append(addedContent: string): TextOutput;
clear(): TextOutput;
downloadAsFile(filename: string): TextOutput;
@@ -52,7 +52,6 @@ declare namespace GoogleAppsScript {
setContent(content: string): TextOutput;
setMimeType(mimeType: MimeType): TextOutput;
}
}
}
types/google-apps-script/google-apps-script.data-studio.d.ts
Vendored
+30 -30
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,16 +6,16 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Data_Studio {
namespace Data_Studio {
/**
* An enum that defines the aggregation types that can be set for a Field.
*/
export enum AggregationType { AVG, COUNT, COUNT_DISTINCT, MAX, MIN, SUM, AUTO, NO_AGGREGATION }
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.
*/
export enum AuthType { NONE, OAUTH2, USER_PASS, KEY, USER_TOKEN }
enum AuthType { NONE, OAUTH2, USER_PASS, KEY, USER_TOKEN }
/**
* A configuration object for a native BigQuery connector. Return this object from getData()
@@ -32,7 +32,7 @@ declare namespace GoogleAppsScript {
* .addQueryParameter('dob', types.STRING, '01011990')
* .build();
*/
export interface BigQueryConfig {
interface BigQueryConfig {
addQueryParameter(name: string, type: BigQueryParameterType, value: string): BigQueryConfig;
build(): Config;
printJson(): string;
@@ -45,7 +45,7 @@ declare namespace GoogleAppsScript {
/**
* An enum that defines the BigQuery parameter types that you can set.
*/
export enum BigQueryParameterType { STRING, INT64, BOOL, FLOAT64 }
enum BigQueryParameterType { STRING, INT64, BOOL, FLOAT64 }
/**
* Contains checkbox information for the config. Its properties determine how the checkbox is
@@ -57,7 +57,7 @@ declare namespace GoogleAppsScript {
* .setHelpText("Whether or not https should be used.")
* .setAllowOverride(true);
*/
export interface Checkbox {
interface Checkbox {
setAllowOverride(allowOverride: boolean): Checkbox;
setHelpText(helpText: string): Checkbox;
setId(id: string): Checkbox;
@@ -80,7 +80,7 @@ declare namespace GoogleAppsScript {
* .setAggregation(aggregationType.AVG)
* .setType(fieldType.CURRENCY_USD);
*/
export interface CommunityConnector {
interface CommunityConnector {
AggregationType: typeof AggregationType;
AuthType: typeof AuthType;
BigQueryParameterType: typeof BigQueryParameterType;
@@ -104,7 +104,7 @@ declare namespace GoogleAppsScript {
* .setId("info_id")
* .setHelpText("This connector can connect to multiple data endpoints.");
*/
export interface Config {
interface Config {
build(): Config;
newCheckbox(): Checkbox;
newInfo(): Info;
@@ -120,7 +120,7 @@ declare namespace GoogleAppsScript {
/**
* DataStudioApp allows scripts to interact with developer-oriented features for Data Studio.
*/
export interface DataStudioApp {
interface DataStudioApp {
createCommunityConnector(): CommunityConnector;
}
@@ -133,7 +133,7 @@ declare namespace GoogleAppsScript {
* .setText("This is the debug error text.")
* .throwException();
*/
export interface DebugError {
interface DebugError {
printJson(): string;
setText(text: string): DebugError;
throwException(): void;
@@ -153,7 +153,7 @@ declare namespace GoogleAppsScript {
* .setType(types.YEAR_MONTH)
* .setGroup('DATETIME');
*/
export interface Field {
interface Field {
getAggregation(): AggregationType;
getDescription(): string;
getFormula(): string;
@@ -180,7 +180,7 @@ declare namespace GoogleAppsScript {
/**
* An enum that defines the types that can be set for a Field.
*/
export enum FieldType { YEAR, YEAR_QUARTER, YEAR_MONTH, YEAR_WEEK, YEAR_MONTH_DAY, YEAR_MONTH_DAY_HOUR, 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 }
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
@@ -194,7 +194,7 @@ declare namespace GoogleAppsScript {
* // Set other properties as needed.
* .setId('field1_id');
*/
export interface Fields {
interface Fields {
asArray(): Field[];
build(): any[];
forIds(ids: string[]): Fields;
@@ -220,7 +220,7 @@ declare namespace GoogleAppsScript {
* .build();
* }
*/
export interface GetAuthTypeResponse {
interface GetAuthTypeResponse {
build(): GetAuthTypeResponse;
printJson(): string;
setAuthType(authType: AuthType): GetAuthTypeResponse;
@@ -238,7 +238,7 @@ declare namespace GoogleAppsScript {
* .setId("info1")
* .setText("This text gives some context on the configuration.");
*/
export interface Info {
interface Info {
setId(id: string): Info;
setText(text: string): Info;
}
@@ -264,7 +264,7 @@ declare namespace GoogleAppsScript {
* .addOption(option1)
* .addOption(option2);
*/
export interface OptionBuilder {
interface OptionBuilder {
setLabel(label: string): OptionBuilder;
setValue(value: string): OptionBuilder;
}
@@ -291,7 +291,7 @@ declare namespace GoogleAppsScript {
* .addOption(option1)
* .addOption(option2);
*/
export interface SelectMultiple {
interface SelectMultiple {
addOption(optionBuilder: OptionBuilder): SelectMultiple;
setAllowOverride(allowOverride: boolean): SelectMultiple;
setHelpText(helpText: string): SelectMultiple;
@@ -319,7 +319,7 @@ declare namespace GoogleAppsScript {
* .addOption(option1)
* .addOption(option2);
*/
export interface SelectSingle {
interface SelectSingle {
addOption(optionBuilder: OptionBuilder): SelectSingle;
setAllowOverride(allowOverride: boolean): SelectSingle;
setHelpText(helpText: string): SelectSingle;
@@ -343,7 +343,7 @@ declare namespace GoogleAppsScript {
* .setAllowOverride(true)
* .setPlaceholder("Search for an artist for all songs.");
*/
export interface TextArea {
interface TextArea {
setAllowOverride(allowOverride: boolean): TextArea;
setHelpText(helpText: string): TextArea;
setId(id: string): TextArea;
@@ -365,7 +365,7 @@ declare namespace GoogleAppsScript {
* .setAllowOverride(true)
* .setPlaceholder("Search for an artist for all songs.");
*/
export interface TextInput {
interface TextInput {
setAllowOverride(allowOverride: boolean): TextInput;
setHelpText(helpText: string): TextInput;
setId(id: string): TextInput;
@@ -383,7 +383,7 @@ declare namespace GoogleAppsScript {
* .setDebugText("This text is only shown to admins.")
* .throwException();
*/
export interface UserError {
interface UserError {
printJson(): string;
setDebugText(text: string): UserError;
setText(text: string): UserError;
@@ -392,10 +392,10 @@ declare namespace GoogleAppsScript {
/**
* function getData(request: GoogleAppsScript.Data_Studio.Request<YourConnectorParams>)
*
*
* See https://developers.google.com/datastudio/connector/reference#getdata
*/
export interface Request<T> {
interface Request<T> {
/** 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. */
@@ -415,24 +415,24 @@ declare namespace GoogleAppsScript {
dimensionsFilters: DimensionsFilters[][];
}
export interface DateRange {
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;
}
export interface ScriptParams {
interface ScriptParams {
/** If true, the getData() request is for automatic semantic type detection. */
sampleExtraction?: boolean;
/** 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";
export interface DimensionsFilters {
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. */
types/google-apps-script/google-apps-script.document.d.ts
Vendored
+43 -44
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Document {
namespace Document {
/**
* An enumeration of the element attributes.
*
@@ -23,7 +23,7 @@ declare namespace GoogleAppsScript {
* .insertText(0, 'Hello\n')
* .setAttributes(0, 4, highlightStyle);
*/
export 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 }
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
@@ -39,7 +39,7 @@ declare namespace GoogleAppsScript {
* body.appendParagraph("A paragraph.");
* body.appendPageBreak();
*/
export interface Body {
interface Body {
appendHorizontalRule(): HorizontalRule;
appendImage(image: Base.BlobSource): InlineImage;
appendImage(image: InlineImage): InlineImage;
@@ -125,7 +125,7 @@ declare namespace GoogleAppsScript {
* var bookmark = doc.addBookmark(cursor);
* Logger.log(bookmark.getId());
*/
export interface Bookmark {
interface Bookmark {
getId(): string;
getPosition(): Position;
remove(): void;
@@ -135,7 +135,7 @@ declare namespace GoogleAppsScript {
* A generic element that may contain other elements. All elements that may contain child elements,
* such as Paragraph, inherit from ContainerElement.
*/
export interface ContainerElement {
interface ContainerElement {
asBody(): Body;
asEquation(): Equation;
asFooterSection(): FooterSection;
@@ -185,7 +185,7 @@ declare namespace GoogleAppsScript {
* // Create and open a document.
* doc = DocumentApp.create("Document Title");
*/
export interface Document {
interface Document {
addBookmark(position: Position): Bookmark;
addEditor(emailAddress: string): Document;
addEditor(user: Base.User): Document;
@@ -238,7 +238,7 @@ declare namespace GoogleAppsScript {
* // Create and open a document.
* doc = DocumentApp.create('Document Name');
*/
export interface DocumentApp {
interface DocumentApp {
Attribute: typeof Attribute;
ElementType: typeof ElementType;
/** @deprecated DO NOT USE */
@@ -309,7 +309,7 @@ declare namespace GoogleAppsScript {
* UnsupportedElementAn element representing a region that is unknown or cannot be affected by a script, such as a
* page number.
*/
export interface Element {
interface Element {
asBody(): Body;
asEquation(): Equation;
asEquationFunction(): EquationFunction;
@@ -353,14 +353,14 @@ declare namespace GoogleAppsScript {
* firstChild.asParagraph().setHeading(DocumentApp.ParagraphHeading.HEADING1);
* }
*/
export enum ElementType { BODY_SECTION, COMMENT_SECTION, 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, TABLE, TABLE_CELL, TABLE_OF_CONTENTS, TABLE_ROW, TEXT, UNSUPPORTED }
enum ElementType { BODY_SECTION, COMMENT_SECTION, 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, 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.
*/
export interface Equation {
interface Equation {
clear(): Equation;
copy(): Equation;
editAsText(): Text;
@@ -392,7 +392,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface EquationFunction {
interface EquationFunction {
clear(): EquationFunction;
copy(): EquationFunction;
editAsText(): Text;
@@ -426,7 +426,7 @@ declare namespace GoogleAppsScript {
* document structure, see the guide to
* extending Google Docs.
*/
export interface EquationFunctionArgumentSeparator {
interface EquationFunctionArgumentSeparator {
copy(): EquationFunctionArgumentSeparator;
getAttributes(): any;
getNextSibling(): Element;
@@ -443,7 +443,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface EquationSymbol {
interface EquationSymbol {
copy(): EquationSymbol;
getAttributes(): any;
getCode(): string;
@@ -484,13 +484,13 @@ declare namespace GoogleAppsScript {
* var b = a + text.length - 1;
* body.editAsText().setFontFamily(a, b, DocumentApp.FontFamily.COMIC_SANS_MS);
*/
export 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 }
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.
*/
export interface FooterSection {
interface FooterSection {
appendHorizontalRule(): HorizontalRule;
appendImage(image: Base.BlobSource): InlineImage;
appendImage(image: InlineImage): InlineImage;
@@ -557,7 +557,7 @@ declare namespace GoogleAppsScript {
* document structure, see the guide to
* extending Google Docs.
*/
export interface Footnote {
interface Footnote {
copy(): Footnote;
getAttributes(): any;
getFootnoteContents(): FootnoteSection;
@@ -575,7 +575,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface FootnoteSection {
interface FootnoteSection {
appendParagraph(paragraph: Paragraph): Paragraph;
appendParagraph(text: string): Paragraph;
clear(): FootnoteSection;
@@ -629,13 +629,13 @@ declare namespace GoogleAppsScript {
* body.appendListItem("Item 2").setNestingLevel(1).setIndentStart(72)
* .setGlyphType(DocumentApp.GlyphType.SQUARE_BULLET);
*/
export enum GlyphType { BULLET, HOLLOW_BULLET, SQUARE_BULLET, NUMBER, LATIN_UPPER, LATIN_LOWER, ROMAN_UPPER, ROMAN_LOWER }
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.
*/
export interface HeaderSection {
interface HeaderSection {
appendHorizontalRule(): HorizontalRule;
appendImage(image: Base.BlobSource): InlineImage;
appendImage(image: InlineImage): InlineImage;
@@ -717,14 +717,14 @@ declare namespace GoogleAppsScript {
* // Right align the second cell.
* par3.setAlignment(DocumentApp.HorizontalAlignment.RIGHT);
*/
export enum HorizontalAlignment { LEFT, CENTER, RIGHT, JUSTIFY }
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.
*/
export interface HorizontalRule {
interface HorizontalRule {
copy(): HorizontalRule;
getAttributes(): any;
getNextSibling(): Element;
@@ -742,7 +742,7 @@ declare namespace GoogleAppsScript {
* a FootnoteSection. An InlineDrawing cannot itself contain any other element. For
* more information on document structure, see the guide to extending Google Docs.
*/
export interface InlineDrawing {
interface InlineDrawing {
copy(): InlineDrawing;
getAltDescription(): string;
getAltTitle(): string;
@@ -765,7 +765,7 @@ declare namespace GoogleAppsScript {
* a FootnoteSection. An InlineImage cannot itself contain any other element. For
* more information on document structure, see the guide to extending Google Docs.
*/
export interface InlineImage {
interface InlineImage {
copy(): InlineImage;
getAltDescription(): string;
getAltTitle(): string;
@@ -821,7 +821,7 @@ declare namespace GoogleAppsScript {
* var item2 = body.appendListItem('Item 2');
* item2.setListId(item1);
*/
export interface ListItem {
interface ListItem {
addPositionedImage(image: Base.BlobSource): PositionedImage;
appendHorizontalRule(): HorizontalRule;
appendInlineImage(image: Base.BlobSource): InlineImage;
@@ -911,7 +911,7 @@ declare namespace GoogleAppsScript {
* }
* doc.addNamedRange('myUniquePrefix-tables', rangeBuilder.build());
*/
export interface NamedRange {
interface NamedRange {
getId(): string;
getName(): string;
getRange(): Range;
@@ -924,7 +924,7 @@ declare namespace GoogleAppsScript {
* see the guide to extending Google
* Docs.
*/
export interface PageBreak {
interface PageBreak {
copy(): PageBreak;
getAttributes(): any;
getNextSibling(): Element;
@@ -956,7 +956,7 @@ declare namespace GoogleAppsScript {
* // Append a regular paragraph.
* body.appendParagraph("This is a typical paragraph.");
*/
export interface Paragraph {
interface Paragraph {
addPositionedImage(image: Base.BlobSource): PositionedImage;
appendHorizontalRule(): HorizontalRule;
appendInlineImage(image: Base.BlobSource): InlineImage;
@@ -1041,7 +1041,7 @@ declare namespace GoogleAppsScript {
* var par3 = body.appendParagraph("Text");
* par3.setHeading(DocumentApp.ParagraphHeading.NORMAL);
*/
export enum ParagraphHeading { NORMAL, HEADING1, HEADING2, HEADING3, HEADING4, HEADING5, HEADING6, TITLE, SUBTITLE }
enum ParagraphHeading { NORMAL, HEADING1, HEADING2, HEADING3, HEADING4, HEADING5, HEADING6, TITLE, SUBTITLE }
/**
* A reference to a location in the document, relative to a specific element. The user's cursor is
@@ -1063,7 +1063,7 @@ declare namespace GoogleAppsScript {
* DocumentApp.getUi().alert('Cannot find a cursor.');
* }
*/
export interface Position {
interface Position {
getElement(): Element;
getOffset(): Integer;
getSurroundingText(): Text;
@@ -1093,7 +1093,7 @@ declare namespace GoogleAppsScript {
* .setTopOffset(60)
* .setLeftOffset(40);
*/
export interface PositionedImage {
interface PositionedImage {
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
getHeight(): Integer;
@@ -1114,7 +1114,7 @@ declare namespace GoogleAppsScript {
* An enumeration that specifies how to lay out a PositionedImage in relation to surrounding
* text.
*/
export enum PositionedLayout { ABOVE_TEXT, BREAK_BOTH, BREAK_LEFT, BREAK_RIGHT, WRAP_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
@@ -1142,7 +1142,7 @@ declare namespace GoogleAppsScript {
* }
* }
*/
export interface Range {
interface Range {
getRangeElements(): RangeElement[];
/** @deprecated DO NOT USE */
getSelectedElements(): RangeElement[];
@@ -1160,7 +1160,7 @@ declare namespace GoogleAppsScript {
* }
* doc.setSelection(rangeBuilder.build());
*/
export interface RangeBuilder {
interface RangeBuilder {
addElement(element: Element): RangeBuilder;
addElement(textElement: Text, startOffset: Integer, endOffsetInclusive: Integer): RangeBuilder;
addElementsBetween(startElement: Element, endElementInclusive: Element): RangeBuilder;
@@ -1177,7 +1177,7 @@ declare namespace GoogleAppsScript {
* range of characters within a Text
* element to be represented in search results, document selections, and named ranges.
*/
export interface RangeElement {
interface RangeElement {
getElement(): Element;
getEndOffsetInclusive(): Integer;
getStartOffset(): Integer;
@@ -1202,7 +1202,7 @@ declare namespace GoogleAppsScript {
* // Build a table from the array.
* body.appendTable(cells);
*/
export interface Table {
interface Table {
appendTableRow(): TableRow;
appendTableRow(tableRow: TableRow): TableRow;
clear(): Table;
@@ -1248,7 +1248,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface TableCell {
interface TableCell {
appendHorizontalRule(): HorizontalRule;
appendImage(image: Base.BlobSource): InlineImage;
appendImage(image: InlineImage): InlineImage;
@@ -1321,7 +1321,7 @@ declare namespace GoogleAppsScript {
* document structure, see the guide to
* extending Google Docs.
*/
export interface TableOfContents {
interface TableOfContents {
clear(): TableOfContents;
copy(): TableOfContents;
editAsText(): Text;
@@ -1353,7 +1353,7 @@ declare namespace GoogleAppsScript {
* structure, see the guide to extending
* Google Docs.
*/
export interface TableRow {
interface TableRow {
appendTableCell(): TableCell;
appendTableCell(textContents: string): TableCell;
appendTableCell(tableCell: TableCell): TableCell;
@@ -1415,7 +1415,7 @@ declare namespace GoogleAppsScript {
* // Make the first half of the document blue.
* text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');
*/
export interface Text {
interface Text {
appendText(text: string): Text;
copy(): Text;
deleteText(startOffset: Integer, endOffsetInclusive: Integer): Text;
@@ -1487,13 +1487,13 @@ declare namespace GoogleAppsScript {
* var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
* text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);
*/
export enum TextAlignment { NORMAL, SUPERSCRIPT, SUBSCRIPT }
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.
*/
export interface UnsupportedElement {
interface UnsupportedElement {
copy(): UnsupportedElement;
getAttributes(): any;
getNextSibling(): Element;
@@ -1525,8 +1525,7 @@ declare namespace GoogleAppsScript {
* // Align the third cell's contents to the bottom.
* table.getCell(0, 2).setVerticalAlignment(DocumentApp.VerticalAlignment.BOTTOM);
*/
export enum VerticalAlignment { BOTTOM, CENTER, TOP }
enum VerticalAlignment { BOTTOM, CENTER, TOP }
}
}
types/google-apps-script/google-apps-script.drive.d.ts
Vendored
+14 -14
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2018-07-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Drive {
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.
@@ -17,7 +17,7 @@ declare namespace GoogleAppsScript {
* var folder = DriveApp.createFolder('Shared Folder');
* folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
*/
export enum Access { ANYONE, ANYONE_WITH_LINK, DOMAIN, DOMAIN_WITH_LINK, PRIVATE }
enum Access { ANYONE, ANYONE_WITH_LINK, DOMAIN, DOMAIN_WITH_LINK, PRIVATE }
/**
* Allows scripts to create, find, and modify files and folders in Google Drive.
@@ -29,7 +29,7 @@ declare namespace GoogleAppsScript {
* Logger.log(file.getName());
* }
*/
export interface DriveApp {
interface DriveApp {
Access: typeof Access;
Permission: typeof Permission;
/**
@@ -145,7 +145,7 @@ declare namespace GoogleAppsScript {
* }
* }
*/
export interface File {
interface File {
addCommenter(emailAddress: string): File;
addCommenter(user: Base.User): File;
addCommenters(emailAddresses: string[]): File;
@@ -159,12 +159,12 @@ declare namespace GoogleAppsScript {
getAccess(user: Base.User): Permission;
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
getDateCreated(): Date;
getDateCreated(): Base.Date;
getDescription(): string;
getDownloadUrl(): string;
getEditors(): User[];
getId(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getMimeType(): string;
getName(): string;
getOwner(): User;
@@ -212,7 +212,7 @@ declare namespace GoogleAppsScript {
* Logger.log(file.getName());
* }
*/
export interface FileIterator {
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
@@ -238,7 +238,7 @@ declare namespace GoogleAppsScript {
* Logger.log(folder.getName());
* }
*/
export interface Folder {
interface Folder {
addEditor(emailAddress: string): Folder;
addEditor(user: Base.User): Folder;
addEditors(emailAddresses: string[]): Folder;
@@ -253,7 +253,7 @@ declare namespace GoogleAppsScript {
createFolder(name: string): Folder;
getAccess(email: string): Permission;
getAccess(user: Base.User): Permission;
getDateCreated(): Date;
getDateCreated(): Base.Date;
getDescription(): string;
getEditors(): User[];
getFiles(): FileIterator;
@@ -262,7 +262,7 @@ declare namespace GoogleAppsScript {
getFolders(): FolderIterator;
getFoldersByName(name: string): FolderIterator;
getId(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getName(): string;
getOwner(): User;
getParents(): FolderIterator;
@@ -305,7 +305,7 @@ declare namespace GoogleAppsScript {
* Logger.log(folder.getName());
* }
*/
export interface FolderIterator {
interface FolderIterator {
getContinuationToken(): string;
hasNext(): boolean;
next(): Folder;
@@ -321,7 +321,7 @@ declare namespace GoogleAppsScript {
* var folder = DriveApp.createFolder('Shared Folder');
* folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
*/
export enum Permission { VIEW, EDIT, COMMENT, OWNER, ORGANIZER, NONE }
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.
@@ -333,7 +333,7 @@ declare namespace GoogleAppsScript {
* Logger.log(editors[i].getEmail());
* }
*/
export interface User {
interface User {
/** Gets the domain name associated with the user's account. */
getDomain(): string;
/**
types/google-apps-script/google-apps-script.forms.d.ts
Vendored
+54 -47
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Forms {
namespace Forms {
/**
* An enum representing the supported types of image alignment. Alignment types can be accessed from
* FormApp.Alignment.
@@ -19,7 +19,7 @@ declare namespace GoogleAppsScript {
* .setImage(img)
* .setAlignment(FormApp.Alignment.CENTER);
*/
export enum Alignment { LEFT, CENTER, RIGHT }
enum Alignment { LEFT, CENTER, RIGHT }
/**
* A question item, presented as a grid of columns and rows, that allows the respondent to select
@@ -33,7 +33,7 @@ declare namespace GoogleAppsScript {
* .setRows(['New York', 'San Francisco', 'London'])
* .setColumns(['2014', '2015', '2016', '2017']);
*/
export interface CheckboxGridItem {
interface CheckboxGridItem {
clearValidation(): CheckboxGridItem;
createResponse(responses: string[][]): ItemResponse;
duplicate(): CheckboxGridItem;
@@ -67,7 +67,9 @@ declare namespace GoogleAppsScript {
* .build();
* checkboxGridItem.setValidation(checkboxGridValidation);
*/
export interface CheckboxGridValidation {
// tslint:disable-next-line: no-empty-interface
interface CheckboxGridValidation {
// TODO: no-empty-interface
}
/**
@@ -84,7 +86,7 @@ declare namespace GoogleAppsScript {
* .build();
* checkboxGridItem.setValidation(checkboxGridValidation);
*/
export interface CheckboxGridValidationBuilder {
interface CheckboxGridValidationBuilder {
requireLimitOneResponsePerColumn(): CheckboxGridValidationBuilder;
}
@@ -104,7 +106,7 @@ declare namespace GoogleAppsScript {
* ])
* .showOtherOption(true);
*/
export interface CheckboxItem {
interface CheckboxItem {
clearValidation(): CheckboxItem;
createChoice(value: string): Choice;
createChoice(value: string, isCorrect: boolean): Choice;
@@ -150,11 +152,11 @@ declare namespace GoogleAppsScript {
* .build();
* checkBoxItem.setValidation(checkBoxValidation);
*/
export interface CheckboxValidation {
requireSelectAtLeast(number: Integer): CheckboxValidation;
requireSelectAtMost(number: Integer): CheckboxValidation;
requireSelectExactly(number: Integer): CheckboxValidation;
}
interface CheckboxValidation {
requireSelectAtLeast(number: Integer): CheckboxValidation;
requireSelectAtMost(number: Integer): CheckboxValidation;
requireSelectExactly(number: Integer): CheckboxValidation;
}
/**
* A DataValidationBuilder for a CheckboxValidation.
@@ -173,7 +175,7 @@ declare namespace GoogleAppsScript {
* .build();
* checkBoxItem.setValidation(checkBoxValidation);
*/
export interface CheckboxValidationBuilder {
interface CheckboxValidationBuilder {
requireSelectAtLeast(number: Integer): CheckboxValidationBuilder;
requireSelectAtMost(number: Integer): CheckboxValidationBuilder;
requireSelectExactly(number: Integer): CheckboxValidationBuilder;
@@ -202,7 +204,7 @@ declare namespace GoogleAppsScript {
* choices[i].getPageNavigationType());
* }
*/
export interface Choice {
interface Choice {
getGotoPage(): PageBreakItem;
getPageNavigationType(): PageNavigationType;
getValue(): string;
@@ -218,7 +220,7 @@ declare namespace GoogleAppsScript {
* var item = form.addDateItem();
* item.setTitle('When were you born?');
*/
export interface DateItem {
interface DateItem {
createResponse(response: Base.Date): ItemResponse;
duplicate(): DateItem;
getGeneralFeedback(): QuizFeedback;
@@ -247,7 +249,7 @@ declare namespace GoogleAppsScript {
* var item = form.addDateTimeItem();
* item.setTitle('When do you want to meet?');
*/
export interface DateTimeItem {
interface DateTimeItem {
createResponse(response: Base.Date): ItemResponse;
duplicate(): DateTimeItem;
getGeneralFeedback(): QuizFeedback;
@@ -279,7 +281,7 @@ declare namespace GoogleAppsScript {
* // Update the form's response destination.
* form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());
*/
export enum DestinationType { SPREADSHEET }
enum DestinationType { SPREADSHEET }
/**
* A question item that allows the respondent to indicate a length of time. Items can be accessed or
@@ -290,7 +292,7 @@ declare namespace GoogleAppsScript {
* var item = form.addDurationItem();
* item.setTitle('How long can you hold your breath?');
*/
export interface DurationItem {
interface DurationItem {
createResponse(hours: Integer, minutes: Integer, seconds: Integer): ItemResponse;
duplicate(): DurationItem;
getGeneralFeedback(): QuizFeedback;
@@ -323,7 +325,7 @@ declare namespace GoogleAppsScript {
* item.setFeedbackForCorrect(
* FormApp.createFeedback().setDisplayText("Dogs rule, cats drool.").build());
*/
export enum FeedbackType { CORRECT, INCORRECT, GENERAL }
enum FeedbackType { CORRECT, INCORRECT, GENERAL }
/**
* A form that contains overall properties and items. Properties include title, settings, and where
@@ -344,7 +346,7 @@ declare namespace GoogleAppsScript {
* // Update the form's response destination.
* form.setDestination(FormApp.DestinationType.SPREADSHEET, ss.getId());
*/
export interface Form {
interface Form {
addCheckboxGridItem(): CheckboxGridItem;
addCheckboxItem(): CheckboxItem;
addDateItem(): DateItem;
@@ -429,7 +431,7 @@ declare namespace GoogleAppsScript {
* // Create and open a form.
* var newForm = FormApp.create('Form Name');
*/
export interface FormApp {
interface FormApp {
Alignment: typeof Alignment;
DestinationType: typeof DestinationType;
FeedbackType: typeof FeedbackType;
@@ -469,7 +471,7 @@ declare namespace GoogleAppsScript {
* }
* }
*/
export interface FormResponse {
interface FormResponse {
getEditResponseUrl(): string;
getGradableItemResponses(): ItemResponse[];
getGradableResponseForItem(item: Item): ItemResponse;
@@ -496,7 +498,7 @@ declare namespace GoogleAppsScript {
* .setRows(['Cars', 'Computers', 'Celebrities'])
* .setColumns(['Boring', 'So-so', 'Interesting']);
*/
export interface GridItem {
interface GridItem {
clearValidation(): GridItem;
createResponse(responses: string[]): ItemResponse;
duplicate(): GridItem;
@@ -530,7 +532,9 @@ declare namespace GoogleAppsScript {
* .build();
* gridItem.setValidation(gridValidation);
*/
export interface GridValidation {
// tslint:disable-next-line: no-empty-interface
interface GridValidation {
// TODO: no-empty-interface
}
/**
@@ -547,7 +551,7 @@ declare namespace GoogleAppsScript {
* .build();
* gridItem.setValidation(gridValidation);
*/
export interface GridValidationBuilder {
interface GridValidationBuilder {
requireLimitOneResponsePerColumn(): GridValidationBuilder;
}
@@ -562,7 +566,7 @@ declare namespace GoogleAppsScript {
* .setHelpText('Google Logo') // The help text is the image description
* .setImage(img);
*/
export interface ImageItem {
interface ImageItem {
duplicate(): ImageItem;
getAlignment(): Alignment;
getHelpText(): string;
@@ -604,7 +608,7 @@ declare namespace GoogleAppsScript {
*
* NameBrief description
*/
export interface Item {
interface Item {
asCheckboxGridItem(): CheckboxGridItem;
asCheckboxItem(): CheckboxItem;
asDateItem(): DateItem;
@@ -649,10 +653,10 @@ declare namespace GoogleAppsScript {
* }
* }
*/
export interface ItemResponse {
interface ItemResponse {
getFeedback(): QuizFeedback;
getItem(): Item;
getResponse(): string[][]|string[]|string;
getResponse(): string[][] | string[] | string;
getScore(): number;
setFeedback(feedback: any): ItemResponse;
setScore(score: any): ItemResponse;
@@ -671,7 +675,7 @@ declare namespace GoogleAppsScript {
* item.setHelpText('Description of new section.');
* }
*/
export enum ItemType { CHECKBOX, CHECKBOX_GRID, DATE, DATETIME, DURATION, GRID, IMAGE, LIST, MULTIPLE_CHOICE, PAGE_BREAK, PARAGRAPH_TEXT, SCALE, SECTION_HEADER, TEXT, TIME, VIDEO }
enum ItemType { CHECKBOX, CHECKBOX_GRID, DATE, DATETIME, DURATION, GRID, IMAGE, LIST, MULTIPLE_CHOICE, PAGE_BREAK, PARAGRAPH_TEXT, SCALE, SECTION_HEADER, TEXT, TIME, VIDEO }
/**
* A question item that allows the respondent to select one choice from a drop-down list. Items can
@@ -686,7 +690,7 @@ declare namespace GoogleAppsScript {
* item.createChoice('Dogs')
* ]);
*/
export interface ListItem {
interface ListItem {
createChoice(value: string): Choice;
createChoice(value: string, isCorrect: boolean): Choice;
createChoice(value: string, navigationItem: PageBreakItem): Choice;
@@ -728,7 +732,7 @@ declare namespace GoogleAppsScript {
* ])
* .showOtherOption(true);
*/
export interface MultipleChoiceItem {
interface MultipleChoiceItem {
createChoice(value: string): Choice;
createChoice(value: string, isCorrect: boolean): Choice;
createChoice(value: string, navigationItem: PageBreakItem): Choice;
@@ -769,7 +773,7 @@ declare namespace GoogleAppsScript {
* 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
*/
export interface PageBreakItem {
interface PageBreakItem {
duplicate(): PageBreakItem;
getGoToPage(): PageBreakItem;
getHelpText(): string;
@@ -811,7 +815,7 @@ declare namespace GoogleAppsScript {
* var otherChoice = item.createChoice('Strawberry', FormApp.PageNavigationType.CONTINUE);
* item.setChoices([rightChoice, wrongChoice, iffyChoice, otherChoice]);
*/
export enum PageNavigationType { CONTINUE, GO_TO_PAGE, RESTART, SUBMIT }
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
@@ -822,7 +826,7 @@ declare namespace GoogleAppsScript {
* var item = form.addParagraphTextItem();
* item.setTitle('What is your address?');
*/
export interface ParagraphTextItem {
interface ParagraphTextItem {
clearValidation(): ParagraphTextItem;
createResponse(response: string): ItemResponse;
duplicate(): ParagraphTextItem;
@@ -852,7 +856,9 @@ declare namespace GoogleAppsScript {
* .requireTextLengthGreatherThan(100);
* paragraphTextItem.setValidation(paragraphtextValidation);
*/
export interface ParagraphTextValidation {
// tslint:disable-next-line: no-empty-interface
interface ParagraphTextValidation {
// TODO: no-empty-interface
}
/**
@@ -865,7 +871,7 @@ declare namespace GoogleAppsScript {
* .requireTextLengthGreatherThan(100);
* paragraphTextItem.setValidation(paragraphtextValidation);
*/
export interface ParagraphTextValidationBuilder {
interface ParagraphTextValidationBuilder {
requireTextContainsPattern(pattern: string): ParagraphTextValidationBuilder;
requireTextDoesNotContainPattern(pattern: string): ParagraphTextValidationBuilder;
requireTextDoesNotMatchPattern(pattern: string): ParagraphTextValidationBuilder;
@@ -889,7 +895,7 @@ declare namespace GoogleAppsScript {
* .addLink("http://wikipedia.com/osmosis");
* textItem.setFeedbackForIncorrect(feedback);
*/
export interface QuizFeedback {
interface QuizFeedback {
getLinkUrls(): string[];
getText(): string;
}
@@ -908,7 +914,7 @@ declare namespace GoogleAppsScript {
* // Add feedback which will be shown for correct responses; ie "Dogs".
* item.setFeedbackForCorrect(FormApp.createFeedback().setText("Dogs rule, cats drool.").build());
*/
export interface QuizFeedbackBuilder {
interface QuizFeedbackBuilder {
addLink(url: string): QuizFeedbackBuilder;
addLink(url: string, displayText: string): QuizFeedbackBuilder;
build(): QuizFeedback;
@@ -927,7 +933,7 @@ declare namespace GoogleAppsScript {
* item.setTitle('Pick a number between 1 and 10')
* .setBounds(1, 10);
*/
export interface ScaleItem {
interface ScaleItem {
createResponse(response: Integer): ItemResponse;
duplicate(): ScaleItem;
getGeneralFeedback(): QuizFeedback;
@@ -960,7 +966,7 @@ declare namespace GoogleAppsScript {
* var item = form.addSectionHeaderItem();
* item.setTitle('Title of new section');
*/
export interface SectionHeaderItem {
interface SectionHeaderItem {
duplicate(): SectionHeaderItem;
getHelpText(): string;
getId(): Integer;
@@ -980,7 +986,7 @@ declare namespace GoogleAppsScript {
* var item = form.addTextItem();
* item.setTitle('What is your name?');
*/
export interface TextItem {
interface TextItem {
clearValidation(): TextItem;
createResponse(response: string): ItemResponse;
duplicate(): TextItem;
@@ -1011,7 +1017,9 @@ declare namespace GoogleAppsScript {
* .build();
* textItem.setValidation(textValidation);
*/
export interface TextValidation {
// tslint:disable-next-line: no-empty-interface
interface TextValidation {
// TODO: no-empty-interface
}
/**
@@ -1024,7 +1032,7 @@ declare namespace GoogleAppsScript {
* .requireNumberBetween(1, 100);
* textItem.setValidation(textValidation);
*/
export interface TextValidationBuilder {
interface TextValidationBuilder {
requireNumber(): TextValidationBuilder;
requireNumberBetween(start: number, end: number): TextValidationBuilder;
requireNumberEqualTo(number: number): TextValidationBuilder;
@@ -1054,7 +1062,7 @@ declare namespace GoogleAppsScript {
* var item = form.addTimeItem();
* item.setTitle('What time do you usually wake up in the morning?');
*/
export interface TimeItem {
interface TimeItem {
createResponse(hour: Integer, minute: Integer): ItemResponse;
duplicate(): TimeItem;
getGeneralFeedback(): QuizFeedback;
@@ -1093,7 +1101,7 @@ declare namespace GoogleAppsScript {
* .setHelpText('Video Caption')
* .setVideoUrl('1234abcdxyz');
*/
export interface VideoItem {
interface VideoItem {
duplicate(): VideoItem;
getAlignment(): Alignment;
getHelpText(): string;
@@ -1108,7 +1116,6 @@ declare namespace GoogleAppsScript {
setVideoUrl(youtubeUrl: string): VideoItem;
setWidth(width: Integer): VideoItem;
}
}
}
types/google-apps-script/google-apps-script.gmail.d.ts
Vendored
+13 -13
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,11 +7,11 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Gmail {
namespace Gmail {
/**
* Provides access to Gmail threads, messages, and labels.
*/
export interface GmailApp {
interface GmailApp {
createDraft(recipient: string, subject: string, body: string): GmailDraft;
createDraft(recipient: string, subject: string, body: string, options: GmailAdvancedOptions): GmailDraft;
createLabel(name: string): GmailLabel;
@@ -96,7 +96,7 @@ declare namespace GoogleAppsScript {
* }
* }
*/
export interface GmailAttachment {
interface GmailAttachment {
copyBlob(): Base.Blob;
getAs(contentType: string): Base.Blob;
getBytes(): Byte[];
@@ -120,7 +120,7 @@ declare namespace GoogleAppsScript {
/**
* A user-created draft message in a user's Gmail account.
*/
export interface GmailDraft {
interface GmailDraft {
/**
* Deletes this draft message.
*/
@@ -154,7 +154,7 @@ declare namespace GoogleAppsScript {
/**
* Options for a Gmail draft.
*/
export type GmailAdvancedOptions = {
interface GmailAdvancedOptions {
/**
* An array of files to send with the email.
*/
@@ -189,12 +189,12 @@ declare namespace GoogleAppsScript {
replyTo?: string;
}
/** alias to GmailAdvancedOptions */
export type GmailDraftOptions = GmailAdvancedOptions;
type GmailDraftOptions = GmailAdvancedOptions;
/**
* Options for a Gmail Attachments.
*/
export type GmailAttachmentOptions = {
interface GmailAttachmentOptions {
/**
* If the returned array of Blob attachments should include inline images.
*/
@@ -211,7 +211,7 @@ declare namespace GoogleAppsScript {
/**
* A user-created label in a user's Gmail account.
*/
export interface GmailLabel {
interface GmailLabel {
addToThread(thread: GmailThread): GmailLabel;
addToThreads(threads: GmailThread[]): GmailLabel;
deleteLabel(): void;
@@ -226,7 +226,7 @@ declare namespace GoogleAppsScript {
/**
* A message in a user's Gmail account.
*/
export interface GmailMessage {
interface GmailMessage {
createDraftReply(body: string): GmailDraft;
createDraftReply(body: string, options: GmailAdvancedOptions): GmailDraft;
createDraftReplyAll(body: string): GmailDraft;
@@ -238,7 +238,7 @@ declare namespace GoogleAppsScript {
getBcc(): string;
getBody(): string;
getCc(): string;
getDate(): Date;
getDate(): Base.Date;
getFrom(): string;
getHeader(name: string): string;
getId(): string;
@@ -270,7 +270,7 @@ declare namespace GoogleAppsScript {
/**
* A thread in a user's Gmail account.
*/
export interface GmailThread {
interface GmailThread {
addLabel(label: GmailLabel): GmailThread;
createDraftReply(body: string): GmailDraft;
createDraftReply(body: string, options: GmailAdvancedOptions): GmailDraft;
@@ -279,7 +279,7 @@ declare namespace GoogleAppsScript {
getFirstMessageSubject(): string;
getId(): string;
getLabels(): GmailLabel[];
getLastMessageDate(): Date;
getLastMessageDate(): Base.Date;
getMessageCount(): Integer;
getMessages(): GmailMessage[];
getPermalink(): string;
types/google-apps-script/google-apps-script.groups.d.ts
Vendored
+6 -6
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-08-09
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Groups {
namespace Groups {
/**
* A group object whose members and those members' roles within the group can be queried.
*
@@ -25,11 +25,12 @@ declare namespace GoogleAppsScript {
* Logger.log(str);
* }
*/
export interface Group {
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;
@@ -46,7 +47,7 @@ declare namespace GoogleAppsScript {
* var groups = GroupsApp.getGroups();
* Logger.log('You belong to ' + groups.length + ' groups.');
*/
export interface GroupsApp {
interface GroupsApp {
Role: typeof Role;
getGroupByEmail(email: string): Group;
getGroups(): Group[];
@@ -59,8 +60,7 @@ declare namespace GoogleAppsScript {
*
* Group.getRole(email)
*/
export enum Role { OWNER, MANAGER, MEMBER, INVITED, PENDING }
enum Role { OWNER, MANAGER, MEMBER, INVITED, PENDING }
}
}
types/google-apps-script/google-apps-script.html.d.ts
Vendored
+8 -9
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2018-07-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module HTML {
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
@@ -21,7 +21,7 @@ declare namespace GoogleAppsScript {
* Google Caja
* guide to restrictions in HTML service
*/
export interface HtmlOutput {
interface HtmlOutput {
addMetaTag(name: string, content: string): HtmlOutput;
append(addedContent: string): HtmlOutput;
appendUntrusted(addedContent: string): HtmlOutput;
@@ -53,7 +53,7 @@ declare namespace GoogleAppsScript {
* var tags = output.getMetaTags();
* Logger.log('<meta name="%s" content="%s"/>', tags[0].getName(), tags[0].getContent());
*/
export interface HtmlOutputMetaTag {
interface HtmlOutputMetaTag {
getContent(): string;
getName(): string;
}
@@ -65,7 +65,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface HtmlService {
interface HtmlService {
SandboxMode: typeof SandboxMode;
XFrameOptionsMode: typeof XFrameOptionsMode;
createHtmlOutput(): HtmlOutput;
@@ -81,7 +81,7 @@ declare namespace GoogleAppsScript {
/**
* A template object for dynamically constructing HTML. For more information, see the guide to templates.
*/
export interface HtmlTemplate {
interface HtmlTemplate {
evaluate(): HtmlOutput;
getCode(): string;
getCodeWithComments(): string;
@@ -114,7 +114,7 @@ declare namespace GoogleAppsScript {
* alert(google.script.sandbox.mode);
* </script>
*/
export enum SandboxMode { EMULATED, IFRAME, NATIVE }
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,
@@ -130,8 +130,7 @@ declare namespace GoogleAppsScript {
* var output = HtmlService.createHtmlOutput('<b>Hello, world!</b>');
* output.setXFrameOptionsMode(HtmlService.XFrameOptionsMode.ALLOWALL);
*/
export enum XFrameOptionsMode { ALLOWALL, DEFAULT }
enum XFrameOptionsMode { ALLOWALL, DEFAULT }
}
}
types/google-apps-script/google-apps-script.jdbc.d.ts
Vendored
+24 -25
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,9 +7,9 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module JDBC {
namespace JDBC {
/** JdbcAdvancedParameters */
export type CloudSqlAdvancedParameters = {
interface CloudSqlAdvancedParameters {
/** connection timeout in seconds */
connectTimeoutSeconds?: Integer;
/** the database to connect to */
@@ -24,7 +24,7 @@ declare namespace GoogleAppsScript {
user?: string;
}
/** JdbcAdvancedParameters */
export type ConnectionAdvancedParameters = {
interface ConnectionAdvancedParameters {
/** the database to connect to */
databaseName?: string;
/** the user's password */
@@ -44,7 +44,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface Jdbc {
interface Jdbc {
getCloudSqlConnection(url: string): JdbcConnection;
getCloudSqlConnection(url: string, info: CloudSqlAdvancedParameters): JdbcConnection;
getCloudSqlConnection(url: string, userName: string, password: string): JdbcConnection;
@@ -63,7 +63,7 @@ declare namespace GoogleAppsScript {
* A JDBC Array. For documentation of this class, see java.sql.Array
* .
*/
export interface JdbcArray {
interface JdbcArray {
free(): void;
getArray(): any;
getArray(index: Integer, count: Integer): any;
@@ -77,7 +77,7 @@ declare namespace GoogleAppsScript {
* A JDBC Blob. For documentation of this class, see java.sql.Blob
* .
*/
export interface JdbcBlob {
interface JdbcBlob {
free(): void;
getAppsScriptBlob(): Base.Blob;
getAs(contentType: string): Base.Blob;
@@ -96,7 +96,7 @@ declare namespace GoogleAppsScript {
* A JDBC CallableStatement. For documentation of this class, see
* java.sql.CallableStatement.
*/
export interface JdbcCallableStatement {
interface JdbcCallableStatement {
addBatch(): void;
addBatch(sql: string): void;
cancel(): void;
@@ -267,7 +267,7 @@ declare namespace GoogleAppsScript {
* A JDBC Clob. For documentation of this class, see java.sql.Clob
* .
*/
export interface JdbcClob {
interface JdbcClob {
free(): void;
getAppsScriptBlob(): Base.Blob;
getAs(contentType: string): Base.Blob;
@@ -286,7 +286,7 @@ declare namespace GoogleAppsScript {
* A JDBC Connection. For documentation of this class, see
* java.sql.Connection.
*/
export interface JdbcConnection {
interface JdbcConnection {
clearWarnings(): void;
close(): void;
commit(): void;
@@ -334,7 +334,7 @@ declare namespace GoogleAppsScript {
* A JDBC database metadata object. For documentation of this class, see
* java.sql.DatabaseMetaData.
*/
export interface JdbcDatabaseMetaData {
interface JdbcDatabaseMetaData {
allProceduresAreCallable(): boolean;
allTablesAreSelectable(): boolean;
autoCommitFailureClosesAllResultSets(): boolean;
@@ -513,7 +513,7 @@ declare namespace GoogleAppsScript {
* A JDBC Date. For documentation of this class, see java.sql.Date
* .
*/
export interface JdbcDate {
interface JdbcDate {
after(when: JdbcDate): boolean;
before(when: JdbcDate): boolean;
getDate(): Integer;
@@ -530,7 +530,7 @@ declare namespace GoogleAppsScript {
* A JDBC ParameterMetaData. For documentation of this class, see
* java.sql.ParameterMetaData.
*/
export interface JdbcParameterMetaData {
interface JdbcParameterMetaData {
getParameterClassName(param: Integer): string;
getParameterCount(): Integer;
getParameterMode(param: Integer): Integer;
@@ -546,7 +546,7 @@ declare namespace GoogleAppsScript {
* A JDBC PreparedStatement. For documentation of this class, see
* java.sql.PreparedStatement.
*/
export interface JdbcPreparedStatement {
interface JdbcPreparedStatement {
addBatch(): void;
addBatch(sql: string): void;
cancel(): void;
@@ -629,7 +629,7 @@ declare namespace GoogleAppsScript {
/**
* A JDBC Ref. For documentation of this class, see java.sql.Ref.
*/
export interface JdbcRef {
interface JdbcRef {
getBaseTypeName(): string;
getObject(): any;
setObject(object: any): void;
@@ -639,7 +639,7 @@ declare namespace GoogleAppsScript {
* A JDBC ResultSet. For documentation of this class, see java.sql.ResultSet
* .
*/
export interface JdbcResultSet {
interface JdbcResultSet {
absolute(row: Integer): boolean;
afterLast(): void;
beforeFirst(): void;
@@ -785,7 +785,7 @@ declare namespace GoogleAppsScript {
* A JDBC ResultSetMetaData. For documentation of this class, see
* java.sql.ResultSetMetaData.
*/
export interface JdbcResultSetMetaData {
interface JdbcResultSetMetaData {
getCatalogName(column: Integer): string;
getColumnClassName(column: Integer): string;
getColumnCount(): Integer;
@@ -813,7 +813,7 @@ declare namespace GoogleAppsScript {
* A JDBC RowId. For documentation of this class, see java.sql.RowId
* .
*/
export interface JdbcRowId {
interface JdbcRowId {
getBytes(): Byte[];
}
@@ -821,7 +821,7 @@ declare namespace GoogleAppsScript {
* A JDBC SQLXML. For documentation of this class, see java.sql.SQLXML
* .
*/
export interface JdbcSQLXML {
interface JdbcSQLXML {
free(): void;
getString(): string;
setString(value: string): void;
@@ -831,7 +831,7 @@ declare namespace GoogleAppsScript {
* A JDBC Savepoint. For documentation of this class, see java.sql.Savepoint
* .
*/
export interface JdbcSavepoint {
interface JdbcSavepoint {
getSavepointId(): Integer;
getSavepointName(): string;
}
@@ -840,7 +840,7 @@ declare namespace GoogleAppsScript {
* A JDBC Statement. For documentation of this class, see java.sql.Statement
* .
*/
export interface JdbcStatement {
interface JdbcStatement {
addBatch(sql: string): void;
cancel(): void;
clearBatch(): void;
@@ -887,7 +887,7 @@ declare namespace GoogleAppsScript {
* A JDBC Struct. For documentation of this class, see java.sql.Struct
* .
*/
export interface JdbcStruct {
interface JdbcStruct {
getAttributes(): any[];
getSQLTypeName(): string;
}
@@ -896,7 +896,7 @@ declare namespace GoogleAppsScript {
* A JDBC Time. For documentation of this class, see java.sql.Time
* .
*/
export interface JdbcTime {
interface JdbcTime {
after(when: JdbcTime): boolean;
before(when: JdbcTime): boolean;
getHours(): Integer;
@@ -913,7 +913,7 @@ declare namespace GoogleAppsScript {
* A JDBC Timestamp. For documentation of this class, see java.sql.Timestamp
* .
*/
export interface JdbcTimestamp {
interface JdbcTimestamp {
after(when: JdbcTimestamp): boolean;
before(when: JdbcTimestamp): boolean;
getDate(): Integer;
@@ -933,7 +933,6 @@ declare namespace GoogleAppsScript {
setTime(milliseconds: Integer): void;
setYear(year: Integer): void;
}
}
}
types/google-apps-script/google-apps-script.language.d.ts
Vendored
+5 -6
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,10 +6,10 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Language {
export type LanguageAdvancedParameters = {
namespace Language {
interface LanguageAdvancedParameters {
/** the content type of the text; supported values are 'text' (default) and 'html' */
contentType?: 'html'|'text'
contentType?: 'html'|'text';
}
/**
* The Language service provides scripts a way to compute automatic translations of text.
@@ -18,11 +18,10 @@ declare namespace GoogleAppsScript {
* var spanish = LanguageApp.translate('This is a test', 'en', 'es');
* Logger.log(spanish);
*/
export interface LanguageApp {
interface LanguageApp {
translate(text: string, sourceLanguage: string, targetLanguage: string): string;
translate(text: string, sourceLanguage: string, targetLanguage: string, advancedArgs: LanguageAdvancedParameters): string;
}
}
}
types/google-apps-script/google-apps-script.lock.d.ts
Vendored
+4 -5
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2018-07-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Lock {
namespace Lock {
/**
* A representation of a mutual-exclusion lock.
*
@@ -37,7 +37,7 @@ declare namespace GoogleAppsScript {
* lastTicketNumber
* ScriptProperties
*/
export interface Lock {
interface Lock {
hasLock(): boolean;
releaseLock(): void;
tryLock(timeoutInMillis: Integer): boolean;
@@ -48,12 +48,11 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface LockService {
interface LockService {
getDocumentLock(): Lock;
getScriptLock(): Lock;
getUserLock(): Lock;
}
}
}
types/google-apps-script/google-apps-script.mail.d.ts
Vendored
+15 -16
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,30 +6,30 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Mail {
export type MailAdvancedParameters = {
namespace Mail {
interface MailAdvancedParameters {
/** an array of files to send with the email */
attachments?: Base.BlobSource[]
attachments?: Base.BlobSource[];
/** a comma-separated list of email addresses to BCC */
bcc?: string
bcc?: string;
/** the body of the email */
body?: string
body?: string;
/** a comma-separated list of email addresses to CC */
cc?: string
cc?: string;
/** 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
htmlBody?: string;
/** 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 <img src="cid:imageKey" /> */
inlineImages?: { [imageKey: string]: Base.BlobSource }
inlineImages?: { [imageKey: string]: Base.BlobSource };
/** the name of the sender of the email (default: the user's name) */
name?: string
name?: string;
/** 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
noReply?: boolean;
/** an email address to use as the default reply-to address (default: the user's email address) */
replyTo?: string
replyTo?: string;
/** the subject of the email */
subject?: string
subject?: string;
/** the address of the recipient */
to?: string
to?: string;
}
/**
* Sends email.
@@ -41,14 +41,13 @@ declare namespace GoogleAppsScript {
* Changes to scripts written using GmailApp are more likely to trigger a re-authorization
* request from a user than MailApp scripts.
*/
export interface MailApp {
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;
}
}
}
types/google-apps-script/google-apps-script.maps.d.ts
Vendored
+15 -16
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-07-30
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,16 +7,16 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Maps {
namespace Maps {
/**
* An enum representing the types of restrictions to avoid when finding directions.
*/
export enum Avoid { TOLLS, HIGHWAYS }
enum Avoid { TOLLS, HIGHWAYS }
/**
* An enum representing the named colors available to use in map images.
*/
export enum Color { BLACK, BROWN, GREEN, PURPLE, YELLOW, BLUE, GRAY, ORANGE, RED, WHITE }
enum Color { BLACK, BROWN, GREEN, PURPLE, YELLOW, BLUE, GRAY, ORANGE, RED, WHITE }
/**
* Allows for the retrieval of directions between locations.
@@ -73,7 +73,7 @@ declare namespace GoogleAppsScript {
*
* Google Directions API
*/
export interface DirectionFinder {
interface DirectionFinder {
addWaypoint(latitude: number, longitude: number): DirectionFinder;
addWaypoint(address: string): DirectionFinder;
clearWaypoints(): DirectionFinder;
@@ -95,7 +95,7 @@ declare namespace GoogleAppsScript {
/**
* A collection of enums used by DirectionFinder.
*/
export interface DirectionFinderEnums {
interface DirectionFinderEnums {
Avoid: typeof Avoid;
Mode: typeof Mode;
}
@@ -141,7 +141,7 @@ declare namespace GoogleAppsScript {
*
* Google Elevation API
*/
export interface ElevationSampler {
interface ElevationSampler {
sampleLocation(latitude: number, longitude: number): any;
sampleLocations(points: number[]): any;
sampleLocations(encodedPolyline: string): any;
@@ -155,7 +155,7 @@ declare namespace GoogleAppsScript {
*
* Google Static Maps API
*/
export enum Format { PNG, PNG8, PNG32, GIF, JPG, JPG_BASELINE }
enum Format { PNG, PNG8, PNG32, GIF, JPG, JPG_BASELINE }
/**
* Allows for the conversion between an address and geographical coordinates.
@@ -187,7 +187,7 @@ declare namespace GoogleAppsScript {
*
* Google Geocoding API
*/
export interface Geocoder {
interface Geocoder {
geocode(address: string): any;
reverseGeocode(latitude: number, longitude: number): any;
reverseGeocode(swLatitude: number, swLongitude: number, neLatitude: number, neLongitude: number): any;
@@ -200,7 +200,7 @@ declare namespace GoogleAppsScript {
* Allows for direction finding, geocoding, elevation sampling and the creation of static map
* images.
*/
export interface Maps {
interface Maps {
DirectionFinder: DirectionFinderEnums;
StaticMap: StaticMapEnums;
decodePolyline(polyline: string): number[];
@@ -218,12 +218,12 @@ declare namespace GoogleAppsScript {
*
* Google Static Maps API
*/
export enum MarkerSize { TINY, MID, SMALL }
enum MarkerSize { TINY, MID, SMALL }
/**
* An enum representing the mode of travel to use when finding directions.
*/
export enum Mode { DRIVING, WALKING, BICYCLING, TRANSIT }
enum Mode { DRIVING, WALKING, BICYCLING, TRANSIT }
/**
* Allows for the creation and decoration of static map images.
@@ -260,7 +260,7 @@ declare namespace GoogleAppsScript {
*
* Google Static Maps API
*/
export interface StaticMap {
interface StaticMap {
addAddress(address: string): StaticMap;
addMarker(latitude: number, longitude: number): StaticMap;
addMarker(address: string): StaticMap;
@@ -294,7 +294,7 @@ declare namespace GoogleAppsScript {
/**
* A collection of enums used by StaticMap.
*/
export interface StaticMapEnums {
interface StaticMapEnums {
Color: typeof Color;
Format: typeof Format;
MarkerSize: typeof MarkerSize;
@@ -307,8 +307,7 @@ declare namespace GoogleAppsScript {
*
* Google Static Maps API
*/
export enum Type { ROADMAP, SATELLITE, TERRAIN, HYBRID }
enum Type { ROADMAP, SATELLITE, TERRAIN, HYBRID }
}
}
types/google-apps-script/google-apps-script.optimization.d.ts
Vendored
+8 -9
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-05-20
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Optimization {
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
@@ -26,7 +26,7 @@ declare namespace GoogleAppsScript {
* // 0 <= 2 * x <= 5
* constraint.setCoefficient('x', 2);
*/
export interface LinearOptimizationConstraint {
interface LinearOptimizationConstraint {
setCoefficient(variableName: string, coefficient: number): LinearOptimizationConstraint;
}
@@ -82,7 +82,7 @@ declare namespace GoogleAppsScript {
* Logger.log('Value of y: ' + solution.getVariableValue('y'));
* }
*/
export interface LinearOptimizationEngine {
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;
@@ -148,7 +148,7 @@ declare namespace GoogleAppsScript {
* Logger.log('Value of y: ' + solution.getVariableValue('y'));
* }
*/
export interface LinearOptimizationService {
interface LinearOptimizationService {
Status: typeof Status;
VariableType: typeof VariableType;
createEngine(): LinearOptimizationEngine;
@@ -206,7 +206,7 @@ declare namespace GoogleAppsScript {
* Logger.log('Value of y: ' + solution.getVariableValue('y'));
* }
*/
export interface LinearOptimizationSolution {
interface LinearOptimizationSolution {
getObjectiveValue(): number;
getStatus(): Status;
getVariableValue(variableName: string): number;
@@ -218,13 +218,12 @@ declare namespace GoogleAppsScript {
* afterwards it will take any of the other values depending if it successfully found a solution and
* if the solution is optimal.
*/
export enum Status { OPTIMAL, FEASIBLE, INFEASIBLE, UNBOUNDED, ABNORMAL, MODEL_INVALID, NOT_SOLVED }
enum Status { OPTIMAL, FEASIBLE, INFEASIBLE, UNBOUNDED, ABNORMAL, MODEL_INVALID, NOT_SOLVED }
/**
* Type of variables created by the engine.
*/
export enum VariableType { INTEGER, CONTINUOUS }
enum VariableType { INTEGER, CONTINUOUS }
}
}
types/google-apps-script/google-apps-script.properties.d.ts
Vendored
+6 -7
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module Properties {
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
@@ -14,7 +14,7 @@ declare namespace GoogleAppsScript {
* Properties cannot be shared between scripts. For more information about property types, see the
* guide to the Properties service.
*/
export interface Properties {
interface Properties {
deleteAllProperties(): Properties;
deleteProperty(key: string): Properties;
getKeys(): string[];
@@ -39,7 +39,7 @@ declare namespace GoogleAppsScript {
* scriptProperties.setProperty('SERVER_URL', 'http://www.example.com/MyWeatherService/');
* userProperties.setProperty('DISPLAY_UNITS', 'metric');
*/
export interface PropertiesService {
interface PropertiesService {
getDocumentProperties(): Properties;
getScriptProperties(): Properties;
getUserProperties(): Properties;
@@ -51,7 +51,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface ScriptProperties {
interface ScriptProperties {
deleteAllProperties(): ScriptProperties;
deleteProperty(key: string): ScriptProperties;
getKeys(): string[];
@@ -68,7 +68,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface UserProperties {
interface UserProperties {
deleteAllProperties(): UserProperties;
deleteProperty(key: string): UserProperties;
getKeys(): string[];
@@ -78,7 +78,6 @@ declare namespace GoogleAppsScript {
setProperties(properties: { [key: string]: string }, deleteAllOthers: boolean): UserProperties;
setProperty(key: string, value: string): UserProperties;
}
}
}
types/google-apps-script/google-apps-script.script.d.ts
Vendored
+23 -23
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -10,7 +10,7 @@
/// <reference path="google-apps-script.spreadsheet.d.ts" />
declare namespace GoogleAppsScript {
export module Script {
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
@@ -38,7 +38,7 @@ declare namespace GoogleAppsScript {
* menu.addToUi();
* }
*/
export enum AuthMode { NONE, CUSTOM_FUNCTION, LIMITED, FULL }
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
@@ -51,7 +51,7 @@ declare namespace GoogleAppsScript {
* all cases, scripts should call ScriptApp.getAuthorizationInfo(ScriptApp.AuthMode.FULL),
* since no other authorization mode requires that users grant authorization.
*/
export interface AuthorizationInfo {
interface AuthorizationInfo {
getAuthorizationStatus(): AuthorizationStatus;
getAuthorizationUrl(): string;
}
@@ -59,12 +59,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration denoting the authorization status of a script.
*/
export enum AuthorizationStatus { REQUIRED, NOT_REQUIRED }
enum AuthorizationStatus { REQUIRED, NOT_REQUIRED }
/**
* Builder for calendar triggers.
*/
export interface CalendarTriggerBuilder {
interface CalendarTriggerBuilder {
create(): Trigger;
onEventUpdated(): CalendarTriggerBuilder;
}
@@ -72,9 +72,9 @@ declare namespace GoogleAppsScript {
/**
* A builder for clock triggers.
*/
export interface ClockTriggerBuilder {
interface ClockTriggerBuilder {
after(durationMilliseconds: Integer): ClockTriggerBuilder;
at(date: Date): ClockTriggerBuilder;
at(date: Base.Date): ClockTriggerBuilder;
atDate(year: Integer, month: Integer, day: Integer): ClockTriggerBuilder;
atHour(hour: Integer): ClockTriggerBuilder;
create(): Trigger;
@@ -91,7 +91,7 @@ declare namespace GoogleAppsScript {
/**
* A builder for document triggers.
*/
export interface DocumentTriggerBuilder {
interface DocumentTriggerBuilder {
create(): Trigger;
onOpen(): DocumentTriggerBuilder;
}
@@ -99,12 +99,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration denoting the type of triggered event.
*/
export enum EventType { CLOCK, ON_OPEN, ON_EDIT, ON_FORM_SUBMIT, ON_CHANGE, ON_EVENT_UPDATED }
enum EventType { CLOCK, ON_OPEN, ON_EDIT, ON_FORM_SUBMIT, ON_CHANGE, ON_EVENT_UPDATED }
/**
* A builder for form triggers.
*/
export interface FormTriggerBuilder {
interface FormTriggerBuilder {
create(): Trigger;
onFormSubmit(): FormTriggerBuilder;
onOpen(): FormTriggerBuilder;
@@ -114,13 +114,13 @@ declare namespace GoogleAppsScript {
* An enumeration that indicates how the script came to be installed as an add-on for the current
* user.
*/
export enum InstallationSource { APPS_MARKETPLACE_DOMAIN_ADD_ON, NONE, WEB_STORE_ADD_ON }
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.
*/
export interface ScriptApp {
interface ScriptApp {
AuthMode: typeof AuthMode;
AuthorizationStatus: typeof AuthorizationStatus;
EventType: typeof EventType;
@@ -142,23 +142,24 @@ declare namespace GoogleAppsScript {
newTrigger(functionName: string): TriggerBuilder;
/** @deprecated DO NOT USE */
getProjectKey(): string;
/** @deprecated DO NOT USE */
getScriptTriggers(): Trigger[];
/** @deprecated DO NOT USE */
getScriptTriggers(): Trigger[];
}
/**
* Access and manipulate script publishing.
*/
export interface Service {
disable(): void;
interface Service {
getUrl(): string;
isEnabled(): boolean;
/** @deprecated DO NOT USE */
disable(): void;
}
/**
* Builder for spreadsheet triggers.
*/
export interface SpreadsheetTriggerBuilder {
interface SpreadsheetTriggerBuilder {
create(): Trigger;
onChange(): SpreadsheetTriggerBuilder;
onEdit(): SpreadsheetTriggerBuilder;
@@ -183,7 +184,7 @@ declare namespace GoogleAppsScript {
* return url + stateToken;
* }
*/
export interface StateTokenBuilder {
interface StateTokenBuilder {
createToken(): string;
withArgument(name: string, value: string): StateTokenBuilder;
withMethod(method: string): StateTokenBuilder;
@@ -193,7 +194,7 @@ declare namespace GoogleAppsScript {
/**
* A script trigger.
*/
export interface Trigger {
interface Trigger {
getEventType(): EventType;
getHandlerFunction(): string;
getTriggerSource(): TriggerSource;
@@ -204,7 +205,7 @@ declare namespace GoogleAppsScript {
/**
* A generic builder for script triggers.
*/
export interface TriggerBuilder {
interface TriggerBuilder {
forDocument(document: Document.Document): DocumentTriggerBuilder;
forDocument(key: string): DocumentTriggerBuilder;
forForm(form: Forms.Form): FormTriggerBuilder;
@@ -218,8 +219,7 @@ declare namespace GoogleAppsScript {
/**
* An enumeration denoting the source of the event that causes the trigger to fire.
*/
export enum TriggerSource { SPREADSHEETS, CLOCK, FORMS, DOCUMENTS, CALENDAR }
enum TriggerSource { SPREADSHEETS, CLOCK, FORMS, DOCUMENTS, CALENDAR }
}
}
types/google-apps-script/google-apps-script.sites.d.ts
Vendored
+27 -28
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,7 +7,7 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Sites {
namespace Sites {
/**
* A Sites Attachment such as a file attached to a page.
*
@@ -24,15 +24,15 @@ declare namespace GoogleAppsScript {
* // just pass it directly to that method
* var file = DocsList.createFile(attachments[0]);
*/
export interface Attachment {
interface Attachment {
deleteAttachment(): void;
getAs(contentType: string): Base.Blob;
getAttachmentType(): AttachmentType;
getBlob(): Base.Blob;
getContentType(): string;
getDatePublished(): Date;
getDatePublished(): Base.Date;
getDescription(): string;
getLastUpdated(): Date;
getLastUpdated(): Base.Date;
getParent(): Page;
getTitle(): string;
getUrl(): string;
@@ -51,7 +51,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export enum AttachmentType { WEB, HOSTED }
enum AttachmentType { WEB, HOSTED }
/**
* A Sites Column - a column from a Sites List page.
@@ -60,7 +60,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface Column {
interface Column {
deleteColumn(): void;
getName(): string;
getParent(): Page;
@@ -74,13 +74,13 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface Comment {
interface Comment {
deleteComment(): void;
getAuthorEmail(): string;
getAuthorName(): string;
getContent(): string;
getDatePublished(): Date;
getLastUpdated(): Date;
getDatePublished(): Base.Date;
getLastUpdated(): Base.Date;
getParent(): Page;
setContent(content: string): Comment;
setParent(parent: Page): Comment;
@@ -93,10 +93,10 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface ListItem {
interface ListItem {
deleteListItem(): void;
getDatePublished(): Date;
getLastUpdated(): Date;
getDatePublished(): Base.Date;
getLastUpdated(): Base.Date;
getParent(): Page;
getValueByIndex(index: Integer): string;
getValueByName(name: string): string;
@@ -105,19 +105,19 @@ declare namespace GoogleAppsScript {
setValueByName(name: string, value: string): ListItem;
}
export type PageAdvancedParameters = {
interface PageAdvancedParameters {
/** only get pages of this type */
type?: PageType[]
type?: PageType[];
/** start the results here */
start?: Integer
start?: Integer;
/** the max number of results (default 200) */
max?: Integer
max?: Integer;
/** whether to include draft pages (default false) */
includeDrafts?: boolean
includeDrafts?: boolean;
/** whether to include deleted pages (default false) */
includeDeleted?: boolean
includeDeleted?: boolean;
/** only return pages matching this query */
search?: string
search?: string;
}
/**
* A Page on a Google Site.
@@ -126,7 +126,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface Page {
interface Page {
addColumn(name: string): Column;
addHostedAttachment(blob: Base.BlobSource): Attachment;
addHostedAttachment(blob: Base.BlobSource, description: string): Attachment;
@@ -151,11 +151,11 @@ declare namespace GoogleAppsScript {
getChildren(): Page[];
getChildren(options: PageAdvancedParameters): Page[];
getColumns(): Column[];
getDatePublished(): Date;
getDatePublished(): Base.Date;
getHtmlContent(): string;
getIsDraft(): boolean;
getLastEdited(): Date;
getLastUpdated(): Date;
getLastEdited(): Base.Date;
getLastUpdated(): Base.Date;
getListItems(): ListItem[];
getListItems(optOptions: { start?: Integer; max?: Integer}): ListItem[];
getName(): string;
@@ -193,7 +193,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export enum PageType { WEB_PAGE, LIST_PAGE, ANNOUNCEMENT, ANNOUNCEMENTS_PAGE, FILE_CABINET_PAGE }
enum PageType { WEB_PAGE, LIST_PAGE, ANNOUNCEMENT, ANNOUNCEMENTS_PAGE, FILE_CABINET_PAGE }
/**
* An object representing a Google Site.
@@ -202,7 +202,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface Site {
interface Site {
addEditor(emailAddress: string): Site;
addEditor(user: Base.User): Site;
addEditors(emailAddresses: string[]): Site;
@@ -292,7 +292,7 @@ declare namespace GoogleAppsScript {
* modify Sites made with this version, but script can still access
* classic Sites.
*/
export interface SitesApp {
interface SitesApp {
AttachmentType: typeof AttachmentType;
PageType: typeof PageType;
copySite(domain: string, name: string, title: string, summary: string, site: Site): Site;
@@ -310,7 +310,6 @@ declare namespace GoogleAppsScript {
getSites(domain: string): Site[];
getSites(domain: string, start: Integer, max: Integer): Site[];
}
}
}
types/google-apps-script/google-apps-script.slides.d.ts
Vendored
+79 -96
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-07-30
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -8,7 +8,7 @@
/// <reference path="google-apps-script.spreadsheet.d.ts" />
declare namespace GoogleAppsScript {
export module Slides {
namespace Slides {
/**
* A 3x3 matrix used to transform source coordinates (x1, y1) into destination coordinates (x2, y2)
* according to matrix multiplication:
@@ -22,7 +22,7 @@ declare namespace GoogleAppsScript {
* x2 = scaleX * x1 + shearX * y1 + translateX
* y2 = scaleY * y1 + shearY * x1 + translateY
*/
export interface AffineTransform {
interface AffineTransform {
getScaleX(): number;
getScaleY(): number;
getShearX(): number;
@@ -45,7 +45,7 @@ declare namespace GoogleAppsScript {
* [ 1.1 1.0 0.0 ]
* [ 0 0 1 ]
*/
export interface AffineTransformBuilder {
interface AffineTransformBuilder {
build(): AffineTransform;
setScaleX(scaleX: number): AffineTransformBuilder;
setScaleY(scaleY: number): AffineTransformBuilder;
@@ -58,7 +58,7 @@ declare namespace GoogleAppsScript {
/**
* The alignment position to apply.
*/
export enum AlignmentPosition { CENTER, HORIZONTAL_CENTER, VERTICAL_CENTER }
enum AlignmentPosition { CENTER, HORIZONTAL_CENTER, VERTICAL_CENTER }
/**
* The kinds of start and end forms with which linear geometry can be rendered.
@@ -67,13 +67,13 @@ declare namespace GoogleAppsScript {
* of "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th
* edition.
*/
export enum ArrowStyle { UNSUPPORTED, NONE, STEALTH_ARROW, FILL_ARROW, FILL_CIRCLE, FILL_SQUARE, FILL_DIAMOND, OPEN_ARROW, OPEN_CIRCLE, OPEN_SQUARE, OPEN_DIAMOND }
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.
*/
export interface AutoText {
interface AutoText {
getAutoTextType(): AutoTextType;
getIndex(): Integer;
getRange(): TextRange;
@@ -82,12 +82,12 @@ declare namespace GoogleAppsScript {
/**
* The types of auto text.
*/
export enum AutoTextType { UNSUPPORTED, SLIDE_NUMBER }
enum AutoTextType { UNSUPPORTED, SLIDE_NUMBER }
/**
* Describes the border around an element.
*/
export interface Border {
interface Border {
getDashStyle(): DashStyle;
getLineFill(): LineFill;
getWeight(): number;
@@ -100,22 +100,22 @@ declare namespace GoogleAppsScript {
/**
* The table cell merge states.
*/
export enum CellMergeState { NORMAL, HEAD, MERGED }
enum CellMergeState { NORMAL, HEAD, MERGED }
/**
* An opaque color
*/
export interface Color {
asRgbColor(): RgbColor;
interface Color {
asRgbColor(): Base.RgbColor;
asThemeColor(): ThemeColor;
getColorType(): ColorType;
getColorType(): Base.ColorType;
}
/**
* A color scheme defines a mapping from members of ThemeColorType to the actual colors used
* to render them.
*/
export interface ColorScheme {
interface ColorScheme {
getConcreteColor(theme: ThemeColorType): Color;
getThemeColors(): ThemeColorType[];
setConcreteColor(type: ThemeColorType, color: Color): ColorScheme;
@@ -123,15 +123,10 @@ declare namespace GoogleAppsScript {
setConcreteColor(type: ThemeColorType, hexColor: string): ColorScheme;
}
/**
* The types of Colors
*/
export enum ColorType { UNSUPPORTED, RGB, THEME }
/**
* The connection site on a PageElement that can connect to a connector.
*/
export interface ConnectionSite {
interface ConnectionSite {
getIndex(): Integer;
getPageElement(): PageElement;
}
@@ -145,7 +140,7 @@ declare namespace GoogleAppsScript {
* Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th
* edition.
*/
export enum ContentAlignment { UNSUPPORTED, TOP, MIDDLE, BOTTOM }
enum ContentAlignment { UNSUPPORTED, TOP, MIDDLE, BOTTOM }
/**
* The kinds of dashes with which linear geometry can be rendered. These values are based on the
@@ -153,12 +148,12 @@ declare namespace GoogleAppsScript {
* Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th
* edition.
*/
export enum DashStyle { UNSUPPORTED, SOLID, DOT, DASH, DASH_DOT, LONG_DASH, LONG_DASH_DOT }
enum DashStyle { UNSUPPORTED, SOLID, DOT, DASH, DASH_DOT, LONG_DASH, LONG_DASH_DOT }
/**
* Describes the page element's background
*/
export interface Fill {
interface Fill {
getSolidFill(): SolidFill;
getType(): FillType;
isVisible(): boolean;
@@ -176,12 +171,12 @@ declare namespace GoogleAppsScript {
/**
* The kinds of fill.
*/
export enum FillType { UNSUPPORTED, NONE, SOLID }
enum FillType { UNSUPPORTED, NONE, SOLID }
/**
* A collection of PageElements joined as a single unit.
*/
export interface Group {
interface Group {
alignOnPage(alignmentPosition: AlignmentPosition): Group;
bringForward(): Group;
bringToFront(): Group;
@@ -224,7 +219,7 @@ declare namespace GoogleAppsScript {
/**
* A PageElement representing an image.
*/
export interface Image {
interface Image {
alignOnPage(alignmentPosition: AlignmentPosition): Image;
bringForward(): Image;
bringToFront(): Image;
@@ -283,7 +278,7 @@ declare namespace GoogleAppsScript {
* Each layout serves as a template for slides that inherit from it, determining how content on
* those slides is arranged and styled.
*/
export interface Layout {
interface Layout {
getBackground(): PageBackground;
getColorScheme(): ColorScheme;
getGroups(): Group[];
@@ -340,7 +335,7 @@ declare namespace GoogleAppsScript {
/**
* A PageElement representing a line.
*/
export interface Line {
interface Line {
alignOnPage(alignmentPosition: AlignmentPosition): Line;
bringForward(): Line;
bringToFront(): Line;
@@ -414,12 +409,12 @@ declare namespace GoogleAppsScript {
* The exact LineType created is determined based on the category and how it's routed to
* connect to other page elements.
*/
export enum LineCategory { UNSUPPORTED, STRAIGHT, BENT, CURVED }
enum LineCategory { UNSUPPORTED, STRAIGHT, BENT, CURVED }
/**
* Describes the fill of a line or outline
*/
export interface LineFill {
interface LineFill {
getFillType(): LineFillType;
getSolidFill(): SolidFill;
setSolidFill(color: Color): void;
@@ -435,7 +430,7 @@ declare namespace GoogleAppsScript {
/**
* The kinds of line fill.
*/
export enum LineFillType { UNSUPPORTED, NONE, SOLID }
enum LineFillType { UNSUPPORTED, NONE, SOLID }
/**
* The line types.
@@ -444,12 +439,12 @@ declare namespace GoogleAppsScript {
* "Office Open XML File Formats - Fundamentals and Markup Language Reference", part 1 of ECMA-376 4th
* edition.
*/
export 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 }
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.
*/
export interface Link {
interface Link {
getLinkType(): LinkType;
getLinkedSlide(): Slide;
getSlideId(): string;
@@ -461,12 +456,12 @@ declare namespace GoogleAppsScript {
/**
* The types of a Link.
*/
export enum LinkType { UNSUPPORTED, URL, SLIDE_POSITION, SLIDE_ID, SLIDE_INDEX }
enum LinkType { UNSUPPORTED, URL, SLIDE_POSITION, SLIDE_ID, SLIDE_INDEX }
/**
* A list in the text.
*/
export interface List {
interface List {
getListId(): string;
getListParagraphs(): Paragraph[];
}
@@ -512,12 +507,12 @@ declare namespace GoogleAppsScript {
* LEFTTRIANGLE: A triangle pointing left, ◄, corresponding to a Unicode U+25c4 code
* point
*/
export 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 }
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.
*/
export interface ListStyle {
interface ListStyle {
applyListPreset(listPreset: ListPreset): ListStyle;
getGlyph(): string;
getList(): List;
@@ -540,7 +535,7 @@ declare namespace GoogleAppsScript {
* Any other shapes on the master slide appear on all slides using that master, regardless of
* their layout.
*/
export interface Master {
interface Master {
getBackground(): PageBackground;
getColorScheme(): ColorScheme;
getGroups(): Group[];
@@ -599,7 +594,7 @@ declare namespace GoogleAppsScript {
* Notes masters define the default text styles and page elements for all notes pages. Notes
* masters are read-only.
*/
export interface NotesMaster {
interface NotesMaster {
getGroups(): Group[];
getImages(): Image[];
getLines(): Line[];
@@ -623,7 +618,7 @@ declare namespace GoogleAppsScript {
* the slide's speaker notes. Each slide has one corresponding notes page. Only the text in the
* speaker notes shape can be modified.
*/
export interface NotesPage {
interface NotesPage {
getGroups(): Group[];
getImages(): Image[];
getLines(): Line[];
@@ -646,7 +641,7 @@ declare namespace GoogleAppsScript {
/**
* A page in a presentation.
*/
export interface Page {
interface Page {
asLayout(): Layout;
asMaster(): Master;
asSlide(): Slide;
@@ -704,7 +699,7 @@ declare namespace GoogleAppsScript {
/**
* Describes the page's background
*/
export interface PageBackground {
interface PageBackground {
getPictureFill(): PictureFill;
getSolidFill(): SolidFill;
getType(): PageBackgroundType;
@@ -725,12 +720,12 @@ declare namespace GoogleAppsScript {
/**
* The kinds of page backgrounds.
*/
export enum PageBackgroundType { UNSUPPORTED, NONE, SOLID, PICTURE }
enum PageBackgroundType { UNSUPPORTED, NONE, SOLID, PICTURE }
/**
* A visual element rendered on a page.
*/
export interface PageElement {
interface PageElement {
alignOnPage(alignmentPosition: AlignmentPosition): PageElement;
asGroup(): Group;
asImage(): Image;
@@ -779,31 +774,31 @@ declare namespace GoogleAppsScript {
/**
* A collection of one or more PageElement instances.
*/
export interface PageElementRange {
interface PageElementRange {
getPageElements(): PageElement[];
}
/**
* The page element type.
*/
export enum PageElementType { UNSUPPORTED, SHAPE, IMAGE, VIDEO, TABLE, GROUP, LINE, WORD_ART, SHEETS_CHART }
enum PageElementType { UNSUPPORTED, SHAPE, IMAGE, VIDEO, TABLE, GROUP, LINE, WORD_ART, SHEETS_CHART }
/**
* A collection of one or more Page instances.
*/
export interface PageRange {
interface PageRange {
getPages(): Page[];
}
/**
* The page types.
*/
export enum PageType { UNSUPPORTED, SLIDE, LAYOUT, MASTER }
enum PageType { UNSUPPORTED, SLIDE, LAYOUT, MASTER }
/**
* A segment of text terminated by a newline character.
*/
export interface Paragraph {
interface Paragraph {
getIndex(): Integer;
getRange(): TextRange;
}
@@ -811,7 +806,7 @@ declare namespace GoogleAppsScript {
/**
* The types of text alignment for a paragraph.
*/
export enum ParagraphAlignment { UNSUPPORTED, START, CENTER, END, JUSTIFIED }
enum ParagraphAlignment { UNSUPPORTED, START, CENTER, END, JUSTIFIED }
/**
* The styles of text that apply to entire paragraphs.
@@ -820,7 +815,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface ParagraphStyle {
interface ParagraphStyle {
getIndentEnd(): number;
getIndentFirstLine(): number;
getIndentStart(): number;
@@ -844,7 +839,7 @@ declare namespace GoogleAppsScript {
/**
* A fill that renders an image that's stretched to the dimensions of its container.
*/
export interface PictureFill {
interface PictureFill {
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
getContentUrl(): string;
@@ -858,12 +853,12 @@ declare namespace GoogleAppsScript {
* Markup Language Reference", part 1 of ECMA-376 5th
* edition.
*/
export 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 }
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.
*/
export interface Point {
interface Point {
getX(): number;
getY(): number;
}
@@ -873,12 +868,12 @@ declare namespace GoogleAppsScript {
* 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.
*/
export 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 }
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.
*/
export interface Presentation {
interface Presentation {
addEditor(emailAddress: string): Presentation;
addEditor(user: Base.User): Presentation;
addEditors(emailAddresses: string[]): Presentation;
@@ -921,17 +916,6 @@ declare namespace GoogleAppsScript {
setName(name: string): void;
}
/**
* A color defined by red, green, blue color channels.
*/
export interface RgbColor {
asHexString(): string;
getBlue(): Integer;
getColorType(): ColorType;
getGreen(): Integer;
getRed(): Integer;
}
/**
* The user's selection in the active presentation.
*
@@ -940,7 +924,7 @@ declare namespace GoogleAppsScript {
* var selectionType = selection.getSelectionType();
* }
*/
export interface Selection {
interface Selection {
getCurrentPage(): Page;
getPageElementRange(): PageElementRange;
getPageRange(): PageRange;
@@ -958,13 +942,13 @@ declare namespace GoogleAppsScript {
* using the Selection.getPageElementRange and the Page can be retrieved from the
* Selection.getCurrentPage.
*/
export enum SelectionType { UNSUPPORTED, NONE, TEXT, TABLE_CELL, PAGE, PAGE_ELEMENT, CURRENT_PAGE }
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.
*/
export interface Shape {
interface Shape {
alignOnPage(alignmentPosition: AlignmentPosition): Shape;
bringForward(): Shape;
bringToFront(): Shape;
@@ -1030,12 +1014,12 @@ declare namespace GoogleAppsScript {
* Reference", part 1 of ECMA-376 4th
* edition.
*/
export 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 }
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.
*/
export interface SheetsChart {
interface SheetsChart {
alignOnPage(alignmentPosition: AlignmentPosition): SheetsChart;
asImage(): Image;
bringForward(): SheetsChart;
@@ -1087,7 +1071,7 @@ declare namespace GoogleAppsScript {
/**
* The Sheets chart's embed type.
*/
export enum SheetsChartEmbedType { UNSUPPORTED, IMAGE }
enum SheetsChartEmbedType { UNSUPPORTED, IMAGE }
/**
* A slide in a presentation.
@@ -1095,7 +1079,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface Slide {
interface Slide {
duplicate(): Slide;
getBackground(): PageBackground;
getColorScheme(): ColorScheme;
@@ -1159,12 +1143,12 @@ declare namespace GoogleAppsScript {
/**
* The mode of links between slides.
*/
export enum SlideLinkingMode { UNSUPPORTED, LINKED, NOT_LINKED }
enum SlideLinkingMode { UNSUPPORTED, LINKED, NOT_LINKED }
/**
* The relative position of a Slide.
*/
export enum SlidePosition { NEXT_SLIDE, PREVIOUS_SLIDE, FIRST_SLIDE, LAST_SLIDE }
enum SlidePosition { NEXT_SLIDE, PREVIOUS_SLIDE, FIRST_SLIDE, LAST_SLIDE }
/**
* Creates and opens Presentations that can be edited.
@@ -1175,12 +1159,12 @@ declare namespace GoogleAppsScript {
* // Create and open a presentation.
* preso = SlidesApp.create('Presentation Name');
*/
export interface SlidesApp {
interface SlidesApp {
AlignmentPosition: typeof AlignmentPosition;
ArrowStyle: typeof ArrowStyle;
AutoTextType: typeof AutoTextType;
CellMergeState: typeof CellMergeState;
ColorType: typeof ColorType;
ColorType: typeof Base.ColorType;
ContentAlignment: typeof ContentAlignment;
DashStyle: typeof DashStyle;
FillType: typeof FillType;
@@ -1219,7 +1203,7 @@ declare namespace GoogleAppsScript {
* SolidFill objects are detached and immutable, so do not reflect changes made after
* they have been created.
*/
export interface SolidFill {
interface SolidFill {
getAlpha(): number;
getColor(): Color;
}
@@ -1227,12 +1211,12 @@ declare namespace GoogleAppsScript {
/**
* The different modes for paragraph spacing.
*/
export enum SpacingMode { UNSUPPORTED, NEVER_COLLAPSE, COLLAPSE_LISTS }
enum SpacingMode { UNSUPPORTED, NEVER_COLLAPSE, COLLAPSE_LISTS }
/**
* A PageElement representing a table.
*/
export interface Table {
interface Table {
alignOnPage(alignmentPosition: AlignmentPosition): Table;
appendColumn(): TableColumn;
appendRow(): TableRow;
@@ -1282,7 +1266,7 @@ declare namespace GoogleAppsScript {
/**
* A cell in a table.
*/
export interface TableCell {
interface TableCell {
getColumnIndex(): Integer;
getColumnSpan(): Integer;
getContentAlignment(): ContentAlignment;
@@ -1301,7 +1285,7 @@ declare namespace GoogleAppsScript {
/**
* A collection of one or more TableCell instances.
*/
export interface TableCellRange {
interface TableCellRange {
getTableCells(): TableCell[];
}
@@ -1309,7 +1293,7 @@ declare namespace GoogleAppsScript {
* A column in a table. A column consists of a list of table cells. A column is identified by the
* column index.
*/
export interface TableColumn {
interface TableColumn {
getCell(cellIndex: Integer): TableCell;
getIndex(): Integer;
getNumCells(): Integer;
@@ -1321,7 +1305,7 @@ declare namespace GoogleAppsScript {
/**
* A row in a table. A row consists of a list of table cells. A row is identified by the row index.
*/
export interface TableRow {
interface TableRow {
getCell(cellIndex: Integer): TableCell;
getIndex(): Integer;
getMinimumHeight(): number;
@@ -1333,17 +1317,17 @@ declare namespace GoogleAppsScript {
/**
* The text vertical offset from its normal position.
*/
export enum TextBaselineOffset { UNSUPPORTED, NONE, SUPERSCRIPT, SUBSCRIPT }
enum TextBaselineOffset { UNSUPPORTED, NONE, SUPERSCRIPT, SUBSCRIPT }
/**
* The directions text can flow in.
*/
export enum TextDirection { UNSUPPORTED, LEFT_TO_RIGHT, RIGHT_TO_LEFT }
enum TextDirection { UNSUPPORTED, LEFT_TO_RIGHT, RIGHT_TO_LEFT }
/**
* A segment of the text contents of a Shape or a TableCell.
*/
export interface TextRange {
interface TextRange {
appendParagraph(text: string): Paragraph;
appendRange(textRange: TextRange): TextRange;
appendRange(textRange: TextRange, matchSourceFormatting: boolean): TextRange;
@@ -1384,7 +1368,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface TextStyle {
interface TextStyle {
getBackgroundColor(): Color;
getBaselineOffset(): TextBaselineOffset;
getFontFamily(): string;
@@ -1427,20 +1411,20 @@ declare namespace GoogleAppsScript {
/**
* A color that refers to an entry in the page's ColorScheme.
*/
export interface ThemeColor {
getColorType(): ColorType;
interface ThemeColor {
getColorType(): Base.ColorType;
getThemeColorType(): ThemeColorType;
}
/**
* The name of an entry in the page's color scheme.
*/
export enum ThemeColorType { UNSUPPORTED, DARK1, LIGHT1, DARK2, LIGHT2, ACCENT1, ACCENT2, ACCENT3, ACCENT4, ACCENT5, ACCENT6, HYPERLINK, FOLLOWED_HYPERLINK }
enum ThemeColorType { UNSUPPORTED, DARK1, LIGHT1, DARK2, LIGHT2, ACCENT1, ACCENT2, ACCENT3, ACCENT4, ACCENT5, ACCENT6, HYPERLINK, FOLLOWED_HYPERLINK }
/**
* A PageElement representing a video.
*/
export interface Video {
interface Video {
alignOnPage(alignmentPosition: AlignmentPosition): Video;
bringForward(): Video;
bringToFront(): Video;
@@ -1486,12 +1470,12 @@ declare namespace GoogleAppsScript {
/**
* The video source types.
*/
export enum VideoSourceType { UNSUPPORTED, YOUTUBE }
enum VideoSourceType { UNSUPPORTED, YOUTUBE }
/**
* A PageElement representing word art.
*/
export interface WordArt {
interface WordArt {
alignOnPage(alignmentPosition: AlignmentPosition): WordArt;
bringForward(): WordArt;
bringToFront(): WordArt;
@@ -1535,7 +1519,6 @@ declare namespace GoogleAppsScript {
setTransform(transform: AffineTransform): WordArt;
setWidth(width: number): WordArt;
}
}
}
types/google-apps-script/google-apps-script.spreadsheet.d.ts
Vendored
+81 -86
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -9,18 +9,18 @@
/// <reference path="google-apps-script.drive.d.ts" />
declare namespace GoogleAppsScript {
export module Spreadsheet {
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.
*/
export enum AutoFillSeries { DEFAULT_SERIES, ALTERNATE_SERIES }
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.
*/
export interface Banding {
interface Banding {
copyTo(range: Range): Banding;
getFirstColumnColor(): string | null;
getFirstRowColor(): string | null;
@@ -47,13 +47,13 @@ declare namespace GoogleAppsScript {
* An enumeration of banding themes. Each theme consists of several complementary colors that are
* applied to different cells based on the banding settings.
*/
export enum BandingTheme { LIGHT_GREY, CYAN, GREEN, YELLOW, ORANGE, BLUE, TEAL, GREY, BROWN, LIGHT_GREEN, INDIGO, PINK }
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().
*/
export interface BigQueryDataSourceSpec {
interface BigQueryDataSourceSpec {
copy(): DataSourceSpecBuilder;
getParameters(): DataSourceParameter[];
getProjectId(): string;
@@ -64,7 +64,7 @@ declare namespace GoogleAppsScript {
/**
* The builder for BigQueryDataSourceSpecBuilder.
*/
export interface BigQueryDataSourceSpecBuilder {
interface BigQueryDataSourceSpecBuilder {
build(): DataSourceSpec;
copy(): DataSourceSpecBuilder;
getParameters(): DataSourceParameter[];
@@ -85,7 +85,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface BooleanCondition {
interface BooleanCondition {
getBackground(): string | null;
getBold(): boolean | null;
getCriteriaType(): BooleanCriteria;
@@ -100,19 +100,19 @@ declare namespace GoogleAppsScript {
* An enumeration representing the boolean criteria that can be used in conditional format or
* filter.
*/
export 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 }
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).
*/
export enum BorderStyle { DOTTED, DASHED, SOLID, SOLID_MEDIUM, SOLID_THICK, DOUBLE }
enum BorderStyle { DOTTED, DASHED, SOLID, SOLID_MEDIUM, SOLID_THICK, DOUBLE }
/**
* 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.
*/
export interface ConditionalFormatRule {
interface ConditionalFormatRule {
copy(): ConditionalFormatRuleBuilder;
getBooleanCondition(): BooleanCondition | null;
getGradientCondition(): GradientCondition | null;
@@ -135,7 +135,7 @@ declare namespace GoogleAppsScript {
* rules.push(rule);
* sheet.setConditionalFormatRules(rules);
*/
export interface ConditionalFormatRuleBuilder {
interface ConditionalFormatRuleBuilder {
build(): ConditionalFormatRule;
copy(): ConditionalFormatRuleBuilder;
getBooleanCondition(): BooleanCondition | null;
@@ -184,7 +184,7 @@ declare namespace GoogleAppsScript {
* chart = chart.modify().setPosition(5, 5, 0, 0).build();
* sheet.updateChart(chart);
*/
export interface ContainerInfo {
interface ContainerInfo {
getAnchorColumn(): Integer;
getAnchorRow(): Integer;
getOffsetX(): Integer;
@@ -194,22 +194,22 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of possible special paste types.
*/
export enum CopyPasteType { PASTE_NORMAL, PASTE_NO_BORDERS, PASTE_FORMAT, PASTE_FORMULA, PASTE_DATA_VALIDATION, PASTE_VALUES, PASTE_CONDITIONAL_FORMATTING, PASTE_COLUMN_WIDTHS }
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.
*/
export 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 }
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.
*/
export enum DataExecutionState { DATA_EXECUTION_STATE_UNSUPPORTED, RUNNING, SUCCESS, ERROR, NOT_STARTED }
enum DataExecutionState { DATA_EXECUTION_STATE_UNSUPPORTED, RUNNING, SUCCESS, ERROR, NOT_STARTED }
/**
* The data execution status.
*/
export interface DataExecutionStatus {
interface DataExecutionStatus {
getErrorCode(): DataExecutionErrorCode;
getErrorMessage(): string;
getExecutionState(): DataExecutionState;
@@ -221,7 +221,7 @@ declare namespace GoogleAppsScript {
* Access and modify existing data source. To create a data source table with new data source, see
* DataSourceTable.
*/
export interface DataSource {
interface DataSource {
getSpec(): DataSourceSpec;
updateSpec(spec: DataSourceSpec): DataSource;
}
@@ -229,7 +229,7 @@ declare namespace GoogleAppsScript {
/**
* Access existing data source parameters.
*/
export interface DataSourceParameter {
interface DataSourceParameter {
getName(): string;
getSourceCell(): string | null;
getType(): DataSourceParameterType;
@@ -238,7 +238,7 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of data source parameter types.
*/
export enum DataSourceParameterType { DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED, CELL }
enum DataSourceParameterType { DATA_SOURCE_PARAMETER_TYPE_UNSUPPORTED, CELL }
/**
* Access the general settings of an existing data source spec. To access data source spec for
@@ -255,7 +255,7 @@ declare namespace GoogleAppsScript {
* Logger.log("Raw query string: %s\n", bqSpec.getRawQuery());
* }
*/
export interface DataSourceSpec {
interface DataSourceSpec {
asBigQuery(): BigQueryDataSourceSpec;
copy(): DataSourceSpecBuilder;
getParameters(): DataSourceParameter[];
@@ -275,7 +275,7 @@ declare namespace GoogleAppsScript {
* .setParameterFromCell('LIMIT', 'namedRangeCell')
* .build();
*/
export interface DataSourceSpecBuilder {
interface DataSourceSpecBuilder {
asBigQuery(): BigQueryDataSourceSpecBuilder;
build(): DataSourceSpec;
copy(): DataSourceSpecBuilder;
@@ -330,7 +330,7 @@ declare namespace GoogleAppsScript {
* // Check status after execution.
* Logger.log("Data execution state: %s.", dataSourceTable.getStatus().getExecutionState());
*/
export interface DataSourceTable {
interface DataSourceTable {
forceRefreshData(): DataSourceTable;
getDataSource(): DataSource;
getRange(): Range;
@@ -342,7 +342,7 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of data source types.
*/
export enum DataSourceType { DATA_SOURCE_TYPE_UNSUPPORTED, BIGQUERY }
enum DataSourceType { DATA_SOURCE_TYPE_UNSUPPORTED, BIGQUERY }
/**
* Access data validation rules. To create a new rule, use SpreadsheetApp.newDataValidation() and DataValidationBuilder. You can use
@@ -359,7 +359,7 @@ declare namespace GoogleAppsScript {
* Logger.log('The cell does not have a data validation rule.')
* }
*/
export interface DataValidation {
interface DataValidation {
copy(): DataValidationBuilder;
getAllowInvalid(): boolean;
getCriteriaType(): DataValidationCriteria;
@@ -376,7 +376,7 @@ declare namespace GoogleAppsScript {
* var rule = SpreadsheetApp.newDataValidation().requireValueInRange(range).build();
* cell.setDataValidation(rule);
*/
export interface DataValidationBuilder {
interface DataValidationBuilder {
build(): DataValidation;
copy(): DataValidationBuilder;
getAllowInvalid(): boolean;
@@ -446,12 +446,12 @@ declare namespace GoogleAppsScript {
* }
* range.setDataValidations(rules);
*/
export 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 }
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).
*/
export interface DeveloperMetadata {
interface DeveloperMetadata {
getId(): Integer;
getKey(): string;
getLocation(): DeveloperMetadataLocation;
@@ -472,7 +472,7 @@ declare namespace GoogleAppsScript {
* Range.createDeveloperMetadataFinder(), Sheet.createDeveloperMetadataFinder(),
* or Spreadsheet.createDeveloperMetadataFinder().
*/
export interface DeveloperMetadataFinder {
interface DeveloperMetadataFinder {
find(): DeveloperMetadata[];
onIntersectingLocations(): DeveloperMetadataFinder;
withId(id: Integer): DeveloperMetadataFinder;
@@ -485,7 +485,7 @@ declare namespace GoogleAppsScript {
/**
* Access developer metadata location information.
*/
export interface DeveloperMetadataLocation {
interface DeveloperMetadataLocation {
getColumn(): Range | null;
getLocationType(): DeveloperMetadataLocationType;
getRow(): Range | null;
@@ -496,29 +496,29 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of the types of developer metadata location types.
*/
export enum DeveloperMetadataLocationType { SPREADSHEET, SHEET, ROW, COLUMN }
enum DeveloperMetadataLocationType { SPREADSHEET, SHEET, ROW, COLUMN }
/**
* An enumeration of the types of developer metadata visibility.
*/
export enum DeveloperMetadataVisibility { DOCUMENT, PROJECT }
enum DeveloperMetadataVisibility { DOCUMENT, PROJECT }
/**
* An enumeration of possible directions along which data can be stored in a spreadsheet.
*/
export enum Dimension { COLUMNS, ROWS }
enum Dimension { COLUMNS, ROWS }
/**
* An enumeration representing the possible directions that one can move within a spreadsheet using
* the arrow keys.
*/
export enum Direction { UP, DOWN, PREVIOUS, NEXT }
enum Direction { UP, DOWN, PREVIOUS, NEXT }
/**
* Builder for area charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedAreaChartBuilder {
interface EmbeddedAreaChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -565,7 +565,7 @@ declare namespace GoogleAppsScript {
* Builder for bar charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedBarChartBuilder {
interface EmbeddedBarChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -635,21 +635,18 @@ declare namespace GoogleAppsScript {
* sheet.insertChart(chartBuilder.build());
* }
*/
export interface EmbeddedChart {
interface EmbeddedChart {
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
getChartId(): Integer | null;
getContainerInfo(): ContainerInfo;
getHiddenDimensionStrategy(): Charts.ChartHiddenDimensionStrategy;
getId(): string;
getMergeStrategy(): Charts.ChartMergeStrategy;
getNumHeaders(): Integer;
getOptions(): Charts.ChartOptions;
getRanges(): Range[];
getTransposeRowsAndColumns(): boolean;
getType(): string;
modify(): EmbeddedChartBuilder;
setId(id: string): Charts.Chart;
}
/**
@@ -667,7 +664,7 @@ declare namespace GoogleAppsScript {
* .build();
* sheet.updateChart(chart);
*/
export interface EmbeddedChartBuilder {
interface EmbeddedChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -697,7 +694,7 @@ declare namespace GoogleAppsScript {
* Builder for column charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedColumnChartBuilder {
interface EmbeddedColumnChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -742,7 +739,7 @@ declare namespace GoogleAppsScript {
/**
* Builder for combo charts. For more details, see the Gviz documentation.
*/
export interface EmbeddedComboChartBuilder {
interface EmbeddedComboChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -788,7 +785,7 @@ declare namespace GoogleAppsScript {
* Builder for histogram charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedHistogramChartBuilder {
interface EmbeddedHistogramChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -834,7 +831,7 @@ declare namespace GoogleAppsScript {
* Builder for line charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedLineChartBuilder {
interface EmbeddedLineChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -881,7 +878,7 @@ declare namespace GoogleAppsScript {
* Builder for pie charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedPieChartBuilder {
interface EmbeddedPieChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -919,7 +916,7 @@ declare namespace GoogleAppsScript {
* Builder for scatter charts. For more details, see the Gviz
* documentation.
*/
export interface EmbeddedScatterChartBuilder {
interface EmbeddedScatterChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -965,7 +962,7 @@ declare namespace GoogleAppsScript {
/**
* Builder for table charts. For more details, see the Gviz documentation.
*/
export interface EmbeddedTableChartBuilder {
interface EmbeddedTableChartBuilder {
addRange(range: Range): EmbeddedChartBuilder;
asAreaChart(): EmbeddedAreaChartBuilder;
asBarChart(): EmbeddedBarChartBuilder;
@@ -1004,7 +1001,7 @@ declare namespace GoogleAppsScript {
/**
* Access and modify existing filters. To create a new filter, use Range.createFilter().
*/
export interface Filter {
interface Filter {
getColumnFilterCriteria(columnPosition: Integer): FilterCriteria | null;
getRange(): Range;
remove(): void;
@@ -1016,7 +1013,7 @@ declare namespace GoogleAppsScript {
/**
* Access filter criteria. To create a new criteria, use SpreadsheetApp.newFilterCriteria() and FilterCriteriaBuilder.
*/
export interface FilterCriteria {
interface FilterCriteria {
copy(): FilterCriteriaBuilder;
getCriteriaType(): BooleanCriteria;
getCriteriaValues(): any[];
@@ -1027,7 +1024,7 @@ declare namespace GoogleAppsScript {
/**
* Builder for FilterCriteria.
*/
export interface FilterCriteriaBuilder {
interface FilterCriteriaBuilder {
build(): FilterCriteria;
copy(): FilterCriteriaBuilder;
getCriteriaType(): BooleanCriteria;
@@ -1083,7 +1080,7 @@ declare namespace GoogleAppsScript {
* gradient.getMaxColor(), gradient.getMaxType(), gradient.getMaxValue());
* }
*/
export interface GradientCondition {
interface GradientCondition {
getMaxColor(): string;
getMaxType(): InterpolationType | null;
getMaxValue(): string;
@@ -1108,7 +1105,7 @@ declare namespace GoogleAppsScript {
* set visible, though individual rows or columns can be hidden or set visible irrespective of the
* collapsed state.
*/
export interface Group {
interface Group {
collapse(): Group;
expand(): Group;
getControlIndex(): Integer;
@@ -1121,20 +1118,20 @@ declare namespace GoogleAppsScript {
/**
* An enumeration representing the possible positions that a group control toggle can have.
*/
export enum GroupControlTogglePosition { BEFORE, AFTER }
enum GroupControlTogglePosition { BEFORE, AFTER }
/**
* An enumeration representing the interpolation options for calculating a value to be used in a
* GradientCondition in a ConditionalFormatRule.
*/
export enum InterpolationType { NUMBER, PERCENT, PERCENTILE, MIN, MAX }
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.
*/
export interface NamedRange {
interface NamedRange {
getName(): string;
getRange(): Range;
remove(): void;
@@ -1145,7 +1142,7 @@ declare namespace GoogleAppsScript {
/**
* Represents an image over the grid in a spreadsheet.
*/
export interface OverGridImage {
interface OverGridImage {
assignScript(functionName: string): OverGridImage;
getAltTextDescription(): string;
getAltTextTitle(): string;
@@ -1179,7 +1176,7 @@ declare namespace GoogleAppsScript {
* for compatibility with the older version of Sheets.
* Access and modify protected sheets in the older version of Google Sheets.
*/
export interface PageProtection {
interface PageProtection {
addUser(email: string): void;
getUsers(): string[];
isProtected(): boolean;
@@ -1190,7 +1187,7 @@ declare namespace GoogleAppsScript {
/**
* Access and modify pivot table filters.
*/
export interface PivotFilter {
interface PivotFilter {
getFilterCriteria(): FilterCriteria;
getPivotTable(): PivotTable;
getSourceDataColumn(): Integer;
@@ -1201,7 +1198,7 @@ declare namespace GoogleAppsScript {
/**
* Access and modify pivot table breakout groups.
*/
export interface PivotGroup {
interface PivotGroup {
addManualGroupingRule(groupName: string, groupMembers: any[]): PivotGroup;
areLabelsRepeated(): boolean;
clearGroupingRule(): PivotGroup;
@@ -1229,7 +1226,7 @@ declare namespace GoogleAppsScript {
/**
* Access and modify pivot tables.
*/
export interface PivotTable {
interface PivotTable {
addCalculatedPivotValue(name: string, formula: string): PivotValue;
addColumnGroup(sourceDataColumn: Integer): PivotGroup;
addFilter(sourceDataColumn: Integer, filterCriteria: FilterCriteria): PivotFilter;
@@ -1248,12 +1245,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of functions that summarize pivot table data.
*/
export enum PivotTableSummarizeFunction { CUSTOM, SUM, COUNTA, COUNT, COUNTUNIQUE, AVERAGE, MAX, MIN, MEDIAN, PRODUCT, STDEV, STDEVP, VAR, VARP }
enum PivotTableSummarizeFunction { CUSTOM, SUM, COUNTA, COUNT, COUNTUNIQUE, AVERAGE, MAX, MIN, MEDIAN, PRODUCT, STDEV, STDEVP, VAR, VARP }
/**
* Access and modify value groups in pivot tables.
*/
export interface PivotValue {
interface PivotValue {
getDisplayType(): PivotValueDisplayType;
getFormula(): string | null;
getPivotTable(): PivotTable;
@@ -1267,7 +1264,7 @@ declare namespace GoogleAppsScript {
/**
* An enumeration of ways to display a pivot value as a function of another value.
*/
export enum PivotValueDisplayType { DEFAULT, PERCENT_OF_ROW_TOTAL, PERCENT_OF_COLUMN_TOTAL, PERCENT_OF_GRAND_TOTAL }
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
@@ -1312,7 +1309,7 @@ declare namespace GoogleAppsScript {
* protection.setDomainEdit(false);
* }
*/
export interface Protection {
interface Protection {
addEditor(emailAddress: string): Protection;
addEditor(user: Base.User): Protection;
addEditors(emailAddresses: string[]): Protection;
@@ -1329,7 +1326,6 @@ declare namespace GoogleAppsScript {
removeEditor(emailAddress: string): Protection;
removeEditor(user: Base.User): Protection;
removeEditors(emailAddresses: string[]): Protection;
removeEditors(user: Base.User[]): Protection;
setDescription(description: string): Protection;
setDomainEdit(editable: boolean): Protection;
setNamedRange(namedRange: NamedRange): Protection;
@@ -1359,13 +1355,13 @@ declare namespace GoogleAppsScript {
* protection.remove();
* }
*/
export enum ProtectionType { RANGE, SHEET }
enum ProtectionType { RANGE, SHEET }
/**
* Access and modify spreadsheet ranges. A range can be a single cell in a sheet or a group of
* adjacent cells in a sheet.
*/
export interface Range {
interface Range {
activate(): Range;
activateAsCurrentCell(): Range;
addDeveloperMetadata(key: string): Range;
@@ -1556,7 +1552,7 @@ declare namespace GoogleAppsScript {
* 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.
*/
export interface RangeList {
interface RangeList {
activate(): RangeList;
breakApart(): RangeList;
check(): RangeList;
@@ -1601,13 +1597,13 @@ declare namespace GoogleAppsScript {
/**
* An enumeration representing the possible intervals used in spreadsheet recalculation.
*/
export enum RecalculationInterval { ON_CHANGE, MINUTE, HOUR }
enum RecalculationInterval { ON_CHANGE, MINUTE, HOUR }
/**
* An enumeration representing the relative date options for calculating a value to be used in
* date-based BooleanCriteria.
*/
export enum RelativeDate { TODAY, TOMORROW, YESTERDAY, PAST_WEEK, PAST_MONTH, PAST_YEAR }
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
@@ -1617,7 +1613,7 @@ declare namespace GoogleAppsScript {
* sentence "This kid has two apples." has four runs: ["This ", "kid ", "has two ",
* "apples."].
*/
export interface RichTextValue {
interface RichTextValue {
copy(): RichTextValueBuilder;
getEndIndex(): Integer;
getRuns(): RichTextValue[];
@@ -1630,7 +1626,7 @@ declare namespace GoogleAppsScript {
/**
* A builder for Rich Text values.
*/
export interface RichTextValueBuilder {
interface RichTextValueBuilder {
build(): RichTextValue;
setText(text: string): RichTextValueBuilder;
setTextStyle(startOffset: Integer, endOffset: Integer, textStyle: TextStyle | null): RichTextValueBuilder;
@@ -1659,7 +1655,7 @@ declare namespace GoogleAppsScript {
* }
* Logger.log('Active Sheet: ' + selection.getActiveSheet().getName());
*/
export interface Selection {
interface Selection {
getActiveRange(): Range | null;
getActiveRangeList(): RangeList | null;
getActiveSheet(): Sheet;
@@ -1671,7 +1667,7 @@ declare namespace GoogleAppsScript {
* Access and modify spreadsheet sheets. Common operations are renaming a sheet and accessing range
* objects from the sheet.
*/
export interface Sheet {
interface Sheet {
activate(): Sheet;
addDeveloperMetadata(key: string): Sheet;
addDeveloperMetadata(key: string, visibility: DeveloperMetadataVisibility): Sheet;
@@ -1816,13 +1812,13 @@ declare namespace GoogleAppsScript {
/**
* The different types of sheets that can exist in a spreadsheet.
*/
export enum SheetType { GRID, OBJECT }
enum SheetType { GRID, OBJECT }
/**
* Access and modify Google Sheets files. Common operations are adding new sheets and adding
* collaborators.
*/
export interface Spreadsheet {
interface Spreadsheet {
addDeveloperMetadata(key: string): Spreadsheet;
addDeveloperMetadata(key: string, visibility: DeveloperMetadataVisibility): Spreadsheet;
addDeveloperMetadata(key: string, value: string): Spreadsheet;
@@ -1967,7 +1963,7 @@ declare namespace GoogleAppsScript {
/**
* Access and create Google Sheets files. This class is the parent class for the Spreadsheet service.
*/
export interface SpreadsheetApp {
interface SpreadsheetApp {
AutoFillSeries: typeof AutoFillSeries;
BandingTheme: typeof BandingTheme;
BooleanCriteria: typeof BooleanCriteria;
@@ -2026,12 +2022,12 @@ declare namespace GoogleAppsScript {
/**
* An enumerations of text directions.
*/
export enum TextDirection { LEFT_TO_RIGHT, RIGHT_TO_LEFT }
enum TextDirection { LEFT_TO_RIGHT, RIGHT_TO_LEFT }
/**
* Find or replace text within a range, sheet or spreadsheet. Can also specify search options.
*/
export interface TextFinder {
interface TextFinder {
findAll(): Range[];
findNext(): Range | null;
findPrevious(): Range | null;
@@ -2049,7 +2045,7 @@ declare namespace GoogleAppsScript {
/**
* Access the text rotation settings for a cell.
*/
export interface TextRotation {
interface TextRotation {
getDegrees(): Integer;
isVertical(): boolean;
}
@@ -2061,7 +2057,7 @@ declare namespace GoogleAppsScript {
* method, the method returns null. To avoid this, query for text styles using the Rich Text
* values returned by the RichTextValue.getRuns() method.
*/
export interface TextStyle {
interface TextStyle {
copy(): TextStyleBuilder;
getFontFamily(): string | null;
getFontSize(): Integer | null;
@@ -2075,7 +2071,7 @@ declare namespace GoogleAppsScript {
/**
* A builder for text styles.
*/
export interface TextStyleBuilder {
interface TextStyleBuilder {
build(): TextStyle;
setBold(bold: boolean): TextStyleBuilder;
setFontFamily(fontFamily: string): TextStyleBuilder;
@@ -2090,13 +2086,12 @@ declare namespace GoogleAppsScript {
* An enumeration of the types of preset delimiters that can split a column of text into multiple
* columns.
*/
export enum TextToColumnsDelimiter { COMMA, SEMICOLON, PERIOD, SPACE }
enum TextToColumnsDelimiter { COMMA, SEMICOLON, PERIOD, SPACE }
/**
* An enumeration of the strategies used to handle cell text wrapping.
*/
export enum WrapStrategy { WRAP, OVERFLOW, CLIP }
enum WrapStrategy { WRAP, OVERFLOW, CLIP }
}
}
types/google-apps-script/google-apps-script.types.d.ts
Vendored
+1 -1
View File
@@ -3,7 +3,7 @@
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare module GoogleAppsScript {
declare namespace GoogleAppsScript {
type BigNumber = any;
type Byte = number;
type Integer = number;
types/google-apps-script/google-apps-script.url-fetch.d.ts
Vendored
+9 -8
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// takoyaki9n <https://github.com/takoyaki9n>
@@ -8,14 +8,14 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module URL_Fetch {
namespace URL_Fetch {
/**
* This class allows users to access specific information on HTTP responses.
* See also
*
* UrlFetchApp
*/
export interface HTTPResponse {
interface HTTPResponse {
getAllHeaders(): object;
getAs(contentType: string): Base.Blob;
getBlob(): Base.Blob;
@@ -26,10 +26,10 @@ declare namespace GoogleAppsScript {
getResponseCode(): Integer;
}
export interface URLFetchRequest extends URLFetchRequestOptions {
interface URLFetchRequest extends URLFetchRequestOptions {
url: string;
}
export interface URLFetchRequestOptions {
interface URLFetchRequestOptions {
/**
* the content type (defaults to 'application/x-www-form-urlencoded'). Another example of content
* type is 'application/xml; charset=utf-8'.
@@ -104,17 +104,18 @@ declare namespace GoogleAppsScript {
*
* Setting explicit scopes
*/
export interface UrlFetchApp {
interface UrlFetchApp {
fetch(url: string): HTTPResponse;
fetch(url: string, params: URLFetchRequestOptions): HTTPResponse;
fetchAll(requests: (URLFetchRequest | string)[]): HTTPResponse[];
getRequest(url: string): URLFetchRequest;
getRequest(url: string, params: URLFetchRequestOptions): URLFetchRequest;
}
type HttpHeaders = {[key: string]: string};
interface HttpHeaders {
[key: string]: string;
}
type HttpMethod = 'get' | 'delete' | 'patch' | 'post' | 'put';
type Payload = string | { [key: string]: any } | Base.Blob;
}
}
types/google-apps-script/google-apps-script.utilities.d.ts
Vendored
+8 -9
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-09-11
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -7,32 +7,32 @@
/// <reference path="google-apps-script.base.d.ts" />
declare namespace GoogleAppsScript {
export module Utilities {
namespace Utilities {
/**
* A typesafe enum for character sets.
*/
export enum Charset { US_ASCII, UTF_8 }
enum Charset { US_ASCII, UTF_8 }
/**
* Selector of Digest algorithm.
*/
export enum DigestAlgorithm { MD2, MD5, SHA_1, SHA_256, SHA_384, SHA_512 }
enum DigestAlgorithm { MD2, MD5, SHA_1, SHA_256, SHA_384, SHA_512 }
/**
* Selector of MAC algorithm
*/
export enum MacAlgorithm { HMAC_MD5, HMAC_SHA_1, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512 }
enum MacAlgorithm { HMAC_MD5, HMAC_SHA_1, HMAC_SHA_256, HMAC_SHA_384, HMAC_SHA_512 }
/**
* Selector of RSA algorithm
*/
export enum RsaAlgorithm { RSA_SHA_1, RSA_SHA_256 }
enum RsaAlgorithm { RSA_SHA_1, RSA_SHA_256 }
/**
* This service provides utilities for string encoding/decoding, date formatting, JSON manipulation,
* and other miscellaneous tasks.
*/
export interface Utilities {
interface Utilities {
Charset: typeof Charset;
DigestAlgorithm: typeof DigestAlgorithm;
MacAlgorithm: typeof MacAlgorithm;
@@ -62,7 +62,7 @@ declare namespace GoogleAppsScript {
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: Date, timeZone: string, format: string): string;
formatDate(date: Base.Date, timeZone: string, format: string): string;
formatString(template: string, ...args: any[]): string;
getUuid(): string;
gzip(blob: Base.BlobSource): Base.Blob;
@@ -85,7 +85,6 @@ declare namespace GoogleAppsScript {
/** @deprecated DO NOT USE */
jsonStringify(obj: any): string;
}
}
}
types/google-apps-script/google-apps-script.xml-service.d.ts
Vendored
+16 -17
View File
@@ -1,4 +1,4 @@
// Type definitions for Google Apps Script 2019-04-09
// Type definitions for Google Apps Script 2019-10-24
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
@@ -6,7 +6,7 @@
/// <reference path="google-apps-script.types.d.ts" />
declare namespace GoogleAppsScript {
export module XML_Service {
namespace XML_Service {
/**
* A representation of an XML attribute.
*
@@ -26,7 +26,7 @@ declare namespace GoogleAppsScript {
* xml = XmlService.getPrettyFormat().format(document);
* Logger.log(xml);
*/
export interface Attribute {
interface Attribute {
getName(): string;
getNamespace(): Namespace;
getValue(): string;
@@ -48,7 +48,7 @@ declare namespace GoogleAppsScript {
* var xml = XmlService.getPrettyFormat().format(document);
* Logger.log(xml);
*/
export interface Cdata {
interface Cdata {
append(text: string): Text;
detach(): Content;
getParentElement(): Element;
@@ -60,7 +60,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML Comment node.
*/
export interface Comment {
interface Comment {
detach(): Content;
getParentElement(): Element;
getText(): string;
@@ -88,7 +88,7 @@ declare namespace GoogleAppsScript {
*
* TextA representation of an XML Text node.
*/
export interface Content {
interface Content {
asCdata(): Cdata;
asComment(): Comment;
asDocType(): DocType;
@@ -105,12 +105,12 @@ declare namespace GoogleAppsScript {
/**
* An enumeration representing the types of XML content nodes.
*/
export enum ContentType { CDATA, COMMENT, DOCTYPE, ELEMENT, ENTITYREF, PROCESSINGINSTRUCTION, TEXT }
enum ContentType { CDATA, COMMENT, DOCTYPE, ELEMENT, ENTITYREF, PROCESSINGINSTRUCTION, TEXT }
/**
* A representation of an XML DocumentType node.
*/
export interface DocType {
interface DocType {
detach(): Content;
getElementName(): string;
getInternalSubset(): string;
@@ -127,7 +127,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML document.
*/
export interface Document {
interface Document {
addContent(content: Content): Document;
addContent(index: Integer, content: Content): Document;
cloneContent(): Content[];
@@ -167,7 +167,7 @@ declare namespace GoogleAppsScript {
* xml = XmlService.getPrettyFormat().format(document);
* Logger.log(xml);
*/
export interface Element {
interface Element {
addContent(content: Content): Element;
addContent(index: Integer, content: Content): Element;
cloneContent(): Content[];
@@ -213,7 +213,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML EntityReference node.
*/
export interface EntityRef {
interface EntityRef {
detach(): Content;
getName(): string;
getParentElement(): Element;
@@ -239,7 +239,7 @@ declare namespace GoogleAppsScript {
* .format(document);
* Logger.log(output);
*/
export interface Format {
interface Format {
format(document: Document): string;
format(element: Element): string;
setEncoding(encoding: string): Format;
@@ -252,7 +252,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML namespace.
*/
export interface Namespace {
interface Namespace {
getPrefix(): string;
getURI(): string;
}
@@ -260,7 +260,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML ProcessingInstruction node.
*/
export interface ProcessingInstruction {
interface ProcessingInstruction {
detach(): Content;
getData(): string;
getParentElement(): Element;
@@ -271,7 +271,7 @@ declare namespace GoogleAppsScript {
/**
* A representation of an XML Text node.
*/
export interface Text {
interface Text {
append(text: string): Text;
detach(): Content;
getParentElement(): Element;
@@ -319,7 +319,7 @@ declare namespace GoogleAppsScript {
* Logger.log(xml);
* }
*/
export interface XmlService {
interface XmlService {
ContentTypes: typeof ContentType;
createCdata(text: string): Cdata;
createComment(text: string): Comment;
@@ -340,7 +340,6 @@ declare namespace GoogleAppsScript {
getXmlNamespace(): Namespace;
parse(xml: string): Document;
}
}
}
types/google-apps-script/index.d.ts
Vendored
+3 -2
View File
@@ -1,6 +1,7 @@
// Type definitions for google-apps-script
// Type definitions for google-apps-script 1.0
// Project: https://developers.google.com/apps-script/
// Definitions by: motemen <https://github.com/motemen>, grant <https://github.com/grant>
// Definitions by: motemen <https://github.com/motemen>
// grant <https://github.com/grant>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2
types/google-apps-script/tslint.json
+1 -70
View File
@@ -1,80 +1,11 @@
{
"extends": "dtslint/dt.json",
"rules": {
"adjacent-overload-signatures": false,
"array-type": false,
"arrow-return-shorthand": false,
"ban-types": false,
"callable-types": false,
"comment-format": false,
"dt-header": false,
"npm-naming": false,
"eofline": false,
"export-just-namespace": false,
"import-spacing": false,
"interface-name": false,
"interface-over-type-literal": false,
"jsdoc-format": false,
"max-line-length": false,
"member-access": false,
"new-parens": false,
"no-any-union": false,
"no-boolean-literal-compare": false,
"no-conditional-assignment": false,
"no-consecutive-blank-lines": false,
"no-construct": false,
"no-declare-current-package": false,
"no-duplicate-imports": false,
"no-duplicate-variable": false,
"no-empty-interface": false,
"no-for-in-array": false,
"no-inferrable-types": false,
"no-internal-module": false,
"no-irregular-whitespace": false,
"no-mergeable-namespace": false,
"no-misused-new": false,
"no-namespace": false,
"no-object-literal-type-assertion": false,
"no-padding": false,
"no-redundant-jsdoc": false,
"no-redundant-jsdoc-2": false,
"no-redundant-undefined": false,
"no-reference-import": false,
"no-relative-import-in-test": false,
"no-self-import": false,
"no-single-declare-module": false,
"no-string-throw": false,
"no-unnecessary-callback-wrapper": false,
"no-unnecessary-class": false,
"no-unnecessary-generics": false,
"no-unnecessary-qualifier": false,
"no-unnecessary-type-assertion": false,
"no-useless-files": false,
"no-var-keyword": false,
"no-var-requires": false,
"no-void-expression": false,
"no-trailing-whitespace": false,
"object-literal-key-quotes": false,
"object-literal-shorthand": false,
"one-line": false,
"one-variable-per-declaration": false,
"only-arrow-functions": false,
"prefer-conditional-expression": false,
"prefer-const": false,
"prefer-declare-function": false,
"prefer-for-of": false,
"prefer-method-signature": false,
"prefer-template": false,
"radix": false,
"semicolon": false,
"space-before-function-paren": false,
"space-within-parens": false,
"strict-export-declare-modifiers": false,
"trim-file": false,
"triple-equals": false,
"typedef-whitespace": false,
"unified-signatures": false,
"void-return": false,
"whitespace": false
"unified-signatures": false
}
}