diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 81913375f9..43267255d1 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -55,7 +55,6 @@ /types/aframe/ @devpaul @bertoritger @twastvedt /types/agenda/ @meirgottlieb @princjef /types/agent-base/ @Shinigami92 -/types/aggregate-error/ @BendingBender /types/agora-rtc-sdk/ @menthays /types/airbnb-prop-types/ @milesj /types/ajv-errors/ @afshawnlotfi @@ -75,6 +74,8 @@ /types/almost-equal/ @cmaddalozzo /types/alt/ @Shearerbeard /types/amap-js-api/ @breeze9527 +/types/amap-js-api-indoor-map/ @breeze9527 +/types/amap-js-api-map3d/ @breeze9527 /types/amap-js-sdk/ @agasbzj /types/amazon-cognito-auth-js/ @scottescue /types/amazon-product-api/ @MattiLehtinen @alien35 @@ -268,7 +269,7 @@ /types/auto-bind/ @sseppola /types/auto-launch/ @rhysd @unindented /types/auto-sni/ @janwo -/types/autobahn/ @darkl @a904guy @valepu @glenroy37 +/types/autobahn/ @darkl @a904guy @valepu @glenroy37 @spcfran /types/autolinker/ @leonyu /types/autoprefixer/ @odnamrataizem @murt /types/autosize/ @kingdango @keika299 @NeekSandhu @@ -387,7 +388,7 @@ /types/bl/ @Bartvds @reconbot /types/blacklist/ @mhegazy /types/blazy/ @julienpa -/types/blessed/ @brynbellomy @skellock +/types/blessed/ @brynbellomy @skellock @mamachanko /types/blissfuljs/ @fskorzec /types/blob-stream/ @erichillah /types/blob-to-buffer/ @nrlquaker @@ -462,6 +463,7 @@ /types/browserslist-useragent/ @nju33 /types/bs58/ @chrootsu @BendingBender /types/bs58/v3/ @chrootsu +/types/bser/ @claasahl /types/bson/ @horiuchi @CaselIT @justingrant /types/btoa/ @johngeorgewright @bricka /types/buble/ @Kocal @@ -476,7 +478,7 @@ /types/bufferstream/ @Bartvds /types/build-output-script/ @BendingBender /types/builtin-modules/ @ajafff -/types/bull/ @bgrieder @JProgrammer @marshall007 @weeco @blaugold @iamolegga @koblas @bondz @wuha-team @aleccool213 @danmana @kjellmorten @pc-jedi +/types/bull/ @bgrieder @JProgrammer @marshall007 @weeco @blaugold @iamolegga @koblas @bondz @wuha-team @aleccool213 @danmana @kjellmorten @pc-jedi @lenovouser /types/bull/v2/ @bgrieder @JProgrammer /types/bump-regex/ @silkentrance /types/bunnymq/ @cyrilschumacher @@ -581,6 +583,7 @@ /types/cheerio/ @blittle @wmaurer @umarniz @LiJinyao @chennakrishna8 @AzSiAz @nwtgck /types/chess.js/ @JacobFischer /types/chessboardjs/ @sliverb @davidmpaz +/types/child-process-promise/ @TheDSCPL /types/chmodr/ @BendingBender /types/chordsheetjs/ @adamsbloom /types/chosen-js/ @borisyankov @denisname @@ -594,6 +597,7 @@ /types/chromedriver/ @pe8ter /types/cipher-base/ @adamzerella /types/circuit-breaker-js/ @DeTeam +/types/circular-dependency-plugin/ @jeremejevs /types/circular-json/ @jpevarnek /types/ckeditor/ @wittwert @stuartlong @viktorpegy /types/ckeditor/v2/ @wittwert @@ -642,6 +646,7 @@ /types/cloudflare-apps/ @MartynasZilinskas /types/clovelced-plugin-audiomanagement/ @marckassay /types/cls-hooked/ @aleung +/types/clui/ @farzadmf /types/clusterize.js/ @Pr1st0n /types/cmd-shim/ @cspotcode /types/co/ @doniyor2109 @@ -949,7 +954,6 @@ /types/decode-entities/ @waspothegreat /types/decode-uri-component/ @BendingBender /types/decompress/ @plantain-00 @jbethke -/types/decompress-response/ @DanielRosenwasser /types/decorum/ @dflor003 /types/dedent/ @douglasduteil /types/deep-assign/ @souldreamer @@ -1038,7 +1042,6 @@ /types/dom-clipboard-api/ @43081j /types/dom-helpers/ @mctep /types/dom-inputevent/ @diagramatics -/types/dom-loaded/ @ltetzlaff /types/dom-mediacapture-record/ @eliasmeire /types/dom-to-image/ @JipSterk /types/dom4/ @adidahiya @giladgray @@ -1144,12 +1147,12 @@ /types/electron-window-state/ @rhysd /types/electron-winstaller/ @shiftkey @unindented /types/elegant-spinner/ @danwbyrne -/types/element-ready/ @BendingBender /types/element-resize-detector/ @saranshkataria @franklixuefei /types/element-resize-event/ @rogierschouten @plgregoire /types/elementtree/ @dwieeb /types/elliptic/ @danwbyrne @Gilthoniel /types/elm/ @thSoft +/types/elo-rank/ @apavlinovic /types/email-templates/ @cyrilschumacher @gurisko @blankstar85 /types/ember/ @jedmao @bttf @dwickern @chriskrycho @theroncross @mfeckie @alexlafroscia @mike-north @BryanCrotaz /types/ember/v2/ @jedmao @bttf @dwickern @chriskrycho @theroncross @mfeckie @alexlafroscia @mike-north @@ -1300,7 +1303,7 @@ /types/express-brute-memcached/ @cyrilschumacher /types/express-brute-mongo/ @cyrilschumacher /types/express-brute-redis/ @scottharwell -/types/express-bunyan-logger/ @shreyjain1994 +/types/express-bunyan-logger/ @shreyjain1994 @mastermatt /types/express-busboy/ @pinguet62 /types/express-cluster/ @nenadalm /types/express-correlation-id/ @natemara @@ -1430,8 +1433,6 @@ /types/file-exists/ @BendingBender /types/file-saver/ @cyrilschumacher @DaIgeb @chrismbarr /types/file-url/ @coderslagoon -/types/filenamify/ @rokt33r -/types/filenamify-url/ @cprecioso /types/filesize/ @GiedriusGrabauskas @renchap @Ky6uk @ffxsam /types/fill-pdf/ @westy92 /types/filter-console/ @BendingBender @@ -1464,13 +1465,12 @@ /types/first-run/ @BendingBender /types/fixed-data-table/ @pepaar @stephenjelfs /types/fixed-data-table-2/ @ilivit -/types/fkill/ @BendingBender /types/flagged-respawn/ @BendingBender /types/flat/ @chrootsu /types/fleximap/ @DanielRose /types/flexmonster/ @flexmonster /types/flexslider/ @diullei -/types/flickity/ @clmcgrath @wagich +/types/flickity/ @clmcgrath @wagich @aheber /types/flight/ @jonathanhedren /types/flightplan/ @borislavjivkov /types/flipsnap/ @kubosho @gsino @mayuki @@ -1725,7 +1725,6 @@ /types/get-range/ @BendingBender /types/get-res/ @satyarohith /types/get-stdin/ @DanielRosenwasser -/types/get-stream/ @douglasduteil @BendingBender /types/get-urls/ @BendingBender /types/get-value/ @DanielRosenwasser /types/getenv/ @impankratov @@ -1796,6 +1795,7 @@ /types/google-cloud__kms/ @ben-tbotlabs /types/google-cloud__pubsub/ @pheromonez @LunaPg @msiviero /types/google-cloud__tasks/ @ifiokjr +/types/google-cloud__text-to-speech/ @benhjames /types/google-earth/ @icholy /types/google-images/ @dolanmiu /types/google-libphonenumber/ @leonyu @winfinit @@ -1962,11 +1962,9 @@ /types/harmony-proxy/ @remojansen /types/has-ansi/ @BendingBender /types/has-emoji/ @BendingBender -/types/has-yarn/ @BendgingBender /types/hash-file/ @HiromiShikata /types/hash-stream/ @BendingBender /types/hash-sum/ @DanielRosenwasser -/types/hasha/ @BendgingBender /types/hasher/ @flyfishMT /types/hashids/ @pocesar /types/hashmap/ @outring @@ -1994,7 +1992,7 @@ /types/hexo-fs/ @segayuu /types/hexo-log/ @segayuu /types/hexo-util/ @segayuu -/types/highcharts/ @damianog @baltie @AlbertOzimek @hanssens @jgresham +/types/highcharts/ @damianog @baltie @AlbertOzimek @hanssens @jgresham @Arunkeshavareddy /types/highcharts-ng/ @scatcher /types/highland/ @Bartvds @hgwood @iwllyu @alvis @notbobthebuilder /types/highlight.js/ @nikeee @sourrust @joshuakgoldberg @@ -2121,6 +2119,7 @@ /types/iniparser/ @chrootsu /types/init-package-json/ @kfarnung /types/ink/ @cprecioso +/types/ink-select-input/ @lukostry /types/ink-spinner/ @lukostry /types/ink-table/ @lukostry /types/ink-testing-library/ @MancunianSam @@ -2128,7 +2127,7 @@ /types/inline-css/ @philipisapain /types/inline-style-prefixer/ @ahz @dpetrezselyova @franklixuefei /types/inputmask/ @dmester -/types/inquirer/ @tkQubo @ppathan @jouderianjr @bang88 @bitjson @synarque @jrockwood @kwkelly @Ailrun +/types/inquirer/ @tkQubo @ppathan @jouderianjr @bang88 @bitjson @synarque @jrockwood @kwkelly @Ailrun @chigix /types/inquirer-npm-name/ @manuth /types/insert-css/ @hvoecking /types/insert-module-globals/ @leonard-thieu @@ -2139,13 +2138,13 @@ /types/intercom-web/ @fongandrew @salbahra @onatm /types/intercomjs/ @spencerwi /types/interpret/ @BendingBender +/types/intersects/ @voxylu /types/intl/ @RagibHasin /types/intl-locales-supported/ @Slessi /types/intl-messageformat/ @mhegazy /types/intl-relativeformat/ @mohsen1 /types/intl-tel-input/ @fdnhkj @leonard-thieu @molnarm /types/intl-tel-input/v13/ @fdnhkj @leonard-thieu -/types/into-stream/ @BendingBender /types/intrinsic-scale/ @shalomdotnet /types/intro.js/ @anahkiasen /types/invariant/ @bennett000 @@ -2181,6 +2180,7 @@ /types/is-ci/ @atd-schubert /types/is-color/ @VitorLuizC /types/is-compressed/ @mhegazy +/types/is-date-object/ @adamzerella /types/is-docker/ @YashdalfTheGray /types/is-dotdir/ @BendingBender /types/is-dotfile/ @BendingBender @@ -2216,7 +2216,6 @@ /types/is-root/ @mhegazy /types/is-root-path/ @mhegazy /types/is-running/ @danwbyrne -/types/is-scoped/ @postcrafter /types/is-stream/ @me /types/is-text-path/ @mhegazy /types/is-touch-device/ @screendriver @@ -2561,6 +2560,7 @@ /types/k6/ @MajorBreakfast /types/kafka-node/ @dansitu @bkim54 @sfrooster @amiram @insanehong /types/kafkajs/ @michal-b-kaminski +/types/kamailio-kemi/ @bonan /types/karma/ @tkrotoff @43081j @devoto13 /types/karma/v1/ @tkrotoff @43081j /types/karma-chai/ @JayAndCatchFire @@ -2598,7 +2598,6 @@ /types/klaw/v1/ @mceachen /types/klaw-sync/ @shiftkey /types/kms-json/ @sunnyone -/types/knex/ @tkQubo @MeLlamoPablo @mastermatt @micksatana @shreyjain1994 @joelshepherd /types/knex-postgis/ @vesse /types/knockback/ @borisyankov /types/knockout/ @borisyankov @Igorbek @moonpyk @EnableSoftware @BenjaminEckardt @ffMathy @ltlombardi @Retsam @@ -2693,7 +2692,6 @@ /types/lasso/ @darkwebdev /types/later/ @jasond-s /types/latest-semver/ @BendingBender -/types/latest-version/ @BendingBender /types/latinize/ @GiedriusGrabauskas /types/latlon-geohash/ @rimig /types/launchpad/ @rictic @@ -2749,14 +2747,13 @@ /types/leveldown/v1/ @tarruda @LinusU /types/levelup/ @MeirionHughes @danwbyrne /types/levelup/v1/ @blittle @tarruda -/types/leven/ @jmalonzo /types/levenshtein/ @geoffreak /types/libpq/ @Lodin /types/libsodium-wrappers/ @ffflorian /types/libsodium-wrappers-sumo/ @ffflorian /types/libxmljs/ @fdecampredon @ComFreek /types/libxslt/ @alejo90 -/types/license-checker/ @rogierschouten @unindented +/types/license-checker/ @rogierschouten @unindented @alechemy /types/liftoff/ @BendingBender /types/lil-uri/ @wcarson /types/lil-uuid/ @Pr1st0n @@ -3220,7 +3217,6 @@ /types/media-typer/ @BendingBender /types/medium-editor/ @keika299 @pascaliske /types/megajs/ @danwbyrne -/types/mem/ @SamVerschueren /types/mem-cache/ @MutterPedro /types/mem-fs/ @MyFoodBag /types/mem-fs-editor/ @MyFoodBag @@ -3379,7 +3375,7 @@ /types/msgpack5/ @wokim @heycalmdown /types/msnodesql/ @borisyankov @SomaticIT /types/msportalfx-test/ @julioct -/types/mssql/ @jaminfarr @buzinas @mrrichar @elhaard @pkeuter @mcdado +/types/mssql/ @jaminfarr @buzinas @mrrichar @elhaard @pkeuter @mcdado @woodenconsulting /types/mu2/ @jedigo /types/mui-datatables/ @favna @ankithkonda /types/muicss/ @samuelneff @@ -3433,6 +3429,7 @@ /types/nconf/ @jedigo @jmthibault @ew73 /types/ncp/ @bartvds /types/ndarray/ @pawsong @taoqf +/types/ndn-js/ @yoursunny /types/nearley/ @deltaidea @BendingBender /types/neat-csv/ @calamitizer /types/nedb/ @reppners @anthonynichols @afharo @@ -3515,9 +3512,9 @@ /types/node-dir/ @panuhorsmalahti /types/node-dogstatsd/ @chrisbobo @xzyfer /types/node-emoji/ @jonestristand @styu @rimiti -/types/node-fetch/ @torstenwerner @nikcorg @vinaybedre @kyranet +/types/node-fetch/ @torstenwerner @nikcorg @vinaybedre @kyranet @AndrewLeedham /types/node-fibers/ @caryhaynie -/types/node-forge/ @westy92 @flynetworks @a-k-g @rafal2228 @beenotung @joeflateau @Apologiz @timhwang21 @supaiku0 @andersk +/types/node-forge/ @westy92 @flynetworks @a-k-g @rafal2228 @beenotung @joeflateau @Apologiz @timhwang21 @supaiku0 @andersk @saschazar21 /types/node-gcm/ @horiuchi /types/node-geocoder/ @rosek86 /types/node-getopt/ @kcauchy @@ -3577,6 +3574,7 @@ /types/nodeunit/ @jedigo /types/noisejs/ @izmhr /types/nomnom/ @panopticoncentral +/types/nonogram-solver/ @me /types/nookies/ @andreasbergqvist /types/nopt/ @jbondc /types/normalize-package-data/ @jdxcode @@ -3591,15 +3589,12 @@ /types/nouislider/v7/ @acoreyj /types/novnc-core/ @smithkl42 @BendingBender /types/npm/ @SomaticIT -/types/npm-email/ @BendingBender -/types/npm-keyword/ @BendingBender /types/npm-license-crawler/ @ffflorian /types/npm-list-author-packages/ @ffflorian /types/npm-package-arg/ @mgroenhoff @OiYouYeahYou /types/npm-packlist/ @ajafff /types/npm-paths/ @BendingBender /types/npm-registry-package-info/ @ffflorian -/types/npm-user/ @BendingBender /types/npm-user-packages/ @BendingBender /types/npmlog/ @DanielMSchmidt @littlepiggy03 /types/ns-api/ @Archcry @@ -3668,7 +3663,7 @@ /types/onionoo/ @BendingBender /types/onoff/ @marcel-ernst @Kallu609 /types/ontime/ @Hirse -/types/open/ @Bartvds +/types/open/ @shinnn @SomaticIT @tlent @ffflorian /types/open-editor/ @BendingBender /types/open-graph/ @ffflorian /types/openapi-factory/ @runebaas @@ -3684,9 +3679,8 @@ /types/openlayers/v2/ @bolhovsky /types/openpgp/ @errietta @damonpam @po5i @ecamellini @SardineFish /types/openstack-wrapper/ @sanjaymadane -/types/opentok/ @westy92 @CatGuardian +/types/opentok/ @westy92 @CatGuardian @pronebird /types/opentype.js/ @danmarshall @edzis -/types/opn/ @shinnn @SomaticIT @tlent /types/opossum/ @quinnlangille @merufm @lance @mastermatt /types/optics-agent/ @crevil /types/optimist/ @soywiz @chbrown @@ -3712,34 +3706,16 @@ /types/owl.carousel/ @igorissen @KennethanCeyer /types/owlcarousel/ @dpiatkowski /types/p-all/ @BendingBender -/types/p-any/ @BendingBender -/types/p-cancelable/ @BendingBender -/types/p-catch-if/ @LinusU -/types/p-debounce/ @BendingBender /types/p-defer/ @SamVerschueren @BendingBender /types/p-do-whilst/ @BendingBender -/types/p-each-series/ @BendingBender -/types/p-every/ @BendingBender /types/p-forever/ @BendingBender /types/p-is-promise/ @BendingBender /types/p-lazy/ @BendingBender /types/p-loading/ @renjfk -/types/p-locate/ @BendingBender -/types/p-log/ @BendingBender -/types/p-map-series/ @BendingBender -/types/p-memoize/ @forabi /types/p-min-delay/ @BendingBender -/types/p-one/ @BendingBender -/types/p-progress/ @icopp -/types/p-props/ @BendingBender -/types/p-reduce/ @BendingBender /types/p-reflect/ @BendingBender -/types/p-retry/ @BendingBender -/types/p-series/ @BendingBender /types/p-settle/ @natesilva -/types/p-tap/ @BendingBender /types/p-time/ @BendingBender -/types/p-timeout/ @BendingBender /types/p-times/ @BendingBender /types/p-try/ @BendingBender @LinusU /types/p-wait-for/ @BendingBender @@ -3748,7 +3724,6 @@ /types/p-whilst/ @BendingBender /types/p2/ @clark-stevenson @jramstedt /types/p5/ @p5-types -/types/package-json/ @jinwoo @BendingBender /types/packery/ @piraveen @hanssens /types/pad/ @mhegazy /types/page/ @43081j @@ -3768,7 +3743,7 @@ /types/parity-pmr/ @leovujanic /types/parity-poe/ @leovujanic /types/park-miller/ @BendingBender -/types/parse/ @dpoetzsch @jaeggerr @flavionegrao @wesleygrimes @owsas @agoldis @AlexandreHetu +/types/parse/ @dpoetzsch @jaeggerr @flavionegrao @wesleygrimes @owsas @agoldis @AlexandreHetu @dplewis @yomybaby /types/parse/v1/ @dpoetzsch @jaeggerr @flavionegrao @wesleygrimes @owsas /types/parse-columns/ @BendingBender /types/parse-filepath/ @BendingBender @@ -3821,7 +3796,7 @@ /types/passport-oauth2/ @pasieronen @WangZishi @EduardoAC @ivan94 /types/passport-oauth2-client-password/ @akaNightmare /types/passport-remember-me-extended/ @AylaJK -/types/passport-saml/ @cjbarth @dassennato @ksamborski +/types/passport-saml/ @cjbarth @dassennato @ksamborski @josecolella /types/passport-steam/ @kzay /types/passport-strategy/ @liorm /types/passport-twitter/ @staticfunction @@ -3835,7 +3810,6 @@ /types/path-is-absolute/ @mhegazy /types/path-is-inside/ @aomarks /types/path-regex/ @BendingBender -/types/path-type/ @BendingBender /types/pathfinding/ @BNedry /types/pathjs/ @lokeshpeta /types/pathwatcher/ @GlenCFL @@ -3907,9 +3881,7 @@ /types/piwik-tracker/ @lbguilherme /types/pixelmatch/ @iamolegga /types/pixi.js/ @clark-stevenson -/types/pkg-dir/ @NK-WEB-Git /types/pkg-up/ @forivall -/types/pkg-versions/ @BendingBender /types/pkgcloud/ @dantman /types/pkijs/ @microshine /types/platform/ @JakeH @@ -3939,6 +3911,8 @@ /types/pollyjs__persister-fs/ @feinoujc /types/pollyjs__utils/ @feinoujc /types/polyfill-service/ @Alorel +/types/polygon/ @Nielio +/types/polygons-intersect/ @Nielio /types/polylabel/ @DenisCarriere /types/polyline/ @Kern0 /types/polymer/ @lgrignon @laco0416 @@ -3978,6 +3952,7 @@ /types/pouchdb-upsert/ @keithdmoore @hotforfeature @apolkingg8 @zamb3zi /types/power-assert/ @vvakame /types/power-assert-formatter/ @vvakame +/types/powerapps-component-framework/ @jopursle /types/powerbi-visuals-tools/ @zBritva @Microsoft /types/preact-i18n/ @ltetzlaff /types/precise/ @codeanimal @@ -4330,7 +4305,7 @@ /types/react-loader/ @artfuldev /types/react-lottie/ @Kana00 @Ricki-BumbleDev /types/react-mailchimp-subscribe/ @osdiab -/types/react-map-gl/ @rimig @fnberta +/types/react-map-gl/ @rimig @fnberta @sandersiim /types/react-maskedinput/ @LKay @lavoaster @CarlosBonetti /types/react-material-ui-form-validator/ @FrankBrullo /types/react-mce/ @morphologue @@ -4351,6 +4326,7 @@ /types/react-native-background-timer/ @chillkroeteTTS /types/react-native-bluetooth-serial/ @RodrigoAWeber /types/react-native-calendars/ @Tyler-Zhang @DavidNorena @FabianMeul +/types/react-native-canvas/ @hmajid2301 /types/react-native-communications/ @huhuanming @PaitoAnderson /types/react-native-custom-tabs/ @philnova /types/react-native-datepicker/ @jacobbaskin @nossbigg @@ -4492,6 +4468,7 @@ /types/react-s-alert/ @mitsuruog /types/react-scroll/ @sudoplz @GiedriusGrabauskas /types/react-scroll-into-view-if-needed/ @angusfretwell @allanpope @jonathanly +/types/react-scrollable-anchor/ @AntoineDoubovetzky /types/react-scrollbar/ @stephenjelfs /types/react-scrollspy/ @ZhangYiJiang /types/react-select/ @claasahl @jonfreedman @@ -4524,7 +4501,7 @@ /types/react-svg-pan-zoom/ @huy-nguyen /types/react-swf/ @stepancar /types/react-swipe/ @DeividasBakanas @AAlakkad -/types/react-swipeable/ @GiedriusGrabauskas @mctep @horiuchi +/types/react-swipeable/ @GiedriusGrabauskas @mctep @horiuchi @adambowles /types/react-swipeable-views/ @mxl @DeividasBakanas /types/react-syntax-highlighter/ @NoHomey @ajgamble-milner /types/react-table/ @royxue @psakalo @Havret @andys8 @Gelio @@ -4539,6 +4516,7 @@ /types/react-test-renderer/v15/ @arvitaly @lochbrunner @lochbrunner @johnnyreilly /types/react-tether/ @ryprice /types/react-text-mask/ @guilhermehubner @cavarzan @needpower +/types/react-text-truncate/ @adriantoine /types/react-textarea-autosize/ @asvetliakov @zry656565 /types/react-timeago/ @koss-lebedev /types/react-timeout/ @kerwynrg @@ -4565,7 +4543,7 @@ /types/react-weui/ @tairan /types/react-widgets/ @rogierschouten @sanyatuning @frodehansen2 @r3nya @MBillemaz @georg94 @tzarger @vegtelenseg /types/react-widgets-moment/ @dawnmist -/types/react-window/ @martynaskadisa @heyimalex +/types/react-window/ @martynaskadisa @heyimalex @jgoz /types/react-window-size/ @jakejrichards /types/react-wow/ @mikepthomas /types/react-youtube/ @kgtkr @salguerooo @@ -4576,7 +4554,7 @@ /types/reactstrap/v4/ @alihammad @mfal @danilobjr @fabiopaiva /types/read/ @timjk /types/read-package-tree/ @mgroenhoff -/types/read-pkg/ @jdxcode +/types/read-pkg/ @jdxcode @arichardsmith /types/read-pkg-up/ @dudeofawesome @jdxcode /types/readable-stream/ @TeamworkGuy2 /types/readdir-enhanced/ @mrmlnc @@ -4610,11 +4588,11 @@ /types/reduce-reducers/ @huy-nguyen @daliusd /types/redux-action/ @newraina /types/redux-action-utils/ @tkqubo -/types/redux-actions/ @jaysoo @alexgorbatchev @alechill @alexey-pelykh @7hi4g0 +/types/redux-actions/ @jaysoo @alexgorbatchev @alechill @alexey-pelykh @7hi4g0 @oddui /types/redux-async-queue/ @andreiho /types/redux-auth-wrapper/ @LKay /types/redux-auth-wrapper/v1/ @LKay -/types/redux-batched-subscribe/ @mDibyo +/types/redux-batched-subscribe/ @mDibyo @azizhk /types/redux-debounced/ @seansfkelley /types/redux-devtools/ @mc-petry /types/redux-devtools-dock-monitor/ @mc-petry @@ -4624,7 +4602,7 @@ /types/redux-first-router-link/ @janb87 /types/redux-first-router-restore-scroll/ @icopp /types/redux-first-routing/ @tlaziuk -/types/redux-form/ @carsonf @aikoven @LKay @bancek @alsiola @tehbi4 @huwmartin @ethanresnick @reggino @maddijoyce @smifun @mshaaban088 @esetnik @bwlt +/types/redux-form/ @carsonf @aikoven @LKay @bancek @alsiola @tehbi4 @huwmartin @ethanresnick @reggino @maddijoyce @smifun @mshaaban088 @esetnik @bwlt @mrsekut /types/redux-form/v7/ @carsonf @aikoven @LKay @bancek @alsiola @tehbi4 @huwmartin @ethanresnick @reggino @maddijoyce @smifun @mshaaban088 @esetnik /types/redux-form/v6/ @carsonf @aikoven @LKay @bancek @mshaaban088 /types/redux-form/v4/ @aikoven @@ -4649,6 +4627,7 @@ /types/redux-recycle/ @LKay /types/redux-router/ @stepancar /types/redux-saga-tester/ @BenLorantfy @lawsumisu +/types/redux-seamless-immutable/ @SoaresMG /types/redux-sentry-middleware/ @dolezel /types/redux-shortcuts/ @tstirrat /types/redux-socket.io/ @snakeego @@ -4711,6 +4690,7 @@ /types/resolve-from/ @unional @BendingBender /types/resolve-from/v2/ @unional /types/resolve-global/ @BendingBender +/types/resolve-options/ @delprzemo /types/resolve-pkg/ @mabels @BendingBender /types/resourcejs/ @shaunluttin /types/response-time/ @urossmolnik @TonyPythoneer @danmana @@ -4857,13 +4837,12 @@ /types/schema-registry/ @bonzzy /types/schwifty/ @ozum /types/scoped-http-client/ @mattvperry @rianadon -/types/screenfull/ @icholy @lionelb @joelshepherd @BendingBender -/types/screenfull/v3/ @icholy @lionelb @joelshepherd /types/screeps/ @MarkoSulamagi @NhanHo @bryanbecker @resir014 @Arcath @dmarcuse /types/screeps-profiler/ @ramblurr /types/script-ext-html-webpack-plugin/ @davecardwell /types/scriptjs/ @ssttevee /types/scroll-into-view/ @zivni +/types/scroll-to-element/ @kirillurgant /types/scroller/ @haskellcamargo /types/scrollparent/ @Sintifo /types/scrollreveal/ @Davidblkx @@ -5006,7 +4985,6 @@ /types/simplesmtp/ @rogierschouten /types/simplestorage.js/ @axelcostaspena @mxl /types/sindresorhus__class-names/ @BendingBender -/types/sindresorhus__df/ @whatknight /types/sindresorhus__djb2a/ @BendingBender /types/sindresorhus__fnv1a/ @BendingBender /types/sindresorhus__string-hash/ @BendingBender @@ -5046,6 +5024,7 @@ /types/slate-react/ @andykent @majelbstoat @JanLoebel @PatrickSachs @YangusKhan @isubasti @sgreav @Kornil @jackall3n /types/sleep/ @rajarz /types/slice-ansi/ @dwieeb +/types/slick-carousel/ @Kocal /types/slickgrid/ @jbaldwin /types/slideout/ @ToastHawaii /types/slimerjs/ @alexwall @@ -5227,7 +5206,7 @@ /types/stripe/ @wjohnsto @codeanimal @sampsonjoliver @LinusU @brannon @kkamperschroer @starhoshi @bruun @galtalmor @htunnicliff @squirly @tzarger @ifiokjr @SimonSchick @yultyyev @cpsoinos @adamduren @saranshkataria @0xJoKe @delianides /types/stripe-checkout/ @cgwrench /types/stripe-v2/ @ejsmith @amritk @adamcmiel @jleider @galuszkak -/types/stripe-v3/ @ejsmith @amritk @adamcmiel @jleider @galuszkak @slangeder +/types/stripe-v3/ @ejsmith @amritk @adamcmiel @jleider @galuszkak @slangeder @marlosin /types/stripejs/ @RobinvanTienhoven @mattferderer /types/strong-cluster-control/ @shuntksh /types/strong-error-handler/ @blankstar85 @@ -5241,7 +5220,7 @@ /types/styled-react-modal/ @Lavoaster /types/styled-system/ @maxdeviant @phobon @zephraph @damassi @alloy @maoueh @lavoaster @jschuler @adam187 @gretzky @chrislopresto /types/styled-theming/ @ArjanJ -/types/stylelint/ @alan-agius4 @filipsalpe +/types/stylelint/ @alan-agius4 @filipsalpe @43081j /types/stylelint/v7/ @alan-agius4 /types/stylelint-webpack-plugin/ @bahlo /types/stylenames/ @bengry @@ -5368,6 +5347,7 @@ /types/texzilla/ @m93a /types/tgfancy/ @Dabolus /types/theming/ @eps1lon +/types/then-eos/ @seangenabe /types/theo/ @petekp @laitine /types/thepiratebay/ @jsorrell /types/three/ @gyohk @florentpoujol @omni360 @ivoisbelongtous @piranha771 @qszhusightp @nakakura @Pro @efokschaner @PsychoSTS @apurvaojas @NotWoods @Methuselah96 @Dukuo @JulianSSS @devilsparta @KonstantinLukaschenko @danyim @saranshkataria @psuter @@ -5512,6 +5492,7 @@ /types/underscore.string/ @rygine /types/undertaker/ @tkqubo @GiedriusGrabauskas /types/undertaker-registry/ @GiedriusGrabauskas +/types/uni-app/ @dcloudio /types/unidecode/ @vfernandestoptal /types/uniq/ @hansrwindhoff /types/uniqid/ @idchlife @@ -5527,7 +5508,6 @@ /types/unorm/ @chbrown /types/unsplash-js/ @markupcode /types/untildify/ @BendingBender -/types/unused-filename/ @BendingBender /types/unzip/ @coding2012 /types/unzipper/ @s73obrien @natemara @bartje321 /types/update-notifier/ @vvakame @nchen63 @bitjson @grinich @@ -5588,9 +5568,11 @@ /types/validatorjs/ @LKay @danmana @MatiasOlivera /types/vanilla-modal/ @samnau /types/vanilla-tilt/ @BrunnerLivio +/types/vara/ @Chnapy /types/varint/ @dbrockman /types/vary/ @BendingBender /types/vast-client/ @jgainfort @kobawan +/types/vec2/ @Nielio /types/vec3/ @xstoudi /types/vectorious/ @erikgerrits /types/velocity-animate/ @smrq @@ -5658,7 +5640,6 @@ /types/walk/ @poppa /types/wallabyjs/ @andrewconnell /types/wallop/ @leemcd56 -/types/wallpaper/ @BendingBender /types/wampy/ @KSDaemon /types/warning/ @cvle /types/watch/ @soywiz @Perlmint @@ -5772,6 +5753,7 @@ /types/word-list-json/ @dovidm /types/word2vector/ @renekeijzer /types/wordcloud/ @joeskeen +/types/wordpress__jest-console/ @mistic100 /types/words-to-numbers/ @James-Frowen /types/wordwrap/ @ark120202 /types/workbox-sw/ @wessberg @@ -5801,7 +5783,7 @@ /types/xml-parser/ @mhfrantz /types/xml2js/ @michelsalib @jasonrm @ccurrens @edwardhinkle @BehindTheMath @claasahl /types/xml2json/ @dolanmiu -/types/xmlbuilder/ @wallymathieu +/types/xmlbuilder/ @wallymathieu @GaikwadPratik /types/xmldoc/ @Xstoudi @ajsheehan @notlaforge /types/xmldom/ @tkqubo /types/xmlpoke/ @garthk @@ -5834,7 +5816,7 @@ /types/ydn-db/ @yathit @gabrielmaldi /types/year-days/ @BendingBender /types/yeoman-assert/ @Toilal -/types/yeoman-generator/ @armorik83 @janslow @ikatyang @tasadar2 @haggen +/types/yeoman-generator/ @armorik83 @janslow @ikatyang @tasadar2 @haggen @chigix /types/yeoman-test/ @ikatyang /types/yesql/ @Sumolari /types/yn/ @BendingBender @@ -5850,6 +5832,7 @@ /types/yui/ @giabao /types/yup/ @dhardtke @vtserman @MoretonBayRC @sseppola @YashdalfTheGray @vincentjames501 @robertbullen @sat0yu @dancrumb /types/z-schema/ @pgonzal +/types/zeit__next-source-maps/ @ldthorne /types/zeit__next-typescript/ @icopp /types/zen-observable/ @aicest @JounQin @itomtom /types/zen-push/ @daprahamian diff --git a/README.es.md b/README.es.md index df675cbe41..4ba1be28fc 100644 --- a/README.es.md +++ b/README.es.md @@ -332,5 +332,3 @@ Es más apropiado importar este módulo utilizando la sintaxis `import foo = req Este proyecto es licenciado bajo la licencia MIT. Los derechos de autor de cada archivo de definición son respectivos de cada contribuidor listado al comienzo de cada archivo de definición. - -[![Analytics](https://ga-beacon.appspot.com/UA-47495295-4/borisyankov/DefinitelyTyped)](https://github.com/igrigorik/ga-beacon) diff --git a/README.ko.md b/README.ko.md index 224967a9dc..4314ccdc71 100644 --- a/README.ko.md +++ b/README.ko.md @@ -334,5 +334,3 @@ NPM 패키지의 경우, `node -p 'require("foo")'` 가 원하는 값이라면 ` 이 프로젝트는 MIT license 가 적용되어 있습니다. 각 자료형 정의(Type definition) 파일들의 저작권은 각 기여자들에게 있으며, 기여자들은 해당 자료형 정의(Type definition) 파일들의 맨 위에 나열되어 있습니다. - -[![Analytics](https://ga-beacon.appspot.com/UA-47495295-4/borisyankov/DefinitelyTyped)](https://github.com/igrigorik/ga-beacon) diff --git a/README.md b/README.md index b50272dbf4..7faea9035b 100644 --- a/README.md +++ b/README.md @@ -452,5 +452,3 @@ GitHub doesn't [support](http://stackoverflow.com/questions/5646174/how-to-make- This project is licensed under the MIT license. Copyrights on the definition files are respective of each contributor listed at the beginning of each definition file. - -[![Analytics](https://ga-beacon.appspot.com/UA-47495295-4/borisyankov/DefinitelyTyped)](https://github.com/igrigorik/ga-beacon) diff --git a/README.ru.md b/README.ru.md index 9186c2ddd5..fc2eb49c47 100644 --- a/README.ru.md +++ b/README.ru.md @@ -346,8 +346,6 @@ GitHub не [поддерживает](http://stackoverflow.com/questions/564617 Авторские права на файлы определений принадлежат каждому участнику, указанному в начале каждого файла определения. -[![Analytics](https://ga-beacon.appspot.com/UA-47495295-4/borisyankov/DefinitelyTyped)](https://github.com/igrigorik/ga-beacon) - [![Build Status](https://typescript.visualstudio.com/TypeScript/_apis/build/status/sandersn.types-publisher-watchdog)](https://typescript.visualstudio.com/TypeScript/_build/latest?definitionId=13) В среднем пакеты публикуются на npm менее чем за 10000 секунд? [![Build Status](https://typescript.visualstudio.com/TypeScript/_apis/build/status/sandersn.typescript-bot-watchdog)](https://typescript.visualstudio.com/TypeScript/_build/latest?definitionId=14) Был ли typescript-bot активным на DefinitelyTyped в последние два часа? diff --git a/azure-pipelines.yml b/azure-pipelines.yml new file mode 100644 index 0000000000..ecd56b7e2e --- /dev/null +++ b/azure-pipelines.yml @@ -0,0 +1,24 @@ +# Starter pipeline +# Start with a minimal pipeline that you can customize to build and deploy your code. +# Add steps that build, run tests, deploy, and more: +# https://aka.ms/yaml +jobs: +- job: npmRunTest + pool: + vmImage: 'Ubuntu 16.04' + demands: npm + + timeoutInMinutes: 360 + + steps: + - task: Npm@1 + displayName: 'npm install' + inputs: + verbose: false + + - script: 'git checkout -- . && npm run test' + displayName: 'npm run test' + +trigger: +- master + \ No newline at end of file diff --git a/notNeededPackages.json b/notNeededPackages.json index 4cda1eb572..3286978309 100644 --- a/notNeededPackages.json +++ b/notNeededPackages.json @@ -786,6 +786,12 @@ "sourceRepoURL": "https://github.com/manuelbieh/Geolib", "asOfVersion": "2.0.23" }, + { + "libraryName": "get-port", + "typingsPackageName": "get-port", + "sourceRepoURL": "https://github.com/sindresorhus/get-port", + "asOfVersion": "4.2.0" + }, { "libraryName": "get-stream", "typingsPackageName": "get-stream", @@ -1104,6 +1110,12 @@ "sourceRepoURL": "https://github.com/keycloak/keycloak", "asOfVersion": "3.4.1" }, + { + "libraryName": "knex", + "typingsPackageName": "knex", + "sourceRepoURL": "https://github.com/tgriesser/knex", + "asOfVersion": "0.16.1" + }, { "libraryName": "knockout-paging", "typingsPackageName": "knockout-paging", @@ -1404,6 +1416,12 @@ "sourceRepoURL": "http://onsen.io", "asOfVersion": "2.0.0" }, + { + "libraryName": "opn", + "typingsPackageName": "opn", + "sourceRepoURL": "https://github.com/sindresorhus/opn", + "asOfVersion": "5.5.0" + }, { "libraryName": "ora", "typingsPackageName": "ora", @@ -2004,6 +2022,12 @@ "sourceRepoURL": "https://github.com/Lellansin/node-scanf", "asOfVersion": "0.7.3" }, + { + "libraryName": "screenfull", + "typingsPackageName": "screenfull", + "sourceRepoURL": "https://github.com/sindresorhus/screenfull.js", + "asOfVersion": "4.1.0" + }, { "libraryName": "sendgrid", "typingsPackageName": "sendgrid", @@ -2112,6 +2136,12 @@ "sourceRepoURL": "https://servicestack.net/", "asOfVersion": "0.1.5" }, + { + "libraryName": "@storybook/addon-notes", + "typingsPackageName": "storybook__addon-notes", + "sourceRepoURL": "https://github.com/storybooks/storybook", + "asOfVersion": "5.0.0" + }, { "libraryName": "striptags", "typingsPackageName": "striptags", diff --git a/types/absolute/tslint.json b/types/absolute/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/absolute/tslint.json +++ b/types/absolute/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/acc-wizard/tslint.json b/types/acc-wizard/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/acc-wizard/tslint.json +++ b/types/acc-wizard/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ace/tslint.json b/types/ace/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ace/tslint.json +++ b/types/ace/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/actioncable/tslint.json b/types/actioncable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/actioncable/tslint.json +++ b/types/actioncable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/activestorage/index.d.ts b/types/activestorage/index.d.ts index e8214d2d8e..544c9bca60 100644 --- a/types/activestorage/index.d.ts +++ b/types/activestorage/index.d.ts @@ -13,7 +13,7 @@ export class DirectUpload { file: File; url: string; - constructor(file: File, url: string, delegate: DirectUploadDelegate) + constructor(file: File, url: string, delegate?: DirectUploadDelegate) create(callback: (error: Error, blob: Blob) => void): void; } diff --git a/types/add2home/tslint.json b/types/add2home/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/add2home/tslint.json +++ b/types/add2home/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/agenda/tslint.json b/types/agenda/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/agenda/tslint.json +++ b/types/agenda/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/airbnb-prop-types/airbnb-prop-types-tests.ts b/types/airbnb-prop-types/airbnb-prop-types-tests.ts index 7b79086848..9272fe6ddc 100644 --- a/types/airbnb-prop-types/airbnb-prop-types-tests.ts +++ b/types/airbnb-prop-types/airbnb-prop-types-tests.ts @@ -104,12 +104,13 @@ AirbnbPropTypes.forbidExtraProps({ // $ExpectType Requireable AirbnbPropTypes.integer(); -// $ExpectType Requireable<{}> -AirbnbPropTypes.keysOf(PropTypes.number); -// $ExpectType Requireable<{}> -AirbnbPropTypes.keysOf(PropTypes.number, 'foo'); -// $ExpectType Requireable<{}> -AirbnbPropTypes.keysOf(PropTypes.oneOf(['foo', 'bar'])); +const top = ((x?: T): T => x!)(); +type Top = typeof top; +declare function validateRequireableTop(x: React.Requireable): void; + +validateRequireableTop(AirbnbPropTypes.keysOf(PropTypes.number)); +validateRequireableTop(AirbnbPropTypes.keysOf(PropTypes.number, 'foo')); +validateRequireableTop(AirbnbPropTypes.keysOf(PropTypes.oneOf(['foo', 'bar']))); // $ExpectType Requireable AirbnbPropTypes.mutuallyExclusiveProps(PropTypes.number); @@ -137,8 +138,8 @@ AirbnbPropTypes.nonNegativeNumber(); // $ExpectType Requireable AirbnbPropTypes.numericString(); -// $ExpectType Requireable<{}> -AirbnbPropTypes.object(); +// $ExpectType Requireable +const props: PropTypes.Requireable = AirbnbPropTypes.object(); // $ExpectType Requireable<{ foo: string; }> AirbnbPropTypes.object<{ foo: string }>(); @@ -156,23 +157,17 @@ AirbnbPropTypes.requiredBy('foo', PropTypes.string); // $ExpectType Validator AirbnbPropTypes.requiredBy('bar', PropTypes.number, 42).isRequired; -// $ExpectType Requireable<{}> -AirbnbPropTypes.restrictedProp(); -// $ExpectType Requireable<{}> -AirbnbPropTypes.restrictedProp(() => 'Error'); -// $ExpectType Requireable<{}> -AirbnbPropTypes.restrictedProp(() => new Error('Error')); +validateRequireableTop(AirbnbPropTypes.restrictedProp()); +validateRequireableTop(AirbnbPropTypes.restrictedProp(() => 'Error')); +validateRequireableTop(AirbnbPropTypes.restrictedProp(() => new Error('Error'))); -// $ExpectType Requireable<{}> -AirbnbPropTypes.sequenceOf({ validator: PropTypes.number }); -// $ExpectType Requireable<{}> -AirbnbPropTypes.sequenceOf({ validator: PropTypes.number }, { validator: PropTypes.string }); -// $ExpectType Requireable<{}> -AirbnbPropTypes.sequenceOf( +validateRequireableTop(AirbnbPropTypes.sequenceOf({ validator: PropTypes.number })); +validateRequireableTop(AirbnbPropTypes.sequenceOf({ validator: PropTypes.number }, { validator: PropTypes.string })); +validateRequireableTop(AirbnbPropTypes.sequenceOf( { validator: PropTypes.number, min: 0, max: 10 }, { validator: PropTypes.string }, { validator: PropTypes.bool }, -); +)); interface ShapeShape { foo: string; diff --git a/types/airtable/airtable-tests.ts b/types/airtable/airtable-tests.ts new file mode 100644 index 0000000000..7d7dfbdc60 --- /dev/null +++ b/types/airtable/airtable-tests.ts @@ -0,0 +1,43 @@ +import * as Airtable from 'airtable'; + +interface Row extends Airtable.FieldSet { + field1: string; + attachments: Airtable.Attachment[]; +} + +const airtable = new Airtable(); + +const base = airtable.base('app id'); + +const table = base('table name') as Airtable.Table; + +async () => { + const query = table.select(); + { + const rows = await query.all(); + for (const row of rows) { + row.id; // $ExpectType string + row.fields.field1; // $ExpectType string + for (const attachment of row.fields.attachments) { + attachment.id; // $ExpectType string + attachment.filename; // $ExpectType string + attachment.size; // $ExpectType number + attachment.type; // $ExpectType string + attachment.url; // $ExpectType string + if (attachment.thumbnails) { + attachment.thumbnails.full.height; // $ExpectType number + attachment.thumbnails.full.width; // $ExpectType number + attachment.thumbnails.full.url; // $ExpectType string + + attachment.thumbnails.large.height; // $ExpectType number + attachment.thumbnails.large.width; // $ExpectType number + attachment.thumbnails.large.url; // $ExpectType string + + attachment.thumbnails.small.height; // $ExpectType number + attachment.thumbnails.small.width; // $ExpectType number + attachment.thumbnails.small.url; // $ExpectType string + } + } + } + } +}; diff --git a/types/airtable/index.d.ts b/types/airtable/index.d.ts new file mode 100644 index 0000000000..f3b6efa4ee --- /dev/null +++ b/types/airtable/index.d.ts @@ -0,0 +1,62 @@ +// Type definitions for airtable 0.5 +// Project: https://github.com/airtable/airtable.js +// Definitions by: Brandon Valosek +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +export = Airtable; + +declare global { + class Airtable { + base(appId: string): Airtable.Base; + } + + namespace Airtable { + interface FieldSet { + [ key: string ]: undefined | string | ReadonlyArray; + } + + interface Base { + (tableName: string): Table<{}>; + } + + interface Table { + select(opt?: SelectOptions): Query; + } + + interface SelectOptions { + view?: string; + } + + interface Query { + all(): Promise>; + firstPage(): Promise>; + } + + type Response = ReadonlyArray>; + + interface Row { + id: string; + fields: TFields; + } + + interface Attachment { + id: string; + url: string; + filename: string; + size: number; + type: string; + thumbnails?: { + small: Thumbnail; + large: Thumbnail; + full: Thumbnail; + }; + } + + interface Thumbnail { + url: string; + width: number; + height: number; + } + } +} diff --git a/types/get-port/tsconfig.json b/types/airtable/tsconfig.json similarity index 94% rename from types/get-port/tsconfig.json rename to types/airtable/tsconfig.json index 0d9f3a8975..9ec625d762 100644 --- a/types/get-port/tsconfig.json +++ b/types/airtable/tsconfig.json @@ -18,6 +18,6 @@ }, "files": [ "index.d.ts", - "get-port-tests.ts" + "airtable-tests.ts" ] } diff --git a/types/storybook__addon-notes/tslint.json b/types/airtable/tslint.json similarity index 100% rename from types/storybook__addon-notes/tslint.json rename to types/airtable/tslint.json diff --git a/types/alertify/tslint.json b/types/alertify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/alertify/tslint.json +++ b/types/alertify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/algoliasearch/tslint.json b/types/algoliasearch/tslint.json index 886f1a8b6c..4ef1833aa4 100644 --- a/types/algoliasearch/tslint.json +++ b/types/algoliasearch/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/align-text/index.d.ts b/types/align-text/index.d.ts new file mode 100644 index 0000000000..652eb5f453 --- /dev/null +++ b/types/align-text/index.d.ts @@ -0,0 +1,37 @@ +// Type definitions for align-text 1.0 +// Project: https://github.com/jonschlinkert/align-text +// Definitions by: Claas Ahlrichs +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.1 + +interface TransformResult { + /** + * the amount of indentation to use. Default is 0 when an object is returned. + */ + indent: number; + /** + * the character to use for indentation. Default is '' (empty string) when an object is returned. + */ + character: string; + /** + * leading characters to use at the beginning of each line. '' (empty string) when an object is returned. + */ + prefix: string; +} + +interface Callback { + /** + * @param len the length of the "current" line + * @param longest the length of the longest line + * @param line the current line (string) being aligned + * @param lines the array of all lines + */ + (len: number, longest: number, line: string, lines: string[]): + | number + | TransformResult; +} + +declare function align_text(text: string, fn: number | Callback): string; +declare function align_text(text: string[], fn: number | Callback): string[]; + +export = align_text; diff --git a/types/align-text/test/center-complex.ts b/types/align-text/test/center-complex.ts new file mode 100644 index 0000000000..8520f92583 --- /dev/null +++ b/types/align-text/test/center-complex.ts @@ -0,0 +1,12 @@ +import align from "align-text"; + +function centerAlign(len: number, longest: number) { + return { + character: "\t", + indent: Math.floor((longest - len) / 2), + prefix: "~ " + }; +} + +const text = ["abc", "abc", "abc"]; +align(text, centerAlign); diff --git a/types/align-text/test/center-simple.ts b/types/align-text/test/center-simple.ts new file mode 100644 index 0000000000..5400551b81 --- /dev/null +++ b/types/align-text/test/center-simple.ts @@ -0,0 +1,8 @@ +import align from "align-text"; + +function centerAlign(len: number, longest: number) { + return Math.floor((longest - len) / 2); +} + +const text = ["abc", "abc", "abc"]; +align(text, centerAlign); diff --git a/types/align-text/test/simple.ts b/types/align-text/test/simple.ts new file mode 100644 index 0000000000..0571e5aad0 --- /dev/null +++ b/types/align-text/test/simple.ts @@ -0,0 +1,6 @@ +import align from "align-text"; + +const text = ["abc", "abc", "abc"]; +align(text, 4); + +align("abc", 2); diff --git a/types/align-text/tsconfig.json b/types/align-text/tsconfig.json new file mode 100644 index 0000000000..5184832b59 --- /dev/null +++ b/types/align-text/tsconfig.json @@ -0,0 +1,22 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "allowSyntheticDefaultImports": true + }, + "files": [ + "index.d.ts", + "test/simple.ts", + "test/center-simple.ts", + "test/center-complex.ts" + ] +} diff --git a/types/align-text/tslint.json b/types/align-text/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/align-text/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/alt/tslint.json b/types/alt/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/alt/tslint.json +++ b/types/alt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/amap-js-api-indoor-map/amap-js-api-indoor-map-tests.ts b/types/amap-js-api-indoor-map/amap-js-api-indoor-map-tests.ts new file mode 100644 index 0000000000..f6efc2dc54 --- /dev/null +++ b/types/amap-js-api-indoor-map/amap-js-api-indoor-map-tests.ts @@ -0,0 +1,114 @@ +// $ExpectType IndoorMap +new AMap.IndoorMap(); +// $ExpectType IndoorMap +new AMap.IndoorMap({}); +// $ExpectType IndoorMap +const indoorMap = new AMap.IndoorMap({ + zIndex: 1, + opacity: 0.5, + cursor: 'cursor', + hideFloorBar: false, + alaysShow: true +}); + +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId'); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', (error, result) => { + // $ExpectType Error | null + error; + // $ExpectType SearchResult + result; + // $ExpectType string + result.id; + // $ExpectType 0 | 1 + result.status; + if (result.status === 0) { + // $ExpectType Building + const building = result.building; + { + // $ExpectType number + building.floor; + // $ExpectType FloorDetails + const floorDetails = building.floor_details; + { + // $ExpectType number[] + floorDetails.floor_indexs; + // $ExpectType string[] + floorDetails.floor_names; + // $ExpectType string[] + floorDetails.floor_nonas; + } + // $ExpectType string + building.id; + // $ExpectType LngLat + building.lnglat; + // $ExpectType string + building.name; + } + } else { + // $ExpectType Error + result.error; + } +}); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1, () => { }); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1, 'shopId'); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1, 'shopId', () => { }); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1, 'shopId', true); +// $ExpectType void +indoorMap.showIndoorMap('indoorMapId', 1, 'shopId', true, () => { }); + +let floor: undefined | false; +floor = indoorMap.showFloor(1); +floor = indoorMap.showFloor(1, true); + +// $ExpectType void +indoorMap.showFloorBar(); + +// $ExpectType void +indoorMap.hideFloorBar(); + +// $ExpectType void +indoorMap.hideLabels(); + +// $ExpectType string | null +indoorMap.getSelectedBuildingId(); + +// $ExpectType Building | null +const building = indoorMap.getSelectedBuilding(); +if (building) { + // $ExpectType number + building.floor; + // $ExpectType FloorDetails + building.floor_details; + // $ExpectType string + building.id; + // $ExpectType LngLat + building.lnglat; + // $ExpectType string + building.name; +} + +indoorMap.on('complete', (event: AMap.IndoorMap.EventMap['complete']) => { + // $ExpectType "complete" + event.type; +}); + +indoorMap.on('click', (event: AMap.IndoorMap.EventMap['click']) => { + // $ExpectType string + event.building_id; + // $ExpectType number + event.floor; + // $ExpectType LngLat + event.lnglat; + // $ExpectType Shop + event.shop; + // $ExpectType "click" + event.type; +}); diff --git a/types/amap-js-api-indoor-map/index.d.ts b/types/amap-js-api-indoor-map/index.d.ts new file mode 100644 index 0000000000..9b30ea1722 --- /dev/null +++ b/types/amap-js-api-indoor-map/index.d.ts @@ -0,0 +1,239 @@ +// Type definitions for non-npm package amap-js-api-indoor-map 1.4 +// Project: https://lbs.amap.com/api/javascript-api/reference/indoormap +// Definitions by: breeze9527 +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +declare namespace AMap { + namespace IndoorMap { + interface EventMap { + complete: Event<'complete'>; + click: MouseEvent<'click'>; + + floor_complete: Event<'floor_complete', SearchResult>; + mouseover: MouseEvent<'mouseover'>; + mouseout: MouseEvent<'mouseout'>; + } + type MouseEvent = Event; + interface Options extends Layer.Options { + /** + * 图层叠加的顺序值 + */ + zIndex?: number; + /** + * 图层的透明度 + */ + opacity?: number; + /** + * 鼠标悬停到店铺面时的鼠标样式 + */ + cursor?: string; + /** + * 是否隐藏楼层切换控件 + */ + hideFloorBar?: boolean; + /** + * 是否持续显示 + */ + alaysShow?: boolean; + + // internal + visible?: boolean; + featurezIndex?: number; + zooms?: [number, number]; + disableIconRender?: boolean; + disableLabelRender?: boolean; + disableHoverMarker?: boolean; + autoLoadBuildingsInTile?: boolean; + } + interface FloorDetails { + /** + * 各楼层索引 + */ + floor_indexs: number[]; + /** + * 各楼层英文 + */ + floor_nonas: string[]; + /** + * 各楼层名字 + */ + floor_names: string[]; + } + type ShopCategory = 'public' | 'connection' | 'shop'; + interface Shop { + /** + * 店铺的id + */ + id: string; + /** + * 兴趣点ID + */ + poiId: string; + /** + * 店铺所属楼宇ID + */ + building_id: string; + /** + * 店铺名称 + */ + name: string; + /** + * 店铺的经纬度 + */ + lnglat: LngLat; + /** + * 分类 + */ + category: ShopCategory; + } + interface Building { + /** + * 所属楼宇ID + */ + id: string; + /** + * 楼层名称 + */ + name: string; + /** + * 楼层的经纬度 + */ + lnglat: LngLat; + /** + * 所在楼层 + */ + floor: number; + floor_details: FloorDetails; + } + interface SearchSuccessResult { + /** + * 楼层的id + */ + id: string; + status: 0; + /** + * 建筑信息 + */ + building: Building; + } + interface SearchErrorResult { + /** + * 楼宇id + */ + id: string; + status: 1; + error: Error; + } + type SearchResult = SearchSuccessResult | SearchErrorResult; + } + + class IndoorMap extends Layer { + /** + * 室内地图 + * @param options 选项 + */ + constructor(options?: IndoorMap.Options); + /** + * 显示指定室内地图信息 + * @param indoorId 建筑物ID + * @param callback 回调 + */ + showIndoorMap( + indoorId: string, + callback?: (error: null | Error, result: IndoorMap.SearchResult) => void + ): void; + /** + * 显示指定室内地图信息 + * @param indoorId 建筑物ID + * @param floor 楼层 + * @param callback 回调 + */ + showIndoorMap( + indoorId: string, + floor?: number, + callback?: (error: null | Error, result: IndoorMap.SearchResult) => void + ): void; + /** + * 显示指定室内地图信息 + * @param indoorId 建筑物ID + * @param floor 楼层 + * @param shopId 商铺ID + * @param callback 回调 + */ + showIndoorMap( + indoorId: string, + floor?: number, + shopId?: string, + callback?: (error: null | Error, result: IndoorMap.SearchResult) => void + ): void; + /** + * 显示指定室内地图信息 + * @param indoorId 建筑物ID + * @param floor 楼层 + * @param shopId 商铺ID + * @param noMove 阻止移动 + * @param callback 回调 + */ + showIndoorMap( + indoorId: string, + floor?: number, + shopId?: string, + noMove?: boolean, + callback?: (error: null | Error, result: IndoorMap.SearchResult) => void + ): void; + /** + * 显示指定的楼层 + * @param floor 楼层 + * @param noMove 禁止移动 + */ + showFloor(floor: number, noMove?: boolean): false | undefined; + /** + * 显示楼层切换控件 + */ + showFloorBar(): void; + /** + * 隐藏楼层切换控件 + */ + hideFloorBar(): void; + /** + * 显示室内地图标注 + */ + showLabels(): void; + /** + * 隐藏室内地图标注 + */ + hideLabels(): void; + /** + * 获取处于被选中状态的室内地图的ID + */ + getSelectedBuildingId(): string | null; + /** + * 获取处于被选中状态的室内地图的一些基本信息 + */ + getSelectedBuilding(): IndoorMap.Building | null; + + // internal + getFloorBar(): void; + setSelectedBuildingId(id: string): void; + } +} diff --git a/types/knex/tsconfig.json b/types/amap-js-api-indoor-map/tsconfig.json similarity index 78% rename from types/knex/tsconfig.json rename to types/amap-js-api-indoor-map/tsconfig.json index 8f0b7771d9..da736c3c7b 100644 --- a/types/knex/tsconfig.json +++ b/types/amap-js-api-indoor-map/tsconfig.json @@ -5,20 +5,20 @@ "es6", "dom" ], + "noEmit": true, "noImplicitAny": true, - "noImplicitThis": false, - "strictNullChecks": false, + "noImplicitThis": true, + "strictNullChecks": true, "strictFunctionTypes": true, "baseUrl": "../", "typeRoots": [ "../" ], "types": [], - "noEmit": true, "forceConsistentCasingInFileNames": true }, "files": [ "index.d.ts", - "knex-tests.ts" + "amap-js-api-indoor-map-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/get-port/tslint.json b/types/amap-js-api-indoor-map/tslint.json similarity index 100% rename from types/get-port/tslint.json rename to types/amap-js-api-indoor-map/tslint.json diff --git a/types/amap-js-api-place-search/amap-js-api-place-search-tests.ts b/types/amap-js-api-place-search/amap-js-api-place-search-tests.ts new file mode 100644 index 0000000000..b4c787c301 --- /dev/null +++ b/types/amap-js-api-place-search/amap-js-api-place-search-tests.ts @@ -0,0 +1,435 @@ +declare const map: AMap.Map; +declare const div: HTMLElement; +declare const lnglat: AMap.LngLat; +declare const lnglatTuple: [number, number]; +declare const bounds: AMap.Bounds; +declare const polygon: AMap.Polygon; +declare const lang: AMap.Lang; + +// $ExpectType PlaceSearch +const placeSearch = new AMap.PlaceSearch(); +// $ExpectType PlaceSearch +new AMap.PlaceSearch({}); +// $ExpectType PlaceSearch +new AMap.PlaceSearch({ + city: '深圳', + citylimit: true, + children: 1, + type: '餐饮服务', + lang: 'zh_cn', + pageSize: 10, + pageIndex: 10, + extensions: 'all', + map, + panel: div, + showCover: true, + renderStyle: 'newpc', + autoFitView: true +}); + +// $ExpectType void +placeSearch.search('keyword', (status, result) => { + const temp: 'error' | 'complete' | 'no_data' = status; + // $ExpectType string | SearchResult + result; + if (typeof result !== 'string') { + // $ExpectType string + result.info; + // $ExpectType PoiList + result.poiList; + // $ExpectType string[] | undefined + result.keywordList; + // $ExpectType CityInfo[] | undefined + result.cityList; + + const poiList = result.poiList; + // $ExpectType number + poiList.pageIndex; + // $ExpectType number + poiList.pageSize; + // $ExpectType number + poiList.count; + + const poi = poiList.pois[0]; + // $ExpectType string + poi.address; + // $ExpectType number + poi.distance; + // $ExpectType string + poi.id; + // $ExpectType LngLat | null + poi.location; + // $ExpectType string + poi.name; + // $ExpectType string + poi.shopinfo; + // $ExpectType string + poi.tel; + // $ExpectType string + poi.type; + if ('website' in poi) { + // $ExpectType string + poi.adcode; + // $ExpectType string + poi.adname; + // $ExpectType string + poi.citycode; + // $ExpectType string + poi.cityname; + // $ExpectType boolean + poi.discount; + // $ExpectType string + poi.email; + // $ExpectType LngLat | null + poi.entr_location; + // $ExpectType LngLat | null + poi.exit_location; + // $ExpectType boolean + poi.groupbuy; + if (poi.indoor_map) { + const indoorData = poi.indoor_data; + // $ExpectType string + indoorData.cpid; + // $ExpectType string + indoorData.floor; + // $ExpectType string + indoorData.truefloor; + } + poi.pcode; + // $ExpectType PoiPhoto[] + poi.photos; + // $ExpectType string + poi.pname; + // $ExpectType string + poi.postcode; + // $ExpectType string + poi.website; + + const photo = poi.photos[0]; + // $ExpectType string + photo.title; + // $ExpectType string + photo.url; + // $ExpectType Groupbuy[] | undefined + poi.groupbuys; + if (poi.groupbuys) { + const groupbuy = poi.groupbuys[0]; + // $ExpectType string + groupbuy.title; + // $ExpectType string + groupbuy.type_code; + // $ExpectType string + groupbuy.type; + // $ExpectType string + groupbuy.detail; + // $ExpectType string + groupbuy.stime; + // $ExpectType string + groupbuy.etime; + // $ExpectType number + groupbuy.count; + // $ExpectType number + groupbuy.sold_num; + // $ExpectType number + groupbuy.original_price; + // $ExpectType number + groupbuy.groupbuy_price; + // $ExpectType number + groupbuy.discount; + // $ExpectType string + groupbuy.ticket_address; + // $ExpectType string + groupbuy.ticket_tel; + // $ExpectType PoiPhoto[] + groupbuy.photos; + // $ExpectType string + groupbuy.url; + // $ExpectType string + groupbuy.provider; + } + // $ExpectType Discount[] | undefined + poi.discounts; + if (poi.discounts) { + const discount = poi.discounts[0]; + // $ExpectType string + discount.title; + // $ExpectType string + discount.detail; + // $ExpectType string + discount.start_time; + // $ExpectType string + discount.end_time; + // $ExpectType number + discount.sold_num; + // $ExpectType PoiPhoto[] + discount.photos; + // $ExpectType string + discount.url; + // $ExpectType string + discount.provider; + } + if (poi.deep_type === 'CINEMA') { + // $ExpectType Cinema + const cinema = poi.cinema; + // $ExpectType string + cinema.intro; + // $ExpectType string + cinema.rating; + // $ExpectType string + cinema.deep_src; + // $ExpectType string + cinema.parking; + // $ExpectType string + cinema.opentime_GDF; + // $ExpectType string + cinema.opentime; + // $ExpectType PoiPhoto[] + cinema.photos; + } + if (poi.deep_type === 'DINING') { + // $ExpectType Dining + const dining = poi.dining; + // $ExpectType string + dining.cuisines; + // $ExpectType string + dining.tag; + // $ExpectType string + dining.intro; + // $ExpectType string + dining.rating; + // $ExpectType string + dining.cp_rating; + // $ExpectType string + dining.deep_src; + // $ExpectType string + dining.taste_rating; + // $ExpectType string + dining.environment_rating; + // $ExpectType string + dining.service_rating; + // $ExpectType string + dining.cost; + // $ExpectType string + dining.recommend; + // $ExpectType string + dining.atmosphere; + // $ExpectType string + dining.ordering_wap_url; + // $ExpectType string + dining.ordering_web_url; + // $ExpectType string + dining.ordering_app_url; + // $ExpectType string + dining.opentime_GDF; + // $ExpectType string + dining.opentime; + // $ExpectType string + dining.addition; + // $ExpectType PoiPhoto[] + dining.photos; + } + if (poi.deep_type === 'SCENIC') { + // $ExpectType Scenic + const scenic = poi.scenic; + // $ExpectType string + scenic.intro; + // $ExpectType string + scenic.rating; + // $ExpectType string + scenic.deep_src; + // $ExpectType string + scenic.level; + // $ExpectType string + scenic.price; + // $ExpectType string + scenic.season; + // $ExpectType string + scenic.recommend; + // $ExpectType string + scenic.theme; + // $ExpectType string + scenic.ordering_wap_url; + // $ExpectType string + scenic.ordering_web_url; + // $ExpectType string + scenic.opentime_GDF; + // $ExpectType string + scenic.opentime; + // $ExpectType PoiPhoto[] + scenic.photos; + } + if (poi.deep_type === 'HOTEL') { + // $ExpectType Hotel + const hotel = poi.hotel; + // $ExpectType string + hotel.rating; + // $ExpectType string + hotel.star; + // $ExpectType string + hotel.intro; + // $ExpectType string + hotel.lowest_price; + // $ExpectType string + hotel.faci_rating; + // $ExpectType string + hotel.health_rating; + // $ExpectType string + hotel.environment_rating; + // $ExpectType string + hotel.service_rating; + // $ExpectType string + hotel.traffic; + // $ExpectType string + hotel.addition; + // $ExpectType string + hotel.deep_src; + // $ExpectType PoiPhoto[] + hotel.photos; + } + } + + if (result.cityList) { + const city = result.cityList[0]; + // $ExpectType string + city.adcode; + // $ExpectType string + city.citycode; + // $ExpectType number + city.count; + // $ExpectType string + city.name; + } + } else { + // $ExpectType string + result; + } +}); + +// $ExpectType void +placeSearch.searchNearBy('keyword', lnglat, 10, (status, result) => { + const temp: 'error' | 'complete' | 'no_data' = status; + // $ExpectType string | SearchResult + result; +}); +// $ExpectType void +placeSearch.searchNearBy('keyword', lnglatTuple, 10, () => { }); + +// $ExpectType void +placeSearch.searchInBounds('keyword', bounds, (status, result) => { + const temp: 'error' | 'complete' | 'no_data' = status; + // $ExpectType string | SearchResult + result; +}); +// $ExpectType void +placeSearch.searchInBounds('keyword', polygon, () => { }); + +// $ExpectType void +placeSearch.getDetails('id', (status, result) => { + const temp: 'error' | 'complete' | 'no_data' = status; + // $ExpectType string | SearchResult + result; +}); + +// $ExpectType void +placeSearch.setType('type'); +// $ExpectType void +placeSearch.setType(); + +// $ExpectType void +placeSearch.setCityLimit(true); +// $ExpectType void +placeSearch.setCityLimit(); + +// $ExpectType void +placeSearch.setPageIndex(1); +// $ExpectType void +placeSearch.setPageIndex(); + +// $ExpectType void +placeSearch.setPageSize(1); +// $ExpectType void +placeSearch.setPageSize(); + +// $ExpectType void +placeSearch.setCity('city'); +// $ExpectType void +placeSearch.setCity(); + +// $ExpectType void +placeSearch.setLang(lang); +// $ExpectType void +placeSearch.setLang(); + +// $ExpectType "zh_cn" | "en" | "zh_en" | undefined +placeSearch.getLang(); + +// $ExpectType void +placeSearch.clear(); + +// $ExpectType void +placeSearch.poiOnAMAP({ + id: 'id', +}); +// $ExpectType void +placeSearch.poiOnAMAP({ + location: lnglat, + id: 'id', + name: 'name' +}); + +// $ExpectType void +placeSearch.detailOnAMAP({ + id: 'id', +}); +// $ExpectType void +placeSearch.detailOnAMAP({ + location: lnglat, + id: 'id', + name: 'name' +}); + +// $ExpectType void +placeSearch.open(); + +// $ExpectType void +placeSearch.close(); + +placeSearch.on('complete', (event: AMap.PlaceSearch.EventMap['complete']) => { + // $ExpectType "complete" + event.type; + // $ExpectType string + event.info; + // $ExpectType PoiList + event.poiList; + // $ExpectType string[] | undefined + event.keywordList; + // $ExpectType CityInfo[] | undefined + event.cityList; +}); + +placeSearch.on('listElementClick', (event: AMap.PlaceSearch.EventMap['listElementClick']) => { + // $ExpectType MouseEvent + event.event; + // $ExpectType string + event.id; + // $ExpectType number + event.index; + // $ExpectType Marker + event.marker; + // $ExpectType HTMLLIElement + event.listElement; +}); + +placeSearch.on('markerClick', (event: AMap.PlaceSearch.EventMap['markerClick']) => { + const markerEvent = event.event; + // $ExpectType Marker + markerEvent.target; + // $ExpectType string + event.id; + // $ExpectType number + event.index; + // $ExpectType Marker + event.marker; + // $ExpectType HTMLLIElement + event.listElement; +}); diff --git a/types/amap-js-api-place-search/index.d.ts b/types/amap-js-api-place-search/index.d.ts new file mode 100644 index 0000000000..4a333f3b2b --- /dev/null +++ b/types/amap-js-api-place-search/index.d.ts @@ -0,0 +1,737 @@ +// Type definitions for non-npm package amap-js-api-place-search 1.4 +// Project: https://lbs.amap.com/api/javascript-api/reference/search#m_AMap.PlaceSearch +// Definitions by: breeze9527 +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +/// + +declare namespace AMap { + namespace PlaceSearch { + interface EventMap { + complete: Event<'complete', SearchResult>; + error: Event<'error', { info: string }>; + selectChanged: Event<'selectChanged', { + selected: SelectChangeEventData | EventMap['markerClick'] | EventMap['listElementClick']; + lastSelected: SelectChangeEventData | EventMap['markerClick'] | EventMap['listElementClick'] | null; + }>; + listElementClick: SelectChangeEvent<'listElementClick', MouseEvent>; + markerClick: SelectChangeEvent<'markerClick', Marker.EventMap['click']>; + // internal + renderComplete: Event<'renderComplete', { + result: SelectChangeEventData[]; + markers: Marker[]; + listElements: HTMLElement[]; + }>; + infoWindowClick: Event<'infoWindowClick', SelectChangeEventData & { + event: MouseEvent; + infoWindow: InfoWindow; + infoWindowContentDom: HTMLDivElement; + }>; + willClear: Event<'willClear', { + id: string; + index: number; + data: Poi[]; + }>; + markerDestoryed: Event<'markerDestoryed', SelectChangeEventData>; // typo in source code + listElementDetroyed: Event<'listElementDetroyed', SelectChangeEventData>; // typo too + } + + interface SelectChangeEventData { + /** + * 当前选中的POI的ID + */ + id: string; + /** + * 索引 + */ + index: number; + /** + * 当前选中的POI对应的在地图中的Marker对象 + */ + marker: Marker; + /** + * 当前选中的POI在结果面板中对应的列表项 + */ + listElement: HTMLLIElement; + /** + * 当前选中的POI的信息 + */ + data: Poi[]; + } + type SelectChangeEvent = Event; + interface PoiPhoto { + /** + * 图片名称 + */ + title: string; + /** + * 图片url + */ + url: string; + } + interface PoiBase { + /** + * 全局唯一ID + */ + id: string; + /** + * 名称 + */ + name: string; + /** + * 兴趣点类型 + */ + type: string; + /** + * 兴趣点经纬度 + */ + location: LngLat | null; + /** + * 地址 + */ + address: string; + /** + * 离中心点距离 + */ + distance: number; + /** + * 电话 + */ + tel: string; + shopinfo: string; + children?: any[]; // TODO Array<{location: LngLat | null}> + } + interface Groupbuy { + /** + * 团购标题 + */ + title: string; + /** + * 团购分类代码 + */ + type_code: string; + /** + * 团购分类 + */ + type: string; + /** + * 团购详情 + */ + detail: string; + /** + * 团购开始时间 + */ + stime: string; + /** + * 团购结束时间 + */ + etime: string; + /** + * 团购总量 + */ + count: number; + /** + * 已卖出数量 + */ + sold_num: number; + /** + * 原价 + */ + original_price: number; + /** + * 折扣价 + */ + groupbuy_price: number; + /** + * 折扣 + */ + discount: number; + /** + * 取票地址 + */ + ticket_address: string; + /** + * 取票电话 + */ + ticket_tel: string; + /** + * 图片信息 + */ + photos: PoiPhoto[]; + /** + * 来源url + */ + url: string; + /** + * 来源标识 + */ + provider: string; + } + interface Discount { + /** + * 优惠标题 + */ + title: string; + /** + * 优惠详情 + */ + detail: string; + /** + * 开始时间 + */ + start_time: string; + /** + * 结束时间 + */ + end_time: string; + /** + * 已卖出数量 + */ + sold_num: number; + /** + * 图片信息列表 + */ + photos: PoiPhoto[]; + /** + * 来源url + */ + url: string; + /** + * 来源标识 + */ + provider: string; + } + interface Cinema { + /** + * 简介 + */ + intro: string; + /** + * 综合评分 + */ + rating: string; + /** + * 信息来源 + */ + deep_src: string; + /** + * 停车场设施 + */ + parking: string; + /** + * 规范格式的营业时间 + */ + opentime_GDF: string; + /** + * 非规范格式的营业时间 + */ + opentime: string; + /** + * 图片信息列表 + */ + photos: PoiPhoto[]; + } + interface Dining { + /** + * 菜系 + */ + cuisines: string; + /** + * 标签 + */ + tag: string; + /** + * 简介 + */ + intro: string; + /** + * 综合评分 + */ + rating: string; + /** + * 单数据源的评分 + */ + cp_rating: string; + /** + * 信息来源 + */ + deep_src: string; + /** + * 口味评分 + */ + taste_rating: string; + /** + * 环境评分 + */ + environment_rating: string; + /** + * 服务评分 + */ + service_rating: string; + /** + * 人均消费 + */ + cost: string; + /** + * 特色菜 + */ + recommend: string; + /** + * 氛围 + */ + atmosphere: string; + /** + * 订餐wap链接 + */ + ordering_wap_url: string; + /** + * 订餐web链接 + */ + ordering_web_url: string; + /** + * 订餐APP URL + */ + ordering_app_url: string; + /** + * 规范格式的营业时间 + */ + opentime_GDF: string; + /** + * 非规范格式的营业时间 + */ + opentime: string; + /** + * 餐厅特色 + */ + addition: string; + /** + * 图片信息列表 + */ + photos: PoiPhoto[]; + } + interface Scenic { + /** + * 简介 + */ + intro: string; + /** + * 综合评分 + */ + rating: string; + /** + * 信息来源 + */ + deep_src: string; + /** + * 景区国标级别 + */ + level: string; + /** + * 门票价格 + */ + price: string; + /** + * 适合游玩的季节 + */ + season: string; + /** + * 推荐景点 + */ + recommend: string; + /** + * 景区主题 + */ + theme: string; + /** + * wap购票链接 + */ + ordering_wap_url: string; + /** + * web购票链接 + */ + ordering_web_url: string; + /** + * 规范格式的营业时间 + */ + opentime_GDF: string; + /** + * 非规范格式的营业时间 + */ + opentime: string; + /** + * 图片信息列表 + */ + photos: PoiPhoto[]; + } + interface Hotel { + /** + * 综合评分 + */ + rating: string; + /** + * 星级 + */ + star: string; + /** + * 简介 + */ + intro: string; + /** + * 最低房价 + */ + lowest_price: string; + /** + * 设施评分 + */ + faci_rating: string; + /** + * 卫生评分 + */ + health_rating: string; + /** + * 环境评分 + */ + environment_rating: string; + /** + * 服务评分 + */ + service_rating: string; + /** + * 交通提示 + */ + traffic: string; + /** + * 特色服务 + */ + addition: string; + /** + * 信息来源 + */ + deep_src: string; + /** + * 图片信息列表 + */ + photos: PoiPhoto[]; + } + type PoiExt = PoiBase & { + /** + * 网址 + */ + website: string; + /** + * 所在省份编码 + */ + pcode: string; + /** + * 所在城市编码 + */ + citycode: string; + /** + * 所在区域编码 + */ + adcode: string; + /** + * 邮编 + */ + postcode: string; + /** + * 所在省份 + */ + pname: string; + /** + * 所在城市名称 + */ + cityname: string; + /** + * 所在行政区名称 + */ + adname: string; + /** + * 电子邮箱 + */ + email: string; + /** + * 照片 + */ + photos: PoiPhoto[]; + /** + * 入口经纬度 + */ + entr_location: LngLat | null; + /** + * 出口经纬度 + */ + exit_location: LngLat | null; + /** + * @deprecated 是否有团购信息 + */ + groupbuy: boolean; + /** + * @deprecated 是否有优惠信息 + */ + discount: boolean; + } & ({ + indoor_map: true; + indoor_data: { + cpid: string; + floor: string; + truefloor: string; + }; + } | { + indoor_map: false; + }) & { + /** + * @deprecated 团购信息 + */ + groupbuys?: Groupbuy[]; + /** + * @deprecated 优惠信息 + */ + discounts?: Discount[]; + } & ({ + deep_type: 'CINEMA'; + /** + * @deprecated 影院类深度信息 + */ + cinema: Cinema; + } | { + deep_type: 'DINING'; + /** + * @deprecated 餐饮类深度信息 + */ + dining: Dining; + } | { + deep_type: 'SCENIC'; + /** + * @deprecated 景点类深度信息 + */ + scenic: Scenic; + } | { + deep_type: 'HOTEL'; + /** + * @deprecated 酒店类深度信息 + */ + hotel: Hotel; + }); + interface Options { + /** + * 兴趣点城市 + */ + city?: string; + /** + * 是否强制限制在设置的城市内搜索 + */ + citylimit?: boolean; + /** + * 是否按照层级展示子POI数据 + * children=1,展示子节点POI数据,children=0,不展示子节点数据 + */ + children?: number; + /** + * 兴趣点类别,多个类别用“|”分割 + */ + type?: string; + /** + * 检索语言类型 + */ + lang?: Lang; + /** + * 单页显示结果条数 + */ + pageSize?: number; + /** + * 页码 + */ + pageIndex?: number; + /** + * 是否返回详细信息 + * base返回基本地址信息;all返回基本+详细信息 + */ + extensions?: 'base' | 'all'; + /** + * Map对象 + */ + map?: Map; + /** + * 结果列表的HTML容器id或容器元素 + */ + panel?: string | HTMLElement; + /** + * 是否在地图上显示周边搜索的圆或者范围搜索的多边形 + */ + showCover?: boolean; + /** + * 绘制的UI风格 + */ + renderStyle?: 'newpc' | 'default'; + /** + * 是否自动调整地图视野使绘制的Marker点都处于视口的可见范围 + */ + autoFitView?: boolean; + + // internal + renderEngine?: string; + rankBy?: string; + } + interface PoiList { + /** + * Poi列表 + */ + pois: Poi[]; // PlaceSearchPoiBase[] | PlaceSearchPoiExt[]; + /** + * 页码 + */ + pageIndex: number; + /** + * 单页结果数 + */ + pageSize: number; + /** + * 查询结果总数 + */ + count: number; + } + interface CityInfo { + /** + * 建议城市名称 + */ + name: string; + /** + * 城市编码 + */ + citycode: string; + /** + * 行政区编码 + */ + adcode: string; + /** + * 该城市的建议结果数目 + */ + count: number; + } + interface SearchResult { + /** + * 成功状态说明 + */ + info: string; + /** + * 兴趣点列表 + */ + poiList: PoiList; + /** + * 建议关键字列表 + */ + keywordList?: string[]; + /** + * 城市建议列表 + */ + cityList?: CityInfo[]; + } + type Poi = PoiBase | PoiExt; + type SearchStatus = 'complete' | 'error' | 'no_data'; + } + class PlaceSearch extends EventEmitter { + /** + * 地点搜索服务 + * @param options 选项 + */ + constructor(options?: PlaceSearch.Options); + /** + * 根据关键字搜索 + * @param keyword 根据关键字搜索 + * @param callback 回调 + */ + search( + keyword: string, + callback: (status: PlaceSearch.SearchStatus, result: string | PlaceSearch.SearchResult) => void + ): void; + /** + * 周边查询 + * @param keyword 关键字 + * @param center 搜索中心 + * @param radius 搜索半径 + * @param callback 回调 + */ + searchNearBy( + keyword: string, + center: LocationValue, + radius: number, + callback: (status: PlaceSearch.SearchStatus, result: string | PlaceSearch.SearchResult) => void + ): void; + /** + * 根据范围和关键词进行范围查询 + * @param keyword 关键字 + * @param bounds 搜索范围 + * @param callback 回调 + */ + searchInBounds( + keyword: string, + bounds: Bounds | Polygon, + callback: (status: PlaceSearch.SearchStatus, result: string | PlaceSearch.SearchResult) => void + ): void; + /** + * 根据POIID 查询POI 详细信息 + * @param POIID POIID + * @param callback 搜索回调 + */ + getDetails( + POIID: string, + callback: (status: PlaceSearch.SearchStatus, result: string | PlaceSearch.SearchResult) => void + ): void; + /** + * 设置查询类别 + * @param type 查询类别 + */ + setType(type?: string): void; + /** + * 设置是否强制限制城市 + * @param limit 是否强制限制城市 + */ + setCityLimit(limit?: boolean): void; + /** + * 设置查询结果特定页数 + * @param pageIndex 页码 + */ + setPageIndex(pageIndex?: number): void; + /** + * 设置查询单页结果数 + * @param pageSize 结果数 + */ + setPageSize(pageSize?: number): void; + /** + * 设置查询城市 + * @param city 城市 + */ + setCity(city?: string): void; + /** + * 设置检索语言类型 + * @param lang 语言类型 + */ + setLang(lang?: Lang): void; + /** + * 获取检索语言类型 + */ + getLang(): Lang | undefined; + /** + * 清除搜索结果 + */ + clear(): void; + /** + * 唤起高德地图客户端marker页 + * @param obj 唤起参数 + */ + poiOnAMAP(obj: { location?: LocationValue; id: string; name?: string; }): void; + /** + * 唤起高德地图客户端POI详情页 + * @param obj 唤起参数 + */ + detailOnAMAP(obj: { location?: LocationValue; id: string; name?: string; }): void; + + // internal + open(): void; + close(): void; + } +} diff --git a/types/amap-js-api-place-search/tsconfig.json b/types/amap-js-api-place-search/tsconfig.json new file mode 100644 index 0000000000..e3259e1b01 --- /dev/null +++ b/types/amap-js-api-place-search/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noEmit": true, + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "amap-js-api-place-search-tests.ts" + ] +} diff --git a/types/opn/tslint.json b/types/amap-js-api-place-search/tslint.json similarity index 100% rename from types/opn/tslint.json rename to types/amap-js-api-place-search/tslint.json diff --git a/types/amap-js-api/amap-js-api-tests.ts b/types/amap-js-api/amap-js-api-tests.ts index ee7a2ac583..57f7fb07d2 100644 --- a/types/amap-js-api/amap-js-api-tests.ts +++ b/types/amap-js-api/amap-js-api-tests.ts @@ -2415,6 +2415,7 @@ const testInfoWindow = new AMap.InfoWindow({ closeWhenClickMap: false, content: 'content', size: [100, 100], + anchor: 'bottom-center', offset: new AMap.Pixel(10, 10), position: lnglat, showShadow: true @@ -2449,6 +2450,20 @@ testInfoWindow.setPosition(lnglatTuple); // $ExpectType LngLat | undefined testInfoWindow.getPosition(); +const testInfoWindowAnchor = testInfoWindow.getAnchor(); +if (testInfoWindowAnchor !== undefined) { + // $ExpectType Anchor + testInfoWindowAnchor; +} else { + // $ExpectType undefined + testInfoWindowAnchor; +} + +// $ExpectType void +testInfoWindow.setAnchor(); +// $ExpectType void +testInfoWindow.setAnchor(testInfoWindowAnchor); + // $ExpectType Size | undefined testInfoWindow.getSize(); @@ -2491,6 +2506,7 @@ new AMap.Marker({}); export const testMarker = new AMap.Marker({ map, position: lnglat, + anchor: 'bottom-center', offset: pixel, icon: 'iconUrl', content: 'htmlString', @@ -2526,6 +2542,20 @@ testMarker.markOnAMAP({ name: '123' }); +const testMarkerAnchor = testMarker.getAnchor(); +if (testMarkerAnchor) { + // $ExpectType Anchor + testMarkerAnchor; +} else { + // $ExpectType undefined + testMarkerAnchor; +} + +// $ExpectType void +testMarker.setAnchor(testMarkerAnchor); +// $ExpectType void +testMarker.setAnchor(); + // $ExpectType Pixel testMarker.getOffset(); @@ -3229,6 +3259,7 @@ const testText = new AMap.Text({ verticalAlign: 'top', map, position: lnglat, + anchor: 'bottom-center', offset: pixel, topWhenClick: true, bubble: true, @@ -3246,6 +3277,20 @@ const testText = new AMap.Text({ extData: { test: 1 } }); +const testTextAnchor = testText.getAnchor(); +if (testTextAnchor) { + // $ExpectType Anchor + testTextAnchor; +} else { + // $ExpectType undefined + testTextAnchor; +} + +// $ExpectType void +testText.setAnchor(testTextAnchor); +// $ExpectType void +testText.setAnchor(); + // $ExpectType string testText.getText(); @@ -3363,7 +3408,7 @@ testText.setShadow(icon); testText.setShadow('shadow url'); // $ExpectType void -testText.setExtData({test: 1}); +testText.setExtData({ test: 1 }); // $ExpectType {} | TextExtraData testText.getExtData(); diff --git a/types/amap-js-api/array-bounds.d.ts b/types/amap-js-api/array-bounds.d.ts index 419d8e4b1d..3e0145e049 100644 --- a/types/amap-js-api/array-bounds.d.ts +++ b/types/amap-js-api/array-bounds.d.ts @@ -2,7 +2,12 @@ declare namespace AMap { class ArrayBounds { constructor(bounds: LocationValue[]); bounds: LngLat[]; + /** + * 判断传入的点是否在ArrayBounds内 + * @param point 目标点 + */ contains(point: LocationValue): boolean; + // internal toBounds(): Bounds; getCenter(): LngLat; diff --git a/types/amap-js-api/bounds.d.ts b/types/amap-js-api/bounds.d.ts index 63e880fe65..f594969292 100644 --- a/types/amap-js-api/bounds.d.ts +++ b/types/amap-js-api/bounds.d.ts @@ -1,12 +1,39 @@ declare namespace AMap { class Bounds { + /** + * 地物对象的经纬度矩形范围。 + * @param southWest 西南角经纬度 + * @param northEast 东北角经纬度 + */ constructor(southWest: LngLat, northEast: LngLat); + /** + * 指定点坐标是否在矩形范围内 + * @param point 制定坐标 + */ contains(point: LocationValue): boolean; + /** + * 获取当前Bounds的中心点经纬度坐标 + */ getCenter(): LngLat; + /** + * 获取西南角坐标 + */ getSouthWest(): LngLat; + /** + * 获取东南角坐标 + */ getSouthEast(): LngLat; + /** + * 获取东北角坐标 + */ getNorthEast(): LngLat; + /** + * 获取西北角坐标 + */ getNorthWest(): LngLat; + /** + * 以字符串形式返回地物对象的矩形范围 + */ toString(): string; } } diff --git a/types/amap-js-api/browser.d.ts b/types/amap-js-api/browser.d.ts index 71bfaa8fea..26b3956aa1 100644 --- a/types/amap-js-api/browser.d.ts +++ b/types/amap-js-api/browser.d.ts @@ -1,51 +1,192 @@ declare namespace AMap { namespace Browser { + /** + * 当前浏览器userAgent + */ const ua: string; + /** + * 是否移动设备 + */ const mobile: boolean; + /** + * 平台类型,如:'windows'、'mac'、'ios'、'android'、'other' + */ const plat: 'android' | 'ios' | 'windows' | 'mac' | 'other'; + /** + * 是否mac设备 + */ const mac: boolean; + /** + * 是否windows设备 + */ const windows: boolean; + /** + * 是否iOS设备 + */ const ios: boolean; + /** + * 是否iPad + */ const iPad: boolean; + /** + * 是否iPhone + */ const iPhone: boolean; + /** + * 是否安卓设备 + */ const android: boolean; + /** + * 是否安卓4以下系统 + */ const android23: boolean; + /** + * 是否Chrome浏览器 + */ const chrome: boolean; + /** + * 是否火狐浏览器 + */ const firefox: boolean; + /** + * 是否Safari浏览器 + */ const safari: boolean; + /** + * 是否微信 + */ const wechat: boolean; + /** + * 是否UC浏览器 + */ const uc: boolean; + /** + * 是否QQ或者QQ浏览器 + */ const qq: boolean; + /** + * 是否IE + */ const ie: boolean; + /** + * 是否IE6 + */ const ie6: boolean; + /** + * 是否IE7 + */ const ie7: boolean; + /** + * 是否IE8 + */ const ie8: boolean; + /** + * 是否IE9 + */ const ie9: boolean; + /** + * 是否IE10 + */ const ie10: boolean; + /** + * 是否IE11 + */ const ie11: boolean; + /** + * 是否Edge浏览器 + */ const edge: boolean; + /** + * 是否IE9以下 + */ const ielt9: boolean; + /** + * 是否百度浏览器 + */ const baidu: boolean; + /** + * 是否支持LocaStorage + */ const isLocalStorage: boolean; + /** + * 是否支持Geolocation + */ const isGeolocation: boolean; + /** + * 是否Webkit移动浏览器 + */ const mobileWebkit: boolean; + /** + * 是否支持Css3D的Webkit移动端浏览器 + */ const mobileWebkit3d: boolean; + /** + * 是否Opera移动浏览器 + */ const mobileOpera: boolean; + /** + * 是否高清屏幕,devicePixelRatio>1 + */ const retina: boolean; + /** + * 是否触屏 + */ const touch: boolean; + /** + * 是否msPointer设备 + */ const msPointer: boolean; + /** + * 是否pointer设备 + */ const pointer: boolean; + /** + * 是否webkit浏览器 + */ const webkit: boolean; + /** + * 是否支持Css3D的ie浏览器 + */ const ie3d: boolean; + /** + * 是否支持Css3D的Webkit浏览器 + */ const webkit3d: boolean; + /** + * 是否支持Css3D的gecko浏览器 + */ const gecko3d: boolean; + /** + * 是否支持Css3D的opera浏览器 + */ const opera3d: boolean; + /** + * 是否支持Css3D的浏览器 + */ const any3d: boolean; + /** + * 是否支持canvas + */ const isCanvas: boolean; + /** + * 是否支持svg + */ const isSvg: boolean; + /** + * 是否支持vml + */ const isVML: boolean; + /** + * 是否支持WebWorker + */ const isWorker: boolean; + /** + * 是否支持WebSocket + */ const isWebsocket: boolean; + /** + * 判断是否支持webgl + */ function isWebGL(): boolean; } } diff --git a/types/amap-js-api/common.d.ts b/types/amap-js-api/common.d.ts index 3d51dc719e..8b442ad0a3 100644 --- a/types/amap-js-api/common.d.ts +++ b/types/amap-js-api/common.d.ts @@ -9,8 +9,17 @@ declare namespace AMap { : V extends undefined ? {} : { value: V }); type MapsEvent = Event; diff --git a/types/amap-js-api/convert-from.d.ts b/types/amap-js-api/convert-from.d.ts index 9fe1f1e76d..61f83f9b94 100644 --- a/types/amap-js-api/convert-from.d.ts +++ b/types/amap-js-api/convert-from.d.ts @@ -1,12 +1,24 @@ declare namespace AMap { namespace convertFrom { interface Result { + /** + * 成功状态文字描述 + */ info: string; // 'ok' + /** + * 高德坐标集合 + */ locations: LngLat[]; } type Type = 'gps' | 'baidu' | 'mapbar'; type SearchStatus = 'complete' | 'error'; } + /** + * 为坐标转换类,支持将其他坐标系的坐标点转换为高德坐标系。 + * @param lnglat 待转换坐标 + * @param type 用于说明是哪个服务商的坐标 + * @param callback 转换完成后的回调函数 + */ function convertFrom( lnglat: LocationValue | LocationValue[], type: convertFrom.Type | null, diff --git a/types/amap-js-api/dom-util.d.ts b/types/amap-js-api/dom-util.d.ts index d83a2ca69a..e39793f006 100644 --- a/types/amap-js-api/dom-util.d.ts +++ b/types/amap-js-api/dom-util.d.ts @@ -1,31 +1,78 @@ declare namespace AMap { namespace DomUtil { + /** + * 获取DOM元素的大小 + * @param dom DOM元素 + */ function getViewport(dom: HTMLElement): Size; - + /** + * 获取DOM元素距离窗口左上角的距离 + * @param dom DOM元素 + */ function getViewportOffset(dom: HTMLElement): Pixel; - + /** + * 在parentNode内部创建一个className类名的tagName元素 + * @param tagName 标签名称 + * @param parent 父节点 + * @param className 类名 + */ function create( tagName: K, parent?: HTMLElement, className?: string ): HTMLElementTagNameMap[K]; - + /** + * 给DOM元素设置为className样式 + * @param dom DOM元素 + * @param className 类名 + */ function setClass(dom: HTMLElement, className?: string): void; - + /** + * DOM元素是否包含className + * @param dom DOM元素 + * @param className 类名 + */ function hasClass(dom: HTMLElement, className: string): boolean; - + /** + * 给DOM元素添加一个className + * @param dom DOM元素 + * @param className 类名 + */ function addClass(dom: HTMLElement, className: string): void; - + /** + * 给DOM元素删除一个className + * @param dom DOM元素 + * @param className 类名 + */ function removeClass(dom: HTMLElement, className: string): void; - + /** + * 给DOM元素设定一个透明度 + * @param dom DOM元素 + * @param opacity 透明度(0-1) + */ function setOpacity(dom: HTMLElement, opacity: number): void; - + /** + * 给DOM元素旋转一个角度,以center为中心,center以元素左上角为坐标原点 + * @param dom DOM元素 + * @param deg 旋转角度 + * @param origin 旋转中心 + */ function rotate(dom: HTMLElement, deg: number, origin?: { x: number, y: number }): void; - + /** + * 给DOM元素删除一组样式,Object同样式表 + * @param dom DOM元素 + * @param style 样式 + */ function setCss(dom: HTMLElement | HTMLElement[], style: Partial): typeof DomUtil; // this - + /** + * 清空DOM元素 + * @param dom DOM元素 + */ function empty(dom: HTMLElement): void; - + /** + * 将DOM元素从父节点删除 + * @param dom DOM元素 + */ function remove(dom: HTMLElement): void; } } diff --git a/types/amap-js-api/event.d.ts b/types/amap-js-api/event.d.ts index d8ff5753c9..d90ee4c720 100644 --- a/types/amap-js-api/event.d.ts +++ b/types/amap-js-api/event.d.ts @@ -1,5 +1,13 @@ declare namespace AMap { abstract class EventEmitter { + /** + * 注册事件 + * @param eventName 事件名称 + * @param handler 事件回调函数 + * @param context 事件回调中的上下文 + * @param once 触发一次 + * @param unshift 更改事件顺序 + */ on( eventName: string, // tslint:disable-next-line:no-unnecessary-generics @@ -8,14 +16,23 @@ declare namespace AMap { once?: boolean, unshift?: boolean ): this; - + /** + * 移除事件绑定 + * @param eventName 事件名称 + * @param handler 事件功能函数 + * @param context 事件上下文 + */ off( eventName: string, // tslint:disable-next-line handler: ((this: C, event: E) => void) | 'mv', context?: C ): this; - + /** + * 触发事件 + * @param eventName 事件名称 + * @param data 事件数据 + */ emit(eventName: string, data?: any): this; } @@ -23,7 +40,13 @@ declare namespace AMap { interface EventListener { type: T; } - + /** + * 注册DOM对象事件 + * @param instance 需注册事件的DOM对象 + * @param eventName 事件名称 + * @param handler 事件功能函数 + * @param context 事件上下文 + */ function addDomListener( // tslint:disable-next-line: no-unnecessary-generics instance: HTMLElementTagNameMap[N], @@ -31,7 +54,13 @@ declare namespace AMap { handler: (this: C, event: HTMLElementEventMap[E]) => void, context?: C ): EventListener<0>; - + /** + * 给对象注册事件 + * @param instance 需注册事件的对象 + * @param eventName 事件名称 + * @param handler 事件功能函数 + * @param context 事件上下文 + */ function addListener( // tslint:disable-next-line: no-unnecessary-generics instance: I, @@ -41,7 +70,13 @@ declare namespace AMap { // tslint:disable-next-line: no-unnecessary-generics context?: C ): EventListener<1>; - + /** + * 给对象注册一次性事件 + * @param instance 需注册事件的对象 + * @param eventName 事件名称 + * @param handler 事件功能函数 + * @param context 事件上下文 + */ function addListenerOnce( // tslint:disable-next-line: no-unnecessary-generics instance: I, @@ -51,9 +86,17 @@ declare namespace AMap { // tslint:disable-next-line: no-unnecessary-generics context?: C ): EventListener<1>; - + /** + * 删除事件 + * @param listener 侦听器 + */ function removeListener(listener: EventListener<0 | 1>): void; - + /** + * 触发非DOM事件 + * @param instance 触发对象 + * @param eventName 事件名称 + * @param data 事件数据 + */ function trigger(instance: EventEmitter, eventName: string, data?: any): void; } } diff --git a/types/amap-js-api/geometry-util.d.ts b/types/amap-js-api/geometry-util.d.ts index 03f6800088..c8a5eae2e9 100644 --- a/types/amap-js-api/geometry-util.d.ts +++ b/types/amap-js-api/geometry-util.d.ts @@ -1,106 +1,176 @@ declare namespace AMap { namespace GeometryUtil { + /** + * 计算两个经纬度点之间的实际距离 + */ function distance( point1: LocationValue, point2: LocationValue | LocationValue[] ): number; - + /** + * 计算一个经纬度路径围成区域的实际面积 + */ function ringArea(ring: LocationValue[]): number; - + /** + * 判断一个经纬度路径是否为顺时针 + */ function isClockwise(path: LocationValue[]): boolean; - + /** + * 计算一个经纬度路径的实际长度 + */ function distanceOfLine(line: LocationValue[]): number; - + /** + * 计算两个经纬度面的交叉区域 + */ function ringRingClip( ring1: LocationValue[], ring2: LocationValue[] ): Array<[number, number]>; - + /** + * 判断两个经纬度面是否交叉 + */ function doesRingRingIntersect( ring1: LocationValue[], ring2: LocationValue[] ): boolean; - + /** + * 判断经纬度路径和经纬度面是否交叉 + */ function doesLineRingIntersect( line: LocationValue[], ring: LocationValue[] ): boolean; - + /** + * 判断两个经纬度路径是否相交 + */ function doesLineLineIntersect( line1: LocationValue[], line2: LocationValue[] ): boolean; - + /** + * 判断线段和多个环是否相交 + */ function doesSegmentPolygonIntersect( point1: LocationValue, point2: LocationValue, polygon: LocationValue[][] ): boolean; - + /** + * 判断线段和一个环是否相交 + */ function doesSegmentRingIntersect( point1: LocationValue, point2: LocationValue, ring: LocationValue[] ): boolean; - + /** + * 判断线段和一个路径是否相交 + */ function doesSegmentLineIntersect( point1: LocationValue, point2: LocationValue, line: LocationValue[] ): boolean; - + /** + * 判断两个线段是否相交 + */ function doesSegmentsIntersect( point1: LocationValue, point2: LocationValue, point3: LocationValue, point4: LocationValue ): boolean; - + /** + * 判断点是否在环内 + */ function isPointInRing(point: LocationValue, ring: LocationValue[]): boolean; - + /** + * 判断环是否在另一个环内 + */ function isRingInRing(ring1: LocationValue[], ring2: LocationValue[]): boolean; - + /** + * 判断点是否在多个环组成区域内 + */ function isPointInPolygon(point: LocationValue, polygon: LocationValue[][]): boolean; - + /** + * 判断点是否在多个环组成区域内 + */ function makesureClockwise(path: Array<[number, number]>): Array<[number, number]>; - + /** + * 将一个路径变为逆时针 + */ function makesureAntiClockwise(path: Array<[number, number]>): Array<[number, number]>; - + /** + * 计算P2P3上距离P1最近的点 + * @param point1 P1 + * @param point2 P2 + * @param point3 P3 + */ function closestOnSegment( point1: LocationValue, point2: LocationValue, point3: LocationValue ): [number, number]; - + /** + * 计算line上距离P最近的点 + */ function closestOnLine(point: LocationValue, line: LocationValue[]): [number, number]; - + /** + * 计算P2P3到P1的距离 + * @param point1 P1 + * @param point2 P2 + * @param point3 P3 + */ function distanceToSegment( point1: LocationValue, point2: LocationValue, point3: LocationValue ): number; - + /** + * 计算P到line的距离 + */ function distanceToLine(point: LocationValue, line: LocationValue[]): number; - + /** + * 判断P1是否在P2P3上 + * @param point1 P1 + * @param point2 P2 + * @param point3 P3 + * @param tolerance 误差范围 + */ function isPointOnSegment( point1: LocationValue, point2: LocationValue, point3: LocationValue, tolerance?: number ): boolean; - + /** + * 判断P是否在line上 + * @param point 点P + * @param line 线 + * @param tolerance 误差范围 + */ function isPointOnLine( point: LocationValue, line: LocationValue[], tolerance?: number ): boolean; - + /** + * 判断P是否在ring的边上 + * @param point 点P + * @param ring 环 + * @param tolerance 误差范围 + */ function isPointOnRing( point: LocationValue, ring: LocationValue[], tolerance?: number ): boolean; - + /** + * 判断P是否在多个ring的边上 + * @param point 点P + * @param polygon 多边形 + * @param tolerance 误差范围 + */ function isPointOnPolygon( point: LocationValue, polygon: LocationValue[][], diff --git a/types/amap-js-api/layer/building.d.ts b/types/amap-js-api/layer/building.d.ts index 30dd7c4092..1b7426e28d 100644 --- a/types/amap-js-api/layer/building.d.ts +++ b/types/amap-js-api/layer/building.d.ts @@ -1,11 +1,27 @@ declare namespace AMap { namespace Buildings { interface Options extends Layer.Options { + /** + * 可见级别范围 + */ zooms?: [number, number]; + /** + * 不透明度 + */ opacity?: number; + /** + * 高度比例系数,可控制3D视图下的楼块高度 + */ heightFactor?: number; + /** + * 是否可见 + */ visible?: boolean; + /** + * 层级 + */ zIndex?: number; + // inner merge?: boolean; sort?: boolean; @@ -24,7 +40,15 @@ declare namespace AMap { } class Buildings extends Layer { + /** + * 楼块图层,单独展示矢量化的楼块图层 + * @param opts 图层选项 + */ constructor(opts?: Buildings.Options); + /** + * 按区域设置楼块的颜色 + * @param style 颜色设置 + */ setStyle(style: Buildings.Style): void; } } diff --git a/types/amap-js-api/layer/flexible.d.ts b/types/amap-js-api/layer/flexible.d.ts index bdb4001a7c..d91970dc31 100644 --- a/types/amap-js-api/layer/flexible.d.ts +++ b/types/amap-js-api/layer/flexible.d.ts @@ -2,6 +2,14 @@ declare namespace AMap { namespace TileLayer { namespace Flexible { interface Options extends TileLayer.Options { + /** + * 创建切片回调 + * @param x 横坐标 + * @param y 纵坐标 + * @param z 层级 + * @param success 成功回调 + * @param fail 失败回调 + */ createTile?( x: number, y: number, @@ -9,11 +17,21 @@ declare namespace AMap { success: (tile: HTMLImageElement | HTMLCanvasElement) => void, fail: () => void ): void; + /** + * 内存中缓存的切片的数量上限 + */ cacheSize?: number; + /** + * 是否显示 + */ visible?: boolean; } } class Flexible extends TileLayer { + /** + * 灵活切片图层 + * @param options 图层选项 + */ constructor(options?: Flexible.Options); } } diff --git a/types/amap-js-api/layer/layer.d.ts b/types/amap-js-api/layer/layer.d.ts index 8f35d949fd..64714bc68f 100644 --- a/types/amap-js-api/layer/layer.d.ts +++ b/types/amap-js-api/layer/layer.d.ts @@ -1,20 +1,56 @@ declare namespace AMap { namespace Layer { interface Options { + /** + * 所属的地图对象 + */ map?: Map; } } abstract class Layer extends EventEmitter { + /** + * 图层获取DOM节点 + */ getContainer(): HTMLDivElement | undefined; + /** + * 获取图层缩放范围 + */ getZooms(): [number, number]; + /** + * 设置透明度 + * @param alpha 透明度 + */ setOpacity(alpha: number): void; + /** + * 设置透明度 + */ getOpacity(): number; + /** + * 显示图层 + */ show(): void; + /** + * 隐藏图层 + */ hide(): void; + /** + * 设置图层所属地图 + * @param map map对象 + */ setMap(map?: Map | null): void; + /** + * 获取图层所属地图 + */ getMap(): Map | null | undefined; + /** + * 设置图层的层级 + * @param index 层级 + */ setzIndex(index: number): void; + /** + * 获取图层的层级 + */ getzIndex(): number; } } diff --git a/types/amap-js-api/layer/layerGroup.d.ts b/types/amap-js-api/layer/layerGroup.d.ts index 4cc463eef7..6a07c8fc72 100644 --- a/types/amap-js-api/layer/layerGroup.d.ts +++ b/types/amap-js-api/layer/layerGroup.d.ts @@ -1,14 +1,49 @@ declare namespace AMap { class LayerGroup extends Layer { + /** + * 图层集合 + * @param layers 集合中的图层 + */ constructor(layers: L | L[]); + /** + * 添加单个图层到集合中,不支持添加重复的图层 + * @param layer 图层 + */ addLayer(layer: L | L[]): this; + /** + * 添加图层数组到集合中,不支持添加重复的图层 + * @param layers 图层数组 + */ addLayers(layers: L | L[]): this; + /** + * 返回当前集合中所有的图层 + */ getLayers(): L[]; getLayer(finder: (this: null, item: L, index: number, list: L[]) => boolean): L | null; + /** + * 判断传入的图层实例是否在集合中 + * @param layer 目标图层 + */ hasLayer(layer: L | ((this: null, item: L, index: number, list: L[]) => boolean)): boolean; + /** + * 从集合中删除传入的图层实例 + * @param layer 图层 + */ removeLayer(layer: L | L[]): this; - removeLayers(layer: L | L[]): this; + /** + * 从集合中删除传入的图层实例数组 + * @param layers 图层数组 + */ + removeLayers(layers: L | L[]): this; + /** + * 清空集合 + */ clearLayers(): this; + /** + * 对集合中的图层做迭代操作 + * @param iterator 迭代回调 + * @param context 执行上下文 + */ eachLayer(iterator: (this: C, layer: L, index: number, list: L[]) => void, context?: C): void; // overwrite diff --git a/types/amap-js-api/layer/massMarks.d.ts b/types/amap-js-api/layer/massMarks.d.ts index 1ab5464a5b..963f7e2ec6 100644 --- a/types/amap-js-api/layer/massMarks.d.ts +++ b/types/amap-js-api/layer/massMarks.d.ts @@ -12,21 +12,51 @@ declare namespace AMap { } interface Style { + /** + * 图标显示位置偏移量,以图标的左上角为基准点(0,0)点 + */ anchor: Pixel; + /** + * 图标的地址 + */ url: string; + /** + * 图标的尺寸 + */ size: Size; + /** + * 旋转角度 + */ rotation?: number; } type UIEvent = Event ? D : Data; }>; interface Options extends Layer.Options { + /** + * 显示层级 + */ zIndex?: number; + /** + * 指针样式 + */ cursor?: string; + /** + * 是否在拖拽缩放过程中实时重绘 + */ alwayRender?: boolean; + /** + * 设置点的样式 + */ style: Style | Style[]; // rejectMapMask } @@ -37,11 +67,33 @@ declare namespace AMap { } class MassMarks extends Layer { + /** + * 海量点类,利用该类可同时在地图上展示万级别的点 + * @param data 点对象数组或url + * @param opts 选项 + */ constructor(data: D[] | string, opts: MassMarks.Options); + /** + * 设置显示样式 + * @param style 样式设置 + */ setStyle(style: MassMarks.Style | MassMarks.Style[]): void; + /** + * 获取显示样式 + */ getStyle(): MassMarks.Style | MassMarks.Style[]; + /** + * 设置数据集 + * @param data 数据集 + */ setData(data: D[] | string): void; + /** + * 获取数据集 + */ getData(): Array> & { lnglat: LngLat }>; + /** + * 清除海量点 + */ clear(): void; } } diff --git a/types/amap-js-api/layer/mediaLayer.d.ts b/types/amap-js-api/layer/mediaLayer.d.ts index a38f5ba025..43fee214bb 100644 --- a/types/amap-js-api/layer/mediaLayer.d.ts +++ b/types/amap-js-api/layer/mediaLayer.d.ts @@ -1,35 +1,94 @@ declare namespace AMap { namespace MediaLayer { interface Options extends Layer.Options { + /** + * 显示范围 + */ bounds?: Bounds; + /** + * 是否可见 + */ visible?: boolean; + /** + * 缩放范围 + */ zooms?: [number, number]; + /** + * 透明度 + */ opacity?: number; } } abstract class MediaLayer extends Layer { + /** + * @param options 图层选项 + */ constructor(options?: MediaLayer.Options); + /** + * 设置显示范围 + * @param bounds 显示范围 + */ setBounds(bounds: Bounds): void; + /** + * 获取显示的范围 + */ getBounds(): Bounds; + /** + * 设置图层选项 + * @param options 图层选项 + */ setOptions(options: Partial): void; + /** + * 获取图层选项 + */ getOptions(): Partial; + /** + * 获取元素 + */ getElement(): E | null; } + /** + * 图片图层 + */ class ImageLayer extends MediaLayer { + /** + * 修改Image的Url + * @param url url + */ setImageUrl(url: string): void; + /** + * 返回Image的Url + */ getImageUrl(): string | undefined; } class VideoLayer extends MediaLayer { + /** + * 修改Video的Url + * @param source url + */ setVideoUrl(source: string | string[]): void; + /** + * 返回Video的Url + */ getVideoUrl(): string | string[] | undefined; } class CanvasLayer extends MediaLayer { + /** + * 修改显示的Canvas + * @param canvas Canvas对象 + */ setCanvas(canvas: HTMLCanvasElement): void; + /** + * 返回Canvas对象 + */ getCanvas(): HTMLCanvasElement | undefined; + /** + * 当canvas的内容发生改变是用于刷新图层 + */ reFresh(): void; } } diff --git a/types/amap-js-api/layer/tileLayer.d.ts b/types/amap-js-api/layer/tileLayer.d.ts index 7576a70664..1a146b964c 100644 --- a/types/amap-js-api/layer/tileLayer.d.ts +++ b/types/amap-js-api/layer/tileLayer.d.ts @@ -5,33 +5,87 @@ declare namespace AMap { } interface Options extends Layer.Options { + /** + * 切片大小 + */ tileSize?: number; + /** + * 切片取图地址(自1.3版本起,该属性与getTileUrl属性合并) + */ tileUrl?: string; + /** + * 取图错误时的代替地址 + */ errorUrl?: string; + /** + * 获取图块取图地址 + */ getTileUrl?: string | ((x: number, y: number, level: number) => string); + /** + * 图层叠加的顺序值 + */ zIndex?: number; + /** + * 图层的透明度 + */ opacity?: number; + /** + * 支持的缩放级别范围 + */ zooms?: [number, number]; + /** + * 是否在高清屏下进行清晰度适配 + */ detectRetina?: boolean; } + /** + * 卫星图层 + */ class Satellite extends TileLayer { } + /** + * 路网图层 + */ class RoadNet extends TileLayer { } namespace Traffic { interface Options extends TileLayer.Options { + /** + * 是否设置可以自动刷新实时路况信息 + */ autoRefresh?: boolean; + /** + * 设置刷新间隔时长 + */ interval?: number; } } class Traffic extends TileLayer { + /** + * 实时交通图层 + * @param options 图层选项 + */ constructor(options?: Traffic.Options); } } class TileLayer extends Layer { + /** + * 切片图层 + * @param options 图层选项 + */ constructor(options?: TileLayer.Options); + /** + * 获取当前图层所有切片号 + */ getTiles(): string[]; + /** + * 重新加载此图层 + */ reload(): void; + /** + * 设置图层的取图地址 + * @param url 取图地址 + */ setTileUrl(url: string | ((x: number, y: number, level: number) => string)): void; } } diff --git a/types/amap-js-api/layer/wms.d.ts b/types/amap-js-api/layer/wms.d.ts index c4561ddf14..043975d856 100644 --- a/types/amap-js-api/layer/wms.d.ts +++ b/types/amap-js-api/layer/wms.d.ts @@ -13,16 +13,43 @@ declare namespace AMap { ELEVATION?: string; } interface Options extends Flexible.Options { + /** + * wms服务的url地址 + */ url: string; + /** + * OGC标准的WMS地图服务的GetMap接口的参数 + */ params: Params; + /** + * 地图级别切换时,不同级别的图片是否进行混合 + */ blend?: boolean; } } class WMS extends Flexible { + /** + * WMS图层 + * @param options 图层选项 + */ constructor(options: WMS.Options); + /** + * 设置wms服务地址 + * @param url 服务地址 + */ setUrl(url: string): void; + /** + * 返回wms服务地址 + */ getUrl(): string; + /** + * 设置OGC标准的WMS getMap接口的参数 + * @param params 接口参数 + */ setParams(params: WMS.Params): void; + /** + * 返回OGC标准的WMS getMap接口的参数 + */ getParams(): WMS.Params; } } diff --git a/types/amap-js-api/layer/wmts.d.ts b/types/amap-js-api/layer/wmts.d.ts index 5d85e5df48..7a122dd6b9 100644 --- a/types/amap-js-api/layer/wmts.d.ts +++ b/types/amap-js-api/layer/wmts.d.ts @@ -8,17 +8,44 @@ declare namespace AMap { Format?: string; } interface Options extends Flexible.Options { + /** + * wmts服务的url地址 + */ url: string; + /** + * OGC标准的WMTS地图服务的GetTile接口的参数 + */ params: Params; + /** + * 地图级别切换时,不同级别的图片是否进行混合 + */ blend?: boolean; } } class WMTS extends Flexible { + /** + * WMTS图层 + * @param options 图层选项 + */ constructor(options: WMTS.Options); + /** + * 设置wmts服务地址 + * @param url 服务地址 + */ setUrl(url: string): void; + /** + * 返回wmts服务地址 + */ getUrl(): string; + /** + * 设置OGC标准的WMTS getTile接口的参数 + * @param params 接口参数 + */ setParams(params: WMTS.Params): void; + /** + * 返回OGC标准的WMTS getTile接口的参数 + */ getParams(): WMTS.Params; } } diff --git a/types/amap-js-api/lngLat.d.ts b/types/amap-js-api/lngLat.d.ts index 4247002b2b..f649a78de8 100644 --- a/types/amap-js-api/lngLat.d.ts +++ b/types/amap-js-api/lngLat.d.ts @@ -1,11 +1,39 @@ declare namespace AMap { class LngLat { + /** + * 构造一个地理坐标对象 + * @param lng 经度 + * @param lat 纬度 + * @param noAutofix 是否自动修正 + */ constructor(lng: number, lat: number, noAutofix?: boolean); + /** + * 移动当前经纬度坐标得到新的坐标 + * @param east 移动经度,向右为正值 + * @param north 移动维度,向上为正值 + */ offset(east: number, north: number): LngLat; + /** + * 当前经纬度和传入经纬度或者经纬度数组连线之间的地面距离,单位为米 + * @param lnglat 对比目标 + */ distance(lnglat: LngLat | LngLat[]): number; + /** + * 获取经度值 + */ getLng(): number; + /** + * 获取纬度值 + */ getLat(): number; + /** + * 判断当前坐标对象与传入坐标对象是否相等 + * @param lnglat 判断目标 + */ equals(lnglat: LngLat): boolean; + /** + * 以字符串的形式返回 + */ toString(): string; // internal diff --git a/types/amap-js-api/map.d.ts b/types/amap-js-api/map.d.ts index 46edc68577..e7937966b1 100644 --- a/types/amap-js-api/map.d.ts +++ b/types/amap-js-api/map.d.ts @@ -3,39 +3,145 @@ declare namespace AMap { type Feature = 'bg' | 'point' | 'road' | 'building'; type ViewMode = '2D' | '3D'; interface Options { + /** + * 地图视口,用于控制影响地图静态显示的属性 + */ view?: View2D; + /** + * 地图图层数组,数组可以是图层 中的一个或多个,默认为普通二维地图 + */ layers?: Layer[]; + /** + * 地图显示的缩放级别 + */ zoom?: number; + /** + * 地图中心点坐标值 + */ center?: LocationValue; + /** + * 地图标注显示顺序 + */ labelzIndex?: number; + /** + * 地图显示的缩放级别范围 + */ zooms?: [number, number]; + /** + * 地图语言类型 + */ lang?: Lang; + /** + * 地图默认鼠标样式 + */ defaultCursor?: string; + /** + * 地图显示的参考坐标系 + */ crs?: 'EPSG3857' | 'EPSG3395' | 'EPSG4326'; + /** + * 地图平移过程中是否使用动画 + */ animateEnable?: boolean; + /** + * 是否开启地图热点和标注的hover效果 + */ isHotspot?: boolean; + /** + * 当前地图中默认显示的图层 + */ defaultLayer?: TileLayer; + /** + * 地图是否可旋转 + */ rotateEnable?: boolean; + /** + * 是否监控地图容器尺寸变化 + */ resizeEnable?: boolean; + /** + * 是否在有矢量底图的时候自动展示室内地图 + */ showIndoorMap?: boolean; + /** + * 在展示矢量图的时候自动展示室内地图图层 + */ + // indoorMap?: IndorMap + /** + * 是否支持可以扩展最大缩放级别 + */ expandZoomRange?: boolean; + /** + * 地图是否可通过鼠标拖拽平移 + */ dragEnable?: boolean; + /** + * 地图是否可缩放 + */ zoomEnable?: boolean; + /** + * 地图是否可通过双击鼠标放大地图 + */ doubleClickZoom?: boolean; + /** + * 地图是否可通过键盘控制 + */ keyboardEnable?: boolean; + /** + * 地图是否使用缓动效果 + */ jogEnable?: boolean; + /** + * 地图是否可通过鼠标滚轮缩放浏览 + */ scrollWheel?: boolean; + /** + * 地图在移动终端上是否可通过多点触控缩放浏览地图 + */ touchZoom?: boolean; + /** + * 当touchZoomCenter=1的时候,手机端双指缩放的以地图中心为中心,否则默认以双指中间点为中心 + */ touchZoomCenter?: number; + /** + * 设置地图的显示样式 + */ mapStyle?: string; + /** + * 设置地图上显示的元素种类 + */ features?: Feature[] | 'all' | Feature; + /** + * 设置地图显示3D楼块效果 + */ showBuildingBlock?: boolean; + /** + * 视图模式 + */ viewMode?: ViewMode; + /** + * 俯仰角度 + */ pitch?: number; + /** + * 是否允许设置俯仰角度 + */ pitchEnable?: boolean; + /** + * 楼块出现和消失的时候是否显示动画过程 + */ buildingAnimation?: boolean; + /** + * 调整天空颜色 + */ skyColor?: string; + /** + * 设置地图的预加载模式 + */ preloadMode?: boolean; + /** + * 为 Map 实例指定掩模的路径,各图层将只显示路径范围内图像 + */ mask?: Array<[number, number]> | Array> | Array>>; maxPitch?: number; rotation?: number; @@ -58,24 +164,67 @@ declare namespace AMap { // detectRetina: number; } interface Status { + /** + * 是否开启动画 + */ animateEnable: boolean; + /** + * 是否双击缩放 + */ doubleClickZoom: boolean; + /** + * 是否支持拖拽 + */ dragEnable: boolean; isHotspot: boolean; + /** + * 是否开启缓动效果 + */ jogEnable: boolean; + /** + * 是否支持键盘 + */ keyboardEnable: boolean; + /** + * 是否支持调整俯仰角 + */ pitchEnable: boolean; resizeEnable: boolean; + /** + * 是否支持旋转 + */ rotateEnable: boolean; + /** + * 是否支持滚轮缩放 + */ scrollWheel: boolean; + /** + * 是否支持触摸缩放 + */ touchZoom: boolean; + /** + * 是否支持缩放 + */ zoomEnable: boolean; } type HotspotEvent = Event; interface EventMap { @@ -113,73 +262,305 @@ declare namespace AMap { } class Map extends EventEmitter { + /** + * 构造一个地图对象 + * @param container 地图容器的id或者是DOM元素 + * @param opts 选项 + */ constructor(container: string | HTMLElement, opts?: Map.Options); + /** + * 唤起高德地图客户端marker页 + * @param obj 唤起参数 + */ poiOnAMAP(obj: { id: string; location?: LocationValue; name?: string }): void; + /** + * 唤起高德地图客户端marker详情页 + * @param obj 唤起参数 + */ detailOnAMAP(obj: { id: string; location?: LocationValue; name?: string }): void; + /** + * 获取当前地图缩放级别 + */ getZoom(): number; + /** + * 获取地图图层数组 + */ getLayers(): Layer[]; + /** + * 获取地图中心点经纬度坐标值 + */ getCenter(): LngLat; + /** + * 返回地图对象的容器 + */ getContainer(): HTMLElement | null; + /** + * 获取地图中心点所在区域 + */ getCity(callback: (cityData: { + /** + * 市名称 + */ city: string; + /** + * 市代码 + */ citycode: string; + /** + * 区名称 + */ district: string; + /** + * 省 + */ province: string | never[]; // province is empty array when getCity fail }) => void): void; + /** + * 获取当前地图视图范围,获取当前可视区域 + */ getBounds(): Bounds; + /** + * 获取当前地图标注的显示顺序 + */ getLabelzIndex(): number; + /** + * 获取Map的限制区域 + */ getLimitBounds(): Bounds; + /** + * 获取地图语言类型 + */ getLang(): Lang; + /** + * 获取地图容器像素大小 + */ getSize(): Size; + /** + * 获取地图顺时针旋转角度 + */ getRotation(): number; + /** + * 获取当前地图状态信息 + */ getStatus(): Map.Status; + /** + * 获取地图默认鼠标指针样式 + */ getDefaultCursor(): string; + /** + * 获取指定位置的地图分辨率 + * @param point 指定经纬度 + */ getResolution(point?: LocationValue): number; + /** + * 获取当前地图比例尺 + * @param dpi dpi + */ getScale(dpi?: number): number; + /** + * 设置地图显示的缩放级别 + * @param level 缩放级别 + */ setZoom(level: number): void; + /** + * 设置地图标注显示的顺序 + * @param index 显示顺序 + */ setLabelzIndex(index: number): void; + /** + * 设置地图图层数组 + * @param layers 图层数组 + */ setLayers(layers: Layer[]): void; + /** + * 添加覆盖物/图层 + * @param overlay 覆盖物/图层 + */ add(overlay: Overlay | Overlay[]): void; + /** + * 删除覆盖物/图层 + * @param overlay 覆盖物/图层 + */ remove(overlay: Overlay | Overlay[]): void; + /** + * 返回添加的覆盖物对象 + * @param type 覆盖物类型 + */ getAllOverlays(type?: 'marker' | 'circle' | 'polyline' | 'polygon'): Overlay[]; + /** + * 设置地图显示的中心点 + * @param center 中心点经纬度 + */ setCenter(center: LocationValue): void; + /** + * 地图缩放至指定级别并以指定点为地图显示中心点 + * @param zoomLevel 缩放等级 + * @param center 缩放中心 + */ setZoomAndCenter(zoomLevel: number, center: LocationValue): void; + /** + * 按照行政区名称或adcode来设置地图显示的中心点。 + * @param city 城市名称或城市编码 + * @param callback 回调 + */ setCity(city: string, callback: (this: this, coord: [string, string], zoom: number) => void): void; + /** + * 指定当前地图显示范围 + * @param bound 显示范围 + */ setBounds(bound: Bounds): Bounds; + /** + * 设置Map的限制区域 + * @param bound 限制区域 + */ setLimitBounds(bound: Bounds): void; + /** + * 清除限制区域 + */ clearLimitBounds(): void; + /** + * 设置地图语言类型 + * @param lang 语言类型 + */ setLang(lang: Lang): void; + /** + * 设置地图顺时针旋转角度,旋转原点为地图容器中心点 + * @param rotation 旋转角度 + */ setRotation(rotation: number): void; + /** + * 设置当前地图显示状态 + * @param status 状态 + */ setStatus(status: Partial): void; + /** + * 设置鼠标指针默认样式 + * @param cursor 指针样式 + */ setDefaultCursor(cursor: string): void; + /** + * 地图放大一级显示 + */ zoomIn(): void; + /** + * 地图缩小一级显示 + */ zoomOut(): void; + /** + * 地图中心点平移至指定点位置 + * @param position 目标位置经纬度 + */ panTo(position: LocationValue): void; + /** + * 以像素为单位,沿x方向和y方向移动地图 + * @param x 横向移动像素,向右为正 + * @param y 纵向移动像素,向下为正 + */ panBy(x: number, y: number): void; + /** + * 根据地图上添加的覆盖物分布情况,自动缩放地图到合适的视野级别 + * @param overlayList 覆盖物数组 + * @param immediately 是否需要动画过程 + * @param avoid 上下左右的像素避让宽度 + * @param maxZoom 最大缩放级别 + */ setFitView( overlayList?: Overlay | Overlay[], immediately?: boolean, avoid?: [number, number, number, number], maxZoom?: number ): Bounds | false | undefined; + /** + * 删除地图上所有的覆盖物 + */ clearMap(): void; + /** + * 注销地图对象,并清空地图容器 + */ destroy(): void; + /** + * 加载插件, + * tips: 插件的类型定义不在本类型定义中给出,需要另行安装例如 + * 3d地图:@types/amap-js-api-map3d + * 地区搜索:@types/amap-js-api-place-search + * @param name 插件名称 + * @param callback 插件加载完成后的回调函数 + */ plugin(name: string | string[], callback: () => void): this; + /** + * 添加控件 + * @param control 控件 + */ addControl(control: {}): void; // TODO + /** + * 移除控件 + * @param control 控件 + */ removeControl(control: {}): void; // TODO + /** + * 清除地图上的信息窗体。 + */ clearInfoWindow(): void; + /** + * 平面地图像素坐标转换为地图经纬度坐标 + * @param pixel 像素坐标 + * @param level 缩放等级 + */ pixelToLngLat(pixel: Pixel, level?: number): LngLat; + /** + * 地图经纬度坐标转换为平面地图像素坐标 + * @param lnglat 经纬度坐标 + * @param level 缩放等级 + */ lnglatToPixel(lnglat: LocationValue, level?: number): Pixel; + /** + * 地图容器像素坐标转为地图经纬度坐标 + * @param pixel 地图像素坐标 + */ containerToLngLat(pixel: Pixel): LngLat; + /** + * 地图经纬度坐标转为地图容器像素坐标 + * @param lnglat 经纬度坐标 + */ lngLatToContainer(lnglat: LocationValue): Pixel; + /** + * 地图经纬度坐标转为地图容器像素坐标 + * @param lnglat 经纬度坐标 + */ lnglatTocontainer(lnglat: LocationValue): Pixel; + /** + * 设置地图的显示样式 + * @param style 地图样式 + */ setMapStyle(style: string): void; + /** + * 获取地图显示样式 + */ getMapStyle(): string; + /** + * 设置地图上显示的元素种类 + * @param feature 元素 + */ setFeatures(feature: Map.Feature | Map.Feature[] | 'all'): void; + /** + * 获取地图显示元素种类 + */ getFeatures(): Map.Feature | Map.Feature[] | 'all'; + /** + * 修改底图图层 + * @param layer 图层 + */ setDefaultLayer(layer: TileLayer): void; + /** + * 设置俯仰角 + * @param pitch 俯仰角 + */ setPitch(pitch: number): void; + /** + * 获取俯仰角 + */ getPitch(): number; + getViewMode_(): Map.ViewMode; lngLatToGeodeticCoord(lnglat: LocationValue): Pixel; geodeticCoordToLngLat(pixel: Pixel): LngLat; diff --git a/types/amap-js-api/overlay/bezierCurve.d.ts b/types/amap-js-api/overlay/bezierCurve.d.ts index 5778cb72a6..b861440a92 100644 --- a/types/amap-js-api/overlay/bezierCurve.d.ts +++ b/types/amap-js-api/overlay/bezierCurve.d.ts @@ -2,18 +2,31 @@ declare namespace AMap { namespace BezierCurve { interface EventMap extends Polyline.EventMap { } type Options = Merge, { - // internal + /** + * 贝瑟尔曲线的路径 + */ path: Array>>; + // internal tolerance?: number; interpolateNumLimit?: [number | number]; }>; interface GetOptionsResult extends Polyline.GetOptionsResult { + /** + * 贝瑟尔曲线的路径 + */ path: Array; } } class BezierCurve extends Polyline { + /** + * 贝瑟尔曲线 + * @param options 覆盖物选项 + */ constructor(options: BezierCurve.Options); + /** + * 获取覆盖物选项 + */ getOptions(): Partial>; // internal getInterpolateLngLats(): LngLat[]; diff --git a/types/amap-js-api/overlay/circle.d.ts b/types/amap-js-api/overlay/circle.d.ts index 2a1cbd9020..c718119e5a 100644 --- a/types/amap-js-api/overlay/circle.d.ts +++ b/types/amap-js-api/overlay/circle.d.ts @@ -34,15 +34,50 @@ declare namespace AMap { } class Circle extends ShapeOverlay { + /** + * 圆形覆盖物 + * @param options 覆盖物选项 + */ constructor(options?: Circle.Options); + /** + * 设置圆中心点 + * @param center 中心点经纬度 + * @param preventEvent 阻止触发事件 + */ setCenter(center: LocationValue, preventEvent?: boolean): void; + /** + * 获取圆中心点 + */ getCenter(): LngLat | undefined; + /** + * 获取圆外切矩形范围 + */ getBounds(): Bounds | null; + /** + * 设置圆形的半径 + * @param radius 半径 + * @param preventEvent 阻止触发事件 + */ setRadius(radius: number, preventEvent?: boolean): void; + /** + * 获取圆形的半径 + */ getRadius(): number; + /** + * 修改选项 + * @param options 选项 + */ setOptions(options?: Circle.Options): void; + /** + * 获取选项 + */ getOptions(): Partial>; + /** + * 判断指定点坐标是否在圆内 + * @param point 坐标 + */ contains(point: LocationValue): boolean; + // internal getPath(count?: number): LngLat[]; } diff --git a/types/amap-js-api/overlay/circleMarker.d.ts b/types/amap-js-api/overlay/circleMarker.d.ts index 13e4162f46..0b67d7f13e 100644 --- a/types/amap-js-api/overlay/circleMarker.d.ts +++ b/types/amap-js-api/overlay/circleMarker.d.ts @@ -1,4 +1,7 @@ declare namespace AMap { // tslint:disable-next-line; + /** + * 圆点标记 + */ class CircleMarker extends Circle {} } diff --git a/types/amap-js-api/overlay/contextMenu.d.ts b/types/amap-js-api/overlay/contextMenu.d.ts index 72c7fc2852..eacb6673c8 100644 --- a/types/amap-js-api/overlay/contextMenu.d.ts +++ b/types/amap-js-api/overlay/contextMenu.d.ts @@ -1,7 +1,11 @@ declare namespace AMap { namespace ContextMenu { interface Options { + /** + * 右键菜单内容 + */ content?: string | HTMLElement; + // internal visible?: boolean; } @@ -14,10 +18,33 @@ declare namespace AMap { } class ContextMenu extends Overlay { + /** + * 地图右键菜单 + * @param options 选项 + */ constructor(options?: ContextMenu.Options); + /** + * 右键菜单中添加菜单项 + * @param text 菜单显示内容 + * @param fn 该菜单下需进行的操作 + * @param num 当前菜单项在右键菜单中的排序位置,以0开始 + */ addItem(text: string, fn: (this: HTMLLIElement) => void, num?: number): void; - removeItem(test: string, fn: (this: HTMLLIElement) => void): void; + /** + * 删除一个菜单项 + * @param text 菜单显示内容 + * @param fn 该菜单下需进行的操作 + */ + removeItem(text: string, fn: (this: HTMLLIElement) => void): void; + /** + * 在地图的指定位置打开右键菜单。 + * @param map 目标地图 + * @param position 打开位置经纬度 + */ open(map: Map, position: LocationValue): void; + /** + * 关闭右键菜单 + */ close(): void; } } diff --git a/types/amap-js-api/overlay/ellipse.d.ts b/types/amap-js-api/overlay/ellipse.d.ts index 55feaf3112..de9da22e0c 100644 --- a/types/amap-js-api/overlay/ellipse.d.ts +++ b/types/amap-js-api/overlay/ellipse.d.ts @@ -6,7 +6,13 @@ declare namespace AMap { } interface Options extends Polygon.Options { + /** + * 椭圆的中心 + */ center?: LocationValue; + /** + * 椭圆半径 + */ radius?: [number, number]; } type GetOptionsResult = Merge, { @@ -15,9 +21,25 @@ declare namespace AMap { } class Ellipse extends Polygon { + /** + * 椭圆 + * @param options 选项 + */ constructor(options?: Ellipse.Options); + /** + * 获取椭圆的中心点 + */ getCenter(): LngLat | undefined; + /** + * 设置椭圆的中心点 + * @param center 中心点 + * @param preventEvent 阻止触发事件 + */ setCenter(center: LocationValue, preventEvent?: boolean): void; + /** + * 修改椭圆属性 + * @param options 属性 + */ setOptions(options: Ellipse.Options): void; // internal diff --git a/types/amap-js-api/overlay/geoJSON.d.ts b/types/amap-js-api/overlay/geoJSON.d.ts index 75098a59f0..aa3554cb04 100644 --- a/types/amap-js-api/overlay/geoJSON.d.ts +++ b/types/amap-js-api/overlay/geoJSON.d.ts @@ -24,9 +24,27 @@ declare namespace AMap { features: GeoJSONObject[]; }; interface Options { + /** + * 要加载的标准GeoJSON对象 + */ geoJSON?: GeoJSONObject | GeoJSONObject[]; + /** + * 指定点要素的绘制方式 + * @param obj GeoJSON对象 + * @param lnglat 点的位置 + */ getMarker?(obj: GeoJSONObject, lnglat: LngLat): Marker; + /** + * 指定线要素的绘制方式 + * @param obj GeoJSON对象 + * @param lnglats 线的路径 + */ getPolyline?(obj: GeoJSONObject, lnglats: LngLat[]): Polyline; + /** + * 指定面要素的绘制方式 + * @param obj GeoJSON对象 + * @param lnglats 面的路径 + */ getPolygon?(obj: GeoJSONObject, lnglats: LngLat[]): Polygon; coordsToLatLng?(lnglat: LngLat): LngLat; @@ -36,8 +54,19 @@ declare namespace AMap { } class GeoJSON extends OverlayGroup { + /** + * GeoJSON + * @param options 选项 + */ constructor(options?: GeoJSON.Options); + /** + * 加载新的GeoJSON对象,转化为覆盖物,旧的覆盖物将移除 + * @param obj GeoJSON对象 + */ importData(obj: GeoJSON.GeoJSONObject | GeoJSON.GeoJSONObject[]): void; + /** + * 将当前对象包含的覆盖物转换为GeoJSON对象 + */ toGeoJSON(): GeoJSON.GeoJSONObject[]; } } diff --git a/types/amap-js-api/overlay/icon.d.ts b/types/amap-js-api/overlay/icon.d.ts index be300feef3..18d75921bf 100644 --- a/types/amap-js-api/overlay/icon.d.ts +++ b/types/amap-js-api/overlay/icon.d.ts @@ -1,16 +1,39 @@ declare namespace AMap { namespace Icon { interface Options { + /** + * 图标尺寸 + */ size?: SizeValue; + /** + * 图标取图偏移量 + */ imageOffset?: Pixel; + /** + * 图标的取图地址 + */ image?: string; + /** + * 图标所用图片大小 + */ imageSize?: SizeValue; } } class Icon extends EventEmitter { + /** + * 点标记的图标 + * @param options 选项 + */ constructor(options?: Icon.Options); + /** + * 设置图标图片大小 + * @param size 大小 + */ setImageSize(size: SizeValue): void; + /** + * 获取图标图片大小 + */ getImageSize(): Size; } } diff --git a/types/amap-js-api/overlay/infoWindow.d.ts b/types/amap-js-api/overlay/infoWindow.d.ts index 54bedd95a8..7b51076351 100644 --- a/types/amap-js-api/overlay/infoWindow.d.ts +++ b/types/amap-js-api/overlay/infoWindow.d.ts @@ -6,14 +6,44 @@ declare namespace AMap { close: Event<'close', { target: I }>; } + type Anchor = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'; + interface Options extends Overlay.Options { + /** + * 是否自定义窗体 + */ isCustom?: boolean; + /** + * 是否自动调整窗体到视野内 + */ autoMove?: boolean; + /** + * 控制是否在鼠标点击地图后关闭信息窗体 + */ closeWhenClickMap?: boolean; + /** + * 显示内容 + */ content?: string | HTMLElement; + /** + * 信息窗体尺寸 + */ size?: SizeValue; + /** + * 信息窗体锚点 + */ + anchor?: Anchor; + /** + * 信息窗体显示位置偏移量 + */ offset?: Pixel; + /** + * 信息窗体显示基点位置 + */ position?: LocationValue; + /** + * 是否显示信息窗体阴影 + */ showShadow?: boolean; // internal height?: number; @@ -21,16 +51,62 @@ declare namespace AMap { } class InfoWindow extends Overlay { + /** + * 信息展示窗体 + * @param options 选项 + */ constructor(options?: InfoWindow.Options); + /** + * 在地图的指定位置打开信息窗体 + * @param map 地图 + * @param position 打开的位置 + */ open(map: Map, position?: LocationValue): void; + /** + * 关闭信息窗体 + */ close(): void; + /** + * 获取信息窗体是否打开 + */ getIsOpen(): boolean; + /** + * 设置信息窗体内容 + * @param content 窗体内容 + */ setContent(content: string | HTMLElement): void; + /** + * 获取信息窗体内容 + */ getContent(): string | HTMLElement | undefined; + /** + * 设置信息窗体显示基点位置 + * @param lnglat 位置经纬度 + */ setPosition(lnglat: LocationValue): void; + /** + * 获取信息窗体显示基点位置 + */ getPosition(): LngLat | undefined; + /** + * 获取锚点 + */ + getAnchor(): InfoWindow.Anchor | undefined; + /** + * 设置锚点 + * @param anchor 锚点 + */ + setAnchor(anchor?: InfoWindow.Anchor): void; + /** + * 设置信息窗体大小 + * @param size 大小 + */ setSize(size: SizeValue): void; + /** + * 获取信息窗体大小 + */ getSize(): Size | undefined; + // internal setOffset(offset: Pixel): void; } diff --git a/types/amap-js-api/overlay/marker.d.ts b/types/amap-js-api/overlay/marker.d.ts index e24ce7be8f..6e8183911c 100644 --- a/types/amap-js-api/overlay/marker.d.ts +++ b/types/amap-js-api/overlay/marker.d.ts @@ -25,79 +25,283 @@ declare namespace AMap { offset?: Pixel; } + type Anchor = 'top-left' | 'top-center' | 'top-right' | 'middle-left' | 'center' | 'middle-right' | 'bottom-left' | 'bottom-center' | 'bottom-right'; + interface Options extends Overlay.Options { + /** + * 点标记在地图上显示的位置 + */ position?: LocationValue; + /** + * 标记锚点 + */ + anchor?: Anchor; + /** + * 点标记显示位置偏移量 + */ offset?: Pixel; + /** + * 需在点标记中显示的图标 + */ icon?: string | Icon; + /** + * 点标记显示内容 + */ content?: string | HTMLElement; + /** + * 鼠标点击时marker是否置顶 + */ topWhenClick?: boolean; + /** + * 是否将覆盖物的鼠标或touch等事件冒泡到地图上 + */ bubble?: boolean; + /** + * 点标记是否可拖拽移动 + */ draggable?: boolean; + /** + * 拖拽点标记时是否开启点标记离开地图的效果 + */ raiseOnDrag?: boolean; + /** + * 鼠标悬停时的鼠标样式 + */ cursor?: string; + /** + * 点标记是否可见 + */ visible?: boolean; + /** + * 点标记的叠加顺序 + */ zIndex?: number; + /** + * 点标记的旋转角度 + */ angle?: number; + /** + * 是否自动旋转 + */ autoRotation?: boolean; + /** + * 点标记的动画效果 + */ animation?: AnimationName; + /** + * 点标记阴影 + */ shadow?: Icon | string; + /** + * 鼠标滑过点标记时的文字提示 + */ title?: string; + /** + * 可点击区域 + */ shape?: MarkerShape; + /** + * 文本标注 + */ label?: Label; - zooms?: [number, number]; // internal + zooms?: [number, number]; topWhenMouseOver?: boolean; height?: number; } } class Marker extends Overlay { + /** + * 点标记 + * @param options 选项 + */ constructor(options?: Marker.Options); + /** + * 唤起高德地图客户端标注页 + * @param obj 唤起参数 + */ markOnAMAP(obj?: { name?: string, position?: LocationValue }): void; + /** + * 获取锚点 + */ + getAnchor(): Marker.Anchor | undefined; + /** + * 设置锚点 + */ + setAnchor(anchor?: Marker.Anchor): void; + /** + * 获取偏移量 + */ getOffset(): Pixel; + /** + * 设置偏移量 + * @param offset 偏移量 + */ setOffset(offset: Pixel): void; + /** + * 设置点标记的动画效果 + * @param animate 动画效果类型 + */ setAnimation(animate: AnimationName, prevent?: boolean): void; + /** + * 获取点标记的动画效果类型 + */ getAnimation(): AnimationName; + /** + * 设置点标记是支持鼠标单击事件 + * @param cilckable 是否支持点击 + */ setClickable(cilckable: boolean): void; + /** + * 获取点标记是否支持鼠标单击事件 + */ getClickable(): boolean; + /** + * 获取点标记的位置 + */ getPosition(): LngLat | undefined; + /** + * 设置点标记位置 + * @param position 位置经纬度 + */ setPosition(position: LocationValue): void; + /** + * 设置点标记的旋转角度 + * @param angle 旋转角度 + */ setAngle(angle: number): void; + /** + * 设置点标记文本标签内容 + * @param label 标签内容 + */ setLabel(label?: Marker.Label): void; + /** + * 获取点标记文本标签内容 + */ getLabel(): Marker.Label | undefined; + /** + * 获取点标记的旋转角度 + */ getAngle(): number; + /** + * 设置点标记的叠加顺序 + * @param index 层级 + */ setzIndex(index: number): void; + /** + * 获取点标记的叠加顺序 + */ getzIndex(): number; + /** + * 设置点标记的显示图标 + * @param content 图标 + */ setIcon(content: string | Icon): void; + /** + * 获取Icon内容 + */ getIcon(): string | Icon | undefined; + /** + * 设置点标记对象是否可拖拽移动 + * @param draggable 是否可拖拽移动 + */ setDraggable(draggable: boolean): void; + /** + * 获取点标记对象是否可拖拽移动 + */ getDraggable(): boolean; + /** + * 设置鼠标悬停时的光标 + * @param cursor 光标 + */ setCursor(cursor: string): void; + /** + * 设置点标记显示内容,可以是HTML要素字符串或者HTML DOM对象 + * @param content 显示内容 + */ setContent(content: string | HTMLElement): void; + /** + * 获取点标记内容 + */ getContent(): string | HTMLElement; + /** + * 以指定的速度,点标记沿指定的路径移动 + * @param path 移动轨迹 + * @param speed 速度 + * @param timingFunction 缓动函数 + * @param circleable 是否循环 + */ moveAlong( path: LngLat[], speed: number, timingFunction?: (t: number) => number, circleable?: boolean ): void; + /** + * 以给定速度移动点标记到指定位置 + * @param lnglat 目标位置 + * @param speed 速度 + * @param timingFunction 缓动函数 + */ moveTo( - path: LocationValue, + lnglat: LocationValue, speed: number, timingFunction?: (t: number) => number ): void; + /** + * 点标记停止动画 + */ stopMove(): void; + /** + * 暂定点标记的动画效果 + */ pauseMove(): boolean; + /** + * 重新开始点标记的动画效果 + */ resumeMove(): boolean; + /** + * 指定目标显示地图 + * @param map 地图 + */ setMap(map: null | Map): void; + /** + * 鼠标滑过点标时的文字提示 + * @param title 提示文字 + */ setTitle(title: string): void; + /** + * 获取点标记的文字提示 + */ getTitle(): string | undefined; + /** + * 设置是否展示在最顶层 + * @param isTop 是否展示在最顶层 + */ setTop(isTop: boolean): void; + /** + * 获取是否展示在最顶层 + */ getTop(): boolean; + /** + * 设置阴影效果 + * @param icon 阴影效果 + */ setShadow(icon?: Icon | string): void; + /** + * 获取阴影图标 + */ getShadow(): Icon | undefined | string; + /** + * 设置可点击区域 + * @param shape 可点击区域 + */ setShape(shape?: MarkerShape): void; + /** + * 获取可点击区域 + */ getShape(): MarkerShape | undefined; } } diff --git a/types/amap-js-api/overlay/markerShape.d.ts b/types/amap-js-api/overlay/markerShape.d.ts index f0d6c39bac..19264f26cf 100644 --- a/types/amap-js-api/overlay/markerShape.d.ts +++ b/types/amap-js-api/overlay/markerShape.d.ts @@ -16,6 +16,10 @@ declare namespace AMap { } class MarkerShape extends EventEmitter { + /** + * Marker点击范围 + * @param options 选项 + */ constructor(options: MarkerShape.Options); } } diff --git a/types/amap-js-api/overlay/overlay.d.ts b/types/amap-js-api/overlay/overlay.d.ts index 1726b39c3e..f90bdb57ed 100644 --- a/types/amap-js-api/overlay/overlay.d.ts +++ b/types/amap-js-api/overlay/overlay.d.ts @@ -13,21 +13,59 @@ declare namespace AMap { mouseup: MapsEvent<'mouseup', I>; } interface Options { + /** + * 所属地图 + */ map?: Map; + /** + * 鼠标悬停时的鼠标样式 + */ cursor?: string; + /** + * 自定义数据 + */ extData?: ExtraData; + /** + * 事件是否穿透到地图 + */ bubble?: boolean; + /** + * 是否支持点击 + */ clickable?: boolean; + /** + * 是否支持拖拽 + */ draggable?: boolean; } } abstract class Overlay extends EventEmitter { constructor(options?: Overlay.Options); + /** + * 显示覆盖物 + */ show(): void; + /** + * 隐藏覆盖物 + */ hide(): void; + /** + * 获取所属地图 + */ getMap(): Map | null | undefined; + /** + * 设置所属地图 + * @param map 地图 + */ setMap(map: Map | null): void; + /** + * 设置自定义数据 + * @param extData 自定义数据 + */ setExtData(extData: ExtraData): void; + /** + * 获取自定义数据 + */ getExtData(): ExtraData | {}; // internal diff --git a/types/amap-js-api/overlay/overlayGroup.d.ts b/types/amap-js-api/overlay/overlayGroup.d.ts index d397505b04..a219e38fcd 100644 --- a/types/amap-js-api/overlay/overlayGroup.d.ts +++ b/types/amap-js-api/overlay/overlayGroup.d.ts @@ -11,20 +11,72 @@ type ReferOverlayOptions = declare namespace AMap { class OverlayGroup extends Overlay { + /** + * 覆盖物集合 + * @param overlays 覆盖物 + */ constructor(overlays?: O | O[]); + /** + * 添加单个覆盖物到集合中,不支持添加重复的覆盖物 + * @param overlay 覆盖物 + */ addOverlay(overlay: O | O[]): this; + /** + * 添加覆盖物数组到集合中,不支持添加重复的覆盖物 + * @param overlay 覆盖物数组 + */ addOverlays(overlay: O | O[]): this; + /** + * 返回当前集合中所有的覆盖物 + */ getOverlays(): O[]; + /** + * 判断传入的覆盖物实例是否在集合中 + * @param overlay 覆盖物 + */ hasOverlay(overlay: O | ((this: null, item: O, index: number, list: O[]) => boolean)): boolean; + /** + * 从集合中删除传入的覆盖物实例 + * @param overlay 覆盖物 + */ removeOverlay(overlay: O | O[]): this; + /** + * 从集合中删除传入的覆盖物实例数组 + * @param overlay 覆盖物数组 + */ removeOverlays(overlay: O | O[]): this; + /** + * 清空集合 + */ clearOverlays(): this; + /** + * 对集合中的覆盖物做迭代操作 + * @param iterator 迭代回调 + * @param context 执行上下文 + */ eachOverlay(iterator: (this: C, overlay: O, index: number, overlays: O[]) => void, context?: C): this; + /** + * 指定集合中里覆盖物的显示地图 + * @param map 地图 + */ setMap(map: null | Map): this; + /** + * 修改覆盖物属性 + * @param options 属性 + */ setOptions(options: ReferOverlayOptions): this; + /** + * 在地图上显示集合中覆盖物 + */ show(): this; + /** + * 在地图上隐藏集合中覆盖物 + */ hide(): this; - + /** + * 查找集合中的覆盖物 + * @param finder 查找回调 + */ getOverlay(finder: ((this: null, item: O, index: number, list: O[]) => boolean) | O): O | null; } } diff --git a/types/amap-js-api/overlay/pathOverlay.d.ts b/types/amap-js-api/overlay/pathOverlay.d.ts index de21aa35a7..d46b23a1c3 100644 --- a/types/amap-js-api/overlay/pathOverlay.d.ts +++ b/types/amap-js-api/overlay/pathOverlay.d.ts @@ -2,19 +2,49 @@ declare namespace AMap { namespace PathOverlay { interface EventMap extends ShapeOverlay.EventMap { } interface Options extends Overlay.Options { + /** + * 是否可见 + */ visible?: boolean; + /** + * 覆盖物层级 + */ zIndex?: number; + /** + * 描边线条颜色 + */ strokeColor?: string; + /** + * 描边线条透明度 + */ strokeOpacity?: number; + /** + * 描边宽度 + */ strokeWeight?: number; + /** + * 描边样式 + */ strokeStyle?: StrokeStyle; + /** + * 虚线间隔 + */ strokeDasharray?: number[]; + /** + * 折线拐点的绘制样式 + */ lineJoin?: StrokeLineJoin; + /** + * 折线两端线帽的绘制样式 + */ lineCap?: StrokeLineCap; } } abstract class PathOverlay extends ShapeOverlay { constructor(options?: PathOverlay.Options); + /** + * 获取范围 + */ getBounds(): Bounds | (this extends Rectangle ? undefined : null); } } diff --git a/types/amap-js-api/overlay/polygon.d.ts b/types/amap-js-api/overlay/polygon.d.ts index 8792e0e135..20a9c3595e 100644 --- a/types/amap-js-api/overlay/polygon.d.ts +++ b/types/amap-js-api/overlay/polygon.d.ts @@ -2,31 +2,77 @@ declare namespace AMap { namespace Polygon { interface EventMap extends PathOverlay.EventMap { } interface Options extends PathOverlay.Options { + /** + * 多边形轮廓线的节点坐标数组 + */ path?: LocationValue[] | LocationValue[][]; + /** + * 多边形填充颜色 + */ fillColor?: string; + /** + * 边形填充透明度 + */ fillOpacity?: number; } interface GetOptionsResult extends ShapeOverlay.GetOptionsResult { + /** + * 多边形填充颜色 + */ fillColor: string; + /** + * 边形填充透明度 + */ fillOpacity: number; + /** + * 多边形轮廓线的节点坐标数组 + */ path: LngLat[] | LngLat[][]; + /** + * 折线拐点的绘制样式 + */ lineJoin: StrokeLineJoin; texture: string; } } class Polygon extends PathOverlay { + /** + * 多边形 + * @param options 选项 + */ constructor(options?: Polygon.Options); + /** + * 设置多边形轮廓线节点数组 + * @param path 轮廓线节点 + */ setPath(path: LocationValue[] | LocationValue[][]): void; + /** + * 获取多边形轮廓线节点数组 + */ getPath(): LngLat[] | LngLat[][]; + /** + * 修改多边形属性 + * @param options 属性 + */ setOptions(options: Polygon.Options): void; + /** + * 获取多边形的属性 + */ getOptions(): Partial< this extends Omit ? Ellipse.GetOptionsResult : this extends Omit ? Rectangle.GetOptionsResult : Polygon.GetOptionsResult >; + /** + * 获取多边形的面积 + */ getArea(): number; + /** + * 判断指定点坐标是否在多边形范围内 + * @param point 坐标 + */ contains(point: LocationValue): boolean; } } diff --git a/types/amap-js-api/overlay/polyline.d.ts b/types/amap-js-api/overlay/polyline.d.ts index 207279b208..c7abfa6331 100644 --- a/types/amap-js-api/overlay/polyline.d.ts +++ b/types/amap-js-api/overlay/polyline.d.ts @@ -2,45 +2,118 @@ declare namespace AMap { namespace Polyline { interface EventMap extends PathOverlay.EventMap { } interface GetOptionsResult extends ShapeOverlay.GetOptionsResult { + /** + * 线条是否带描边 + */ isOutline: boolean; + /** + * 线条描边颜色 + */ outlineColor: string; + /** + * 是否绘制成大地线 + */ geodesic: boolean; + /** + * 折线的节点数组 + */ path: LngLat[]; + /** + * 折线拐点的绘制样式 + */ lineJoin: StrokeLineJoin; + /** + * 折线两端线帽的绘制样式 + */ lineCap: StrokeLineCap; + /** + * 描边的宽度 + */ borderWeight: number; + /** + * 是否延路径显示方向箭头 + */ showDir: boolean; + /** + * 方向箭头颜色 + */ dirColor: string; + /** + * 方向箭头图片 + */ dirImg: string; } interface Options extends PathOverlay.Options { + /** + * 线条是否带描边 + */ isOutline?: boolean; + /** + * 线条描边颜色 + */ outlineColor?: string; + /** + * 是否绘制成大地线 + */ geodesic?: boolean; + /** + * 方向箭头颜色 + */ dirColor?: string; + /** + * 描边的宽度 + */ borderWeight?: number; + /** + * 是否延路径显示方向箭头 + */ showDir?: boolean; + // internal + /** + * 折线的节点数组 + */ path?: LocationValue[]; } } class Polyline extends PathOverlay { + /** + * 折线 + * @param options 选项 + */ constructor(options?: BezierCurve.Options | Polyline.Options); + /** + * 设置组成该折线的节点数组 + * @param path 节点数组 + */ setPath( path: this extends Omit ? Array>> : LocationValue[] ): void; + /** + * 获取折线路径的节点数组 + */ getPath(): this extends Omit ? Array : LngLat[]; + /** + * 获取折线的总长度(单位:米) + */ getLength(): number; + /** + * 设置线的属性 + * @param options 属性 + */ setOptions(options: this extends Omit ? Partial> : Polyline.Options ): void; + /** + * 获取线的属性 + */ getOptions(): Partial>; } } diff --git a/types/amap-js-api/overlay/rectangle.d.ts b/types/amap-js-api/overlay/rectangle.d.ts index 259e2072de..833a46d3dc 100644 --- a/types/amap-js-api/overlay/rectangle.d.ts +++ b/types/amap-js-api/overlay/rectangle.d.ts @@ -5,17 +5,39 @@ declare namespace AMap { } interface Options extends Polygon.Options { + /** + * 矩形的范围 + */ bounds?: Bounds; } type GetOptionsResult = Merge, { + /** + * 路径节点数组 + */ path: LngLat[]; + /** + * 矩形的范围 + */ bounds: Bounds; texture: string; }>; } class Rectangle extends Polygon { + /** + * 矩形 + * @param options 选项 + */ constructor(options?: Rectangle.Options); + /** + * 获取矩形范围 + * @param bounds 矩形的范围 + * @param preventEvent 阻止触发事件 + */ setBounds(bounds: Bounds, preventEvent?: boolean): void; + /** + * 修改矩形属性 + * @param options 属性 + */ setOptions(options: Partial): void; } } diff --git a/types/amap-js-api/overlay/shapeOverlay.d.ts b/types/amap-js-api/overlay/shapeOverlay.d.ts index b8f239aac1..ab07fa3d88 100644 --- a/types/amap-js-api/overlay/shapeOverlay.d.ts +++ b/types/amap-js-api/overlay/shapeOverlay.d.ts @@ -7,24 +7,74 @@ declare namespace AMap { change: Event<'change', { target: I }>; } interface GetOptionsResult { + /** + * 所属地图 + */ map: Map; + /** + * 层级 + */ zIndex: number; + /** + * 线条颜色 + */ strokeColor: string; + /** + * 线条透明度 + */ strokeOpacity: number; + /** + * 线条宽度 + */ strokeWeight: number; + /** + * 线条样式,虚线或者实线 + */ strokeStyle: StrokeStyle; + /** + * 虚线的分段 + */ strokeDasharray: number[]; + /** + * 自定义属性 + */ extData: ExtraData | {}; + /** + * 事件是否穿透到地图 + */ bubble: boolean; + /** + * 是否支持点击 + */ clickable: boolean; } } abstract class ShapeOverlay extends Overlay { + /** + * 设置覆盖物属性 + * @param options 属性 + */ abstract setOptions(options: {}): void; + /** + * 获得属性 + */ abstract getOptions(): {}; + /** + * 获得层级 + */ getzIndex(): number; + /** + * 设置层级 + * @param zIndex 层级 + */ setzIndex(zIndex: number): void; + /** + * 返回可见 + */ getVisible(): boolean; + /** + * 设置是否可以拖拽 + */ setDraggable(draggable: boolean): void; } } diff --git a/types/amap-js-api/overlay/text.d.ts b/types/amap-js-api/overlay/text.d.ts index db15ae08ce..50f9249ad9 100644 --- a/types/amap-js-api/overlay/text.d.ts +++ b/types/amap-js-api/overlay/text.d.ts @@ -4,16 +4,38 @@ declare namespace AMap { type VerticalAlign = 'top' | 'middle' | 'bottom'; interface EventMap extends Marker.EventMap { } interface Options extends Marker.Options { + /** + * 文本内容 + */ text?: string; + /** + * 对齐方式 + */ textAlign?: TextAlign; + verticalAlign?: VerticalAlign; } } class Text extends Marker { + /** + * 纯文本标记 + * @param options 选项 + */ constructor(options?: Text.Options); + /** + * 标记显示的文本内容 + */ getText(): string; + /** + * 修改文本内容 + * @param text 文本内容 + */ setText(text: string): void; + /** + * 设置文本样式 + * @param style 文本样式 + */ setStyle(style: object): void; } } diff --git a/types/amap-js-api/pixel.d.ts b/types/amap-js-api/pixel.d.ts index fab4605b7a..b211e1d88a 100644 --- a/types/amap-js-api/pixel.d.ts +++ b/types/amap-js-api/pixel.d.ts @@ -1,9 +1,28 @@ declare namespace AMap { class Pixel { + /** + * 像素坐标,确定地图上的一个像素点 + * @param x 横轴坐标 + * @param y 纵轴坐标 + * @param round 是否四舍五入 + */ constructor(x: number, y: number, round?: boolean); + /** + * 获得X方向像素坐标 + */ getX(): number; + /** + * 获得Y方向像素坐标 + */ getY(): number; + /** + * 当前像素坐标与传入像素坐标是否相等 + * @param point 目标像素坐标 + */ equals(point: Pixel): boolean; + /** + * 以字符串形式返回像素坐标对象 + */ toString(): string; // internal diff --git a/types/amap-js-api/size.d.ts b/types/amap-js-api/size.d.ts index 12a1e25423..f13c2fff0b 100644 --- a/types/amap-js-api/size.d.ts +++ b/types/amap-js-api/size.d.ts @@ -1,9 +1,24 @@ declare namespace AMap { class Size { + /** + * 地物对象的像素尺寸 + * @param width 宽度像素 + * @param height 长度像素 + */ constructor(width: number, height: number); + /** + * 获得宽度 + */ getWidth(): number; + /** + * 获得高度 + */ getHeight(): number; + /** + * 以字符串形式返回尺寸大小对象 + */ toString(): string; + // internal contains(size: { x: number; y: number }): boolean; } diff --git a/types/amap-js-api/util.d.ts b/types/amap-js-api/util.d.ts index 70b48c31d1..ee275d66b5 100644 --- a/types/amap-js-api/util.d.ts +++ b/types/amap-js-api/util.d.ts @@ -1,25 +1,64 @@ declare namespace AMap { namespace Util { + /** + * 将颜色名转换为16进制RGB颜色值 + * @param colorName 颜色名 + */ function colorNameToHex(colorName: string): string; - + /** + * 将16进制RGB转为rgba(R,G,B,A) + * @param hex 16进制RGB + */ function rgbHex2Rgba(hex: string): string; - + /** + * 将16进制RGBA转为rgba(R,G,B,A) + * @param hex 16进制RGBA + */ function argbHex2Rgba(hex: string): string; - + /** + * 判断一个对象是都为空 + * @param obj 目标对象 + */ function isEmpty(obj: object): boolean; - + /** + * 从数组删除元素 + * @param array 数组 + * @param item 元素 + */ function deleteItemFromArray(array: T[], item: T): T[]; - + /** + * 按索引删除数组元素 + * @param array 数组 + * @param index 索引 + */ function deleteItemFromArrayByIndex(array: T[], index: number): T[]; - + /** + * 返回元素索引 + * @param array 数组 + * @param item 元素 + */ function indexOf(array: T[], item: T): number; - + /** + * 保留小数点后指定位 + * @param floatNumber 数值 + * @param digits 小数点位数 + */ function format(floatNumber: number, digits?: number): number; - + /** + * 判断是否数组 + * @param data 判断对象 + */ function isArray(data: any): data is any[]; - + /** + * 判断参数是否为DOM元素 + * @param data 判断对象 + */ function isDOM(data: any): data is HTMLElement; - + /** + * 判断数组是否包含某个元素 + * @param array 数组 + * @param item 元素 + */ function includes(array: T[], item: T): boolean; function requestIdleCallback(callback: (...args: any[]) => any, options?: { timeout?: number }): number; diff --git a/types/amap-js-api/view2D.d.ts b/types/amap-js-api/view2D.d.ts index d662b4c50e..f246c5c67f 100644 --- a/types/amap-js-api/view2D.d.ts +++ b/types/amap-js-api/view2D.d.ts @@ -1,13 +1,29 @@ declare namespace AMap { namespace View2D { interface Options { + /** + * 地图中心点坐标值 + */ center?: LocationValue; + /** + * 地图顺时针旋转角度 + */ rotation?: number; + /** + * 地图显示的缩放级别 + */ zoom?: number; + /** + * 地图显示的参考坐标系 + */ crs?: 'EPGS3857' | 'EPGS3395' | 'EPGS4326'; } } class View2D extends EventEmitter { + /** + * 二维地图显示视口,用于定义二维地图静态显示属性 + * @param options 选项 + */ constructor(options?: View2D.Options); } } diff --git a/types/amazon-product-api/tslint.json b/types/amazon-product-api/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/amazon-product-api/tslint.json +++ b/types/amazon-product-api/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/amplitude-js/tslint.json b/types/amplitude-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/amplitude-js/tslint.json +++ b/types/amplitude-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/amqp-rpc/tslint.json b/types/amqp-rpc/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/amqp-rpc/tslint.json +++ b/types/amqp-rpc/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-agility/tslint.json b/types/angular-agility/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/angular-agility/tslint.json +++ b/types/angular-agility/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-animate/tslint.json b/types/angular-animate/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-animate/tslint.json +++ b/types/angular-animate/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-bootstrap-calendar/tslint.json b/types/angular-bootstrap-calendar/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-bootstrap-calendar/tslint.json +++ b/types/angular-bootstrap-calendar/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-bootstrap-lightbox/tslint.json b/types/angular-bootstrap-lightbox/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/angular-bootstrap-lightbox/tslint.json +++ b/types/angular-bootstrap-lightbox/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-breadcrumb/tslint.json b/types/angular-breadcrumb/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-breadcrumb/tslint.json +++ b/types/angular-breadcrumb/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-clipboard/tslint.json b/types/angular-clipboard/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-clipboard/tslint.json +++ b/types/angular-clipboard/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-cookie/tslint.json b/types/angular-cookie/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-cookie/tslint.json +++ b/types/angular-cookie/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-cookies/tslint.json b/types/angular-cookies/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-cookies/tslint.json +++ b/types/angular-cookies/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-deferred-bootstrap/tslint.json b/types/angular-deferred-bootstrap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-deferred-bootstrap/tslint.json +++ b/types/angular-deferred-bootstrap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-dialog-service/tslint.json b/types/angular-dialog-service/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-dialog-service/tslint.json +++ b/types/angular-dialog-service/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-dynamic-locale/tslint.json b/types/angular-dynamic-locale/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-dynamic-locale/tslint.json +++ b/types/angular-dynamic-locale/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-environment/tslint.json b/types/angular-environment/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-environment/tslint.json +++ b/types/angular-environment/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-es/tslint.json b/types/angular-es/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-es/tslint.json +++ b/types/angular-es/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-feature-flags/tslint.json b/types/angular-feature-flags/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-feature-flags/tslint.json +++ b/types/angular-feature-flags/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-file-saver/tslint.json b/types/angular-file-saver/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-file-saver/tslint.json +++ b/types/angular-file-saver/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-formly/tslint.json b/types/angular-formly/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-formly/tslint.json +++ b/types/angular-formly/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-fullscreen/tslint.json b/types/angular-fullscreen/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-fullscreen/tslint.json +++ b/types/angular-fullscreen/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-gettext/tslint.json b/types/angular-gettext/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-gettext/tslint.json +++ b/types/angular-gettext/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-google-analytics/tslint.json b/types/angular-google-analytics/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-google-analytics/tslint.json +++ b/types/angular-google-analytics/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-growl-v2/tslint.json b/types/angular-growl-v2/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-growl-v2/tslint.json +++ b/types/angular-growl-v2/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-http-auth/tslint.json b/types/angular-http-auth/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-http-auth/tslint.json +++ b/types/angular-http-auth/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-httpi/tslint.json b/types/angular-httpi/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-httpi/tslint.json +++ b/types/angular-httpi/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-idle/tslint.json b/types/angular-idle/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-idle/tslint.json +++ b/types/angular-idle/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-jwt/tslint.json b/types/angular-jwt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-jwt/tslint.json +++ b/types/angular-jwt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-load/tslint.json b/types/angular-load/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-load/tslint.json +++ b/types/angular-load/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-loading-bar/tslint.json b/types/angular-loading-bar/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-loading-bar/tslint.json +++ b/types/angular-loading-bar/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-local-storage/tslint.json b/types/angular-local-storage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-local-storage/tslint.json +++ b/types/angular-local-storage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-localforage/tslint.json b/types/angular-localforage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-localforage/tslint.json +++ b/types/angular-localforage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-locker/tslint.json b/types/angular-locker/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/angular-locker/tslint.json +++ b/types/angular-locker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-material/angular-material-tests.ts b/types/angular-material/angular-material-tests.ts index f29de44222..6deaa605d0 100644 --- a/types/angular-material/angular-material-tests.ts +++ b/types/angular-material/angular-material-tests.ts @@ -419,3 +419,14 @@ myApp.controller('StickyController', ($scope: TestScope, $mdSticky: ng.material. $mdSticky($scope, stickyElement); $mdSticky($scope, stickyElement, cloneStickyElement); }); + +function mdUtil($mdUtil: ng.material.IUtilService) { + // $ExpectType void + $mdUtil.enableScrolling(); + + // $ExpectType () => void + $mdUtil.debounce(() => {}); + + // $ExpectType () => string + $mdUtil.debounce((): string => ""); +} diff --git a/types/angular-material/index.d.ts b/types/angular-material/index.d.ts index 444e043210..11ec689cf1 100644 --- a/types/angular-material/index.d.ts +++ b/types/angular-material/index.d.ts @@ -517,5 +517,11 @@ declare module 'angular' { getLastInteractionType(): string|null; isUserInvoked(checkDelay?: number): boolean; } + + interface IUtilService { + // tslint:disable-next-line:ban-types debounce takes in a user provided function + debounce(func: T, wait?: number, scope?: any, invokeApply?: boolean): T; + enableScrolling(): void; + } } } diff --git a/types/angular-media-queries/tslint.json b/types/angular-media-queries/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-media-queries/tslint.json +++ b/types/angular-media-queries/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-meteor/tslint.json b/types/angular-meteor/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/angular-meteor/tslint.json +++ b/types/angular-meteor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-modal/tslint.json b/types/angular-modal/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-modal/tslint.json +++ b/types/angular-modal/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-notifications/tslint.json b/types/angular-notifications/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-notifications/tslint.json +++ b/types/angular-notifications/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-notify/tslint.json b/types/angular-notify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-notify/tslint.json +++ b/types/angular-notify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-odata-resources/tslint.json b/types/angular-odata-resources/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/angular-odata-resources/tslint.json +++ b/types/angular-odata-resources/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-permission/tslint.json b/types/angular-permission/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-permission/tslint.json +++ b/types/angular-permission/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-promise-tracker/tslint.json b/types/angular-promise-tracker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-promise-tracker/tslint.json +++ b/types/angular-promise-tracker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-q-spread/tslint.json b/types/angular-q-spread/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-q-spread/tslint.json +++ b/types/angular-q-spread/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-route/tslint.json b/types/angular-route/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-route/tslint.json +++ b/types/angular-route/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-sanitize/tslint.json b/types/angular-sanitize/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-sanitize/tslint.json +++ b/types/angular-sanitize/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-scenario/tslint.json b/types/angular-scenario/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-scenario/tslint.json +++ b/types/angular-scenario/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-scroll/tslint.json b/types/angular-scroll/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-scroll/tslint.json +++ b/types/angular-scroll/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-signalr-hub/tslint.json b/types/angular-signalr-hub/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-signalr-hub/tslint.json +++ b/types/angular-signalr-hub/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-spinner/tslint.json b/types/angular-spinner/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-spinner/tslint.json +++ b/types/angular-spinner/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-storage/tslint.json b/types/angular-storage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-storage/tslint.json +++ b/types/angular-storage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-toastr/tslint.json b/types/angular-toastr/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-toastr/tslint.json +++ b/types/angular-toastr/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-toasty/tslint.json b/types/angular-toasty/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-toasty/tslint.json +++ b/types/angular-toasty/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-translate/tslint.json b/types/angular-translate/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-translate/tslint.json +++ b/types/angular-translate/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-bootstrap/tslint.json b/types/angular-ui-bootstrap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-ui-bootstrap/tslint.json +++ b/types/angular-ui-bootstrap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-notification/tslint.json b/types/angular-ui-notification/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-ui-notification/tslint.json +++ b/types/angular-ui-notification/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-router/tslint.json b/types/angular-ui-router/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-ui-router/tslint.json +++ b/types/angular-ui-router/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-scroll/tslint.json b/types/angular-ui-scroll/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-ui-scroll/tslint.json +++ b/types/angular-ui-scroll/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-sortable/tslint.json b/types/angular-ui-sortable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-ui-sortable/tslint.json +++ b/types/angular-ui-sortable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-ui-tree/tslint.json b/types/angular-ui-tree/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/angular-ui-tree/tslint.json +++ b/types/angular-ui-tree/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-wizard/tslint.json b/types/angular-wizard/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/angular-wizard/tslint.json +++ b/types/angular-wizard/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular-xeditable/tslint.json b/types/angular-xeditable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular-xeditable/tslint.json +++ b/types/angular-xeditable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angular.throttle/tslint.json b/types/angular.throttle/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angular.throttle/tslint.json +++ b/types/angular.throttle/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angularfire/tslint.json b/types/angularfire/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/angularfire/tslint.json +++ b/types/angularfire/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angularlocalstorage/tslint.json b/types/angularlocalstorage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angularlocalstorage/tslint.json +++ b/types/angularlocalstorage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/angulartics/tslint.json b/types/angulartics/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/angulartics/tslint.json +++ b/types/angulartics/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/animation-frame/tslint.json b/types/animation-frame/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/animation-frame/tslint.json +++ b/types/animation-frame/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ansi-styles/tslint.json b/types/ansi-styles/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ansi-styles/tslint.json +++ b/types/ansi-styles/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ansicolors/tslint.json b/types/ansicolors/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ansicolors/tslint.json +++ b/types/ansicolors/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/any-db-transaction/tslint.json b/types/any-db-transaction/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/any-db-transaction/tslint.json +++ b/types/any-db-transaction/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/any-db/tslint.json b/types/any-db/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/any-db/tslint.json +++ b/types/any-db/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/aphrodite/tslint.json b/types/aphrodite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/aphrodite/tslint.json +++ b/types/aphrodite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/api-error-handler/tslint.json b/types/api-error-handler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/api-error-handler/tslint.json +++ b/types/api-error-handler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/apigee-access/tslint.json b/types/apigee-access/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/apigee-access/tslint.json +++ b/types/apigee-access/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/app-root-path/tslint.json b/types/app-root-path/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/app-root-path/tslint.json +++ b/types/app-root-path/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/appframework/tslint.json b/types/appframework/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/appframework/tslint.json +++ b/types/appframework/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/applepayjs/tslint.json b/types/applepayjs/tslint.json index 65c83fb1e3..1c56ba06b6 100644 --- a/types/applepayjs/tslint.json +++ b/types/applepayjs/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { + "npm-naming": false, "dt-header": false } } diff --git a/types/appletvjs/tslint.json b/types/appletvjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/appletvjs/tslint.json +++ b/types/appletvjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/arbiter/tslint.json b/types/arbiter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/arbiter/tslint.json +++ b/types/arbiter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/arcgis-js-api/tslint.json b/types/arcgis-js-api/tslint.json index e3610fefae..89955128d5 100644 --- a/types/arcgis-js-api/tslint.json +++ b/types/arcgis-js-api/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/arcgis-js-api/v3/index.d.ts b/types/arcgis-js-api/v3/index.d.ts index e38c5c0356..e595cdb9cc 100644 --- a/types/arcgis-js-api/v3/index.d.ts +++ b/types/arcgis-js-api/v3/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for ArcGIS API for JavaScript 3.27 +// Type definitions for ArcGIS API for JavaScript 3.28 // Project: https://developers.arcgis.com/javascript/3/ // Definitions by: Esri // Bjorn Svensson @@ -3477,19 +3477,19 @@ declare module "esri/basemaps" { var basemaps: { /** The Light Gray Canvas basemap is designed to be used as a neutral background map for overlaying and emphasizing other map layers. */ gray: any; - /** The World Imagery map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications. */ + /** The World Imagery with Labels map is a detailed imagery map layer and labels that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/Reference/World_Boundaries_and_Places/MapServer https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer */ hybrid: any; /** The Ocean Basemap is designed to be used as a basemap by marine GIS professionals and as a reference map by anyone interested in ocean data. */ oceans: any; /** The OpenStreetMap is a community map layer that is designed to be used as a basemap for various maps and applications. */ osm: any; - /** The World Imagery map is a detailed imagery map layer that is designed to be used as a basemap for various maps and applications. */ + /** The World Imagery map is a detailed imagery map layer that is designed to be used as a basemap for various maps and applications: https://services.arcgisonline.com/ArcGIS/rest/services/World_Imagery/MapServer. */ satellite: any; - /** The Streets basemap presents a multiscale street map for the world. */ + /** The Streets basemap presents a multiscale street map for the world: https://services.arcgisonline.com/ArcGIS/rest/services/World_Street_Map/MapServer. */ streets: any; /** The Terrain with Labels basemap is designed to be used to overlay and emphasize other thematic map layers. */ terrain: any; - /** The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings. */ + /** The Topographic map includes boundaries, cities, water features, physiographic features, parks, landmarks, transportation, and buildings: https://services.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer */ topo: any; }; export = basemaps; @@ -9228,8 +9228,9 @@ declare module "esri/lang" { * @param data The data object used in the substitution. * @param template The template used for the substitution. * @param first When true, returns only the first property found in the data object. + * @param format The format object used in the substitution. */ - substitute(data: any, template?: string, first?: boolean): string; + substitute(data: any, template?: string, first?: boolean, format?: any): string; /** * Iterates through the argument array and searches for the identifier to which the argument value matches. * @param array The argument array for testing. @@ -10000,6 +10001,8 @@ declare module "esri/layers/FeatureLayer" { displayField: string; /** Indicates the field names for the editor fields. */ editFieldsInfo: any; + /** Applicable to ArcGIS Online hosted feature services. */ + editingInfo: any; /** The array of fields in the layer. */ fields: Field[]; /** The full extent of the layer. */ @@ -10054,6 +10057,8 @@ declare module "esri/layers/FeatureLayer" { supportsAttachmentsByUploadId: boolean; /** When true, the layer supports the Calculate REST operation when updating features. */ supportsCalculate: boolean; + /** If true, the layer supports a user-defined field description. */ + supportsFieldDescription: boolean; /** When true, the layer supports statistical functions in query operations. */ supportsStatistics: boolean; /** When true, the layer is suspended. */ @@ -10468,6 +10473,8 @@ declare module "esri/layers/Field" { class Field { /** The alias name for the field. */ alias: string; + /** A string that describes the default value set for a field. */ + defaultValue: string; /** Domain associated with the field. */ domain: Domain; /** Indicates whether the field is editable. */ diff --git a/types/archiver/index.d.ts b/types/archiver/index.d.ts index a9cafca24b..a25b018c11 100644 --- a/types/archiver/index.d.ts +++ b/types/archiver/index.d.ts @@ -41,6 +41,8 @@ declare namespace archiver { class ArchiverError extends Error { code: string; // Since archiver format support is modular, we cannot enumerate all possible error codes, as the modules can throw arbitrary ones. data: any; + path?: any; + constructor(code: string, data: any); } diff --git a/types/archiver/tslint.json b/types/archiver/tslint.json index 10e16aef18..7bfbd50b5b 100644 --- a/types/archiver/tslint.json +++ b/types/archiver/tslint.json @@ -3,6 +3,7 @@ "rules": { // TODOs "ban-types": false, + "npm-naming": false, "dt-header": false } } diff --git a/types/archy/tslint.json b/types/archy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/archy/tslint.json +++ b/types/archy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/argv/tslint.json b/types/argv/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/argv/tslint.json +++ b/types/argv/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/array-foreach/tslint.json b/types/array-foreach/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/array-foreach/tslint.json +++ b/types/array-foreach/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/asana/tslint.json b/types/asana/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/asana/tslint.json +++ b/types/asana/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/asciify/tslint.json b/types/asciify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/asciify/tslint.json +++ b/types/asciify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/asn1js/tslint.json b/types/asn1js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/asn1js/tslint.json +++ b/types/asn1js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/aspnet-identity-pw/tslint.json b/types/aspnet-identity-pw/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/aspnet-identity-pw/tslint.json +++ b/types/aspnet-identity-pw/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/assertsharp/tslint.json b/types/assertsharp/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/assertsharp/tslint.json +++ b/types/assertsharp/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/async-polling/tslint.json b/types/async-polling/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/async-polling/tslint.json +++ b/types/async-polling/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/async-writer/tslint.json b/types/async-writer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/async-writer/tslint.json +++ b/types/async-writer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/atmosphere.js/tslint.json b/types/atmosphere.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/atmosphere.js/tslint.json +++ b/types/atmosphere.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/atpl/tslint.json b/types/atpl/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/atpl/tslint.json +++ b/types/atpl/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/auth0-angular/tslint.json b/types/auth0-angular/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/auth0-angular/tslint.json +++ b/types/auth0-angular/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/auth0.widget/tslint.json b/types/auth0.widget/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/auth0.widget/tslint.json +++ b/types/auth0.widget/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/auth0/tslint.json b/types/auth0/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/auth0/tslint.json +++ b/types/auth0/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/autolinker/tslint.json b/types/autolinker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/autolinker/tslint.json +++ b/types/autolinker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/autoprefixer-core/tslint.json b/types/autoprefixer-core/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/autoprefixer-core/tslint.json +++ b/types/autoprefixer-core/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/avoscloud-sdk/tslint.json b/types/avoscloud-sdk/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/avoscloud-sdk/tslint.json +++ b/types/avoscloud-sdk/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/aws-iot-device-sdk/tslint.json b/types/aws-iot-device-sdk/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/aws-iot-device-sdk/tslint.json +++ b/types/aws-iot-device-sdk/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/aws-lambda-mock-context/tslint.json b/types/aws-lambda-mock-context/tslint.json index bafaae7817..f6fabe4180 100644 --- a/types/aws-lambda-mock-context/tslint.json +++ b/types/aws-lambda-mock-context/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO + "npm-naming": false, "dt-header": false } } diff --git a/types/aws-lambda/tslint.json b/types/aws-lambda/tslint.json index bafaae7817..f6fabe4180 100644 --- a/types/aws-lambda/tslint.json +++ b/types/aws-lambda/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO + "npm-naming": false, "dt-header": false } } diff --git a/types/aws4/tslint.json b/types/aws4/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/aws4/tslint.json +++ b/types/aws4/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/axel/tslint.json b/types/axel/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/axel/tslint.json +++ b/types/axel/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/azure-mobile-services-client/tslint.json b/types/azure-mobile-services-client/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/azure-mobile-services-client/tslint.json +++ b/types/azure-mobile-services-client/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/azure-sb/tslint.json b/types/azure-sb/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/azure-sb/tslint.json +++ b/types/azure-sb/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/azure/tslint.json b/types/azure/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/azure/tslint.json +++ b/types/azure/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/babelify/tslint.json b/types/babelify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/babelify/tslint.json +++ b/types/babelify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/babyparse/tslint.json b/types/babyparse/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/babyparse/tslint.json +++ b/types/babyparse/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone-associations/tslint.json b/types/backbone-associations/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backbone-associations/tslint.json +++ b/types/backbone-associations/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone-fetch-cache/tslint.json b/types/backbone-fetch-cache/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backbone-fetch-cache/tslint.json +++ b/types/backbone-fetch-cache/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone-relational/tslint.json b/types/backbone-relational/tslint.json index 65e27fce52..fd5f6a3567 100644 --- a/types/backbone-relational/tslint.json +++ b/types/backbone-relational/tslint.json @@ -4,6 +4,7 @@ "array-type": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "jsdoc-format": false, "max-line-length": false, diff --git a/types/backbone.layoutmanager/tslint.json b/types/backbone.layoutmanager/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/backbone.layoutmanager/tslint.json +++ b/types/backbone.layoutmanager/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone.localstorage/tslint.json b/types/backbone.localstorage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backbone.localstorage/tslint.json +++ b/types/backbone.localstorage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone.paginator/tslint.json b/types/backbone.paginator/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backbone.paginator/tslint.json +++ b/types/backbone.paginator/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone.radio/tslint.json b/types/backbone.radio/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backbone.radio/tslint.json +++ b/types/backbone.radio/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backbone/tslint.json b/types/backbone/tslint.json index f5ae3a6788..ab605d9227 100644 --- a/types/backbone/tslint.json +++ b/types/backbone/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "export-just-namespace": false, "interface-name": false, "jsdoc-format": false, diff --git a/types/backgrid/tslint.json b/types/backgrid/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backgrid/tslint.json +++ b/types/backgrid/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/backlog-js/tslint.json b/types/backlog-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/backlog-js/tslint.json +++ b/types/backlog-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/baconjs/tslint.json b/types/baconjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/baconjs/tslint.json +++ b/types/baconjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/baidumap-web-sdk/tslint.json b/types/baidumap-web-sdk/tslint.json index eccb336643..43797d8dd7 100644 --- a/types/baidumap-web-sdk/tslint.json +++ b/types/baidumap-web-sdk/tslint.json @@ -7,6 +7,7 @@ "ban-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "max-line-length": false, "member-access": false, diff --git a/types/barcode/tslint.json b/types/barcode/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/barcode/tslint.json +++ b/types/barcode/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bardjs/tslint.json b/types/bardjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bardjs/tslint.json +++ b/types/bardjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/base16/tslint.json b/types/base16/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/base16/tslint.json +++ b/types/base16/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bases/tslint.json b/types/bases/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bases/tslint.json +++ b/types/bases/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/batch-stream/tslint.json b/types/batch-stream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/batch-stream/tslint.json +++ b/types/batch-stream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bazinga-translator/tslint.json b/types/bazinga-translator/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bazinga-translator/tslint.json +++ b/types/bazinga-translator/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bcrypt-nodejs/tslint.json b/types/bcrypt-nodejs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bcrypt-nodejs/tslint.json +++ b/types/bcrypt-nodejs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bcrypt/tslint.json b/types/bcrypt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bcrypt/tslint.json +++ b/types/bcrypt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bcryptjs/tslint.json b/types/bcryptjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bcryptjs/tslint.json +++ b/types/bcryptjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/benchmark/tslint.json b/types/benchmark/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/benchmark/tslint.json +++ b/types/benchmark/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/better-curry/tslint.json b/types/better-curry/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/better-curry/tslint.json +++ b/types/better-curry/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/better-sqlite3/better-sqlite3-tests.ts b/types/better-sqlite3/better-sqlite3-tests.ts index f5a6c0e070..ac72affc05 100644 --- a/types/better-sqlite3/better-sqlite3-tests.ts +++ b/types/better-sqlite3/better-sqlite3-tests.ts @@ -11,7 +11,7 @@ const registrationOptions: Sqlite.RegistrationOptions = { }; let db: Sqlite.Database = Sqlite('.'); -db = new Sqlite('.', { memory: true }); +db = new Sqlite('.', { memory: true, verbose: () => {} }); db.exec('CREATE TABLE test (id INTEGER PRIMARY KEY NOT NULL, name TEXT NOT NULL);'); db.exec('INSERT INTO test(name) VALUES("name");'); db.pragma('data_version', { simple: true }); diff --git a/types/better-sqlite3/index.d.ts b/types/better-sqlite3/index.d.ts index 32a71d96af..57a17e897f 100644 --- a/types/better-sqlite3/index.d.ts +++ b/types/better-sqlite3/index.d.ts @@ -5,6 +5,7 @@ // Santiago Aguilar // Alessandro Vergani // Andrew Kaiser +// Mark Stewart // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 3.0 @@ -97,6 +98,7 @@ declare namespace Database { readonly?: boolean; fileMustExist?: boolean; timeout?: number; + verbose?: (message?: any, ...additionalArgs: any[]) => void; } interface PragmaOptions { diff --git a/types/bezier-js/tslint.json b/types/bezier-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bezier-js/tslint.json +++ b/types/bezier-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bgiframe/tslint.json b/types/bgiframe/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bgiframe/tslint.json +++ b/types/bgiframe/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bigint/tslint.json b/types/bigint/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bigint/tslint.json +++ b/types/bigint/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bignum/tslint.json b/types/bignum/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bignum/tslint.json +++ b/types/bignum/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bigscreen/tslint.json b/types/bigscreen/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bigscreen/tslint.json +++ b/types/bigscreen/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bind-ponyfill/tslint.json b/types/bind-ponyfill/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bind-ponyfill/tslint.json +++ b/types/bind-ponyfill/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bintrees/tslint.json b/types/bintrees/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bintrees/tslint.json +++ b/types/bintrees/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bip21/tslint.json b/types/bip21/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bip21/tslint.json +++ b/types/bip21/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bit-array/tslint.json b/types/bit-array/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bit-array/tslint.json +++ b/types/bit-array/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bl/tslint.json b/types/bl/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bl/tslint.json +++ b/types/bl/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blazy/tslint.json b/types/blazy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blazy/tslint.json +++ b/types/blazy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bleno/tslint.json b/types/bleno/tslint.json index 0f5eeaf557..d895c355d8 100644 --- a/types/bleno/tslint.json +++ b/types/bleno/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { "dt-header": false, + "npm-naming": false, "unified-signatures": false } } diff --git a/types/blessed/tslint.json b/types/blessed/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blessed/tslint.json +++ b/types/blessed/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blissfuljs/tslint.json b/types/blissfuljs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blissfuljs/tslint.json +++ b/types/blissfuljs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blob-stream/tslint.json b/types/blob-stream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blob-stream/tslint.json +++ b/types/blob-stream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blocks/tslint.json b/types/blocks/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blocks/tslint.json +++ b/types/blocks/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blue-tape/tslint.json b/types/blue-tape/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blue-tape/tslint.json +++ b/types/blue-tape/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/blueimp-md5/tslint.json b/types/blueimp-md5/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/blueimp-md5/tslint.json +++ b/types/blueimp-md5/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bookshelf/package.json b/types/bookshelf/package.json new file mode 100644 index 0000000000..7bd76f13f8 --- /dev/null +++ b/types/bookshelf/package.json @@ -0,0 +1,6 @@ +{ + "private": true, + "dependencies": { + "knex": "^0.16.1" + } +} diff --git a/types/bookshelf/tslint.json b/types/bookshelf/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/bookshelf/tslint.json +++ b/types/bookshelf/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/boolify-string/tslint.json b/types/boolify-string/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/boolify-string/tslint.json +++ b/types/boolify-string/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootbox/tslint.json b/types/bootbox/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootbox/tslint.json +++ b/types/bootbox/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootpag/tslint.json b/types/bootpag/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootpag/tslint.json +++ b/types/bootpag/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-datepicker/tslint.json b/types/bootstrap-datepicker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-datepicker/tslint.json +++ b/types/bootstrap-datepicker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-fileinput/tslint.json b/types/bootstrap-fileinput/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-fileinput/tslint.json +++ b/types/bootstrap-fileinput/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-maxlength/tslint.json b/types/bootstrap-maxlength/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-maxlength/tslint.json +++ b/types/bootstrap-maxlength/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-notify/tslint.json b/types/bootstrap-notify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-notify/tslint.json +++ b/types/bootstrap-notify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-select/tslint.json b/types/bootstrap-select/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-select/tslint.json +++ b/types/bootstrap-select/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-switch/tslint.json b/types/bootstrap-switch/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-switch/tslint.json +++ b/types/bootstrap-switch/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-table/tslint.json b/types/bootstrap-table/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-table/tslint.json +++ b/types/bootstrap-table/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap-touchspin/tslint.json b/types/bootstrap-touchspin/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap-touchspin/tslint.json +++ b/types/bootstrap-touchspin/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap.paginator/tslint.json b/types/bootstrap.paginator/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap.paginator/tslint.json +++ b/types/bootstrap.paginator/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bootstrap.timepicker/tslint.json b/types/bootstrap.timepicker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bootstrap.timepicker/tslint.json +++ b/types/bootstrap.timepicker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bounce.js/tslint.json b/types/bounce.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bounce.js/tslint.json +++ b/types/bounce.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/box2d/tslint.json b/types/box2d/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/box2d/tslint.json +++ b/types/box2d/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/braintree-web/tslint.json b/types/braintree-web/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/braintree-web/tslint.json +++ b/types/braintree-web/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/breeze/tslint.json b/types/breeze/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/breeze/tslint.json +++ b/types/breeze/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bro-fs/index.d.ts b/types/bro-fs/index.d.ts index e0d11cddbe..e2d53cb8a1 100644 --- a/types/bro-fs/index.d.ts +++ b/types/bro-fs/index.d.ts @@ -44,6 +44,8 @@ export function isSupported(): boolean; export function mkdir(path: string): Promise; export function readdir(path: string | DirectoryEntry, options?: {deep?: boolean}): Promise; export function readFile(path: string | FileEntry, options: {type: 'ArrayBuffer'}): Promise; +export function readFile(path: string | FileEntry, options: {type: 'Blob'}): Promise; +export function readFile(path: string | FileEntry, options: {type: 'File'}): Promise; export function readFile(path: string | FileEntry, options?: {type?: TextType}): Promise; export function rename(oldPath: string | FileEntry, newPath: string, options?: {create?: boolean}): Promise; export function rmdir(path: string | DirectoryEntry): Promise; diff --git a/types/brorand/tslint.json b/types/brorand/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/brorand/tslint.json +++ b/types/brorand/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browser-harness/tslint.json b/types/browser-harness/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browser-harness/tslint.json +++ b/types/browser-harness/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browser-pack/tslint.json b/types/browser-pack/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browser-pack/tslint.json +++ b/types/browser-pack/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browser-report/tslint.json b/types/browser-report/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browser-report/tslint.json +++ b/types/browser-report/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browser-resolve/tslint.json b/types/browser-resolve/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browser-resolve/tslint.json +++ b/types/browser-resolve/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browser-sync/tslint.json b/types/browser-sync/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browser-sync/tslint.json +++ b/types/browser-sync/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/browserify/tslint.json b/types/browserify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/browserify/tslint.json +++ b/types/browserify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bson/tslint.json b/types/bson/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bson/tslint.json +++ b/types/bson/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/btoa/btoa-tests.ts b/types/btoa/btoa-tests.ts index 7ce230fcf7..d159bd5b7e 100644 --- a/types/btoa/btoa-tests.ts +++ b/types/btoa/btoa-tests.ts @@ -1,3 +1,5 @@ import btoa = require('btoa'); btoa('foo'); + +btoa(Buffer.from('foo')); diff --git a/types/btoa/index.d.ts b/types/btoa/index.d.ts index 4f16b77328..b4c06cf328 100644 --- a/types/btoa/index.d.ts +++ b/types/btoa/index.d.ts @@ -5,6 +5,8 @@ // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 -declare function btoa(str: string): string; +/// + +declare function btoa(str: string | Buffer): string; export = btoa; diff --git a/types/bucks/tslint.json b/types/bucks/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bucks/tslint.json +++ b/types/bucks/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/buffer-compare/tslint.json b/types/buffer-compare/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/buffer-compare/tslint.json +++ b/types/buffer-compare/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/buffer-equal/tslint.json b/types/buffer-equal/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/buffer-equal/tslint.json +++ b/types/buffer-equal/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/buffers/tslint.json b/types/buffers/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/buffers/tslint.json +++ b/types/buffers/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bull/index.d.ts b/types/bull/index.d.ts index 5297eadb19..648e2ba360 100644 --- a/types/bull/index.d.ts +++ b/types/bull/index.d.ts @@ -13,6 +13,7 @@ // Dan Manastireanu // Kjell-Morten Bratsberg Thorsen // Christian D. +// Silas Rech // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -25,10 +26,12 @@ import { EventEmitter } from "events"; * Everytime the same queue is instantiated it tries to process all the old jobs that may exist from a previous unfinished session. */ declare const Bull: { - (queueName: string, opts?: Bull.QueueOptions): Bull.Queue; - (queueName: string, url: string, opts?: Bull.QueueOptions): Bull.Queue; // tslint:disable-line unified-signatures - new (queueName: string, opts?: Bull.QueueOptions): Bull.Queue; - new (queueName: string, url: string, opts?: Bull.QueueOptions): Bull.Queue; // tslint:disable-line unified-signatures + /* tslint:disable:no-unnecessary-generics unified-signatures */ + (queueName: string, opts?: Bull.QueueOptions): Bull.Queue; + (queueName: string, url: string, opts?: Bull.QueueOptions): Bull.Queue; + new (queueName: string, opts?: Bull.QueueOptions): Bull.Queue; + new (queueName: string, url: string, opts?: Bull.QueueOptions): Bull.Queue; + /* tslint:enable:no-unnecessary-generics unified-signatures */ }; declare namespace Bull { @@ -114,6 +117,9 @@ declare namespace Bull { type JobId = number | string; + type ProcessCallbackFunction = (job: Job, done: DoneCallback) => void; + type ProcessPromiseFunction = (job: Job) => Promise; + interface Job { id: JobId; @@ -397,6 +403,8 @@ declare namespace Bull { */ isReady(): Promise; + /* tslint:disable:unified-signatures */ + /** * Defines a processing function for the jobs placed into a given Queue. * @@ -414,7 +422,9 @@ declare namespace Bull { * If the promise is rejected, the error will be passed as a second argument to the "failed" event. * If it is resolved, its value will be the "completed" event's second argument. */ - process(callback: ((job: Job, done: DoneCallback) => void) | ((job: Job) => Promise) | string): void; + process(callback: ProcessCallbackFunction): void; + process(callback: ProcessPromiseFunction): void; + process(callback: string): void; /** * Defines a processing function for the jobs placed into a given Queue. @@ -435,7 +445,9 @@ declare namespace Bull { * * @param concurrency Bull will then call your handler in parallel respecting this maximum value. */ - process(concurrency: number, callback: ((job: Job, done: DoneCallback) => void) | ((job: Job) => Promise) | string): void; + process(concurrency: number, callback: ProcessCallbackFunction): void; + process(concurrency: number, callback: ProcessPromiseFunction): void; + process(concurrency: number, callback: string): void; /** * Defines a processing function for the jobs placed into a given Queue. @@ -456,8 +468,9 @@ declare namespace Bull { * * @param name Bull will only call the handler if the job name matches */ - // tslint:disable-next-line:unified-signatures - process(name: string, callback: ((job: Job, done: DoneCallback) => void) | ((job: Job) => Promise) | string): void; + process(name: string, callback: ProcessCallbackFunction): void; + process(name: string, callback: ProcessPromiseFunction): void; + process(name: string, callback: string): void; /** * Defines a processing function for the jobs placed into a given Queue. @@ -479,7 +492,11 @@ declare namespace Bull { * @param name Bull will only call the handler if the job name matches * @param concurrency Bull will then call your handler in parallel respecting this maximum value. */ - process(name: string, concurrency: number, callback: ((job: Job, done: DoneCallback) => void) | ((job: Job) => Promise) | string): void; + process(name: string, concurrency: number, callback: ProcessCallbackFunction): void; + process(name: string, concurrency: number, callback: ProcessPromiseFunction): void; + process(name: string, concurrency: number, callback: string): void; + + /* tslint:enable:unified-signatures */ /** * Creates a new job and adds it to the queue. @@ -598,7 +615,7 @@ declare namespace Bull { * Returns a promise that will return an array of job instances of the given types. * Optional parameters for range and ordering are provided. */ - getJobs(types: string[], start?: number, end?: number, asc?: boolean): Promise; + getJobs(types: string[], start?: number, end?: number, asc?: boolean): Promise>>; /** * Returns a promise that resolves with the job counts for the given queue. diff --git a/types/bunyan-config/tslint.json b/types/bunyan-config/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bunyan-config/tslint.json +++ b/types/bunyan-config/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bunyan-logentries/tslint.json b/types/bunyan-logentries/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bunyan-logentries/tslint.json +++ b/types/bunyan-logentries/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bunyan-prettystream/tslint.json b/types/bunyan-prettystream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bunyan-prettystream/tslint.json +++ b/types/bunyan-prettystream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/busboy/tslint.json b/types/busboy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/busboy/tslint.json +++ b/types/busboy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/business-rules-engine/tslint.json b/types/business-rules-engine/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/business-rules-engine/tslint.json +++ b/types/business-rules-engine/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bwip-js/tslint.json b/types/bwip-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bwip-js/tslint.json +++ b/types/bwip-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/byline/tslint.json b/types/byline/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/byline/tslint.json +++ b/types/byline/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/bytebuffer/tslint.json b/types/bytebuffer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/bytebuffer/tslint.json +++ b/types/bytebuffer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cache-manager/tslint.json b/types/cache-manager/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cache-manager/tslint.json +++ b/types/cache-manager/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cacheable-request/index.d.ts b/types/cacheable-request/index.d.ts index 98d858d3f6..16e778274a 100644 --- a/types/cacheable-request/index.d.ts +++ b/types/cacheable-request/index.d.ts @@ -1,6 +1,7 @@ // Type definitions for cacheable-request 6.0 // Project: https://github.com/lukechilds/cacheable-request#readme // Definitions by: BendingBender +// Paul Melnikow // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 @@ -20,7 +21,7 @@ declare const CacheableRequest: CacheableRequest; type RequestFn = typeof request; interface CacheableRequest { - new (requestFn: RequestFn, storageAdapter?: string | Store): ( + new (requestFn: RequestFn, storageAdapter?: string | CacheableRequest.StorageAdapter): ( opts: string | URL | (RequestOptions & CacheSemanticsOptions), cb?: (response: ServerResponse | ResponseLike) => void ) => CacheableRequest.Emitter; @@ -30,6 +31,8 @@ interface CacheableRequest { } declare namespace CacheableRequest { + type StorageAdapter = Store; + interface Options { /** * If the cache should be used. Setting this to `false` will completely bypass the cache for the current request. diff --git a/types/cal-heatmap/tslint.json b/types/cal-heatmap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cal-heatmap/tslint.json +++ b/types/cal-heatmap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/callsite/tslint.json b/types/callsite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/callsite/tslint.json +++ b/types/callsite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/calq/tslint.json b/types/calq/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/calq/tslint.json +++ b/types/calq/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/camljs/tslint.json b/types/camljs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/camljs/tslint.json +++ b/types/camljs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/camo/tslint.json b/types/camo/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/camo/tslint.json +++ b/types/camo/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cannon/tslint.json b/types/cannon/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cannon/tslint.json +++ b/types/cannon/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/canvas-gauges/tslint.json b/types/canvas-gauges/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/canvas-gauges/tslint.json +++ b/types/canvas-gauges/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cash/tslint.json b/types/cash/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cash/tslint.json +++ b/types/cash/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cbor/tslint.json b/types/cbor/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cbor/tslint.json +++ b/types/cbor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/center-align/center-align-tests.ts b/types/center-align/center-align-tests.ts new file mode 100644 index 0000000000..c54c36ea44 --- /dev/null +++ b/types/center-align/center-align-tests.ts @@ -0,0 +1,17 @@ +import center from "center-align"; + +// multi-line sample +center([ + "Lorem ipsum dolor sit amet,", + "consectetur adipiscing", + "elit, sed do eiusmod tempor incididunt", + "ut labore et dolore", + "magna aliqua. Ut enim ad minim", + "veniam, quis" +]); + +// single-line samples +center("foo"); // => 'foo' (does nothing) +center("foo", 12); // => ' foo ' +center("foo", 10); // => ' foo ' +center("foo", 8); // => ' foo ' diff --git a/types/center-align/index.d.ts b/types/center-align/index.d.ts new file mode 100644 index 0000000000..47ff64b101 --- /dev/null +++ b/types/center-align/index.d.ts @@ -0,0 +1,10 @@ +// Type definitions for center-align 1.0 +// Project: https://github.com/jonschlinkert/center-align +// Definitions by: Claas Ahlrichs +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.7 + +declare function center_align(val: string, width?: number): string; +declare function center_align(val: string[], width?: number): string[]; + +export = center_align; diff --git a/types/center-align/tsconfig.json b/types/center-align/tsconfig.json new file mode 100644 index 0000000000..538e2aa296 --- /dev/null +++ b/types/center-align/tsconfig.json @@ -0,0 +1,17 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "esModuleInterop": true + }, + "files": ["index.d.ts", "center-align-tests.ts"] +} diff --git a/types/center-align/tslint.json b/types/center-align/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/center-align/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/chai-as-promised/tslint.json b/types/chai-as-promised/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-as-promised/tslint.json +++ b/types/chai-as-promised/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-datetime/tslint.json b/types/chai-datetime/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-datetime/tslint.json +++ b/types/chai-datetime/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-dom/tslint.json b/types/chai-dom/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-dom/tslint.json +++ b/types/chai-dom/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-enzyme/tslint.json b/types/chai-enzyme/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-enzyme/tslint.json +++ b/types/chai-enzyme/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-fuzzy/tslint.json b/types/chai-fuzzy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-fuzzy/tslint.json +++ b/types/chai-fuzzy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-jquery/tslint.json b/types/chai-jquery/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-jquery/tslint.json +++ b/types/chai-jquery/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-spies/tslint.json b/types/chai-spies/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-spies/tslint.json +++ b/types/chai-spies/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-string/tslint.json b/types/chai-string/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-string/tslint.json +++ b/types/chai-string/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chai-things/tslint.json b/types/chai-things/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chai-things/tslint.json +++ b/types/chai-things/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chance/tslint.json b/types/chance/tslint.json index 2ef6444ebb..a2a331133e 100644 --- a/types/chance/tslint.json +++ b/types/chance/tslint.json @@ -3,6 +3,7 @@ "rules": { "adjacent-overload-signatures": false, "dt-header": false, + "npm-naming": false, "no-declare-current-package": false, "no-single-declare-module": false, "no-unnecessary-generics": false, diff --git a/types/change-emitter/tslint.json b/types/change-emitter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/change-emitter/tslint.json +++ b/types/change-emitter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/changelog-parser/changelog-parser-tests.ts b/types/changelog-parser/changelog-parser-tests.ts new file mode 100644 index 0000000000..69a5ffdab3 --- /dev/null +++ b/types/changelog-parser/changelog-parser-tests.ts @@ -0,0 +1,24 @@ +import parseChangelog = require('changelog-parser'); + +const options = { + filePath: 'path/to/CHANGELOG.md', + removeMarkdown: false +}; + +const fn = (obj: object): void => {}; + +parseChangelog({filePath: 'path/to/CHANGELOG.md'}, (error, result) => { + if (error) { + throw error; + } + + fn(result); +}); + +parseChangelog(options, (error, result) => {}); + +parseChangelog({filePath: 'path/to/CHANGELOG.md'}, (error) => {}); + +parseChangelog(options).then((result) => {}); + +parseChangelog('path/to/CHANGELOG.md').then((result) => {}); diff --git a/types/changelog-parser/index.d.ts b/types/changelog-parser/index.d.ts new file mode 100644 index 0000000000..a1799454c8 --- /dev/null +++ b/types/changelog-parser/index.d.ts @@ -0,0 +1,25 @@ +// Type definitions for changelog-parser 2.7 +// Project: https://github.com/hypermodules/changelog-parser +// Definitions by: Adam Zerella +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.2 + +interface Options { + /** + * Path to changelog file. + */ + filePath: string; + /** + * Removes the markdown markup from the changelog entries by default. + * You can change its value to false to keep the markdown. + */ + removeMarkdown: boolean; +} + +/** + * Change log parser for node. + */ +declare function parseChangelog(options: Partial|string, + callback?: (error: string|null, result: object) => void): Promise; + +export = parseChangelog; diff --git a/types/changelog-parser/tsconfig.json b/types/changelog-parser/tsconfig.json new file mode 100644 index 0000000000..e40482d8e4 --- /dev/null +++ b/types/changelog-parser/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "changelog-parser-tests.ts" + ] +} \ No newline at end of file diff --git a/types/changelog-parser/tslint.json b/types/changelog-parser/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/changelog-parser/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/chart.js/chart.js-tests.ts b/types/chart.js/chart.js-tests.ts index e35c556b56..879ef9bb3f 100644 --- a/types/chart.js/chart.js-tests.ts +++ b/types/chart.js/chart.js-tests.ts @@ -115,7 +115,9 @@ const scaleOptions: Chart.RadialLinearScale = { lineArc: false, display: false, scaleLabel: { - display: false + display: false, + lineHeight: 1, + padding: 0, }, }; const radarChartOptions: Chart.RadialChartOptions = { diff --git a/types/chart.js/index.d.ts b/types/chart.js/index.d.ts index 5a3116618d..111c8da57f 100644 --- a/types/chart.js/index.d.ts +++ b/types/chart.js/index.d.ts @@ -426,10 +426,12 @@ declare namespace Chart { interface ScaleTitleOptions { display?: boolean; labelString?: string; + lineHeight?: number | string; fontColor?: ChartColor; fontFamily?: string; fontSize?: number; fontStyle?: string; + padding?: ChartLayoutPaddingObject | number; } interface TickOptions extends NestedTickOptions { @@ -512,7 +514,7 @@ declare namespace Chart { hoverBorderWidth?: number | number[]; label?: string; lineTension?: number; - steppedLine?: 'before' | 'after' | boolean; + steppedLine?: 'before' | 'after' | 'middle' | boolean; pointBorderColor?: ChartColor | ChartColor[]; pointBackgroundColor?: ChartColor | ChartColor[]; pointBorderWidth?: number | number[]; diff --git a/types/chartist/tslint.json b/types/chartist/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chartist/tslint.json +++ b/types/chartist/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/checksum/tslint.json b/types/checksum/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/checksum/tslint.json +++ b/types/checksum/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cheerio/tslint.json b/types/cheerio/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cheerio/tslint.json +++ b/types/cheerio/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/child-process-promise/child-process-promise-tests.ts b/types/child-process-promise/child-process-promise-tests.ts new file mode 100644 index 0000000000..365e7e8f60 --- /dev/null +++ b/types/child-process-promise/child-process-promise-tests.ts @@ -0,0 +1,15 @@ +import * as cpp from "child-process-promise"; + +import { + ChildProcess +} from 'child_process'; + +const a = cpp.exec("echo \"Hello world!\""); +a.childProcess; // $ExpectType ChildProcess + +(async () => { + const at = await a; + at.childProcess; // $ExpectType ChildProcess + at.stdout; // $ExpectType string + at.stderr; // $ExpectType string +})(); diff --git a/types/child-process-promise/index.d.ts b/types/child-process-promise/index.d.ts new file mode 100644 index 0000000000..344657f4f1 --- /dev/null +++ b/types/child-process-promise/index.d.ts @@ -0,0 +1,104 @@ +// Type definitions for child-process-promise 2.2 +// Project: https://github.com/patrick-steele-idem/child-process-promise +// Definitions by: Luis Paulo +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 3.0 + +/// + +import { + ChildProcess, + ExecFileOptionsWithBufferEncoding, ExecFileOptionsWithOtherEncoding, + ExecFileOptionsWithStringEncoding, + ExecOptions, + ForkOptions, + SpawnOptions +} from 'child_process'; + +/** + * Simple wrapper around the child_process module that makes use of promises + */ + +export interface PromiseResult { + childProcess: ChildProcess; + stdout: Enc; + stderr: Enc; +} + +export interface SpawnPromiseResult extends PromiseResult { + code: number; +} + +export interface ChildProcessPromise extends Promise { + childProcess: ChildProcess; +} + +export interface Options { + /** + * Pass an additional capture option to buffer the result of stdout and/or stderr + * Default: [] + */ + capture?: []|['stdout'|'stderr']|['stdout', 'stderr']|['stderr', 'stdout']; + /** + * Array of the numbers that should be interpreted as successful execution codes + * Default: [0] + */ + successfulExitCodes?: number[]; +} + +export function exec( + command: Readonly, + options: Readonly +): ChildProcessPromise>; +export function exec( + command: Readonly, + options: Readonly +): ChildProcessPromise>; +export function exec( + command: Readonly, + options: Readonly +): ChildProcessPromise>; +export function exec( + command: Readonly, + options?: Readonly +): ChildProcessPromise>; + +export function execFile( + file: Readonly, + options: Readonly +): ChildProcessPromise>; +export function execFile( + file: Readonly, + args: ReadonlyArray | null, + options: Readonly +): ChildProcessPromise>; +export function execFile( + file: Readonly, + options: Readonly +): ChildProcessPromise>; +export function execFile( + file: Readonly, + options: Readonly +): ChildProcessPromise>; +export function execFile( + file: Readonly, + args: ReadonlyArray | null, + options: Readonly +): ChildProcessPromise>; +export function execFile( + file: Readonly, + args?: ReadonlyArray | null, + options?: Readonly +): ChildProcessPromise>; + +export function spawn( + command: Readonly, + args?: ReadonlyArray | null, + options?: Readonly +): ChildProcessPromise; + +export function fork( + modulePath: string, + args?: ReadonlyArray, + options?: Readonly +): ChildProcessPromise; diff --git a/types/child-process-promise/tsconfig.json b/types/child-process-promise/tsconfig.json new file mode 100644 index 0000000000..b0f60c39eb --- /dev/null +++ b/types/child-process-promise/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "child-process-promise-tests.ts" + ] +} diff --git a/types/child-process-promise/tslint.json b/types/child-process-promise/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/child-process-promise/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/chocolatechipjs/tslint.json b/types/chocolatechipjs/tslint.json index 9969e961d1..c5bc46f555 100644 --- a/types/chocolatechipjs/tslint.json +++ b/types/chocolatechipjs/tslint.json @@ -5,6 +5,7 @@ "adjacent-overload-signatures": false, "ban-types": false, "dt-header": false, + "npm-naming": false, "no-any-union": false, "unified-signatures": false, "no-unnecessary-generics": false, diff --git a/types/chrome-apps/tslint.json b/types/chrome-apps/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chrome-apps/tslint.json +++ b/types/chrome-apps/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chrome/tslint.json b/types/chrome/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/chrome/tslint.json +++ b/types/chrome/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/chui/tslint.json b/types/chui/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/chui/tslint.json +++ b/types/chui/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/classnames/tslint.json b/types/classnames/tslint.json index 946c3b6691..0831709701 100644 --- a/types/classnames/tslint.json +++ b/types/classnames/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO - "dt-header": false + "npm-naming": false, + "dt-header": false } } diff --git a/types/cldrjs/tslint.json b/types/cldrjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cldrjs/tslint.json +++ b/types/cldrjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cli-color/tslint.json b/types/cli-color/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cli-color/tslint.json +++ b/types/cli-color/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cli/tslint.json b/types/cli/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cli/tslint.json +++ b/types/cli/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cliff/tslint.json b/types/cliff/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cliff/tslint.json +++ b/types/cliff/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/clipboard-js/tslint.json b/types/clipboard-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/clipboard-js/tslint.json +++ b/types/clipboard-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/clone/tslint.json b/types/clone/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/clone/tslint.json +++ b/types/clone/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/closure-compiler/tslint.json b/types/closure-compiler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/closure-compiler/tslint.json +++ b/types/closure-compiler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cloud-env/tslint.json b/types/cloud-env/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cloud-env/tslint.json +++ b/types/cloud-env/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/clui/clui-tests.ts b/types/clui/clui-tests.ts new file mode 100644 index 0000000000..1968b10cba --- /dev/null +++ b/types/clui/clui-tests.ts @@ -0,0 +1,96 @@ +import { Gauge, Line, LineBuffer, Progress, Sparkline, Spinner } from 'clui'; +import * as clc from 'cli-color'; + +// LineBuffer +const outputBuffer = new LineBuffer({ + x: 0, + y: 0, + width: 'console', + height: 'console' +}); + +new Line(outputBuffer) + .column('Title Placehole', 20, [clc.green]) + .fill() + .store(); + +new Line(outputBuffer) + .fill() + .store(); + +new Line(outputBuffer) + .column('Suscipit', 20, [clc.cyan]) + .column('Voluptatem', 20, [clc.cyan]) + .column('Nesciunt', 20, [clc.cyan]) + .column('Laudantium', 11, [clc.cyan]) + .fill() + .store(); + +for (let l = 0; l < 20; l++) { + new Line(outputBuffer) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 11) + .fill() + .store(); +} + +outputBuffer.output(); + +// Line +new Line() + .padding(2) + .column('Column One', 20, [clc.cyan]) + .column('Column Two', 20, [clc.cyan]) + .column('Column Three', 20, [clc.cyan]) + .column('Column Four', 20, [clc.cyan]) + .fill() + .output(); + +new Line() + .padding(2) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 20) + .column((Math.random() * 100).toFixed(3), 20) + .fill() + .output(); + +// Gauge +const total = 33660133376; +const free = 17763860480; +const used = total - free; +const human = Math.ceil(used / 1000000) + ' MB'; + +console.log(Gauge(used, total, 20, total * 0.8, human)); + +// Sparkline +const reqsPerSec = [10, 12, 3, 7, 12, 9, 23, 10, 9, 19, 16, 18, 12, 12]; + +console.log(Sparkline(reqsPerSec, 'reqs/sec')); + +// Progress +const thisProgressBar = new Progress(20); +console.log(thisProgressBar.update(10, 30)); + +// or + +const thisPercentBar = new Progress(20); +console.log(thisPercentBar.update(0.4)); + +// Spinner +const countdown = new Spinner('Exiting in 10 seconds... ', ['⣾', '⣽', '⣻', '⢿', '⡿', '⣟', '⣯', '⣷']); + +countdown.start(); + +let n = 10; +const interval = setInterval(() => { + n--; + countdown.message(`Exiting in ${n} seconds...`); + if (n === 0) { + console.log('\n'); + countdown.stop(); + clearInterval(interval); + } +}, 1000); diff --git a/types/clui/index.d.ts b/types/clui/index.d.ts new file mode 100644 index 0000000000..339ac031d9 --- /dev/null +++ b/types/clui/index.d.ts @@ -0,0 +1,157 @@ +// Type definitions for clui 0.3 +// Project: https://github.com/nathanpeck/clui#readme +// Definitions by: Farzad Majidfayyaz +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +import * as clc from 'cli-color'; + +export interface LineBufferOptions { + x?: number; + y?: number; + width?: number | 'console'; + height?: number | 'console'; + scroll?: number; +} + +export class LineBuffer { + /** + * Creates an object for buffering a group of text lines and then outputting them + * @param options Values to build the buffer + */ + constructor(options: LineBufferOptions); + + /** + * Return the height of the `LineBuffer`, when specified as `console` + */ + height(): number; + + /** + * Return the width of the `LineBuffer`, when specified as `console` + */ + width(): number; + + /** + * Put a `Line` object into the `LineBuffer` + * @param line The line object to put into the buffer + */ + addLine(line: Line): void; + + /** + * If you don't have enough lines in the buffer, this will fill the reset of + * the lines with empty spaces + */ + fill(): void; + + /** + * Draw the `LineBuffer` to screen + */ + output(): void; +} + +/** + * This chainable object can be used to generate a line of text with columns, padding, and fill + */ +export class Line { + /** + * Create a new instance of Line object + * @param buffer Object to be used as buffer + */ + constructor(buffer?: LineBuffer); + + /** + * Output `width` characters of blank space + * @param width Number of characters to print + */ + padding(width: number): Line; + + /** + * Output text within a column of the specified width + * @param text Text to print + * @param width Width of the column + * @param styles List of `cli-color` styles to apply + */ + column(text: string, width: number, styles?: clc.Format[]): Line; + + /** + * At the end of a line, fill the rest of the columns to the right edge + */ + fill(): Line; + + /** + * Print the generated line of text to the console + */ + output(): Line; + + /** + * Return the contents of this line as a string + */ + contents(): string; + + /** + * Store this line into the buffer + */ + store(): void; +} + +/** + * Creates a basic horizontal gauge to the screen + * @param value The current value of the metric being displayed by this gauge + * @param maxValue The highest possible value of the metric being displayed + * @param guageWidth How many columns widt to draw the gauge + * @param dangerZone The point after which the value will be drawn in red because it's too high + * @param suffix A value to output after the gauge itself + */ +export function Gauge( + value: number, + maxValue: number, + guageWidth: number, + dangerZone: number, + suffix: string, +): string; + +/** + * A simple command line sparkline that draws a series of values, and highlights the peak for the period + * @param values An array of values to go into the sparkline + * @param suffix A suffix to use when drawing the current and max values at the end of the sparkline + */ +export function Sparkline(values: number[], suffix: string): string; + +export class Progress { + /** + * Creates a progress bar + * @param length The desired length of the progress bar in characters + */ + constructor(length: number); + + /** + * Returns the progress bar min/max context to write to stdout + * @param currentValueOrPercent Current value (or percent) of the progress bar + * @param maxValue Maximum value of the progress bar + */ + update(currentValueOrPercent: number, maxValue?: number): string; +} + +export class Spinner { + /** + * Creates a new spinner + * @param statusText The default text to display while the spinner is spinning + * @param style Array of graphical characters used to draw the spinner + */ + constructor(statusText: string, style?: string[]); + + /** + * Show the spinner on the screen + */ + start(): void; + + /** + * Update the status message that follows the spinner + * @param statusMessage Message to be displayed + */ + message(statusMessage: string): void; + + /** + * Erase the spinner from the screen + */ + stop(): void; +} diff --git a/types/clui/tsconfig.json b/types/clui/tsconfig.json new file mode 100644 index 0000000000..05235b1de8 --- /dev/null +++ b/types/clui/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "dom", + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "strictFunctionTypes": true + }, + "files": [ + "index.d.ts", + "clui-tests.ts" + ] +} diff --git a/types/clui/tslint.json b/types/clui/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/clui/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/co-body/tslint.json b/types/co-body/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/co-body/tslint.json +++ b/types/co-body/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/codemirror/tslint.json b/types/codemirror/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/codemirror/tslint.json +++ b/types/codemirror/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/coffeeify/tslint.json b/types/coffeeify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/coffeeify/tslint.json +++ b/types/coffeeify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/collections/tslint.json b/types/collections/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/collections/tslint.json +++ b/types/collections/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/colorbrewer/tslint.json b/types/colorbrewer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/colorbrewer/tslint.json +++ b/types/colorbrewer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/com.darktalker.cordova.screenshot/tslint.json b/types/com.darktalker.cordova.screenshot/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/com.darktalker.cordova.screenshot/tslint.json +++ b/types/com.darktalker.cordova.screenshot/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/combokeys/tslint.json b/types/combokeys/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/combokeys/tslint.json +++ b/types/combokeys/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/command-line-commands/tslint.json b/types/command-line-commands/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/command-line-commands/tslint.json +++ b/types/command-line-commands/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/commangular/tslint.json b/types/commangular/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/commangular/tslint.json +++ b/types/commangular/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/compare-version/tslint.json b/types/compare-version/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/compare-version/tslint.json +++ b/types/compare-version/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/component-emitter/tslint.json b/types/component-emitter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/component-emitter/tslint.json +++ b/types/component-emitter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/compose-function/tslint.json b/types/compose-function/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/compose-function/tslint.json +++ b/types/compose-function/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/compression/tslint.json b/types/compression/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/compression/tslint.json +++ b/types/compression/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/concaveman/tslint.json b/types/concaveman/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/concaveman/tslint.json +++ b/types/concaveman/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/confidence/tslint.json b/types/confidence/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/confidence/tslint.json +++ b/types/confidence/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/config/tslint.json b/types/config/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/config/tslint.json +++ b/types/config/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/confit/tslint.json b/types/confit/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/confit/tslint.json +++ b/types/confit/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-flash/tslint.json b/types/connect-flash/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-flash/tslint.json +++ b/types/connect-flash/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-history-api-fallback/index.d.ts b/types/connect-history-api-fallback/index.d.ts index a39fbfdbd6..b32e61e147 100644 --- a/types/connect-history-api-fallback/index.d.ts +++ b/types/connect-history-api-fallback/index.d.ts @@ -10,26 +10,28 @@ import { Url } from 'url'; import * as core from "express-serve-static-core"; -declare function historyApiFallback(options?: Options): core.RequestHandler; -declare namespace historyApiFallback {} export = historyApiFallback; -interface Options { - disableDotRule?: true; - htmlAcceptHeaders?: string[]; - index?: string; - logger?: typeof console.log; - rewrites?: Rewrite[]; - verbose?: boolean; -} +declare function historyApiFallback(options?: historyApiFallback.Options): core.RequestHandler; -interface Context { - match: RegExpMatchArray; - parsedUrl: Url; -} -type RewriteTo = (context: Context) => string; +declare namespace historyApiFallback { + interface Options { + disableDotRule?: true; + htmlAcceptHeaders?: string[]; + index?: string; + logger?: typeof console.log; + rewrites?: Rewrite[]; + verbose?: boolean; + } -interface Rewrite { - from: RegExp; - to: string | RegExp | RewriteTo; + interface Context { + match: RegExpMatchArray; + parsedUrl: Url; + } + type RewriteTo = (context: Context) => string; + + interface Rewrite { + from: RegExp; + to: string | RegExp | RewriteTo; + } } diff --git a/types/connect-livereload/tslint.json b/types/connect-livereload/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-livereload/tslint.json +++ b/types/connect-livereload/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-modrewrite/tslint.json b/types/connect-modrewrite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-modrewrite/tslint.json +++ b/types/connect-modrewrite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-mongo/tslint.json b/types/connect-mongo/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-mongo/tslint.json +++ b/types/connect-mongo/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-mongodb-session/tslint.json b/types/connect-mongodb-session/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-mongodb-session/tslint.json +++ b/types/connect-mongodb-session/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-redis/tslint.json b/types/connect-redis/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-redis/tslint.json +++ b/types/connect-redis/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-slashes/tslint.json b/types/connect-slashes/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-slashes/tslint.json +++ b/types/connect-slashes/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect-timeout/tslint.json b/types/connect-timeout/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect-timeout/tslint.json +++ b/types/connect-timeout/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/connect/tslint.json b/types/connect/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/connect/tslint.json +++ b/types/connect/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/console-stamp/tslint.json b/types/console-stamp/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/console-stamp/tslint.json +++ b/types/console-stamp/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/consolidate/tslint.json b/types/consolidate/tslint.json index a403f5da2b..69c84d8f83 100644 --- a/types/consolidate/tslint.json +++ b/types/consolidate/tslint.json @@ -9,6 +9,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/consul/tslint.json b/types/consul/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/consul/tslint.json +++ b/types/consul/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/contentful-resolve-response/tslint.json b/types/contentful-resolve-response/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/contentful-resolve-response/tslint.json +++ b/types/contentful-resolve-response/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/contextjs/tslint.json b/types/contextjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/contextjs/tslint.json +++ b/types/contextjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cookie-session/tslint.json b/types/cookie-session/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cookie-session/tslint.json +++ b/types/cookie-session/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cookie_js/tslint.json b/types/cookie_js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cookie_js/tslint.json +++ b/types/cookie_js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/copy-paste/tslint.json b/types/copy-paste/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/copy-paste/tslint.json +++ b/types/copy-paste/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-ionic/tslint.json b/types/cordova-ionic/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-ionic/tslint.json +++ b/types/cordova-ionic/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-app-version/tslint.json b/types/cordova-plugin-app-version/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-app-version/tslint.json +++ b/types/cordova-plugin-app-version/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-background-mode/tslint.json b/types/cordova-plugin-background-mode/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-background-mode/tslint.json +++ b/types/cordova-plugin-background-mode/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-ble-central/tslint.json b/types/cordova-plugin-ble-central/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-ble-central/tslint.json +++ b/types/cordova-plugin-ble-central/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-device-name/tslint.json b/types/cordova-plugin-device-name/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-device-name/tslint.json +++ b/types/cordova-plugin-device-name/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-email-composer/tslint.json b/types/cordova-plugin-email-composer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-email-composer/tslint.json +++ b/types/cordova-plugin-email-composer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-ibeacon/tslint.json b/types/cordova-plugin-ibeacon/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-ibeacon/tslint.json +++ b/types/cordova-plugin-ibeacon/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-insomnia/tslint.json b/types/cordova-plugin-insomnia/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-insomnia/tslint.json +++ b/types/cordova-plugin-insomnia/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-keyboard/tslint.json b/types/cordova-plugin-keyboard/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-keyboard/tslint.json +++ b/types/cordova-plugin-keyboard/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-mapsforge/tslint.json b/types/cordova-plugin-mapsforge/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-mapsforge/tslint.json +++ b/types/cordova-plugin-mapsforge/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-ms-adal/tslint.json b/types/cordova-plugin-ms-adal/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-ms-adal/tslint.json +++ b/types/cordova-plugin-ms-adal/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-ouralabs/tslint.json b/types/cordova-plugin-ouralabs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-ouralabs/tslint.json +++ b/types/cordova-plugin-ouralabs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-qrscanner/tslint.json b/types/cordova-plugin-qrscanner/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-qrscanner/tslint.json +++ b/types/cordova-plugin-qrscanner/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-spinner/tslint.json b/types/cordova-plugin-spinner/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-spinner/tslint.json +++ b/types/cordova-plugin-spinner/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-websql/tslint.json b/types/cordova-plugin-websql/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-websql/tslint.json +++ b/types/cordova-plugin-websql/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova-plugin-x-socialsharing/tslint.json b/types/cordova-plugin-x-socialsharing/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova-plugin-x-socialsharing/tslint.json +++ b/types/cordova-plugin-x-socialsharing/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova/tslint.json b/types/cordova/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/cordova/tslint.json +++ b/types/cordova/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordova_app_version_plugin/tslint.json b/types/cordova_app_version_plugin/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordova_app_version_plugin/tslint.json +++ b/types/cordova_app_version_plugin/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cordovarduino/tslint.json b/types/cordovarduino/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cordovarduino/tslint.json +++ b/types/cordovarduino/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cors/tslint.json b/types/cors/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cors/tslint.json +++ b/types/cors/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/couchbase/tslint.json b/types/couchbase/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/couchbase/tslint.json +++ b/types/couchbase/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/countdown/tslint.json b/types/countdown/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/countdown/tslint.json +++ b/types/countdown/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/counterpart/counterpart-tests.ts b/types/counterpart/counterpart-tests.ts index db9f1cf5d6..850b026ecf 100644 --- a/types/counterpart/counterpart-tests.ts +++ b/types/counterpart/counterpart-tests.ts @@ -2,6 +2,8 @@ import * as counterpart from 'counterpart'; counterpart('translation.to.be.used'); counterpart(['translation', 'to', 'be', 'used']); +counterpart.translate('translation.to.be.used'); +counterpart.translate(['translation', 'to', 'be', 'used']); counterpart.setSeparator('*'); diff --git a/types/counterpart/index.d.ts b/types/counterpart/index.d.ts index f09ad0708c..3fd0caeac7 100644 --- a/types/counterpart/index.d.ts +++ b/types/counterpart/index.d.ts @@ -9,6 +9,7 @@ type LocaleChangeHandler = (newLocale: string, oldLocale: string) => void; interface Counterpart { (key: string|string[], options?: object): string; + translate(key: string|string[], options?: object): string; setSeparator(value: string): string; onTranslationNotFound(callback: NotFoundHandler): void; diff --git a/types/countries-and-timezones/index.d.ts b/types/countries-and-timezones/index.d.ts index 1012133d8e..3a84ea3b76 100644 --- a/types/countries-and-timezones/index.d.ts +++ b/types/countries-and-timezones/index.d.ts @@ -16,9 +16,9 @@ export interface Timezone { countries: string[]; } -export function getAllCountries(): Country[]; +export function getAllCountries(): {[key: string]: Country}; -export function getAllTimezones(): Timezone[]; +export function getAllTimezones(): {[key: string]: Timezone}; export function getCountriesForTimezone(timezoneId: string): Country[]; diff --git a/types/cradle/tslint.json b/types/cradle/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cradle/tslint.json +++ b/types/cradle/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/create-error/tslint.json b/types/create-error/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/create-error/tslint.json +++ b/types/create-error/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/createjs-lib/tslint.json b/types/createjs-lib/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/createjs-lib/tslint.json +++ b/types/createjs-lib/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/createjs/tslint.json b/types/createjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/createjs/tslint.json +++ b/types/createjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/credential/tslint.json b/types/credential/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/credential/tslint.json +++ b/types/credential/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/credit-card-type/tslint.json b/types/credit-card-type/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/credit-card-type/tslint.json +++ b/types/credit-card-type/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cron/cron-tests.ts b/types/cron/cron-tests.ts index d146fe6a61..f152498eca 100644 --- a/types/cron/cron-tests.ts +++ b/types/cron/cron-tests.ts @@ -46,6 +46,12 @@ var job = new CronJob(moment(), () => { timeZone /* Time zone of this job. */ ); +// Another example with system commands +var job = new CronJob('00 30 11 * * 1-5', 'ls', { command: 'ls', args: ['./'] }, + true, /* Start the job right now */ + timeZone /* Time zone of this job. */ +); + // For good measure var job = new CronJob({ cronTime: '00 30 11 * * 1-5', @@ -59,10 +65,14 @@ var job = new CronJob({ start: false, timeZone: 'America/Los_Angeles' }); -console.log(job.lastDate()); -console.log(job.nextDates());// Should be a Moment object -console.log(job.nextDates(1));// Should be an array of Moment object -console.log(job.running); +const ld = job.lastDate(); // $ExpectType Date +console.log(ld); +const nd = job.nextDates(); // $ExpectType Moment +console.log(nd); +const nds = job.nextDates(1); // $ExpectType Moment | Moment[] +console.log(nds);// Should be a Moment array +const ru = job.running // $ExpectType boolean +console.log(ru); job.setTime(new CronTime('00 30 11 * * 1-2')); job.start(); job.stop(); diff --git a/types/cron/index.d.ts b/types/cron/index.d.ts index b508c0d1fd..de4398333c 100644 --- a/types/cron/index.d.ts +++ b/types/cron/index.d.ts @@ -1,10 +1,15 @@ -// Type definitions for cron 1.6 +// Type definitions for cron 1.7 // Project: https://www.npmjs.com/package/cron // Definitions by: Hiroki Horiuchi // Lundarl Gholoi // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +/// + import { Moment } from 'moment'; +import { SpawnOptions } from "child_process"; + +export declare type CronCommand = (() => void) | string | { command: string, args?: ReadonlyArray, options?: SpawnOptions}; export declare class CronTime { /** @@ -17,10 +22,14 @@ export declare class CronTime { /** * Tells you when ```CronTime``` will be run. - * @param i Indicate which turn of run after now. If not given return next run time. */ public sendAt(): Moment; - public sendAt(i?: number): Moment[]; + /** + * Tells you when ```CronTime``` will be run. + * @param i Indicate which turn of run after now. If not given return next run time. + * @returns A `Moment` when the source passed in the constructor is a `Date` or a `Moment` and an array of `Moment` when the source is a string + */ + public sendAt(i?: number): Moment | Moment[]; /** * Get the number of milliseconds in the future at which to fire our callbacks. */ @@ -35,11 +44,11 @@ export declare interface CronJobParameters { /** * The function to fire at the specified time. If an ```onComplete``` callback was provided, ```onTick``` will receive it as an argument. ```onTick``` may call ```onComplete``` when it has finished its work. */ - onTick: () => void; + onTick: CronCommand; /** * A function that will fire when the job is stopped with ```job.stop()```, and may also be called by ```onTick``` at the end of each run. */ - onComplete?: () => void; + onComplete?: CronCommand; /** * Specifies whether to start the job just before exiting the constructor. By default this is set to false. If left at default you will need to call ```job.start()``` in order to start the job (assuming ```job``` is the variable you set the cronjob to). This does not immediately fire your ```onTick``` function, it just gives you more control over the behavior of your jobs. */ @@ -88,7 +97,7 @@ export declare class CronJob { * @param utcOffset This allows you to specify the offset of your timezone rather than using the ```timeZone``` param. Probably don't use both ```timeZone``` and ```utcOffset``` together or weird things may happen. * @param unrefTimeout If you have code that keeps the event loop running and want to stop the node process when that finishes regardless of the state of your cronjob, you can do so making use of this parameter. This is off by default and cron will run as if it needs to control the event loop. For more information take a look at [timers#timers_timeout_unref](https://nodejs.org/api/timers.html#timers_timeout_unref) from the NodeJS docs. */ - constructor(cronTime: string | Date | Moment, onTick: () => void, onComplete?: () => void, start?: boolean, timeZone?: string, context?: any, runOnInit?: boolean, utcOffset?: string | number, unrefTimeout?: boolean); + constructor(cronTime: string | Date | Moment, onTick: CronCommand, onComplete?: CronCommand, start?: boolean, timeZone?: string, context?: any, runOnInit?: boolean, utcOffset?: string | number, unrefTimeout?: boolean); /** * Create a new ```CronJob```. * @param options Job parameters. @@ -114,10 +123,15 @@ export declare class CronJob { public lastDate(): Date; /** * Tells you when a ```CronTime``` will be run. - * @param i Indicate which turn of run after now. If not given return next run time. */ + public nextDate(): Moment; public nextDates(): Moment; - public nextDates(i?: number): Moment[]; + /** + * Tells you when a ```CronTime``` will be run. + * @param i Indicate which turn of run after now. If not given return next run time. + * @returns A `Moment` when the cronTime passed in the constructor is a `Date` or a `Moment` and an array of `Moment` when the cronTime is a string + */ + public nextDates(i?: number): Moment | Moment[]; /** * Add another ```onTick``` function. * @param callback Target function. @@ -126,7 +140,7 @@ export declare class CronJob { } export declare var job: - ((cronTime: string | Date | Moment, onTick: () => void, onComplete?: () => void, start?: boolean, timeZone?: string, context?: any, runOnInit?: boolean, utcOffset?: string | number, unrefTimeout?: boolean) => CronJob) + ((cronTime: string | Date | Moment, onTick: () => void, onComplete?: CronCommand, start?: boolean, timeZone?: string, context?: any, runOnInit?: boolean, utcOffset?: string | number, unrefTimeout?: boolean) => CronJob) | ((options: CronJobParameters) => CronJob); export declare var time: (source: string | Date | Moment, zone?: string) => CronTime; export declare var sendAt: (cronTime: string | Date | Moment) => Moment; diff --git a/types/cron/tslint.json b/types/cron/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cron/tslint.json +++ b/types/cron/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cross-storage/tslint.json b/types/cross-storage/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cross-storage/tslint.json +++ b/types/cross-storage/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/crossfilter/tslint.json b/types/crossfilter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/crossfilter/tslint.json +++ b/types/crossfilter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/crossroads/tslint.json b/types/crossroads/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/crossroads/tslint.json +++ b/types/crossroads/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/crypto-js/tslint.json b/types/crypto-js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/crypto-js/tslint.json +++ b/types/crypto-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cryptojs/tslint.json b/types/cryptojs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cryptojs/tslint.json +++ b/types/cryptojs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cson/tslint.json b/types/cson/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cson/tslint.json +++ b/types/cson/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/css-font-loading-module/tslint.json b/types/css-font-loading-module/tslint.json index 65c83fb1e3..1c56ba06b6 100644 --- a/types/css-font-loading-module/tslint.json +++ b/types/css-font-loading-module/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { + "npm-naming": false, "dt-header": false } } diff --git a/types/css-modules-require-hook/tslint.json b/types/css-modules-require-hook/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/css-modules-require-hook/tslint.json +++ b/types/css-modules-require-hook/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/css/tslint.json b/types/css/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/css/tslint.json +++ b/types/css/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cssbeautify/tslint.json b/types/cssbeautify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cssbeautify/tslint.json +++ b/types/cssbeautify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/csurf/tslint.json b/types/csurf/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/csurf/tslint.json +++ b/types/csurf/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cuid/tslint.json b/types/cuid/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cuid/tslint.json +++ b/types/cuid/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/custom-error-generator/tslint.json b/types/custom-error-generator/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/custom-error-generator/tslint.json +++ b/types/custom-error-generator/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/cybozulabs-md5/tslint.json b/types/cybozulabs-md5/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/cybozulabs-md5/tslint.json +++ b/types/cybozulabs-md5/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/d3-box/tslint.json b/types/d3-box/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/d3-box/tslint.json +++ b/types/d3-box/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/d3-cloud/tslint.json b/types/d3-cloud/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/d3-cloud/tslint.json +++ b/types/d3-cloud/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/d3-dsv/v0/tslint.json b/types/d3-dsv/v0/tslint.json index bafaae7817..f6fabe4180 100644 --- a/types/d3-dsv/v0/tslint.json +++ b/types/d3-dsv/v0/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO + "npm-naming": false, "dt-header": false } } diff --git a/types/d3-sankey/index.d.ts b/types/d3-sankey/index.d.ts index 4f70bbbe61..3f10e2d1ae 100644 --- a/types/d3-sankey/index.d.ts +++ b/types/d3-sankey/index.d.ts @@ -1,10 +1,10 @@ -// Type definitions for D3JS d3-sankey module 0.7 +// Type definitions for D3JS d3-sankey module 0.11 // Project: https://github.com/d3/d3-sankey/ // Definitions by: Tom Wanzek , Alex Ford // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 -// Last module patch version validated against: 0.7.1 +// Last module patch version validated against: 0.11 import { Link } from 'd3-shape'; @@ -337,6 +337,18 @@ export interface SankeyLayout, b: SankeyNode) => number) | undefined; + + /** + * Set the node comparison function and return this Sankey layout generator. + * + * @param compare Node comparison function. + */ + nodeSort(compare: (a: SankeyNode, b: SankeyNode) => number): this; } /** diff --git a/types/d3-tip/tslint.json b/types/d3-tip/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/d3-tip/tslint.json +++ b/types/d3-tip/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/d3.slider/tslint.json b/types/d3.slider/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/d3.slider/tslint.json +++ b/types/d3.slider/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/d3pie/tslint.json b/types/d3pie/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/d3pie/tslint.json +++ b/types/d3pie/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dat.gui/tslint.json b/types/dat.gui/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dat.gui/tslint.json +++ b/types/dat.gui/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/data-driven/tslint.json b/types/data-driven/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/data-driven/tslint.json +++ b/types/data-driven/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/date-arithmetic/tslint.json b/types/date-arithmetic/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/date-arithmetic/tslint.json +++ b/types/date-arithmetic/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/date.format.js/tslint.json b/types/date.format.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/date.format.js/tslint.json +++ b/types/date.format.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/datejs/tslint.json b/types/datejs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/datejs/tslint.json +++ b/types/datejs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/db-migrate-base/tslint.json b/types/db-migrate-base/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/db-migrate-base/tslint.json +++ b/types/db-migrate-base/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/db-migrate-pg/tslint.json b/types/db-migrate-pg/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/db-migrate-pg/tslint.json +++ b/types/db-migrate-pg/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/db.js/tslint.json b/types/db.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/db.js/tslint.json +++ b/types/db.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dc/tslint.json b/types/dc/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dc/tslint.json +++ b/types/dc/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/debug/debug-tests.ts b/types/debug/debug-tests.ts index 92d6f5eb8e..42c3399aff 100644 --- a/types/debug/debug-tests.ts +++ b/types/debug/debug-tests.ts @@ -29,3 +29,7 @@ extendedLog("Testing this is also an IDebugger."); const extendedWithCustomDelimiter: debug1.Debugger = log.extend('with-delim', '.'); extendedWithCustomDelimiter("Testing this is an IDebugger, too."); + +debug2.log = console.log.bind(console); +const anotherLogger = debug2("DefinitelyTyped:error"); +anotherLogger("This should be printed to stdout"); diff --git a/types/debug/index.d.ts b/types/debug/index.d.ts index 715e7c145e..f4f5866af8 100644 --- a/types/debug/index.d.ts +++ b/types/debug/index.d.ts @@ -5,9 +5,10 @@ // John McLaughlin // Brasten Sager // Nicolas Penin +// Kristian Brünn // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -declare var debug: debug.Debug & {debug: debug.Debug, default: debug.Debug}; +declare var debug: debug.Debug & { debug: debug.Debug; default: debug.Debug }; export = debug; export as namespace debug; @@ -19,6 +20,7 @@ declare namespace debug { disable: () => string; enable: (namespaces: string) => void; enabled: (namespaces: string) => boolean; + log: (...args: any[]) => any; names: RegExp[]; skips: RegExp[]; diff --git a/types/decorum/tslint.json b/types/decorum/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/decorum/tslint.json +++ b/types/decorum/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/defaults/tslint.json b/types/defaults/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/defaults/tslint.json +++ b/types/defaults/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/deku/tslint.json b/types/deku/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/deku/tslint.json +++ b/types/deku/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/denodeify/tslint.json b/types/denodeify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/denodeify/tslint.json +++ b/types/denodeify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/deoxxa-content-type/tslint.json b/types/deoxxa-content-type/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/deoxxa-content-type/tslint.json +++ b/types/deoxxa-content-type/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/deployjava/tslint.json b/types/deployjava/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/deployjava/tslint.json +++ b/types/deployjava/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/devexpress-web/tslint.json b/types/devexpress-web/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/devexpress-web/tslint.json +++ b/types/devexpress-web/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/devtools-detect/tslint.json b/types/devtools-detect/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/devtools-detect/tslint.json +++ b/types/devtools-detect/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/df-visible/tslint.json b/types/df-visible/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/df-visible/tslint.json +++ b/types/df-visible/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dhtmlxgantt/tslint.json b/types/dhtmlxgantt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dhtmlxgantt/tslint.json +++ b/types/dhtmlxgantt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dhtmlxscheduler/tslint.json b/types/dhtmlxscheduler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dhtmlxscheduler/tslint.json +++ b/types/dhtmlxscheduler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/di-lite/tslint.json b/types/di-lite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/di-lite/tslint.json +++ b/types/di-lite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/diff-match-patch/tslint.json b/types/diff-match-patch/tslint.json index 65c83fb1e3..1c56ba06b6 100644 --- a/types/diff-match-patch/tslint.json +++ b/types/diff-match-patch/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { + "npm-naming": false, "dt-header": false } } diff --git a/types/diff/index.d.ts b/types/diff/index.d.ts index 5afb72192e..08ac3c3171 100644 --- a/types/diff/index.d.ts +++ b/types/diff/index.d.ts @@ -142,6 +142,7 @@ export interface Hunk { newStart: number; newLines: number; lines: string[]; + linedelimiters: string[]; } export interface BestPath { diff --git a/types/diff2html/tslint.json b/types/diff2html/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/diff2html/tslint.json +++ b/types/diff2html/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/disposable-email-domains/tslint.json b/types/disposable-email-domains/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/disposable-email-domains/tslint.json +++ b/types/disposable-email-domains/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/doccookies/tslint.json b/types/doccookies/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/doccookies/tslint.json +++ b/types/doccookies/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dock-spawn/tslint.json b/types/dock-spawn/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dock-spawn/tslint.json +++ b/types/dock-spawn/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/docopt/tslint.json b/types/docopt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/docopt/tslint.json +++ b/types/docopt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/doctrine/tslint.json b/types/doctrine/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/doctrine/tslint.json +++ b/types/doctrine/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/documentdb-server/tslint.json b/types/documentdb-server/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/documentdb-server/tslint.json +++ b/types/documentdb-server/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dojo/tslint.json b/types/dojo/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dojo/tslint.json +++ b/types/dojo/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dom4/tslint.json b/types/dom4/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dom4/tslint.json +++ b/types/dom4/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/domhandler/domhandler-tests.ts b/types/domhandler/domhandler-tests.ts index eea6441ad7..4b1c5406ec 100644 --- a/types/domhandler/domhandler-tests.ts +++ b/types/domhandler/domhandler-tests.ts @@ -1,6 +1,6 @@ -import { DomHandler, DomHandlerOptions, Node } from "domhandler"; +import { DomHandler, DomHandlerOptions, Node, DomElement } from "domhandler"; -const handler = new DomHandler((error: Error, dom: any) => { +const handler = new DomHandler((error: Error, dom: DomElement[]) => { if (error) console.error('There has been an error...'); else @@ -8,7 +8,7 @@ const handler = new DomHandler((error: Error, dom: any) => { }); handler.ontext = (data: string) => { console.log(data); }; handler.onreset = () => { console.log('We have a reset.'); }; -handler.onerror = (error: Error) => { console.error(Error); }; -handler.onopentag = (name: string, attribs) => { console.log(name, attribs); }; +handler.onerror = (error: Error) => { console.error(error); }; +handler.onopentag = (name: string, attribs: { [s: string]: string }) => { console.log(name, attribs); }; const dho: DomHandlerOptions = { normalizeWhitespace: true, withDomLvl1: true, withEndIndices: true, withStartIndices: true }; diff --git a/types/domhandler/index.d.ts b/types/domhandler/index.d.ts index 9d33055bbd..49dcd6325f 100644 --- a/types/domhandler/index.d.ts +++ b/types/domhandler/index.d.ts @@ -2,7 +2,6 @@ // Project: https://github.com/fb55/DomHandler#readme // Definitions by: Johan Davidsson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 export interface DomHandlerOptions { /*** diff --git a/types/domo/tslint.json b/types/domo/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/domo/tslint.json +++ b/types/domo/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dompurify/tslint.json b/types/dompurify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dompurify/tslint.json +++ b/types/dompurify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/domurl/domurl-tests.ts b/types/domurl/domurl-tests.ts index 2de93bcc20..e00aa7e1ba 100644 --- a/types/domurl/domurl-tests.ts +++ b/types/domurl/domurl-tests.ts @@ -1,13 +1,15 @@ -interface UModel extends QueryString { +import Url = require("domurl"); + +interface UModel { a: any; b: string; } -interface U2Model extends QueryString { +interface U2Model { a: any; } -interface U3Model extends QueryString { +interface U3Model { foo: string; } diff --git a/types/domurl/index.d.ts b/types/domurl/index.d.ts index d0b7896d61..9de60d45b1 100644 --- a/types/domurl/index.d.ts +++ b/types/domurl/index.d.ts @@ -3,14 +3,15 @@ // Definitions by: Mikhus // Definitions: https://github.com/Mikhus/DefinitelyTyped -declare class QueryString { - constructor(qs?: string); - toString: () => string; +// + +declare namespace domurl { + type QueryString = T; } declare class Url { constructor(url?: string); - query: T; + query: domurl.QueryString; protocol: string; user: string; pass: string; @@ -26,5 +27,7 @@ declare class Url { paths: (paths?: [string]) => [string]; isEmptyQuery: () => boolean; queryLength: () => number; - clearQuery: () => Url; + clearQuery: () => Url<{}>; } + +export = Url; diff --git a/types/domurl/tslint.json b/types/domurl/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/domurl/tslint.json +++ b/types/domurl/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/domutils/index.d.ts b/types/domutils/index.d.ts index 5300a68a8c..6790f9bf82 100644 --- a/types/domutils/index.d.ts +++ b/types/domutils/index.d.ts @@ -2,7 +2,6 @@ // Project: https://github.com/FB55/domutils#readme // Definitions by: Johan Davidsson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.1 import { DomElement } from "domhandler"; /*** diff --git a/types/donna/tslint.json b/types/donna/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/donna/tslint.json +++ b/types/donna/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dotdotdot/tslint.json b/types/dotdotdot/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dotdotdot/tslint.json +++ b/types/dotdotdot/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dotenv/dotenv-tests.ts b/types/dotenv/dotenv-tests.ts index 2776e6d202..9e57d1546f 100644 --- a/types/dotenv/dotenv-tests.ts +++ b/types/dotenv/dotenv-tests.ts @@ -3,7 +3,7 @@ import dotenv = require("dotenv"); const env = dotenv.config(); const dbUrl: string | null = env.error || !env.parsed ? null : env.parsed["BASIC"]; -dotenv.load({ +dotenv.config({ path: ".env-example", encoding: "utf8", debug: true diff --git a/types/dotenv/index.d.ts b/types/dotenv/index.d.ts index f8675ec22e..30b346b0bd 100644 --- a/types/dotenv/index.d.ts +++ b/types/dotenv/index.d.ts @@ -62,4 +62,5 @@ export interface DotenvConfigOutput { * */ export function config(options?: DotenvConfigOptions): DotenvConfigOutput; +/** @deprecated since v7.0.0 Use config instead. */ export const load: typeof config; diff --git a/types/doublearray/tslint.json b/types/doublearray/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/doublearray/tslint.json +++ b/types/doublearray/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/draft-js/index.d.ts b/types/draft-js/index.d.ts index 1a3eb0e39a..dd44093c52 100644 --- a/types/draft-js/index.d.ts +++ b/types/draft-js/index.d.ts @@ -10,6 +10,7 @@ // Ulf Schwekendiek // Pablo Varela // Claudio Procida +// Kevin Hawkinson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.8 @@ -211,6 +212,8 @@ declare namespace Draft { static isOptionKeyCommand(e: SyntheticKeyboardEvent): boolean; static hasCommandModifier(e: SyntheticKeyboardEvent): boolean; + + static isSoftNewlineEvent(e: SyntheticKeyboardEvent): boolean; } /** diff --git a/types/draft-js/tslint.json b/types/draft-js/tslint.json index e3610fefae..89955128d5 100644 --- a/types/draft-js/tslint.json +++ b/types/draft-js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dragula/tslint.json b/types/dragula/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dragula/tslint.json +++ b/types/dragula/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dropboxjs/tslint.json b/types/dropboxjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dropboxjs/tslint.json +++ b/types/dropboxjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dropzone/tslint.json b/types/dropzone/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dropzone/tslint.json +++ b/types/dropzone/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dsv/tslint.json b/types/dsv/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dsv/tslint.json +++ b/types/dsv/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dts-bundle/tslint.json b/types/dts-bundle/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dts-bundle/tslint.json +++ b/types/dts-bundle/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/durandal/tslint.json b/types/durandal/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/durandal/tslint.json +++ b/types/durandal/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dustjs-linkedin/tslint.json b/types/dustjs-linkedin/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dustjs-linkedin/tslint.json +++ b/types/dustjs-linkedin/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dvtng-jss/tslint.json b/types/dvtng-jss/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dvtng-jss/tslint.json +++ b/types/dvtng-jss/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dw-bxslider-4/tslint.json b/types/dw-bxslider-4/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dw-bxslider-4/tslint.json +++ b/types/dw-bxslider-4/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dwt/Dynamsoft.d.ts b/types/dwt/Dynamsoft.d.ts index 65569f61b3..38ddc3ef49 100644 --- a/types/dwt/Dynamsoft.d.ts +++ b/types/dwt/Dynamsoft.d.ts @@ -27,6 +27,7 @@ interface dwtEnv { DynamicContainers: string[]; DynamicDWTMap: {}; GetWebTwain(cid: string): WebTwain; + IfInstallDWTModuleWithZIP: boolean; IfUpdateService: boolean; IfUseActiveXForIE10Plus: boolean; JSVersion: string; diff --git a/types/dwt/index.d.ts b/types/dwt/index.d.ts index 04f600367d..3650529393 100644 --- a/types/dwt/index.d.ts +++ b/types/dwt/index.d.ts @@ -4,6 +4,7 @@ // Josh Hall // Lincoln Hu // Tom Kent +// Dave Sueltenfuss // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.4 diff --git a/types/dygraphs/tslint.json b/types/dygraphs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dygraphs/tslint.json +++ b/types/dygraphs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dymo-label-framework/tslint.json b/types/dymo-label-framework/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dymo-label-framework/tslint.json +++ b/types/dymo-label-framework/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/dynatable/tslint.json b/types/dynatable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/dynatable/tslint.json +++ b/types/dynatable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/each/tslint.json b/types/each/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/each/tslint.json +++ b/types/each/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easeljs/tslint.json b/types/easeljs/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/easeljs/tslint.json +++ b/types/easeljs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-api-request/tslint.json b/types/easy-api-request/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-api-request/tslint.json +++ b/types/easy-api-request/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-jsend/tslint.json b/types/easy-jsend/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-jsend/tslint.json +++ b/types/easy-jsend/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-session/tslint.json b/types/easy-session/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-session/tslint.json +++ b/types/easy-session/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-table/tslint.json b/types/easy-table/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-table/tslint.json +++ b/types/easy-table/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-xapi-utils/tslint.json b/types/easy-xapi-utils/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-xapi-utils/tslint.json +++ b/types/easy-xapi-utils/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/easy-xapi/tslint.json b/types/easy-xapi/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/easy-xapi/tslint.json +++ b/types/easy-xapi/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/echarts/index.d.ts b/types/echarts/index.d.ts index 41b3fe801f..ca93cc10ac 100644 --- a/types/echarts/index.d.ts +++ b/types/echarts/index.d.ts @@ -972,17 +972,21 @@ declare namespace echarts { sublink?: string, subtarget?: string, subtextStyle?: object, + textAlign?: string, + textVerticalAlign?: string, + triggerEvent?: boolean, padding?: number, itemGap?: number, zlevel?: number, z?: number, - left?: string, - top?: string, - right?: string, - bottom?: string, + left?: string | number, + top?: string | number, + right?: string | number, + bottom?: string | number, backgroundColor?: string, borderColor?: string, borderWidth?: number, + borderRadius?: number | number[], shadowBlur?: number, shadowColor?: number, shadowOffsetX?: number, diff --git a/types/echarts/tslint.json b/types/echarts/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/echarts/tslint.json +++ b/types/echarts/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/egg-mock/tsconfig.json b/types/egg-mock/tsconfig.json index 86b33fc149..50edb7c401 100644 --- a/types/egg-mock/tsconfig.json +++ b/types/egg-mock/tsconfig.json @@ -4,7 +4,7 @@ "lib": [ "es6" ], - "noImplicitAny": true, + "noImplicitAny": false, "noImplicitThis": true, "strictNullChecks": false, "strictFunctionTypes": true, @@ -20,4 +20,4 @@ "index.d.ts", "egg-mock-tests.ts" ] -} \ No newline at end of file +} diff --git a/types/egg.js/tslint.json b/types/egg.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/egg.js/tslint.json +++ b/types/egg.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ejs-locals/tslint.json b/types/ejs-locals/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ejs-locals/tslint.json +++ b/types/ejs-locals/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ejson/tslint.json b/types/ejson/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ejson/tslint.json +++ b/types/ejson/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/elastic.js/tslint.json b/types/elastic.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/elastic.js/tslint.json +++ b/types/elastic.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/electron-debug/tslint.json b/types/electron-debug/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/electron-debug/tslint.json +++ b/types/electron-debug/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/electron-devtools-installer/tslint.json b/types/electron-devtools-installer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/electron-devtools-installer/tslint.json +++ b/types/electron-devtools-installer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/electron-notifications/tslint.json b/types/electron-notifications/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/electron-notifications/tslint.json +++ b/types/electron-notifications/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/electron-notify/tslint.json b/types/electron-notify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/electron-notify/tslint.json +++ b/types/electron-notify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/electron-window-state/tslint.json b/types/electron-window-state/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/electron-window-state/tslint.json +++ b/types/electron-window-state/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/element-resize-event/tslint.json b/types/element-resize-event/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/element-resize-event/tslint.json +++ b/types/element-resize-event/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/elliptic/index.d.ts b/types/elliptic/index.d.ts index 7b1e885d6f..a6775225eb 100644 --- a/types/elliptic/index.d.ts +++ b/types/elliptic/index.d.ts @@ -4,7 +4,7 @@ // Gaylor Bosson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -import BN = require('bn.js'); +import BN = require("bn.js"); // incomplete typings export const utils: any; @@ -29,10 +29,10 @@ export namespace curve { g: base.BasePoint; redN: BN; - constructor(type: string, conf: base.BaseCurveOptions) + constructor(type: string, conf: base.BaseCurveOptions); validate(point: base.BasePoint): boolean; - decodePoint(bytes: Buffer | string, enc?: 'hex'): base.BasePoint; + decodePoint(bytes: Buffer | string, enc?: "hex"): base.BasePoint; } namespace base { @@ -83,7 +83,12 @@ export namespace curve { constructor(conf: edwards.EdwardsConf); - point(x: BNInput, y: BNInput, z?: BNInput, t?: BNInput): edwards.EdwardsPoint; + point( + x: BNInput, + y: BNInput, + z?: BNInput, + t?: BNInput + ): edwards.EdwardsPoint; pointFromX(x: BNInput, odd?: boolean): edwards.EdwardsPoint; pointFromY(y: BNInput, odd?: boolean): edwards.EdwardsPoint; pointFromJSON(obj: BNInput[]): edwards.EdwardsPoint; @@ -144,7 +149,7 @@ export namespace curves { n: BN | undefined | null; hash: any; // ? - constructor(options: PresetCurve.Options) + constructor(options: PresetCurve.Options); } namespace PresetCurve { @@ -172,17 +177,47 @@ export class ec { g: any; hash: any; - constructor(options: string | curves.PresetCurve) + constructor(options: string | curves.PresetCurve); keyPair(options: ec.KeyPairOptions): ec.KeyPair; - keyFromPrivate(priv: Buffer | string | ec.KeyPair, enc?: string): ec.KeyPair; - keyFromPublic(pub: Buffer | string | {x: string, y: string} | ec.KeyPair, enc?: string): ec.KeyPair; + keyFromPrivate( + priv: Buffer | string | ec.KeyPair, + enc?: string + ): ec.KeyPair; + keyFromPublic( + pub: Buffer | string | { x: string; y: string } | ec.KeyPair, + enc?: string + ): ec.KeyPair; genKeyPair(options?: ec.GenKeyPairOptions): ec.KeyPair; - sign(msg: BNInput, key: Buffer | ec.KeyPair, enc: string, options?: ec.SignOptions): ec.Signature; - sign(msg: BNInput, key: Buffer | ec.KeyPair, options?: ec.SignOptions): ec.Signature; - verify(msg: BNInput, signature: ec.Signature | ec.SignatureOptions, key: Buffer | ec.KeyPair, enc?: string): boolean; - recoverPubKey(msg: BNInput, signature: ec.Signature | ec.SignatureOptions, j: number, enc?: string): any; - getKeyRecoveryParam(e: Error | undefined, signature: ec.Signature | ec.SignatureOptions, Q: BN, enc?: string): number; + sign( + msg: BNInput, + key: Buffer | ec.KeyPair, + enc: string, + options?: ec.SignOptions + ): ec.Signature; + sign( + msg: BNInput, + key: Buffer | ec.KeyPair, + options?: ec.SignOptions + ): ec.Signature; + verify( + msg: BNInput, + signature: ec.Signature | ec.SignatureOptions, + key: Buffer | ec.KeyPair, + enc?: string + ): boolean; + recoverPubKey( + msg: BNInput, + signature: ec.Signature | ec.SignatureOptions, + j: number, + enc?: string + ): any; + getKeyRecoveryParam( + e: Error | undefined, + signature: ec.Signature | ec.SignatureOptions, + Q: BN, + enc?: string + ): number; } export namespace ec { @@ -201,21 +236,32 @@ export namespace ec { } class KeyPair { - static fromPublic(ec: ec, pub: Buffer | string | {x: string, y: string} | KeyPair, enc?: string): KeyPair; - static fromPrivate(ec: ec, priv: Buffer | string | KeyPair, enc?: string): KeyPair; + static fromPublic( + ec: ec, + pub: Buffer | string | { x: string; y: string } | KeyPair, + enc?: string + ): KeyPair; + static fromPrivate( + ec: ec, + priv: Buffer | string | KeyPair, + enc?: string + ): KeyPair; ec: ec; - constructor(ec: ec, options: KeyPairOptions) + constructor(ec: ec, options: KeyPairOptions); - validate(): { readonly result: boolean, readonly reason: string }; + validate(): { readonly result: boolean; readonly reason: string }; getPublic(compact: boolean, enc?: string): any; // ? getPublic(enc?: string): any; // ? - getPrivate(enc?: 'hex'): Buffer | BN | string; + getPrivate(enc?: "hex"): Buffer | BN | string; derive(pub: any): any; // ? sign(msg: BNInput, enc: string, options?: SignOptions): Signature; sign(msg: BNInput, options?: SignOptions): Signature; - verify(msg: BNInput, signature: Signature | SignatureOptions): boolean; + verify( + msg: BNInput, + signature: Signature | SignatureOptions | string + ): boolean; inspect(): string; } @@ -224,7 +270,7 @@ export namespace ec { s: BN; recoveryParam: number | null; - constructor(options: SignatureOptions | Signature, enc?: string) + constructor(options: SignatureOptions | Signature, enc?: string); toDER(enc?: string | null): any; // ? } @@ -246,10 +292,14 @@ export namespace ec { export class eddsa { curve: curve.edwards; - constructor(name: 'ed25519'); + constructor(name: "ed25519"); sign(message: eddsa.Bytes, secret: eddsa.Bytes): eddsa.Signature; - verify(message: eddsa.Bytes, sig: eddsa.Bytes | eddsa.Signature, pub: eddsa.Bytes | eddsa.Point | eddsa.KeyPair): boolean; + verify( + message: eddsa.Bytes, + sig: eddsa.Bytes | eddsa.Signature, + pub: eddsa.Bytes | eddsa.Point | eddsa.KeyPair + ): boolean; hashInt(): BN; keyFromPublic(pub: eddsa.Bytes): eddsa.KeyPair; keyFromSecret(secret: eddsa.Bytes): eddsa.KeyPair; @@ -281,9 +331,9 @@ export namespace eddsa { secret(): Buffer; sign(message: Bytes): Signature; verify(message: Bytes, sig: Signature | Bytes): boolean; - getSecret(enc: 'hex'): string; + getSecret(enc: "hex"): string; getSecret(): Buffer; - getPublic(enc: 'hex'): string; + getPublic(enc: "hex"): string; getPublic(): Buffer; } diff --git a/types/elm/tslint.json b/types/elm/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/elm/tslint.json +++ b/types/elm/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/elv/elv-tests.ts b/types/elv/elv-tests.ts new file mode 100644 index 0000000000..78689fc493 --- /dev/null +++ b/types/elv/elv-tests.ts @@ -0,0 +1,14 @@ +import elv = require('elv'); + +elv(''); // $ExpectType boolean + +elv.behavior.enableFalse; // $ExpectedType boolean +elv.behavior.enableNaN; // $ExpectedType boolean +elv.behavior.enableNull; // $ExpectedType boolean +elv.behavior.enableUndefined; // $ExpectedType boolean + +elv.coalesce(''); // $ExpectType any +elv.ncoalesce(''); // $ExpectType any +elv.populated(''); // $ExpectType boolean +elv.tryGet([], 0); // $ExpectType any +elv.tryGet([], 0, ''); // $ExpectType any diff --git a/types/elv/index.d.ts b/types/elv/index.d.ts new file mode 100644 index 0000000000..defab524f9 --- /dev/null +++ b/types/elv/index.d.ts @@ -0,0 +1,21 @@ +// Type definitions for elv 2.2 +// Project: https://github.com/dsfields/elv#readme +// Definitions by: Gary Parker +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare function elv(val: any): boolean; + +declare namespace elv { + const behavior: { + enableFalse: boolean + enableNaN: boolean + enableNull: boolean + enableUndefined: boolean + }; + function coalesce(...args: any[]): any; + function ncoalesce(...args: any[]): any; + function populated(val: any): boolean; + function tryGet(val: ReadonlyArray, index: number, def?: any): any; +} + +export = elv; diff --git a/types/elv/tsconfig.json b/types/elv/tsconfig.json new file mode 100644 index 0000000000..ae2286a85f --- /dev/null +++ b/types/elv/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "allowSyntheticDefaultImports": true, + "strictFunctionTypes": true + }, + "files": [ + "index.d.ts", + "elv-tests.ts" + ] +} diff --git a/types/elv/tslint.json b/types/elv/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/elv/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/ember-data/index.d.ts b/types/ember-data/index.d.ts index f5ff0c5d57..a98082a60e 100644 --- a/types/ember-data/index.d.ts +++ b/types/ember-data/index.d.ts @@ -16,8 +16,14 @@ import ModelRegistry from 'ember-data/types/registries/model'; import SerializerRegistry from 'ember-data/types/registries/serializer'; import AdapterRegistry from 'ember-data/types/registries/adapter'; -type AttributesFor = keyof Model; // TODO: filter to attr properties only (TS 2.8) -type RelationshipsFor = keyof Model; // TODO: filter to hasMany/belongsTo properties only (TS 2.8) +/** + The keys from the actual Model class, removing all the keys which come from + the base class. + */ +type ModelKeys = Exclude; + +type AttributesFor = ModelKeys; // TODO: filter to attr properties only (TS 2.8) +type RelationshipsFor = ModelKeys; // TODO: filter to hasMany/belongsTo properties only (TS 2.8) export interface ChangedAttributes { [key: string]: [any, any] | undefined; @@ -49,9 +55,9 @@ export namespace DS { */ function errorsArrayToHash(errors: any[]): {}; - interface RelationshipOptions { + interface RelationshipOptions { async?: boolean; - inverse?: RelationshipsFor | null; + inverse?: RelationshipsFor | null; polymorphic?: boolean; } @@ -457,12 +463,12 @@ export namespace DS { * Create a JSON representation of the record, using the serialization * strategy of the store's adapter. */ - serialize(options?: { includeId?: boolean }): {}; + serialize(options?: { includeId?: boolean }): object; /** * Use [DS.JSONSerializer](DS.JSONSerializer.html) to * get the JSON representation of a record. */ - toJSON(options: {}): {}; + toJSON(options?: { includeId?: boolean }): object; /** * Fired when the record is ready to be interacted with, * that is either loaded from the server or created locally. @@ -502,15 +508,15 @@ export namespace DS { * method if you want to allow the user to still `rollbackAttributes()` * after a delete was made. */ - deleteRecord(): any; + deleteRecord(): void; /** * Same as `deleteRecord`, but saves the record immediately. */ - destroyRecord(options?: {}): RSVP.Promise; + destroyRecord(options?: { adapterOptions?: object }): RSVP.Promise; /** * Unloads the record from the store. This will cause the record to be destroyed and freed up for garbage collection. */ - unloadRecord(): any; + unloadRecord(): void; /** * Returns an object, whose keys are changed properties, and value is * an [oldProp, newProp] array. @@ -520,16 +526,16 @@ export namespace DS { * If the model `hasDirtyAttributes` this function will discard any unsaved * changes. If the model `isNew` it will be removed from the store. */ - rollbackAttributes(): any; + rollbackAttributes(): void; /** * Save the record and persist any changes to the record to an * external source via the adapter. */ - save(options?: {}): RSVP.Promise; + save(options?: { adapterOptions?: object }): RSVP.Promise; /** * Reload the record from the adapter. */ - reload(): RSVP.Promise; + reload(options?: { adapterOptions?: object }): RSVP.Promise; /** * Get the reference for the specified belongsTo relationship. */ @@ -547,7 +553,7 @@ export namespace DS { this: T, callback: (name: string, details: RelationshipMeta) => void, binding?: any - ): any; + ): void; /** * Represents the model's class name as a string. This can be used to look up the model's class name through * `DS.Store`'s modelFor method. @@ -605,14 +611,14 @@ export namespace DS { static eachRelationship( callback: (name: string, details: RelationshipMeta) => void, binding?: any - ): any; + ): void; /** * Given a callback, iterates over each of the types related to a model, * invoking the callback with the related type's class. Each type will be * returned just once, regardless of how many different relationships it has * with a model. */ - static eachRelatedType(callback: Function, binding: any): any; + static eachRelatedType(callback: (name: string) => void, binding?: any): void; /** * A map whose keys are the attributes of the model (properties * described by DS.attr) and whose values are the meta object for the @@ -630,26 +636,27 @@ export namespace DS { * Iterates through the attributes of the model, calling the passed function on each * attribute. */ - static eachAttribute(callback: Function, binding: {}): any; + static eachAttribute>( + this: Class, + callback: ( + name: ModelKeys, + meta: AttributeMeta + ) => void, + binding?: any + ): void; /** * Iterates through the transformedAttributes of the model, calling * the passed function on each attribute. Note the callback will not be * called for any attributes that do not have an transformation type. */ - static eachTransformedAttribute(callback: Function, binding: {}): any; - /** - * Discards any unsaved changes to the given attribute. This feature is not enabled by default. You must enable `ds-rollback-attribute` and be running a canary build. - */ - rollbackAttribute(): any; - /** - * This Ember.js hook allows an object to be notified when a property - * is defined. - */ - didDefineProperty( - proto: {}, - key: string, - value: Ember.ComputedProperty - ): any; + static eachTransformedAttribute( + this: Class, + callback: ( + name: ModelKeys>, + type: keyof TransformRegistry + ) => void, + binding?: any + ): void; } /** * ### State @@ -700,7 +707,7 @@ export namespace DS { * Used to get the latest version of all of the records in this array * from the adapter. */ - update(): any; + update(): PromiseArray; /** * Saves all of the records in the `RecordArray`. */ @@ -782,7 +789,7 @@ export namespace DS { /** * `ids()` returns an array of the record ids in this relationship. */ - ids(): any[]; + ids(): string[]; /** * The meta data for the has-many relationship. */ @@ -948,7 +955,7 @@ export namespace DS { /** * Get snapshots of the underlying record array */ - snapshots(): any[]; + snapshots(): Snapshot[]; } class Snapshot { /** @@ -994,14 +1001,19 @@ export namespace DS { belongsTo>( keyName: L, options?: {} - ): Snapshot['record'][L] | string | null | undefined; + ): Snapshot | null | undefined; + belongsTo>( + keyName: L, + options: { id: true } + ): string | null | undefined; + /** * Returns the current value of a hasMany relationship. */ hasMany>( keyName: L, options?: { ids: false } - ): Array['record'][L]> | undefined; + ): Snapshot[] | undefined; hasMany>( keyName: L, options: { ids: true } @@ -1011,21 +1023,21 @@ export namespace DS { * function on each attribute. */ eachAttribute( - callback: (key: keyof M, meta: AttributeMeta) => void, + callback: (key: ModelKeys, meta: AttributeMeta) => void, binding?: {} - ): any; + ): void; /** * Iterates through all the relationships of the model, calling the passed * function on each relationship. */ eachRelationship( - callback: (key: keyof M, meta: RelationshipMeta) => void, + callback: (key: ModelKeys, meta: RelationshipMeta) => void, binding?: {} - ): any; + ): void; /** * Serializes the snapshot using the serializer for the model. */ - serialize(options: {}): {}; + serialize(options: O): object; } /** @@ -1095,7 +1107,8 @@ export namespace DS { */ query( modelName: K, - query: any + query: object, + options?: { adapterOptions?: object } ): AdapterPopulatedRecordArray & PromiseArray; /** @@ -1105,7 +1118,8 @@ export namespace DS { */ queryRecord( modelName: K, - query: any + query: object, + options?: { adapterOptions?: object } ): RSVP.Promise; /** * `findAll` asks the adapter's `findAll` method to find the records for the diff --git a/types/ember-data/test/model.ts b/types/ember-data/test/model.ts index 2085daf90a..356c607748 100644 --- a/types/ember-data/test/model.ts +++ b/types/ember-data/test/model.ts @@ -1,6 +1,7 @@ import Ember from 'ember'; import DS, { ChangedAttributes } from 'ember-data'; import { assertType } from "./lib/assert"; +import RSVP from 'rsvp'; const Person = DS.Model.extend({ firstName: DS.attr(), @@ -33,5 +34,26 @@ user.serialize(); user.serialize({ includeId: true }); user.serialize({ includeId: true }); -const attributes = user.changedAttributes(); -assertType(attributes); +const attributes: ChangedAttributes = user.changedAttributes(); + +user.rollbackAttributes(); // $ExpectType void + +let destroyResult: RSVP.Promise; +destroyResult = user.destroyRecord(); +destroyResult = user.destroyRecord({}); +destroyResult = user.destroyRecord({ adapterOptions: {}}); +destroyResult = user.destroyRecord({ adapterOptions: { waffles: 'are yummy' }}); + +user.deleteRecord(); // $ExpectType void + +user.unloadRecord(); // $ExpectType void + +let jsonified: object; +jsonified = user.toJSON(); +jsonified = user.toJSON({ includeId: true }); + +let reloaded: RSVP.Promise; +reloaded = user.reload(); +reloaded = user.reload({}); +reloaded = user.reload({ adapterOptions: {} }); +reloaded = user.reload({ adapterOptions: { fastAsCanBe: 'yessirree' } }); diff --git a/types/ember-data/test/relationships.ts b/types/ember-data/test/relationships.ts index 13a526ba6a..04aae75f0e 100644 --- a/types/ember-data/test/relationships.ts +++ b/types/ember-data/test/relationships.ts @@ -1,5 +1,7 @@ import Ember from 'ember'; import DS from 'ember-data'; +import TransformRegistry from 'ember-data/types/registries/transform'; +import { assertType } from './lib/assert'; declare const store: DS.Store; @@ -8,24 +10,65 @@ const Person = DS.Model.extend({ parent: DS.belongsTo('folder', { inverse: 'children' }) }); +// $ExpectType void +Person.eachAttribute(() => {}); +// $ExpectType void +Person.eachAttribute(() => {}, {}); +// $ExpectType void +Person.eachAttribute((name, meta) => { + assertType<'children' | 'parent'>(name); + assertType<{ + type: keyof TransformRegistry; + options: object; + name: 'children' | 'parent'; + parentType: DS.Model; + isAttribute: true; + }>(meta); +}); + +// $ExpectType void +Person.eachTransformedAttribute(() => {}); +// $ExpectType void +Person.eachTransformedAttribute(() => {}, {}); +// $ExpectType void +Person.eachTransformedAttribute((name, type) => { + assertType<'children' | 'parent'>(name); + let t: keyof TransformRegistry = type; +}); + const Polymorphic = DS.Model.extend({ paymentMethods: DS.hasMany('payment-method', { polymorphic: true }) }); +// $ExpectType void Polymorphic.eachRelationship(() => ''); +// $ExpectType void Polymorphic.eachRelationship(() => '', {}); +// $ExpectType void Polymorphic.eachRelationship((n, meta) => { let s: string = n; let m: 'belongsTo' | 'hasMany' = meta.kind; }); let p = Polymorphic.create(); +// $ExpectType void p.eachRelationship(() => ''); +// $ExpectType void p.eachRelationship(() => '', {}); +// $ExpectType void p.eachRelationship((n, meta) => { let s: string = n; let m: 'belongsTo' | 'hasMany' = meta.kind; }); +// $ExpectType void +Polymorphic.eachRelatedType(() => ''); +// $ExpectType void +Polymorphic.eachRelatedType(() => '', {}); +// $ExpectType void +Polymorphic.eachRelatedType((name) => { + let s: string = name; +}); + export class Comment extends DS.Model { author = DS.attr('string'); } diff --git a/types/ember-data/test/serializer.ts b/types/ember-data/test/serializer.ts index d38ced647a..490dc77493 100644 --- a/types/ember-data/test/serializer.ts +++ b/types/ember-data/test/serializer.ts @@ -1,6 +1,10 @@ import Ember from 'ember'; import DS from 'ember-data'; +interface Dict { + [key: string]: T | null | undefined; +} + const JsonApi = DS.JSONAPISerializer.extend({}); const Customized = DS.JSONAPISerializer.extend({ @@ -74,14 +78,16 @@ const SerializerUsingSnapshots = DS.RESTSerializer.extend({ DS.Serializer.extend({ serialize(snapshot: DS.Snapshot<'message-for-serializer'>, options: {}) { - let json: any = { + let json: Dict = { id: snapshot.id }; + // $ExpectType void snapshot.eachAttribute((key, attribute) => { json[key] = snapshot.attr(key); }); + // $ExpectType void snapshot.eachRelationship((key, relationship) => { if (relationship.kind === 'belongsTo') { json[key] = snapshot.belongsTo(key, { id: true }); diff --git a/types/ember-data/test/store.ts b/types/ember-data/test/store.ts index b6bb25993c..f692a668d9 100644 --- a/types/ember-data/test/store.ts +++ b/types/ember-data/test/store.ts @@ -24,6 +24,7 @@ let post = store.createRecord('post', { }); post.save(); // => POST to '/posts' +post.save({ adapterOptions: { makeItSo: 'number one ' } }); post.save().then(saved => { assertType(saved); }); diff --git a/types/ember-testing-helpers/tslint.json b/types/ember-testing-helpers/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ember-testing-helpers/tslint.json +++ b/types/ember-testing-helpers/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ember/test/ember-module-tests.ts b/types/ember/test/ember-module-tests.ts index 5935578d3e..b37882a6cc 100644 --- a/types/ember/test/ember-module-tests.ts +++ b/types/ember/test/ember-module-tests.ts @@ -2,8 +2,12 @@ import Ember from 'ember'; // $ Ember.$; // $ExpectType JQueryStatic + +const top = ((x?: T): T => x!)(); +type Top = typeof top; +declare function expectTypeNativeArrayTop(x: Ember.NativeArray): void; // A -Ember.A(); // $ExpectType NativeArray<{}> +expectTypeNativeArrayTop(Ember.A()); Ember.A([1, 2]); // $ExpectType NativeArray // addListener Ember.addListener({ a: 'foo' }, 'a', {}, () => {}); diff --git a/types/ember__routing/-private/route-info.d.ts b/types/ember__routing/-private/route-info.d.ts new file mode 100644 index 0000000000..6cc971bd9c --- /dev/null +++ b/types/ember__routing/-private/route-info.d.ts @@ -0,0 +1,49 @@ +// https://api.emberjs.com/ember/3.6/classes/RouteInfo +/** + * A `RouteInfo` is an object that contains metadata about a specific route within a `Transition`. + * It is read-only and internally immutable. + * It is also not observable, because a `Transition` instance is never changed after creation. + */ +export default interface RouteInfo { + /** + * A reference to the childe route's `RouteInfo`. + * This can be used to traverse downward to the leafmost `RouteInfo`. + */ + readonly child: RouteInfo | null; + /** + * The final segment of the fully-qualified name of the route, like "index". + */ + readonly localName: string; + /** + * The dot-separated, fully-qualified name of the route, like "people.index". + */ + readonly name: string; + /** + * The ordered list of the names of the params required for this route. + * It will contain the same strings as `Object.keys(params)`, but here the order is significant. + * This allows users to correctly pass params into routes programmatically. + */ + readonly paramNames: string[]; + /** + * The values of the route's parameters. + * These are the same params that are received as arguments to the route's `model` hook. + * Contains only the parameters valid for this route, if any (params for parent or child routes are not merged). + */ + readonly params: { [key: string]: string | undefined }; + /** + * A reference to the parent route's `RouteInfo`. + * This can be used to traverse upward to the topmost `RouteInfo`. + */ + readonly parent: RouteInfo | null; + /** + * The values of any query params on this route. + */ + readonly queryParams: { [key: string]: string | undefined }; + /** + * Allows you to traverse through the linked list of `RouteInfo`s from the topmost to leafmost. + * Returns the first `RouteInfo` in the linked list for which the callback returns true. + * + * @param callback the callback to execute. + */ + find(callback: (item: RouteInfo) => boolean): RouteInfo | undefined; +} diff --git a/types/ember__routing/-private/transition.d.ts b/types/ember__routing/-private/transition.d.ts index 53d06f80e8..027e913aca 100644 --- a/types/ember__routing/-private/transition.d.ts +++ b/types/ember__routing/-private/transition.d.ts @@ -1,4 +1,17 @@ +import RouteInfo from './route-info'; + export default interface Transition { + /** + * This property is a `RouteInfo` object that represents where transition originated from. + * It's important to note that a `RouteInfo` is a linked list and this property is simply the head node of the list. + * In the case of an initial render, `from` will be set to `null`. + */ + readonly from: RouteInfo | null; + /** + * This property is a `RouteInfo` object that represents where the router is transitioning to. + * It's important to note that a `RouteInfo` is a linked list and this property is simply the leafmost route. + */ + readonly to: RouteInfo; /** * Aborts the Transition. Note you can also implicitly abort a transition * by initiating another transition while a previous one is underway. diff --git a/types/ember__routing/router-service.d.ts b/types/ember__routing/router-service.d.ts index decc36af34..07349dc765 100644 --- a/types/ember__routing/router-service.d.ts +++ b/types/ember__routing/router-service.d.ts @@ -1,3 +1,4 @@ +import RouteInfo from '@ember/routing/-private/route-info'; import Transition from '@ember/routing/-private/transition'; import Service from '@ember/service'; @@ -10,6 +11,12 @@ type RouteModel = object | string | number; */ export default class RouterService extends Service { // + /** + * A `RouteInfo` that represents the current leaf route. + * It is guaranteed to change whenever a route transition happens + * (even when that transition only changes parameters and doesn't change the active route) + */ + readonly currentRoute: RouteInfo; /** * Name of the current route. * This property represent the logical name of the route, @@ -212,4 +219,23 @@ export default class RouterService extends Service { modelsD: RouteModel, options?: { queryParams: object } ): string; + + // https://api.emberjs.com/ember/3.6/classes/RouterService/events/routeDidChange?anchor=routeDidChange + /** + * Register a callback for an event. + * + * The `routeWillChange` event is fired at the beginning of any attempted transition with a `Transition` object as the sole argument. + * This action can be used for aborting, redirecting, or decorating the transition from the currently active routes. + * + * The `routeDidChange` event only fires once a transition has settled. + * This includes aborts and error substates. + * Like the `routeWillChange` event it recieves a `Transition` as the sole argument. + * + * @param name the name of the event + * @param callback the callback to execute + */ + on( + name: 'routeDidChange' | 'routeWillChange', + callback: (transition: Transition) => void + ): RouterService; } diff --git a/types/ember__routing/test/router.ts b/types/ember__routing/test/router.ts index be1c16d821..cbba58c65d 100755 --- a/types/ember__routing/test/router.ts +++ b/types/ember__routing/test/router.ts @@ -1,4 +1,3 @@ -import { assertType } from './lib/assert'; import Router from '@ember/routing/router'; import Service, { inject as service } from '@ember/service'; import EmberObject, { get } from '@ember/object'; @@ -52,5 +51,33 @@ const RouterServiceConsumer = Service.extend({ const model = EmberObject.create(); get(this, 'router') .transitionTo('index', model, { queryParams: { search: 'ember' }}); - } + }, + onAndRouteInfo() { + const router = get(this, 'router'); + router + .on('routeWillChange', transition => { + const to = transition.to; + to.child; // $ExpectType RouteInfo | null + to.localName; // $ExpectType string + to.name; // $ExpectType string + to.paramNames; // $ExpectType string[] + to.params.foo; // $ExpectType string | undefined + to.parent; // $ExpectType RouteInfo | null + to.queryParams.foo; // $ExpectType string | undefined + to.find(info => info.name === 'foo'); // $ExpectType RouteInfo | undefined + }) + .on('routeDidChange', transition => { + const from = transition.from; + if (from) { + from.child; // $ExpectType RouteInfo | null + from.localName; // $ExpectType string + from.name; // $ExpectType string + from.paramNames; // $ExpectType string[] + from.params.foo; // $ExpectType string | undefined + from.parent; // $ExpectType RouteInfo | null + from.queryParams.foo; // $ExpectType string | undefined + from.find(info => info.name === 'foo'); // $ExpectType RouteInfo | undefined + } + }); + }, }); diff --git a/types/ember__routing/tsconfig.json b/types/ember__routing/tsconfig.json index c5bd434549..e7c16536f6 100644 --- a/types/ember__routing/tsconfig.json +++ b/types/ember__routing/tsconfig.json @@ -44,6 +44,7 @@ "router.d.ts", "types.d.ts", "-private/router-dsl.d.ts", + "-private/route-info.d.ts", "-private/transition.d.ts", "test/lib/assert.ts", "test/route.ts", diff --git a/types/emissary/tslint.json b/types/emissary/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/emissary/tslint.json +++ b/types/emissary/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/empower/tslint.json b/types/empower/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/empower/tslint.json +++ b/types/empower/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/emscripten/tslint.json b/types/emscripten/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/emscripten/tslint.json +++ b/types/emscripten/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/encoding-japanese/tslint.json b/types/encoding-japanese/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/encoding-japanese/tslint.json +++ b/types/encoding-japanese/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/enhanced-resolve/tslint.json b/types/enhanced-resolve/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/enhanced-resolve/tslint.json +++ b/types/enhanced-resolve/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ent/tslint.json b/types/ent/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ent/tslint.json +++ b/types/ent/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/envify/tslint.json b/types/envify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/envify/tslint.json +++ b/types/envify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/enzyme/index.d.ts b/types/enzyme/index.d.ts index 71238871c7..20e25853f9 100644 --- a/types/enzyme/index.d.ts +++ b/types/enzyme/index.d.ts @@ -88,7 +88,7 @@ export interface CommonWrapper

> { /** * Returns whether or not the current node has a className prop including the passed in class name. */ - hasClass(className: string): boolean; + hasClass(className: string | RegExp): boolean; /** * Returns whether or not the current node matches a provided selector. diff --git a/types/enzyme/tslint.json b/types/enzyme/tslint.json index 67c3be0ed0..a5f1f5a4c3 100644 --- a/types/enzyme/tslint.json +++ b/types/enzyme/tslint.json @@ -3,6 +3,7 @@ "rules": { // TODOs "dt-header": false, + "npm-naming": false, "no-duplicate-imports": false, "no-unnecessary-generics": false } diff --git a/types/eonasdan-bootstrap-datetimepicker/tslint.json b/types/eonasdan-bootstrap-datetimepicker/tslint.json index b6afb8acee..4017299a0e 100644 --- a/types/eonasdan-bootstrap-datetimepicker/tslint.json +++ b/types/eonasdan-bootstrap-datetimepicker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/epiceditor/tslint.json b/types/epiceditor/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/epiceditor/tslint.json +++ b/types/epiceditor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/epub/tslint.json b/types/epub/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/epub/tslint.json +++ b/types/epub/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/eq.js/tslint.json b/types/eq.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/eq.js/tslint.json +++ b/types/eq.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/errorhandler/tslint.json b/types/errorhandler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/errorhandler/tslint.json +++ b/types/errorhandler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/es6-collections/tslint.json b/types/es6-collections/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/es6-collections/tslint.json +++ b/types/es6-collections/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/es6-shim/tslint.json b/types/es6-shim/tslint.json index 637071b426..592fc9bcaa 100644 --- a/types/es6-shim/tslint.json +++ b/types/es6-shim/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/escape-html/tslint.json b/types/escape-html/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/escape-html/tslint.json +++ b/types/escape-html/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/escape-latex/tslint.json b/types/escape-latex/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/escape-latex/tslint.json +++ b/types/escape-latex/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/escape-string-regexp/tslint.json b/types/escape-string-regexp/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/escape-string-regexp/tslint.json +++ b/types/escape-string-regexp/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/escodegen/tslint.json b/types/escodegen/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/escodegen/tslint.json +++ b/types/escodegen/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/esprima-walk/tslint.json b/types/esprima-walk/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/esprima-walk/tslint.json +++ b/types/esprima-walk/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/estraverse/tslint.json b/types/estraverse/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/estraverse/tslint.json +++ b/types/estraverse/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/estree/tslint.json b/types/estree/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/estree/tslint.json +++ b/types/estree/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/event-loop-lag/tslint.json b/types/event-loop-lag/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/event-loop-lag/tslint.json +++ b/types/event-loop-lag/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/event-stream/tslint.json b/types/event-stream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/event-stream/tslint.json +++ b/types/event-stream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/event-to-promise/tslint.json b/types/event-to-promise/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/event-to-promise/tslint.json +++ b/types/event-to-promise/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/evernote/tslint.json b/types/evernote/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/evernote/tslint.json +++ b/types/evernote/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/exit/tslint.json b/types/exit/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/exit/tslint.json +++ b/types/exit/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/exorcist/tslint.json b/types/exorcist/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/exorcist/tslint.json +++ b/types/exorcist/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/expect.js/tslint.json b/types/expect.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/expect.js/tslint.json +++ b/types/expect.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/expectations/tslint.json b/types/expectations/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/expectations/tslint.json +++ b/types/expectations/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/expo/index.d.ts b/types/expo/index.d.ts index 88e6ae9fd6..b051946110 100644 --- a/types/expo/index.d.ts +++ b/types/expo/index.d.ts @@ -2616,7 +2616,7 @@ export interface SvgCommonProps { strokeWidth?: number | string; strokeOpacity?: number | string; strokeLinecap?: string; - strokeLineJoin?: string; + strokeLinejoin?: string; strokeDasharray?: any[]; strokeDashoffset?: any; transform?: string | object; diff --git a/types/express-brute-memcached/tslint.json b/types/express-brute-memcached/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-brute-memcached/tslint.json +++ b/types/express-brute-memcached/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-brute-mongo/tslint.json b/types/express-brute-mongo/tslint.json index 81e3db2614..1134194a62 100644 --- a/types/express-brute-mongo/tslint.json +++ b/types/express-brute-mongo/tslint.json @@ -4,6 +4,7 @@ // TODOs "ban-types": false, "dt-header": false, + "npm-naming": false, "no-unnecessary-class": false } } diff --git a/types/express-brute/tslint.json b/types/express-brute/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-brute/tslint.json +++ b/types/express-brute/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-debug/tslint.json b/types/express-debug/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-debug/tslint.json +++ b/types/express-debug/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-domain-middleware/tslint.json b/types/express-domain-middleware/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-domain-middleware/tslint.json +++ b/types/express-domain-middleware/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-handlebars/tslint.json b/types/express-handlebars/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-handlebars/tslint.json +++ b/types/express-handlebars/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-jwt/index.d.ts b/types/express-jwt/index.d.ts index d1029849cc..52d7d901ec 100644 --- a/types/express-jwt/index.d.ts +++ b/types/express-jwt/index.d.ts @@ -37,7 +37,6 @@ declare namespace jwt { export interface Options { secret: secretType | SecretCallback | SecretCallbackLong; userProperty?: string; - skip?: string[]; credentialsRequired?: boolean; isRevoked?: IsRevokedCallback; requestProperty?: string; diff --git a/types/express-jwt/tslint.json b/types/express-jwt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-jwt/tslint.json +++ b/types/express-jwt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-less/tslint.json b/types/express-less/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-less/tslint.json +++ b/types/express-less/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-minify/tslint.json b/types/express-minify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-minify/tslint.json +++ b/types/express-minify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-mung/tslint.json b/types/express-mung/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-mung/tslint.json +++ b/types/express-mung/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-myconnection/tslint.json b/types/express-myconnection/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-myconnection/tslint.json +++ b/types/express-myconnection/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-openapi/tslint.json b/types/express-openapi/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-openapi/tslint.json +++ b/types/express-openapi/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-partials/tslint.json b/types/express-partials/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-partials/tslint.json +++ b/types/express-partials/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-route-fs/tslint.json b/types/express-route-fs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-route-fs/tslint.json +++ b/types/express-route-fs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-unless/tslint.json b/types/express-unless/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-unless/tslint.json +++ b/types/express-unless/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/express-useragent/tslint.json b/types/express-useragent/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/express-useragent/tslint.json +++ b/types/express-useragent/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/extjs/tslint.json b/types/extjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/extjs/tslint.json +++ b/types/extjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/eyes/tslint.json b/types/eyes/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/eyes/tslint.json +++ b/types/eyes/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fabric/fabric-impl.d.ts b/types/fabric/fabric-impl.d.ts index 5b2a7c13af..d800fe01bc 100644 --- a/types/fabric/fabric-impl.d.ts +++ b/types/fabric/fabric-impl.d.ts @@ -143,7 +143,7 @@ interface IDataURLOptions { interface IEvent { e: Event; target?: Object; - transform?: { corner: string }; + transform?: { corner: string, original: Object, width: number }; } interface IFillOptions { @@ -2212,10 +2212,10 @@ export class Image { * Sets image element for this instance to a specified one. * If filters defined they are applied to new image. * You might need to call `canvas.renderAll` and `object.setCoords` after replacing, to render new image and update controls area. - * @param [callback] Callback is invoked when all filters have been applied and new image is generated + * @param element image element * @param [options] Options object */ - setElement(element: HTMLImageElement, callback: Function, options: IImageOptions): Image; + setElement(element: HTMLImageElement, options?: IImageOptions): Image; /** * Delete a single texture if in webgl mode */ @@ -3642,6 +3642,9 @@ export class Polyline extends Object { * @param [skipOffset] Whether points offsetting should be skipped */ constructor(points: Array<{ x: number; y: number }>, options?: IPolylineOptions); + + pathOffset: Point; + /** * List of attribute names to account for when parsing SVG element (used by `fabric.Polygon.fromElement`) */ diff --git a/types/fabric/index.d.ts b/types/fabric/index.d.ts index 3897987589..7444f481b8 100644 --- a/types/fabric/index.d.ts +++ b/types/fabric/index.d.ts @@ -9,6 +9,7 @@ // Bradley Hill // Bryan Krol // Glenn Gartner +// Codertx // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.1 export import fabric = require("./fabric-impl"); diff --git a/types/facebook-js-sdk/tslint.json b/types/facebook-js-sdk/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/facebook-js-sdk/tslint.json +++ b/types/facebook-js-sdk/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/facebook-pixel/tslint.json b/types/facebook-pixel/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/facebook-pixel/tslint.json +++ b/types/facebook-pixel/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/faker/tslint.json b/types/faker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/faker/tslint.json +++ b/types/faker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/falcor-express/tslint.json b/types/falcor-express/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/falcor-express/tslint.json +++ b/types/falcor-express/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/falcor-http-datasource/tslint.json b/types/falcor-http-datasource/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/falcor-http-datasource/tslint.json +++ b/types/falcor-http-datasource/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/falcor-json-graph/tslint.json b/types/falcor-json-graph/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/falcor-json-graph/tslint.json +++ b/types/falcor-json-graph/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/falcor-router/tslint.json b/types/falcor-router/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/falcor-router/tslint.json +++ b/types/falcor-router/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/famous/tslint.json b/types/famous/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/famous/tslint.json +++ b/types/famous/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/farbtastic/tslint.json b/types/farbtastic/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/farbtastic/tslint.json +++ b/types/farbtastic/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fast-levenshtein/tslint.json b/types/fast-levenshtein/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fast-levenshtein/tslint.json +++ b/types/fast-levenshtein/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fast-stats/tslint.json b/types/fast-stats/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fast-stats/tslint.json +++ b/types/fast-stats/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fastclick/tslint.json b/types/fastclick/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fastclick/tslint.json +++ b/types/fastclick/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/favico.js/tslint.json b/types/favico.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/favico.js/tslint.json +++ b/types/favico.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fb/tslint.json b/types/fb/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fb/tslint.json +++ b/types/fb/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fbemitter/tslint.json b/types/fbemitter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fbemitter/tslint.json +++ b/types/fbemitter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/featherlight/tslint.json b/types/featherlight/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/featherlight/tslint.json +++ b/types/featherlight/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fhir/tslint.json b/types/fhir/tslint.json index e87060ef20..9f58325d7f 100644 --- a/types/fhir/tslint.json +++ b/types/fhir/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fibers/tslint.json b/types/fibers/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fibers/tslint.json +++ b/types/fibers/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/field/tslint.json b/types/field/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/field/tslint.json +++ b/types/field/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/filesystem/tslint.json b/types/filesystem/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/filesystem/tslint.json +++ b/types/filesystem/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/filewriter/tslint.json b/types/filewriter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/filewriter/tslint.json +++ b/types/filewriter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fill-pdf/tslint.json b/types/fill-pdf/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fill-pdf/tslint.json +++ b/types/fill-pdf/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/finalhandler/tslint.json b/types/finalhandler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/finalhandler/tslint.json +++ b/types/finalhandler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/finch/tslint.json b/types/finch/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/finch/tslint.json +++ b/types/finch/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fingerprintjs/tslint.json b/types/fingerprintjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fingerprintjs/tslint.json +++ b/types/fingerprintjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/firebase-client/tslint.json b/types/firebase-client/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/firebase-client/tslint.json +++ b/types/firebase-client/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/firebase-token-generator/tslint.json b/types/firebase-token-generator/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/firebase-token-generator/tslint.json +++ b/types/firebase-token-generator/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/firefox/tslint.json b/types/firefox/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/firefox/tslint.json +++ b/types/firefox/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fixed-data-table/tslint.json b/types/fixed-data-table/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fixed-data-table/tslint.json +++ b/types/fixed-data-table/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flake-idgen/tslint.json b/types/flake-idgen/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flake-idgen/tslint.json +++ b/types/flake-idgen/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flat/tslint.json b/types/flat/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flat/tslint.json +++ b/types/flat/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flatbuffers/tslint.json b/types/flatbuffers/tslint.json index 26bcea6634..a083d120e7 100644 --- a/types/flatbuffers/tslint.json +++ b/types/flatbuffers/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { - "dt-header": false + "npm-naming": false, + "dt-header": false } } diff --git a/types/flexslider/tslint.json b/types/flexslider/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flexslider/tslint.json +++ b/types/flexslider/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flight/tslint.json b/types/flight/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flight/tslint.json +++ b/types/flight/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flightplan/tslint.json b/types/flightplan/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flightplan/tslint.json +++ b/types/flightplan/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flipsnap/tslint.json b/types/flipsnap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flipsnap/tslint.json +++ b/types/flipsnap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flot/tslint.json b/types/flot/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flot/tslint.json +++ b/types/flot/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/flowjs/tslint.json b/types/flowjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/flowjs/tslint.json +++ b/types/flowjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fluent-react/index.d.ts b/types/fluent-react/index.d.ts index 5ffc93d874..b3fa7c9dec 100644 --- a/types/fluent-react/index.d.ts +++ b/types/fluent-react/index.d.ts @@ -2,7 +2,7 @@ // Project: http://projectfluent.org // Definitions by: Huy Nguyen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.8 +// TypeScript Version: 3.3 import * as React from 'react'; import { @@ -76,7 +76,7 @@ export type Matching = { */ export type Shared< InjectedProps, - DecorationTargetProps extends Shared + DecorationTargetProps > = { [P in Extract]?: InjectedProps[P] extends DecorationTargetProps[P] ? DecorationTargetProps[P] : never; }; diff --git a/types/fluent/fluent-tests.ts b/types/fluent/fluent-tests.ts index d2fcd4a6c4..90b4bffa61 100644 --- a/types/fluent/fluent-tests.ts +++ b/types/fluent/fluent-tests.ts @@ -29,6 +29,7 @@ const bundle4 = new FluentBundle(['en-US'], { // FluentBundle addMessages examples: bundle1.addMessages('foo = Foo'); +bundle2.hasMessage('foo'); bundle2.getMessage('foo'); // FluentBundle addResource examples: @@ -42,3 +43,8 @@ bundle1.addMessages('hello = Hello, { $name }!'); const hello = bundle2.getMessage('hello'); bundle3.format(hello, { name: 'Jane' }, errors2); bundle3.format(hello, undefined, errors2); + +for (const [id, message] of bundle1.messages) { + bundle1.getMessage(id); + bundle1.format(message); +} diff --git a/types/fluent/index.d.ts b/types/fluent/index.d.ts index 56014044ab..8520443354 100644 --- a/types/fluent/index.d.ts +++ b/types/fluent/index.d.ts @@ -1,6 +1,6 @@ -// Type definitions for fluent 0.10 +// Type definitions for fluent 0.11 // Project: http://projectfluent.org -// Definitions by: Huy Nguyen +// Definitions by: Huy Nguyen , James Nimlos // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.2 @@ -28,6 +28,8 @@ export class FluentResource extends Map { export class FluentBundle { constructor(locales: string | string[], options?: FluentBundleContructorOptions); + messages: IterableIterator<[string, FluentNode[]]>; + hasMessage(source: string): boolean; addMessages(source: string): string[]; getMessage(id: string): FluentNode[]; format(message: FluentNode[], args?: object, errors?: string[]): string; diff --git a/types/fluent/tsconfig.json b/types/fluent/tsconfig.json index 64e2460dcd..c08fe97570 100644 --- a/types/fluent/tsconfig.json +++ b/types/fluent/tsconfig.json @@ -4,6 +4,7 @@ "lib": [ "es6" ], + "target": "es6", "noImplicitAny": true, "noImplicitThis": true, "strictNullChecks": true, diff --git a/types/fluxxor/tslint.json b/types/fluxxor/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fluxxor/tslint.json +++ b/types/fluxxor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fontfaceobserver/tslint.json b/types/fontfaceobserver/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fontfaceobserver/tslint.json +++ b/types/fontfaceobserver/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fontoxml/tslint.json b/types/fontoxml/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fontoxml/tslint.json +++ b/types/fontoxml/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/forge-di/tslint.json b/types/forge-di/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/forge-di/tslint.json +++ b/types/forge-di/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/form-serializer/tslint.json b/types/form-serializer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/form-serializer/tslint.json +++ b/types/form-serializer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/format-number/format-number-tests.ts b/types/format-number/format-number-tests.ts new file mode 100644 index 0000000000..72e3cecdba --- /dev/null +++ b/types/format-number/format-number-tests.ts @@ -0,0 +1,5 @@ +import createFormatNumber from "format-number"; + +createFormatNumber({ round: 2 }); // $ExpectType (number: number, overrideOptions?: { noUnits: boolean; noSeparator: boolean; } | undefined) => string + +createFormatNumber({ round: 2 })(12); // $ExpectType string diff --git a/types/format-number/index.d.ts b/types/format-number/index.d.ts new file mode 100644 index 0000000000..03eafefb45 --- /dev/null +++ b/types/format-number/index.d.ts @@ -0,0 +1,30 @@ +// Type definitions for format-number 2.0 +// Project: https://github.com/componitable/format-number +// Definitions by: Fedai Kaya +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +export default function(options?: { + negativeType?: "right" | "left" | "brackets" | null; + negativeLeftSymbol?: string; + negative?: "R" | null; + negativeRightSymbol?: string; + negativeLeftOut?: boolean; + negativeOut?: boolean; + prefix?: string; + suffix?: string; + integerSeparator?: string; + separator?: string; + decimalsSeparator?: string; + decimal?: string; + padLeft?: number; + padRight?: number; + round?: number; + truncate?: number; + allowedSeparators?: string[]; +}): ( + number: number, + overrideOptions?: { + noUnits: boolean; + noSeparator: boolean; + } +) => string; diff --git a/types/format-number/tsconfig.json b/types/format-number/tsconfig.json new file mode 100644 index 0000000000..77b1c052ad --- /dev/null +++ b/types/format-number/tsconfig.json @@ -0,0 +1,16 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": ["index.d.ts", "format-number-tests.ts"] +} diff --git a/types/format-number/tslint.json b/types/format-number/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/format-number/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/formidable/tslint.json b/types/formidable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/formidable/tslint.json +++ b/types/formidable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fossil-delta/tslint.json b/types/fossil-delta/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fossil-delta/tslint.json +++ b/types/fossil-delta/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/foundation/tslint.json b/types/foundation/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/foundation/tslint.json +++ b/types/foundation/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fpsmeter/tslint.json b/types/fpsmeter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fpsmeter/tslint.json +++ b/types/fpsmeter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/freedom/tslint.json b/types/freedom/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/freedom/tslint.json +++ b/types/freedom/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/from/tslint.json b/types/from/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/from/tslint.json +++ b/types/from/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fromjs/tslint.json b/types/fromjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fromjs/tslint.json +++ b/types/fromjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fromnow/tslint.json b/types/fromnow/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fromnow/tslint.json +++ b/types/fromnow/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fs-ext/tslint.json b/types/fs-ext/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fs-ext/tslint.json +++ b/types/fs-ext/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fs-finder/tslint.json b/types/fs-finder/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fs-finder/tslint.json +++ b/types/fs-finder/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fs-mock/tslint.json b/types/fs-mock/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fs-mock/tslint.json +++ b/types/fs-mock/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ftdomdelegate/tslint.json b/types/ftdomdelegate/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ftdomdelegate/tslint.json +++ b/types/ftdomdelegate/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ftp/tslint.json b/types/ftp/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/ftp/tslint.json +++ b/types/ftp/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/ftpd/tslint.json b/types/ftpd/tslint.json index b6afb8acee..4017299a0e 100644 --- a/types/ftpd/tslint.json +++ b/types/ftpd/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fullname/tslint.json b/types/fullname/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fullname/tslint.json +++ b/types/fullname/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fullpage.js/tslint.json b/types/fullpage.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fullpage.js/tslint.json +++ b/types/fullpage.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fuzzaldrin-plus/tslint.json b/types/fuzzaldrin-plus/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fuzzaldrin-plus/tslint.json +++ b/types/fuzzaldrin-plus/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/fxn/tslint.json b/types/fxn/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/fxn/tslint.json +++ b/types/fxn/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gae.channel.api/tslint.json b/types/gae.channel.api/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gae.channel.api/tslint.json +++ b/types/gae.channel.api/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gamequery/tslint.json b/types/gamequery/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gamequery/tslint.json +++ b/types/gamequery/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gandi-livedns/tslint.json b/types/gandi-livedns/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gandi-livedns/tslint.json +++ b/types/gandi-livedns/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.analytics/tslint.json b/types/gapi.analytics/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.analytics/tslint.json +++ b/types/gapi.analytics/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.calendar/tslint.json b/types/gapi.calendar/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.calendar/tslint.json +++ b/types/gapi.calendar/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.drive/tslint.json b/types/gapi.drive/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.drive/tslint.json +++ b/types/gapi.drive/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.pagespeedonline/tslint.json b/types/gapi.pagespeedonline/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.pagespeedonline/tslint.json +++ b/types/gapi.pagespeedonline/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.people/tslint.json b/types/gapi.people/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.people/tslint.json +++ b/types/gapi.people/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.plus/tslint.json b/types/gapi.plus/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.plus/tslint.json +++ b/types/gapi.plus/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.translate/tslint.json b/types/gapi.translate/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.translate/tslint.json +++ b/types/gapi.translate/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.urlshortener/tslint.json b/types/gapi.urlshortener/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.urlshortener/tslint.json +++ b/types/gapi.urlshortener/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.youtube/tslint.json b/types/gapi.youtube/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.youtube/tslint.json +++ b/types/gapi.youtube/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi.youtubeanalytics/tslint.json b/types/gapi.youtubeanalytics/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi.youtubeanalytics/tslint.json +++ b/types/gapi.youtubeanalytics/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gapi/tslint.json b/types/gapi/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gapi/tslint.json +++ b/types/gapi/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/generic-functions/tslint.json b/types/generic-functions/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/generic-functions/tslint.json +++ b/types/generic-functions/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gently/tslint.json b/types/gently/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gently/tslint.json +++ b/types/gently/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/geoip-lite/tslint.json b/types/geoip-lite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/geoip-lite/tslint.json +++ b/types/geoip-lite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/geojson/index.d.ts b/types/geojson/index.d.ts index 90beca01c1..3a486b66b1 100644 --- a/types/geojson/index.d.ts +++ b/types/geojson/index.d.ts @@ -1,5 +1,5 @@ -// Type definitions for geojson 7946.0 -// Project: https://geojson.org/, https://github.com/caseycesari/geojson.js +// Type definitions for non-npm package geojson 7946.0 +// Project: https://geojson.org/ // Definitions by: Jacob Bruun // Arne Schubert // Jeff Jacobson diff --git a/types/geojson2osm/tslint.json b/types/geojson2osm/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/geojson2osm/tslint.json +++ b/types/geojson2osm/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/geometry-dom/tslint.json b/types/geometry-dom/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/geometry-dom/tslint.json +++ b/types/geometry-dom/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/get-port/get-port-tests.ts b/types/get-port/get-port-tests.ts deleted file mode 100644 index 5e47c33c1a..0000000000 --- a/types/get-port/get-port-tests.ts +++ /dev/null @@ -1,10 +0,0 @@ -import getPort = require('get-port'); - -// $ExpectType Promise -getPort(); -// $ExpectType Promise -getPort({ port: 3000 }); -// $ExpectType Promise -getPort({ port: [3000, 3001] }); -// $ExpectType Promise -getPort({ host: 'foo.local' }); diff --git a/types/get-port/index.d.ts b/types/get-port/index.d.ts deleted file mode 100644 index 9af3b311fc..0000000000 --- a/types/get-port/index.d.ts +++ /dev/null @@ -1,12 +0,0 @@ -// Type definitions for get-port 4.0 -// Project: https://github.com/sindresorhus/get-port -// Definitions by: York Yao -// BendingBender -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare function getPort(options?: { - port?: number | ReadonlyArray; - host?: string; -}): Promise; - -export = getPort; diff --git a/types/get-value/get-value-tests.ts b/types/get-value/get-value-tests.ts index 9e7534e000..c6cf6c7de4 100644 --- a/types/get-value/get-value-tests.ts +++ b/types/get-value/get-value-tests.ts @@ -6,6 +6,9 @@ get(obj, "a"); get(obj, "a.b"); get(obj, "a.b.c"); get(obj, "a.b.c.d"); +get(obj, ['a']); +get(obj, ['a', 'b', 'c']); +get(obj, ['a', 'b', 'c', 'd']); { const isEnumerable = Object.prototype.propertyIsEnumerable; diff --git a/types/get-value/index.d.ts b/types/get-value/index.d.ts index 70cf0286e7..04dabe5101 100644 --- a/types/get-value/index.d.ts +++ b/types/get-value/index.d.ts @@ -1,13 +1,14 @@ // Type definitions for get-value 3.0 // Project: https://github.com/jonschlinkert/get-value // Definitions by: Daniel Rosenwasser +// Mathew Allen // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.4 export = get; declare function get(obj: T): T; -declare function get(obj: object, key: string, options?: get.Options): any; +declare function get(obj: object, key: string | string[], options?: get.Options): any; declare namespace get { interface Options { diff --git a/types/gijgo/tslint.json b/types/gijgo/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gijgo/tslint.json +++ b/types/gijgo/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/giraffe/tslint.json b/types/giraffe/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/giraffe/tslint.json +++ b/types/giraffe/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/git-config/tslint.json b/types/git-config/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/git-config/tslint.json +++ b/types/git-config/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/git-rev/tslint.json b/types/git-rev/tslint.json index 65c83fb1e3..1c56ba06b6 100644 --- a/types/git-rev/tslint.json +++ b/types/git-rev/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { + "npm-naming": false, "dt-header": false } } diff --git a/types/git/tslint.json b/types/git/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/git/tslint.json +++ b/types/git/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gl-matrix/tslint.json b/types/gl-matrix/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gl-matrix/tslint.json +++ b/types/gl-matrix/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gldatepicker/tslint.json b/types/gldatepicker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gldatepicker/tslint.json +++ b/types/gldatepicker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/glidejs/tslint.json b/types/glidejs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/glidejs/tslint.json +++ b/types/glidejs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/glob-expand/tslint.json b/types/glob-expand/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/glob-expand/tslint.json +++ b/types/glob-expand/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/glob-parent/index.d.ts b/types/glob-parent/index.d.ts index 052bbcd1db..b41cc48c31 100644 --- a/types/glob-parent/index.d.ts +++ b/types/glob-parent/index.d.ts @@ -1,5 +1,5 @@ // Type definitions for glob-parent 3.1 -// Project: https://github.com/es128/glob-parent +// Project: https://github.com/gulpjs/glob-parent // Definitions by: mrmlnc // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped diff --git a/types/glob-stream/tslint.json b/types/glob-stream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/glob-stream/tslint.json +++ b/types/glob-stream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/globalize-compiler/tslint.json b/types/globalize-compiler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/globalize-compiler/tslint.json +++ b/types/globalize-compiler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/globalize/tslint.json b/types/globalize/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/globalize/tslint.json +++ b/types/globalize/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/go/tslint.json b/types/go/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/go/tslint.json +++ b/types/go/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-apps-script/apis/admin/directory_v1.d.ts b/types/google-apps-script/apis/admin/directory_v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/admin/reports_v1.d.ts b/types/google-apps-script/apis/admin/reports_v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/adsense/v1.4.d.ts b/types/google-apps-script/apis/adsense/v1.4.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/adsense_v1_4.d.ts b/types/google-apps-script/apis/adsense_v1_4.d.ts new file mode 100644 index 0000000000..43113d9c99 --- /dev/null +++ b/types/google-apps-script/apis/adsense_v1_4.d.ts @@ -0,0 +1,434 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Adsense_v1_4 { + namespace Collection { + namespace Accounts { + namespace Adunits { + export interface CustomchannelsCollection { + // List all custom channels which the specified ad unit belongs to. + list(accountId: string, adClientId: string, adUnitId: string): Adsense_v1_4.Schema.CustomChannels; + // List all custom channels which the specified ad unit belongs to. + list(accountId: string, adClientId: string, adUnitId: string, optionalArgs: object): Adsense_v1_4.Schema.CustomChannels; + } + } + namespace Customchannels { + export interface AdunitsCollection { + // List all ad units in the specified custom channel. + list(accountId: string, adClientId: string, customChannelId: string): Adsense_v1_4.Schema.AdUnits; + // List all ad units in the specified custom channel. + list(accountId: string, adClientId: string, customChannelId: string, optionalArgs: object): Adsense_v1_4.Schema.AdUnits; + } + } + namespace Reports { + export interface SavedCollection { + // Generate an AdSense report based on the saved report ID sent in the query parameters. + generate(accountId: string, savedReportId: string): Adsense_v1_4.Schema.AdsenseReportsGenerateResponse; + // Generate an AdSense report based on the saved report ID sent in the query parameters. + generate(accountId: string, savedReportId: string, optionalArgs: object): Adsense_v1_4.Schema.AdsenseReportsGenerateResponse; + // List all saved reports in the specified AdSense account. + list(accountId: string): Adsense_v1_4.Schema.SavedReports; + // List all saved reports in the specified AdSense account. + list(accountId: string, optionalArgs: object): Adsense_v1_4.Schema.SavedReports; + } + } + export interface AdclientsCollection { + // Get Auto ad code for a given ad client. + getAdCode(accountId: string, adClientId: string): Adsense_v1_4.Schema.AdCode; + // List all ad clients in the specified account. + list(accountId: string): Adsense_v1_4.Schema.AdClients; + // List all ad clients in the specified account. + list(accountId: string, optionalArgs: object): Adsense_v1_4.Schema.AdClients; + } + export interface AdunitsCollection { + Customchannels?: Adsense_v1_4.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_v1_4.Schema.AdUnit; + // Get ad code for the specified ad unit. + getAdCode(accountId: string, adClientId: string, adUnitId: string): Adsense_v1_4.Schema.AdCode; + // List all ad units in the specified ad client for the specified account. + list(accountId: string, adClientId: string): Adsense_v1_4.Schema.AdUnits; + // List all ad units in the specified ad client for the specified account. + list(accountId: string, adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.AdUnits; + } + export interface AlertsCollection { + // List the alerts for the specified AdSense account. + list(accountId: string): Adsense_v1_4.Schema.Alerts; + // List the alerts for the specified AdSense account. + list(accountId: string, optionalArgs: object): Adsense_v1_4.Schema.Alerts; + // Dismiss (delete) the specified alert from the specified publisher AdSense account. + remove(accountId: string, alertId: string): void; + } + export interface CustomchannelsCollection { + Adunits?: Adsense_v1_4.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_v1_4.Schema.CustomChannel; + // List all custom channels in the specified ad client for the specified account. + list(accountId: string, adClientId: string): Adsense_v1_4.Schema.CustomChannels; + // List all custom channels in the specified ad client for the specified account. + list(accountId: string, adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.CustomChannels; + } + export interface PaymentsCollection { + // List the payments for the specified AdSense account. + list(accountId: string): Adsense_v1_4.Schema.Payments; + } + export interface ReportsCollection { + Saved?: Adsense_v1_4.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_v1_4.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_v1_4.Schema.AdsenseReportsGenerateResponse; + } + export interface SavedadstylesCollection { + // List a specific saved ad style for the specified account. + get(accountId: string, savedAdStyleId: string): Adsense_v1_4.Schema.SavedAdStyle; + // List all saved ad styles in the specified account. + list(accountId: string): Adsense_v1_4.Schema.SavedAdStyles; + // List all saved ad styles in the specified account. + list(accountId: string, optionalArgs: object): Adsense_v1_4.Schema.SavedAdStyles; + } + export interface UrlchannelsCollection { + // List all URL channels in the specified ad client for the specified account. + list(accountId: string, adClientId: string): Adsense_v1_4.Schema.UrlChannels; + // List all URL channels in the specified ad client for the specified account. + list(accountId: string, adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.UrlChannels; + } + } + namespace Adunits { + export interface CustomchannelsCollection { + // List all custom channels which the specified ad unit belongs to. + list(adClientId: string, adUnitId: string): Adsense_v1_4.Schema.CustomChannels; + // List all custom channels which the specified ad unit belongs to. + list(adClientId: string, adUnitId: string, optionalArgs: object): Adsense_v1_4.Schema.CustomChannels; + } + } + namespace Customchannels { + export interface AdunitsCollection { + // List all ad units in the specified custom channel. + list(adClientId: string, customChannelId: string): Adsense_v1_4.Schema.AdUnits; + // List all ad units in the specified custom channel. + list(adClientId: string, customChannelId: string, optionalArgs: object): Adsense_v1_4.Schema.AdUnits; + } + } + namespace Metadata { + export interface DimensionsCollection { + // List the metadata for the dimensions available to this AdSense account. + list(): Adsense_v1_4.Schema.Metadata; + } + export interface MetricsCollection { + // List the metadata for the metrics available to this AdSense account. + list(): Adsense_v1_4.Schema.Metadata; + } + } + namespace Reports { + export interface SavedCollection { + // Generate an AdSense report based on the saved report ID sent in the query parameters. + generate(savedReportId: string): Adsense_v1_4.Schema.AdsenseReportsGenerateResponse; + // Generate an AdSense report based on the saved report ID sent in the query parameters. + generate(savedReportId: string, optionalArgs: object): Adsense_v1_4.Schema.AdsenseReportsGenerateResponse; + // List all saved reports in this AdSense account. + list(): Adsense_v1_4.Schema.SavedReports; + // List all saved reports in this AdSense account. + list(optionalArgs: object): Adsense_v1_4.Schema.SavedReports; + } + } + export interface AccountsCollection { + Adclients?: Adsense_v1_4.Collection.Accounts.AdclientsCollection; + Adunits?: Adsense_v1_4.Collection.Accounts.AdunitsCollection; + Alerts?: Adsense_v1_4.Collection.Accounts.AlertsCollection; + Customchannels?: Adsense_v1_4.Collection.Accounts.CustomchannelsCollection; + Payments?: Adsense_v1_4.Collection.Accounts.PaymentsCollection; + Reports?: Adsense_v1_4.Collection.Accounts.ReportsCollection; + Savedadstyles?: Adsense_v1_4.Collection.Accounts.SavedadstylesCollection; + Urlchannels?: Adsense_v1_4.Collection.Accounts.UrlchannelsCollection; + // Get information about the selected AdSense account. + get(accountId: string): Adsense_v1_4.Schema.Account; + // Get information about the selected AdSense account. + get(accountId: string, optionalArgs: object): Adsense_v1_4.Schema.Account; + // List all accounts available to this AdSense account. + list(): Adsense_v1_4.Schema.Accounts; + // List all accounts available to this AdSense account. + list(optionalArgs: object): Adsense_v1_4.Schema.Accounts; + } + export interface AdclientsCollection { + // List all ad clients in this AdSense account. + list(): Adsense_v1_4.Schema.AdClients; + // List all ad clients in this AdSense account. + list(optionalArgs: object): Adsense_v1_4.Schema.AdClients; + } + export interface AdunitsCollection { + Customchannels?: Adsense_v1_4.Collection.Adunits.CustomchannelsCollection; + // Gets the specified ad unit in the specified ad client. + get(adClientId: string, adUnitId: string): Adsense_v1_4.Schema.AdUnit; + // Get ad code for the specified ad unit. + getAdCode(adClientId: string, adUnitId: string): Adsense_v1_4.Schema.AdCode; + // List all ad units in the specified ad client for this AdSense account. + list(adClientId: string): Adsense_v1_4.Schema.AdUnits; + // List all ad units in the specified ad client for this AdSense account. + list(adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.AdUnits; + } + export interface AlertsCollection { + // List the alerts for this AdSense account. + list(): Adsense_v1_4.Schema.Alerts; + // List the alerts for this AdSense account. + list(optionalArgs: object): Adsense_v1_4.Schema.Alerts; + // Dismiss (delete) the specified alert from the publisher's AdSense account. + remove(alertId: string): void; + } + export interface CustomchannelsCollection { + Adunits?: Adsense_v1_4.Collection.Customchannels.AdunitsCollection; + // Get the specified custom channel from the specified ad client. + get(adClientId: string, customChannelId: string): Adsense_v1_4.Schema.CustomChannel; + // List all custom channels in the specified ad client for this AdSense account. + list(adClientId: string): Adsense_v1_4.Schema.CustomChannels; + // List all custom channels in the specified ad client for this AdSense account. + list(adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.CustomChannels; + } + export interface MetadataCollection { + Dimensions?: Adsense_v1_4.Collection.Metadata.DimensionsCollection; + Metrics?: Adsense_v1_4.Collection.Metadata.MetricsCollection; + } + export interface PaymentsCollection { + // List the payments for this AdSense account. + list(): Adsense_v1_4.Schema.Payments; + } + export interface ReportsCollection { + Saved?: Adsense_v1_4.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_v1_4.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_v1_4.Schema.AdsenseReportsGenerateResponse; + } + export interface SavedadstylesCollection { + // Get a specific saved ad style from the user's account. + get(savedAdStyleId: string): Adsense_v1_4.Schema.SavedAdStyle; + // List all saved ad styles in the user's account. + list(): Adsense_v1_4.Schema.SavedAdStyles; + // List all saved ad styles in the user's account. + list(optionalArgs: object): Adsense_v1_4.Schema.SavedAdStyles; + } + export interface UrlchannelsCollection { + // List all URL channels in the specified ad client for this AdSense account. + list(adClientId: string): Adsense_v1_4.Schema.UrlChannels; + // List all URL channels in the specified ad client for this AdSense account. + list(adClientId: string, optionalArgs: object): Adsense_v1_4.Schema.UrlChannels; + } + } + namespace Schema { + export interface Account { + creation_time?: string; + id?: string; + kind?: string; + name?: string; + premium?: boolean; + subAccounts?: Adsense_v1_4.Schema.Account[]; + timezone?: string; + } + export interface Accounts { + etag?: string; + items?: Adsense_v1_4.Schema.Account[]; + kind?: string; + nextPageToken?: string; + } + export interface AdClient { + arcOptIn?: boolean; + id?: string; + kind?: string; + productCode?: string; + supportsReporting?: boolean; + } + export interface AdClients { + etag?: string; + items?: Adsense_v1_4.Schema.AdClient[]; + kind?: string; + nextPageToken?: string; + } + export interface AdCode { + adCode?: string; + ampBody?: string; + ampHead?: string; + kind?: string; + } + export interface AdStyle { + colors?: Adsense_v1_4.Schema.AdStyleColors; + corners?: string; + font?: Adsense_v1_4.Schema.AdStyleFont; + kind?: string; + } + export interface AdStyleColors { + background?: string; + border?: string; + text?: string; + title?: string; + url?: string; + } + export interface AdStyleFont { + family?: string; + size?: string; + } + export interface AdUnit { + code?: string; + contentAdsSettings?: Adsense_v1_4.Schema.AdUnitContentAdsSettings; + customStyle?: Adsense_v1_4.Schema.AdStyle; + feedAdsSettings?: Adsense_v1_4.Schema.AdUnitFeedAdsSettings; + id?: string; + kind?: string; + mobileContentAdsSettings?: Adsense_v1_4.Schema.AdUnitMobileContentAdsSettings; + name?: string; + savedStyleId?: string; + status?: string; + } + export interface AdUnitContentAdsSettings { + backupOption?: Adsense_v1_4.Schema.AdUnitContentAdsSettingsBackupOption; + size?: string; + type?: string; + } + export interface AdUnitContentAdsSettingsBackupOption { + color?: string; + type?: string; + url?: string; + } + export interface AdUnitFeedAdsSettings { + adPosition?: string; + frequency?: number; + minimumWordCount?: number; + type?: string; + } + export interface AdUnitMobileContentAdsSettings { + markupLanguage?: string; + scriptingLanguage?: string; + size?: string; + type?: string; + } + export interface AdUnits { + etag?: string; + items?: Adsense_v1_4.Schema.AdUnit[]; + kind?: string; + nextPageToken?: string; + } + export interface AdsenseReportsGenerateResponse { + averages?: string[]; + endDate?: string; + headers?: Adsense_v1_4.Schema.AdsenseReportsGenerateResponseHeaders[]; + kind?: string; + rows?: String[][]; + startDate?: string; + totalMatchedRows?: string; + totals?: string[]; + warnings?: string[]; + } + export interface AdsenseReportsGenerateResponseHeaders { + currency?: string; + name?: string; + type?: string; + } + export interface Alert { + id?: string; + isDismissible?: boolean; + kind?: string; + message?: string; + severity?: string; + type?: string; + } + export interface Alerts { + items?: Adsense_v1_4.Schema.Alert[]; + kind?: string; + } + export interface CustomChannel { + code?: string; + id?: string; + kind?: string; + name?: string; + targetingInfo?: Adsense_v1_4.Schema.CustomChannelTargetingInfo; + } + export interface CustomChannelTargetingInfo { + adsAppearOn?: string; + description?: string; + location?: string; + siteLanguage?: string; + } + export interface CustomChannels { + etag?: string; + items?: Adsense_v1_4.Schema.CustomChannel[]; + kind?: string; + nextPageToken?: string; + } + export interface Metadata { + items?: Adsense_v1_4.Schema.ReportingMetadataEntry[]; + kind?: string; + } + export interface Payment { + id?: string; + kind?: string; + paymentAmount?: string; + paymentAmountCurrencyCode?: string; + paymentDate?: string; + } + export interface Payments { + items?: Adsense_v1_4.Schema.Payment[]; + kind?: string; + } + export interface ReportingMetadataEntry { + compatibleDimensions?: string[]; + compatibleMetrics?: string[]; + id?: string; + kind?: string; + requiredDimensions?: string[]; + requiredMetrics?: string[]; + supportedProducts?: string[]; + } + export interface SavedAdStyle { + adStyle?: Adsense_v1_4.Schema.AdStyle; + id?: string; + kind?: string; + name?: string; + } + export interface SavedAdStyles { + etag?: string; + items?: Adsense_v1_4.Schema.SavedAdStyle[]; + kind?: string; + nextPageToken?: string; + } + export interface SavedReport { + id?: string; + kind?: string; + name?: string; + } + export interface SavedReports { + etag?: string; + items?: Adsense_v1_4.Schema.SavedReport[]; + kind?: string; + nextPageToken?: string; + } + export interface UrlChannel { + id?: string; + kind?: string; + urlPattern?: string; + } + export interface UrlChannels { + etag?: string; + items?: Adsense_v1_4.Schema.UrlChannel[]; + kind?: string; + nextPageToken?: string; + } + } + } + export interface Adsense_v1_4 { + Accounts?: Adsense_v1_4.Collection.AccountsCollection; + Adclients?: Adsense_v1_4.Collection.AdclientsCollection; + Adunits?: Adsense_v1_4.Collection.AdunitsCollection; + Alerts?: Adsense_v1_4.Collection.AlertsCollection; + Customchannels?: Adsense_v1_4.Collection.CustomchannelsCollection; + Metadata?: Adsense_v1_4.Collection.MetadataCollection; + Payments?: Adsense_v1_4.Collection.PaymentsCollection; + Reports?: Adsense_v1_4.Collection.ReportsCollection; + Savedadstyles?: Adsense_v1_4.Collection.SavedadstylesCollection; + Urlchannels?: Adsense_v1_4.Collection.UrlchannelsCollection; + } +} + +declare var Adsense_v1_4: GoogleAppsScript.Adsense_v1_4; \ No newline at end of file diff --git a/types/google-apps-script/apis/analytics/v3.d.ts b/types/google-apps-script/apis/analytics/v3.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/analytics_v3.d.ts b/types/google-apps-script/apis/analytics_v3.d.ts new file mode 100644 index 0000000000..2bcccb5546 --- /dev/null +++ b/types/google-apps-script/apis/analytics_v3.d.ts @@ -0,0 +1,1339 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Analytics_v3 { + namespace Collection { + namespace Data { + export interface GaCollection { + // Returns Analytics data for a view (profile). + get(ids: string, start_date: string, end_date: string, metrics: string): Analytics_v3.Schema.GaData; + // Returns Analytics data for a view (profile). + get(ids: string, start_date: string, end_date: string, metrics: string, optionalArgs: object): Analytics_v3.Schema.GaData; + } + export interface McfCollection { + // Returns Analytics Multi-Channel Funnels data for a view (profile). + get(ids: string, start_date: string, end_date: string, metrics: string): Analytics_v3.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_v3.Schema.McfData; + } + export interface RealtimeCollection { + // Returns real time data for a view (profile). + get(ids: string, metrics: string): Analytics_v3.Schema.RealtimeData; + // Returns real time data for a view (profile). + get(ids: string, metrics: string, optionalArgs: object): Analytics_v3.Schema.RealtimeData; + } + } + namespace Management { + export interface AccountSummariesCollection { + // Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. + list(): Analytics_v3.Schema.AccountSummaries; + // Lists account summaries (lightweight tree comprised of accounts/properties/profiles) to which the user has access. + list(optionalArgs: object): Analytics_v3.Schema.AccountSummaries; + } + export interface AccountUserLinksCollection { + // Adds a new user to the given account. + insert(resource: Schema.EntityUserLink, accountId: string): Analytics_v3.Schema.EntityUserLink; + // Lists account-user links for a given account. + list(accountId: string): Analytics_v3.Schema.EntityUserLinks; + // Lists account-user links for a given account. + list(accountId: string, optionalArgs: object): Analytics_v3.Schema.EntityUserLinks; + // Removes a user from the given account. + remove(accountId: string, linkId: string): void; + // Updates permissions for an existing user on the given account. + update(resource: Schema.EntityUserLink, accountId: string, linkId: string): Analytics_v3.Schema.EntityUserLink; + } + export interface AccountsCollection { + // Lists all accounts to which the user has access. + list(): Analytics_v3.Schema.Accounts; + // Lists all accounts to which the user has access. + list(optionalArgs: object): Analytics_v3.Schema.Accounts; + } + export interface ClientIdCollection { + // Hashes the given Client ID. + hashClientId(resource: Analytics_v3.Schema.HashClientIdRequest): Analytics_v3.Schema.HashClientIdResponse; + } + export interface CustomDataSourcesCollection { + // List custom data sources to which the user has access. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.CustomDataSources; + // List custom data sources to which the user has access. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.CustomDataSources; + } + export interface CustomDimensionsCollection { + // Get a custom dimension to which the user has access. + get(accountId: string, webPropertyId: string, customDimensionId: string): Analytics_v3.Schema.CustomDimension; + // Create a new custom dimension. + insert(resource: Schema.CustomDimension, accountId: string, webPropertyId: string): Analytics_v3.Schema.CustomDimension; + // Lists custom dimensions to which the user has access. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.CustomDimensions; + // Lists custom dimensions to which the user has access. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.CustomDimensions; + // Updates an existing custom dimension. This method supports patch semantics. + patch(resource: Schema.CustomDimension, accountId: string, webPropertyId: string, customDimensionId: string): Analytics_v3.Schema.CustomDimension; + // Updates an existing custom dimension. This method supports patch semantics. + patch(resource: Schema.CustomDimension, accountId: string, webPropertyId: string, customDimensionId: string, optionalArgs: object): Analytics_v3.Schema.CustomDimension; + // Updates an existing custom dimension. + update(resource: Schema.CustomDimension, accountId: string, webPropertyId: string, customDimensionId: string): Analytics_v3.Schema.CustomDimension; + // Updates an existing custom dimension. + update(resource: Schema.CustomDimension, accountId: string, webPropertyId: string, customDimensionId: string, optionalArgs: object): Analytics_v3.Schema.CustomDimension; + } + export interface CustomMetricsCollection { + // Get a custom metric to which the user has access. + get(accountId: string, webPropertyId: string, customMetricId: string): Analytics_v3.Schema.CustomMetric; + // Create a new custom metric. + insert(resource: Schema.CustomMetric, accountId: string, webPropertyId: string): Analytics_v3.Schema.CustomMetric; + // Lists custom metrics to which the user has access. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.CustomMetrics; + // Lists custom metrics to which the user has access. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.CustomMetrics; + // Updates an existing custom metric. This method supports patch semantics. + patch(resource: Schema.CustomMetric, accountId: string, webPropertyId: string, customMetricId: string): Analytics_v3.Schema.CustomMetric; + // Updates an existing custom metric. This method supports patch semantics. + patch(resource: Schema.CustomMetric, accountId: string, webPropertyId: string, customMetricId: string, optionalArgs: object): Analytics_v3.Schema.CustomMetric; + // Updates an existing custom metric. + update(resource: Schema.CustomMetric, accountId: string, webPropertyId: string, customMetricId: string): Analytics_v3.Schema.CustomMetric; + // Updates an existing custom metric. + update(resource: Schema.CustomMetric, accountId: string, webPropertyId: string, customMetricId: string, optionalArgs: object): Analytics_v3.Schema.CustomMetric; + } + export interface ExperimentsCollection { + // Returns an experiment to which the user has access. + get(accountId: string, webPropertyId: string, profileId: string, experimentId: string): Analytics_v3.Schema.Experiment; + // Create a new experiment. + insert(resource: Schema.Experiment, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Experiment; + // Lists experiments to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Experiments; + // Lists experiments to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string, optionalArgs: object): Analytics_v3.Schema.Experiments; + // Update an existing experiment. This method supports patch semantics. + patch(resource: Schema.Experiment, accountId: string, webPropertyId: string, profileId: string, experimentId: string): Analytics_v3.Schema.Experiment; + // Delete an experiment. + remove(accountId: string, webPropertyId: string, profileId: string, experimentId: string): void; + // Update an existing experiment. + update(resource: Schema.Experiment, accountId: string, webPropertyId: string, profileId: string, experimentId: string): Analytics_v3.Schema.Experiment; + } + export interface FiltersCollection { + // Returns a filters to which the user has access. + get(accountId: string, filterId: string): Analytics_v3.Schema.Filter; + // Create a new filter. + insert(resource: Schema.Filter, accountId: string): Analytics_v3.Schema.Filter; + // Lists all filters for an account + list(accountId: string): Analytics_v3.Schema.Filters; + // Lists all filters for an account + list(accountId: string, optionalArgs: object): Analytics_v3.Schema.Filters; + // Updates an existing filter. This method supports patch semantics. + patch(resource: Schema.Filter, accountId: string, filterId: string): Analytics_v3.Schema.Filter; + // Delete a filter. + remove(accountId: string, filterId: string): Analytics_v3.Schema.Filter; + // Updates an existing filter. + update(resource: Schema.Filter, accountId: string, filterId: string): Analytics_v3.Schema.Filter; + } + export interface GoalsCollection { + // Gets a goal to which the user has access. + get(accountId: string, webPropertyId: string, profileId: string, goalId: string): Analytics_v3.Schema.Goal; + // Create a new goal. + insert(resource: Analytics_v3.Schema.Goal, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Goal; + // Lists goals to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Goals; + // Lists goals to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string, optionalArgs: object): Analytics_v3.Schema.Goals; + // Updates an existing goal. This method supports patch semantics. + patch(resource: Schema.Goal, accountId: string, webPropertyId: string, profileId: string, goalId: string): Analytics_v3.Schema.Goal; + // Updates an existing goal. + update(resource: Schema.Goal, accountId: string, webPropertyId: string, profileId: string, goalId: string): Analytics_v3.Schema.Goal; + } + export interface ProfileFilterLinksCollection { + // Returns a single profile filter link. + get(accountId: string, webPropertyId: string, profileId: string, linkId: string): Analytics_v3.Schema.ProfileFilterLink; + // Create a new profile filter link. + insert(resource: Schema.ProfileFilterLink, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.ProfileFilterLink; + // Lists all profile filter links for a profile. + list(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.ProfileFilterLinks; + // Lists all profile filter links for a profile. + list(accountId: string, webPropertyId: string, profileId: string, optionalArgs: object): Analytics_v3.Schema.ProfileFilterLinks; + // Update an existing profile filter link. This method supports patch semantics. + patch(resource: Schema.ProfileFilterLink, accountId: string, webPropertyId: string, profileId: string, linkId: string): Analytics_v3.Schema.ProfileFilterLink; + // Delete a profile filter link. + remove(accountId: string, webPropertyId: string, profileId: string, linkId: string): void; + // Update an existing profile filter link. + update(resource: Schema.ProfileFilterLink, accountId: string, webPropertyId: string, profileId: string, linkId: string): Analytics_v3.Schema.ProfileFilterLink; + } + export interface ProfileUserLinksCollection { + // Adds a new user to the given view (profile). + insert(resource: Schema.EntityUserLink, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.EntityUserLink; + // Lists profile-user links for a given view (profile). + list(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.EntityUserLinks; + // Lists profile-user links for a given view (profile). + list(accountId: string, webPropertyId: string, profileId: string, optionalArgs: object): Analytics_v3.Schema.EntityUserLinks; + // Removes a user from the given view (profile). + remove(accountId: string, webPropertyId: string, profileId: string, linkId: string): void; + // Updates permissions for an existing user on the given view (profile). + update(resource: Schema.EntityUserLink, accountId: string, webPropertyId: string, profileId: string, linkId: string): Analytics_v3.Schema.EntityUserLink; + } + export interface ProfilesCollection { + // Gets a view (profile) to which the user has access. + get(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Profile; + // Create a new view (profile). + insert(resource: Schema.Profile, accountId: string, webPropertyId: string): Analytics_v3.Schema.Profile; + // Lists views (profiles) to which the user has access. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.Profiles; + // Lists views (profiles) to which the user has access. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.Profiles; + // Updates an existing view (profile). This method supports patch semantics. + patch(resource: Schema.Profile, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Profile; + // Deletes a view (profile). + remove(accountId: string, webPropertyId: string, profileId: string): void; + // Updates an existing view (profile). + update(resource: Schema.Profile, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.Profile; + } + export interface RemarketingAudienceCollection { + // Gets a remarketing audience to which the user has access. + get(accountId: string, webPropertyId: string, remarketingAudienceId: string): Analytics_v3.Schema.RemarketingAudience; + // Creates a new remarketing audience. + insert(resource: Schema.RemarketingAudience, accountId: string, webPropertyId: string): Analytics_v3.Schema.RemarketingAudience; + // Lists remarketing audiences to which the user has access. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.RemarketingAudiences; + // Lists remarketing audiences to which the user has access. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.RemarketingAudiences; + // Updates an existing remarketing audience. This method supports patch semantics. + patch(resource: Schema.RemarketingAudience, accountId: string, webPropertyId: string, remarketingAudienceId: string): Analytics_v3.Schema.RemarketingAudience; + // Delete a remarketing audience. + remove(accountId: string, webPropertyId: string, remarketingAudienceId: string): void; + // Updates an existing remarketing audience. + update(resource: Schema.RemarketingAudience, accountId: string, webPropertyId: string, remarketingAudienceId: string): Analytics_v3.Schema.RemarketingAudience; + } + export interface SegmentsCollection { + // Lists segments to which the user has access. + list(): Analytics_v3.Schema.Segments; + // Lists segments to which the user has access. + list(optionalArgs: object): Analytics_v3.Schema.Segments; + } + export interface UnsampledReportsCollection { + // Returns a single unsampled report. + get(accountId: string, webPropertyId: string, profileId: string, unsampledReportId: string): Analytics_v3.Schema.UnsampledReport; + // Create a new unsampled report. + insert(resource: Schema.UnsampledReport, accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.UnsampledReport; + // Lists unsampled reports to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string): Analytics_v3.Schema.UnsampledReports; + // Lists unsampled reports to which the user has access. + list(accountId: string, webPropertyId: string, profileId: string, optionalArgs: object): Analytics_v3.Schema.UnsampledReports; + // Deletes an unsampled report. + remove(accountId: string, webPropertyId: string, profileId: string, unsampledReportId: string): void; + } + export interface UploadsCollection { + // Delete data associated with a previous upload. + deleteUploadData(resource: Schema.AnalyticsDataimportDeleteUploadDataRequest, accountId: string, webPropertyId: string, customDataSourceId: string): void; + // List uploads to which the user has access. + get(accountId: string, webPropertyId: string, customDataSourceId: string, uploadId: string): Analytics_v3.Schema.Upload; + // List uploads to which the user has access. + list(accountId: string, webPropertyId: string, customDataSourceId: string): Analytics_v3.Schema.Uploads; + // List uploads to which the user has access. + list(accountId: string, webPropertyId: string, customDataSourceId: string, optionalArgs: object): Analytics_v3.Schema.Uploads; + // Upload data for a custom data source. + uploadData(accountId: string, webPropertyId: string, customDataSourceId: string): Analytics_v3.Schema.Upload; + // Upload data for a custom data source. + uploadData(accountId: string, webPropertyId: string, customDataSourceId: string, mediaData: any): Analytics_v3.Schema.Upload; + } + export interface WebPropertyAdWordsLinksCollection { + // Returns a web property-Google Ads link to which the user has access. + get(accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): Analytics_v3.Schema.EntityAdWordsLink; + // Creates a webProperty-Google Ads link. + insert(resource: Schema.EntityAdWordsLink, accountId: string, webPropertyId: string): Analytics_v3.Schema.EntityAdWordsLink; + // Lists webProperty-Google Ads links for a given web property. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.EntityAdWordsLinks; + // Lists webProperty-Google Ads links for a given web property. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.EntityAdWordsLinks; + // Updates an existing webProperty-Google Ads link. This method supports patch semantics. + patch(resource: Schema.EntityAdWordsLink, accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): Analytics_v3.Schema.EntityAdWordsLink; + // Deletes a web property-Google Ads link. + remove(accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): void; + // Updates an existing webProperty-Google Ads link. + update(resource: Schema.EntityAdWordsLink, accountId: string, webPropertyId: string, webPropertyAdWordsLinkId: string): Analytics_v3.Schema.EntityAdWordsLink; + } + export interface WebpropertiesCollection { + // Gets a web property to which the user has access. + get(accountId: string, webPropertyId: string): Analytics_v3.Schema.Webproperty; + // Create a new property if the account has fewer than 20 properties. Web properties are visible in the Google Analytics interface only if they have at least one profile. + insert(resource: Schema.Webproperty, accountId: string): Analytics_v3.Schema.Webproperty; + // Lists web properties to which the user has access. + list(accountId: string): Analytics_v3.Schema.Webproperties; + // Lists web properties to which the user has access. + list(accountId: string, optionalArgs: object): Analytics_v3.Schema.Webproperties; + // Updates an existing web property. This method supports patch semantics. + patch(resource: Schema.Webproperty, accountId: string, webPropertyId: string): Analytics_v3.Schema.Webproperty; + // Updates an existing web property. + update(resource: Schema.Webproperty, accountId: string, webPropertyId: string): Analytics_v3.Schema.Webproperty; + } + export interface WebpropertyUserLinksCollection { + // Adds a new user to the given web property. + insert(resource: Schema.EntityUserLink, accountId: string, webPropertyId: string): Analytics_v3.Schema.EntityUserLink; + // Lists webProperty-user links for a given web property. + list(accountId: string, webPropertyId: string): Analytics_v3.Schema.EntityUserLinks; + // Lists webProperty-user links for a given web property. + list(accountId: string, webPropertyId: string, optionalArgs: object): Analytics_v3.Schema.EntityUserLinks; + // Removes a user from the given web property. + remove(accountId: string, webPropertyId: string, linkId: string): void; + // Updates permissions for an existing user on the given web property. + update(resource: Schema.EntityUserLink, accountId: string, webPropertyId: string, linkId: string): Analytics_v3.Schema.EntityUserLink; + } + } + namespace Metadata { + export interface ColumnsCollection { + // Lists all columns for a report type + list(reportType: string): Analytics_v3.Schema.Columns; + } + } + namespace UserDeletion { + export interface UserDeletionRequestCollection { + // Insert or update a user deletion requests. + upsert(resource: Schema.UserDeletionRequest): Analytics_v3.Schema.UserDeletionRequest; + } + } + export interface DataCollection { + Ga?: Analytics_v3.Collection.Data.GaCollection; + Mcf?: Analytics_v3.Collection.Data.McfCollection; + Realtime?: Analytics_v3.Collection.Data.RealtimeCollection; + } + export interface ManagementCollection { + AccountSummaries?: Analytics_v3.Collection.Management.AccountSummariesCollection; + AccountUserLinks?: Analytics_v3.Collection.Management.AccountUserLinksCollection; + Accounts?: Analytics_v3.Collection.Management.AccountsCollection; + ClientId?: Analytics_v3.Collection.Management.ClientIdCollection; + CustomDataSources?: Analytics_v3.Collection.Management.CustomDataSourcesCollection; + CustomDimensions?: Analytics_v3.Collection.Management.CustomDimensionsCollection; + CustomMetrics?: Analytics_v3.Collection.Management.CustomMetricsCollection; + Experiments?: Analytics_v3.Collection.Management.ExperimentsCollection; + Filters?: Analytics_v3.Collection.Management.FiltersCollection; + Goals?: Analytics_v3.Collection.Management.GoalsCollection; + ProfileFilterLinks?: Analytics_v3.Collection.Management.ProfileFilterLinksCollection; + ProfileUserLinks?: Analytics_v3.Collection.Management.ProfileUserLinksCollection; + Profiles?: Analytics_v3.Collection.Management.ProfilesCollection; + RemarketingAudience?: Analytics_v3.Collection.Management.RemarketingAudienceCollection; + Segments?: Analytics_v3.Collection.Management.SegmentsCollection; + UnsampledReports?: Analytics_v3.Collection.Management.UnsampledReportsCollection; + Uploads?: Analytics_v3.Collection.Management.UploadsCollection; + WebPropertyAdWordsLinks?: Analytics_v3.Collection.Management.WebPropertyAdWordsLinksCollection; + Webproperties?: Analytics_v3.Collection.Management.WebpropertiesCollection; + WebpropertyUserLinks?: Analytics_v3.Collection.Management.WebpropertyUserLinksCollection; + } + export interface MetadataCollection { + Columns?: Analytics_v3.Collection.Metadata.ColumnsCollection; + } + export interface ProvisioningCollection { + // Creates an account ticket. + createAccountTicket(resource: Schema.AccountTicket): Analytics_v3.Schema.AccountTicket; + // Provision account. + createAccountTree(resource: Schema.AccountTreeRequest): Analytics_v3.Schema.AccountTreeResponse; + } + export interface UserDeletionCollection { + UserDeletionRequest?: Analytics_v3.Collection.UserDeletion.UserDeletionRequestCollection; + } + } + namespace Schema { + export interface Account { + childLink?: Analytics_v3.Schema.AccountChildLink; + created?: string; + id?: string; + kind?: string; + name?: string; + permissions?: Analytics_v3.Schema.AccountPermissions; + selfLink?: string; + starred?: boolean; + updated?: string; + } + export interface AccountChildLink { + href?: string; + type?: string; + } + export interface AccountPermissions { + effective?: string[]; + } + export interface AccountRef { + href?: string; + id?: string; + kind?: string; + name?: string; + } + export interface AccountSummaries { + items?: Analytics_v3.Schema.AccountSummary[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface AccountSummary { + id?: string; + kind?: string; + name?: string; + starred?: boolean; + webProperties?: Analytics_v3.Schema.WebPropertySummary[]; + } + export interface AccountTicket { + account?: Analytics_v3.Schema.Account; + id?: string; + kind?: string; + profile?: Analytics_v3.Schema.Profile; + redirectUri?: string; + webproperty?: Analytics_v3.Schema.Webproperty; + } + export interface AccountTreeRequest { + accountName?: string; + kind?: string; + profileName?: string; + timezone?: string; + webpropertyName?: string; + websiteUrl?: string; + } + export interface AccountTreeResponse { + account?: Analytics_v3.Schema.Account; + kind?: string; + profile?: Analytics_v3.Schema.Profile; + webproperty?: Analytics_v3.Schema.Webproperty; + } + export interface Accounts { + items?: Analytics_v3.Schema.Account[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface AdWordsAccount { + autoTaggingEnabled?: boolean; + customerId?: string; + kind?: string; + } + export interface AnalyticsDataimportDeleteUploadDataRequest { + customDataImportUids?: string[]; + } + export interface Column { + attributes?: object; + id?: string; + kind?: string; + } + export interface Columns { + attributeNames?: string[]; + etag?: string; + items?: Analytics_v3.Schema.Column[]; + kind?: string; + totalResults?: number; + } + export interface CustomDataSource { + accountId?: string; + childLink?: Analytics_v3.Schema.CustomDataSourceChildLink; + created?: string; + description?: string; + id?: string; + importBehavior?: string; + kind?: string; + name?: string; + parentLink?: Analytics_v3.Schema.CustomDataSourceParentLink; + profilesLinked?: string[]; + schema?: string[]; + selfLink?: string; + type?: string; + updated?: string; + uploadType?: string; + webPropertyId?: string; + } + export interface CustomDataSourceChildLink { + href?: string; + type?: string; + } + export interface CustomDataSourceParentLink { + href?: string; + type?: string; + } + export interface CustomDataSources { + items?: Analytics_v3.Schema.CustomDataSource[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface CustomDimension { + accountId?: string; + active?: boolean; + created?: string; + id?: string; + index?: number; + kind?: string; + name?: string; + parentLink?: Analytics_v3.Schema.CustomDimensionParentLink; + scope?: string; + selfLink?: string; + updated?: string; + webPropertyId?: string; + } + export interface CustomDimensionParentLink { + href?: string; + type?: string; + } + export interface CustomDimensions { + items?: Analytics_v3.Schema.CustomDimension[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface CustomMetric { + accountId?: string; + active?: boolean; + created?: string; + id?: string; + index?: number; + kind?: string; + max_value?: string; + min_value?: string; + name?: string; + parentLink?: Analytics_v3.Schema.CustomMetricParentLink; + scope?: string; + selfLink?: string; + type?: string; + updated?: string; + webPropertyId?: string; + } + export interface CustomMetricParentLink { + href?: string; + type?: string; + } + export interface CustomMetrics { + items?: Analytics_v3.Schema.CustomMetric[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface EntityAdWordsLink { + adWordsAccounts?: Analytics_v3.Schema.AdWordsAccount[]; + entity?: Analytics_v3.Schema.EntityAdWordsLinkEntity; + id?: string; + kind?: string; + name?: string; + profileIds?: string[]; + selfLink?: string; + } + export interface EntityAdWordsLinkEntity { + webPropertyRef?: Analytics_v3.Schema.WebPropertyRef; + } + export interface EntityAdWordsLinks { + items?: Analytics_v3.Schema.EntityAdWordsLink[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + } + export interface EntityUserLink { + entity?: Analytics_v3.Schema.EntityUserLinkEntity; + id?: string; + kind?: string; + permissions?: Analytics_v3.Schema.EntityUserLinkPermissions; + selfLink?: string; + userRef?: Analytics_v3.Schema.UserRef; + } + export interface EntityUserLinkEntity { + accountRef?: Analytics_v3.Schema.AccountRef; + profileRef?: Analytics_v3.Schema.ProfileRef; + webPropertyRef?: Analytics_v3.Schema.WebPropertyRef; + } + export interface EntityUserLinkPermissions { + effective?: string[]; + local?: string[]; + } + export interface EntityUserLinks { + items?: Analytics_v3.Schema.EntityUserLink[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + } + export interface Experiment { + accountId?: string; + created?: string; + description?: string; + editableInGaUi?: boolean; + endTime?: string; + equalWeighting?: boolean; + id?: string; + internalWebPropertyId?: string; + kind?: string; + minimumExperimentLengthInDays?: number; + name?: string; + objectiveMetric?: string; + optimizationType?: string; + parentLink?: Analytics_v3.Schema.ExperimentParentLink; + profileId?: string; + reasonExperimentEnded?: string; + rewriteVariationUrlsAsOriginal?: boolean; + selfLink?: string; + servingFramework?: string; + snippet?: string; + startTime?: string; + status?: string; + trafficCoverage?: Number; + updated?: string; + variations?: Analytics_v3.Schema.ExperimentVariations[]; + webPropertyId?: string; + winnerConfidenceLevel?: Number; + winnerFound?: boolean; + } + export interface ExperimentParentLink { + href?: string; + type?: string; + } + export interface ExperimentVariations { + name?: string; + status?: string; + url?: string; + weight?: Number; + won?: boolean; + } + export interface Experiments { + items?: Analytics_v3.Schema.Experiment[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface Filter { + accountId?: string; + advancedDetails?: Analytics_v3.Schema.FilterAdvancedDetails; + created?: string; + excludeDetails?: Analytics_v3.Schema.FilterExpression; + id?: string; + includeDetails?: Analytics_v3.Schema.FilterExpression; + kind?: string; + lowercaseDetails?: Analytics_v3.Schema.FilterLowercaseDetails; + name?: string; + parentLink?: Analytics_v3.Schema.FilterParentLink; + searchAndReplaceDetails?: Analytics_v3.Schema.FilterSearchAndReplaceDetails; + selfLink?: string; + type?: string; + updated?: string; + uppercaseDetails?: Analytics_v3.Schema.FilterUppercaseDetails; + } + export interface FilterAdvancedDetails { + caseSensitive?: boolean; + extractA?: string; + extractB?: string; + fieldA?: string; + fieldAIndex?: number; + fieldARequired?: boolean; + fieldB?: string; + fieldBIndex?: number; + fieldBRequired?: boolean; + outputConstructor?: string; + outputToField?: string; + outputToFieldIndex?: number; + overrideOutputField?: boolean; + } + export interface FilterExpression { + caseSensitive?: boolean; + expressionValue?: string; + field?: string; + fieldIndex?: number; + kind?: string; + matchType?: string; + } + export interface FilterLowercaseDetails { + field?: string; + fieldIndex?: number; + } + export interface FilterParentLink { + href?: string; + type?: string; + } + export interface FilterRef { + accountId?: string; + href?: string; + id?: string; + kind?: string; + name?: string; + } + export interface FilterSearchAndReplaceDetails { + caseSensitive?: boolean; + field?: string; + fieldIndex?: number; + replaceString?: string; + searchString?: string; + } + export interface FilterUppercaseDetails { + field?: string; + fieldIndex?: number; + } + export interface Filters { + items?: Analytics_v3.Schema.Filter[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface GaData { + columnHeaders?: Analytics_v3.Schema.GaDataColumnHeaders[]; + containsSampledData?: boolean; + dataLastRefreshed?: string; + dataTable?: Analytics_v3.Schema.GaDataDataTable; + id?: string; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + profileInfo?: Analytics_v3.Schema.GaDataProfileInfo; + query?: Analytics_v3.Schema.GaDataQuery; + rows?: String[][]; + sampleSize?: string; + sampleSpace?: string; + selfLink?: string; + totalResults?: number; + totalsForAllResults?: object; + } + export interface GaDataColumnHeaders { + columnType?: string; + dataType?: string; + name?: string; + } + export interface GaDataDataTable { + cols?: Analytics_v3.Schema.GaDataDataTableCols[]; + rows?: Analytics_v3.Schema.GaDataDataTableRows[]; + } + export interface GaDataDataTableCols { + id?: string; + label?: string; + type?: string; + } + export interface GaDataDataTableRows { + c?: Analytics_v3.Schema.GaDataDataTableRowsC[]; + } + export interface GaDataDataTableRowsC { + v?: string; + } + export interface GaDataProfileInfo { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + } + export interface GaDataQuery { + dimensions?: string; + end_date?: string; + filters?: string; + ids?: string; + max_results?: number; + metrics?: string[]; + samplingLevel?: string; + segment?: string; + sort?: string[]; + start_date?: string; + start_index?: number; + } + export interface Goal { + accountId?: string; + active?: boolean; + created?: string; + eventDetails?: Analytics_v3.Schema.GoalEventDetails; + id?: string; + internalWebPropertyId?: string; + kind?: string; + name?: string; + parentLink?: Analytics_v3.Schema.GoalParentLink; + profileId?: string; + selfLink?: string; + type?: string; + updated?: string; + urlDestinationDetails?: Analytics_v3.Schema.GoalUrlDestinationDetails; + value?: Number; + visitNumPagesDetails?: Analytics_v3.Schema.GoalVisitNumPagesDetails; + visitTimeOnSiteDetails?: Analytics_v3.Schema.GoalVisitTimeOnSiteDetails; + webPropertyId?: string; + } + export interface GoalEventDetails { + eventConditions?: GoalEventDetailsEventConditions[]; + useEventValue?: boolean; + } + export interface GoalEventDetailsEventConditions { + comparisonType?: string; + comparisonValue?: string; + expression?: string; + matchType?: string; + type?: string; + } + export interface GoalParentLink { + href?: string; + type?: string; + } + export interface GoalUrlDestinationDetails { + caseSensitive?: boolean; + firstStepRequired?: boolean; + matchType?: string; + steps?: GoalUrlDestinationDetailsSteps[]; + url?: string; + } + export interface GoalUrlDestinationDetailsSteps { + name?: string; + number?: number; + url?: string; + } + export interface GoalVisitNumPagesDetails { + comparisonType?: string; + comparisonValue?: string; + } + export interface GoalVisitTimeOnSiteDetails { + comparisonType?: string; + comparisonValue?: string; + } + export interface Goals { + items?: Goal[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface HashClientIdRequest { + clientId?: string; + kind?: string; + webPropertyId?: string; + } + export interface HashClientIdResponse { + clientId?: string; + hashedClientId?: string; + kind?: string; + webPropertyId?: string; + } + export interface IncludeConditions { + daysToLookBack?: number; + isSmartList?: boolean; + kind?: string; + membershipDurationDays?: number; + segment?: string; + } + export interface LinkedForeignAccount { + accountId?: string; + eligibleForSearch?: boolean; + id?: string; + internalWebPropertyId?: string; + kind?: string; + linkedAccountId?: string; + remarketingAudienceId?: string; + status?: string; + type?: string; + webPropertyId?: string; + } + export interface McfData { + columnHeaders?: McfDataColumnHeaders[]; + containsSampledData?: boolean; + id?: string; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + profileInfo?: McfDataProfileInfo; + query?: McfDataQuery; + rows?: McfDataRows[][]; + sampleSize?: string; + sampleSpace?: string; + selfLink?: string; + totalResults?: number; + totalsForAllResults?: object; + } + export interface McfDataColumnHeaders { + columnType?: string; + dataType?: string; + name?: string; + } + export interface McfDataProfileInfo { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + } + export interface McfDataQuery { + dimensions?: string; + end_date?: string; + filters?: string; + ids?: string; + max_results?: number; + metrics?: string[]; + samplingLevel?: string; + segment?: string; + sort?: string[]; + start_date?: string; + start_index?: number; + } + export interface McfDataRows { + conversionPathValue?: McfDataRowsConversionPathValue[]; + primitiveValue?: string; + } + export interface McfDataRowsConversionPathValue { + interactionType?: string; + nodeValue?: string; + } + export interface Profile { + accountId?: string; + botFilteringEnabled?: boolean; + childLink?: ProfileChildLink; + created?: string; + currency?: string; + defaultPage?: string; + eCommerceTracking?: boolean; + enhancedECommerceTracking?: boolean; + excludeQueryParameters?: string; + id?: string; + internalWebPropertyId?: string; + kind?: string; + name?: string; + parentLink?: ProfileParentLink; + permissions?: ProfilePermissions; + selfLink?: string; + siteSearchCategoryParameters?: string; + siteSearchQueryParameters?: string; + starred?: boolean; + stripSiteSearchCategoryParameters?: boolean; + stripSiteSearchQueryParameters?: boolean; + timezone?: string; + type?: string; + updated?: string; + webPropertyId?: string; + websiteUrl?: string; + } + export interface ProfileChildLink { + href?: string; + type?: string; + } + export interface ProfileFilterLink { + filterRef?: Analytics_v3.Schema.FilterRef; + id?: string; + kind?: string; + profileRef?: ProfileRef; + rank?: number; + selfLink?: string; + } + export interface ProfileFilterLinks { + items?: ProfileFilterLink[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface ProfileParentLink { + href?: string; + type?: string; + } + export interface ProfilePermissions { + effective?: string[]; + } + export interface ProfileRef { + accountId?: string; + href?: string; + id?: string; + internalWebPropertyId?: string; + kind?: string; + name?: string; + webPropertyId?: string; + } + export interface ProfileSummary { + id?: string; + kind?: string; + name?: string; + starred?: boolean; + type?: string; + } + export interface Profiles { + items?: Profile[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface RealtimeData { + columnHeaders?: RealtimeDataColumnHeaders[]; + id?: string; + kind?: string; + profileInfo?: RealtimeDataProfileInfo; + query?: RealtimeDataQuery; + rows?: String[][]; + selfLink?: string; + totalResults?: number; + totalsForAllResults?: object; + } + export interface RealtimeDataColumnHeaders { + columnType?: string; + dataType?: string; + name?: string; + } + export interface RealtimeDataProfileInfo { + accountId?: string; + internalWebPropertyId?: string; + profileId?: string; + profileName?: string; + tableId?: string; + webPropertyId?: string; + } + export interface RealtimeDataQuery { + dimensions?: string; + filters?: string; + ids?: string; + max_results?: number; + metrics?: string[]; + sort?: string[]; + } + export interface RemarketingAudience { + accountId?: string; + audienceDefinition?: RemarketingAudienceAudienceDefinition; + audienceType?: string; + created?: string; + description?: string; + id?: string; + internalWebPropertyId?: string; + kind?: string; + linkedAdAccounts?: LinkedForeignAccount[]; + linkedViews?: string[]; + name?: string; + stateBasedAudienceDefinition?: RemarketingAudienceStateBasedAudienceDefinition; + updated?: string; + webPropertyId?: string; + } + export interface RemarketingAudienceAudienceDefinition { + includeConditions?: IncludeConditions; + } + export interface RemarketingAudienceStateBasedAudienceDefinition { + excludeConditions?: RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions; + includeConditions?: IncludeConditions; + } + export interface RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions { + exclusionDuration?: string; + segment?: string; + } + export interface RemarketingAudiences { + items?: RemarketingAudience[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface Segment { + created?: string; + definition?: string; + id?: string; + kind?: string; + name?: string; + segmentId?: string; + selfLink?: string; + type?: string; + updated?: string; + } + export interface Segments { + items?: Segment[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface UnsampledReport { + accountId?: string; + cloudStorageDownloadDetails?: UnsampledReportCloudStorageDownloadDetails; + created?: string; + dimensions?: string; + downloadType?: string; + driveDownloadDetails?: UnsampledReportDriveDownloadDetails; + end_date?: string; + filters?: string; + id?: string; + kind?: string; + metrics?: string; + profileId?: string; + segment?: string; + selfLink?: string; + start_date?: string; + status?: string; + title?: string; + updated?: string; + webPropertyId?: string; + } + export interface UnsampledReportCloudStorageDownloadDetails { + bucketId?: string; + objectId?: string; + } + export interface UnsampledReportDriveDownloadDetails { + documentId?: string; + } + export interface UnsampledReports { + items?: UnsampledReport[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface Upload { + accountId?: string; + customDataSourceId?: string; + errors?: string[]; + id?: string; + kind?: string; + status?: string; + uploadTime?: string; + } + export interface Uploads { + items?: Upload[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + } + export interface UserDeletionRequest { + deletionRequestTime?: string; + firebaseProjectId?: string; + id?: UserDeletionRequestId; + kind?: string; + webPropertyId?: string; + } + export interface UserDeletionRequestId { + type?: string; + userId?: string; + } + export interface UserRef { + email?: string; + id?: string; + kind?: string; + } + export interface WebPropertyRef { + accountId?: string; + href?: string; + id?: string; + internalWebPropertyId?: string; + kind?: string; + name?: string; + } + export interface WebPropertySummary { + id?: string; + internalWebPropertyId?: string; + kind?: string; + level?: string; + name?: string; + profiles?: ProfileSummary[]; + starred?: boolean; + websiteUrl?: string; + } + export interface Webproperties { + items?: Webproperty[]; + itemsPerPage?: number; + kind?: string; + nextLink?: string; + previousLink?: string; + startIndex?: number; + totalResults?: number; + username?: string; + } + export interface Webproperty { + accountId?: string; + childLink?: WebpropertyChildLink; + created?: string; + dataRetentionResetOnNewActivity?: boolean; + dataRetentionTtl?: string; + defaultProfileId?: string; + id?: string; + industryVertical?: string; + internalWebPropertyId?: string; + kind?: string; + level?: string; + name?: string; + parentLink?: WebpropertyParentLink; + permissions?: WebpropertyPermissions; + profileCount?: number; + selfLink?: string; + starred?: boolean; + updated?: string; + websiteUrl?: string; + } + export interface WebpropertyChildLink { + href?: string; + type?: string; + } + export interface WebpropertyParentLink { + href?: string; + type?: string; + } + export interface WebpropertyPermissions { + effective?: string[]; + } + } + } + export interface Analytics_v3 { + Data?: Analytics_v3.Collection.DataCollection; + Management?: Analytics_v3.Collection.ManagementCollection; + Metadata?: Analytics_v3.Collection.MetadataCollection; + Provisioning?: Analytics_v3.Collection.ProvisioningCollection; + UserDeletion?: Analytics_v3.Collection.UserDeletionCollection; + // Create a new instance of Account + newAccount(): Analytics_v3.Schema.Account; + // Create a new instance of AccountChildLink + newAccountChildLink(): Analytics_v3.Schema.AccountChildLink; + // Create a new instance of AccountPermissions + newAccountPermissions(): Analytics_v3.Schema.AccountPermissions; + // Create a new instance of AccountRef + newAccountRef(): Analytics_v3.Schema.AccountRef; + // Create a new instance of AccountTicket + newAccountTicket(): Analytics_v3.Schema.AccountTicket; + // Create a new instance of AccountTreeRequest + newAccountTreeRequest(): Analytics_v3.Schema.AccountTreeRequest; + // Create a new instance of AdWordsAccount + newAdWordsAccount(): Analytics_v3.Schema.AdWordsAccount; + // Create a new instance of AnalyticsDataimportDeleteUploadDataRequest + newAnalyticsDataimportDeleteUploadDataRequest(): Analytics_v3.Schema.AnalyticsDataimportDeleteUploadDataRequest; + // Create a new instance of CustomDimension + newCustomDimension(): Analytics_v3.Schema.CustomDimension; + // Create a new instance of CustomDimensionParentLink + newCustomDimensionParentLink(): Analytics_v3.Schema.CustomDimensionParentLink; + // Create a new instance of CustomMetric + newCustomMetric(): Analytics_v3.Schema.CustomMetric; + // Create a new instance of CustomMetricParentLink + newCustomMetricParentLink(): Analytics_v3.Schema.CustomMetricParentLink; + // Create a new instance of EntityAdWordsLink + newEntityAdWordsLink(): Analytics_v3.Schema.EntityAdWordsLink; + // Create a new instance of EntityAdWordsLinkEntity + newEntityAdWordsLinkEntity(): Analytics_v3.Schema.EntityAdWordsLinkEntity; + // Create a new instance of EntityUserLink + newEntityUserLink(): Analytics_v3.Schema.EntityUserLink; + // Create a new instance of EntityUserLinkEntity + newEntityUserLinkEntity(): Analytics_v3.Schema.EntityUserLinkEntity; + // Create a new instance of EntityUserLinkPermissions + newEntityUserLinkPermissions(): Analytics_v3.Schema.EntityUserLinkPermissions; + // Create a new instance of Experiment + newExperiment(): Analytics_v3.Schema.Experiment; + // Create a new instance of ExperimentParentLink + newExperimentParentLink(): Analytics_v3.Schema.ExperimentParentLink; + // Create a new instance of ExperimentVariations + newExperimentVariations(): Analytics_v3.Schema.ExperimentVariations; + // Create a new instance of Filter + newFilter(): Analytics_v3.Schema.Filter; + // Create a new instance of FilterAdvancedDetails + newFilterAdvancedDetails(): Analytics_v3.Schema.FilterAdvancedDetails; + // Create a new instance of FilterExpression + newFilterExpression(): Analytics_v3.Schema.FilterExpression; + // Create a new instance of FilterLowercaseDetails + newFilterLowercaseDetails(): Analytics_v3.Schema.FilterLowercaseDetails; + // Create a new instance of FilterParentLink + newFilterParentLink(): Analytics_v3.Schema.FilterParentLink; + // Create a new instance of FilterRef + newFilterRef(): Analytics_v3.Schema.FilterRef; + // Create a new instance of FilterSearchAndReplaceDetails + newFilterSearchAndReplaceDetails(): Analytics_v3.Schema.FilterSearchAndReplaceDetails; + // Create a new instance of FilterUppercaseDetails + newFilterUppercaseDetails(): Analytics_v3.Schema.FilterUppercaseDetails; + // Create a new instance of Goal + newGoal(): Analytics_v3.Schema.Goal; + // Create a new instance of GoalEventDetails + newGoalEventDetails(): Analytics_v3.Schema.GoalEventDetails; + // Create a new instance of GoalEventDetailsEventConditions + newGoalEventDetailsEventConditions(): Analytics_v3.Schema.GoalEventDetailsEventConditions; + // Create a new instance of GoalParentLink + newGoalParentLink(): Analytics_v3.Schema.GoalParentLink; + // Create a new instance of GoalUrlDestinationDetails + newGoalUrlDestinationDetails(): Analytics_v3.Schema.GoalUrlDestinationDetails; + // Create a new instance of GoalUrlDestinationDetailsSteps + newGoalUrlDestinationDetailsSteps(): Analytics_v3.Schema.GoalUrlDestinationDetailsSteps; + // Create a new instance of GoalVisitNumPagesDetails + newGoalVisitNumPagesDetails(): Analytics_v3.Schema.GoalVisitNumPagesDetails; + // Create a new instance of GoalVisitTimeOnSiteDetails + newGoalVisitTimeOnSiteDetails(): Analytics_v3.Schema.GoalVisitTimeOnSiteDetails; + // Create a new instance of HashClientIdRequest + newHashClientIdRequest(): Analytics_v3.Schema.HashClientIdRequest; + // Create a new instance of IncludeConditions + newIncludeConditions(): Analytics_v3.Schema.IncludeConditions; + // Create a new instance of LinkedForeignAccount + newLinkedForeignAccount(): Analytics_v3.Schema.LinkedForeignAccount; + // Create a new instance of Profile + newProfile(): Analytics_v3.Schema.Profile; + // Create a new instance of ProfileChildLink + newProfileChildLink(): Analytics_v3.Schema.ProfileChildLink; + // Create a new instance of ProfileFilterLink + newProfileFilterLink(): Analytics_v3.Schema.ProfileFilterLink; + // Create a new instance of ProfileParentLink + newProfileParentLink(): Analytics_v3.Schema.ProfileParentLink; + // Create a new instance of ProfilePermissions + newProfilePermissions(): Analytics_v3.Schema.ProfilePermissions; + // Create a new instance of ProfileRef + newProfileRef(): Analytics_v3.Schema.ProfileRef; + // Create a new instance of RemarketingAudience + newRemarketingAudience(): Analytics_v3.Schema.RemarketingAudience; + // Create a new instance of RemarketingAudienceAudienceDefinition + newRemarketingAudienceAudienceDefinition(): Analytics_v3.Schema.RemarketingAudienceAudienceDefinition; + // Create a new instance of RemarketingAudienceStateBasedAudienceDefinition + newRemarketingAudienceStateBasedAudienceDefinition(): Analytics_v3.Schema.RemarketingAudienceStateBasedAudienceDefinition; + // Create a new instance of RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions + newRemarketingAudienceStateBasedAudienceDefinitionExcludeConditions(): Analytics_v3.Schema.RemarketingAudienceStateBasedAudienceDefinitionExcludeConditions; + // Create a new instance of UnsampledReport + newUnsampledReport(): Analytics_v3.Schema.UnsampledReport; + // Create a new instance of UnsampledReportCloudStorageDownloadDetails + newUnsampledReportCloudStorageDownloadDetails(): Analytics_v3.Schema.UnsampledReportCloudStorageDownloadDetails; + // Create a new instance of UnsampledReportDriveDownloadDetails + newUnsampledReportDriveDownloadDetails(): Analytics_v3.Schema.UnsampledReportDriveDownloadDetails; + // Create a new instance of UserDeletionRequest + newUserDeletionRequest(): Analytics_v3.Schema.UserDeletionRequest; + // Create a new instance of UserDeletionRequestId + newUserDeletionRequestId(): Analytics_v3.Schema.UserDeletionRequestId; + // Create a new instance of UserRef + newUserRef(): Analytics_v3.Schema.UserRef; + // Create a new instance of WebPropertyRef + newWebPropertyRef(): Analytics_v3.Schema.WebPropertyRef; + // Create a new instance of Webproperty + newWebproperty(): Analytics_v3.Schema.Webproperty; + // Create a new instance of WebpropertyChildLink + newWebpropertyChildLink(): Analytics_v3.Schema.WebpropertyChildLink; + // Create a new instance of WebpropertyParentLink + newWebpropertyParentLink(): Analytics_v3.Schema.WebpropertyParentLink; + // Create a new instance of WebpropertyPermissions + newWebpropertyPermissions(): Analytics_v3.Schema.WebpropertyPermissions; + } +} + +declare var Analytics_v3: GoogleAppsScript.Analytics_v3; \ No newline at end of file diff --git a/types/google-apps-script/apis/analyticsreporting/v4.d.ts b/types/google-apps-script/apis/analyticsreporting/v4.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/analyticsreporting_v4.d.ts b/types/google-apps-script/apis/analyticsreporting_v4.d.ts new file mode 100644 index 0000000000..35345734d9 --- /dev/null +++ b/types/google-apps-script/apis/analyticsreporting_v4.d.ts @@ -0,0 +1,361 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Analyticsreporting_v4 { + namespace Collection { + export interface ReportsCollection { + // Returns the Analytics data. + batchGet(resource: Schema.GetReportsRequest): Analyticsreporting_v4.Schema.GetReportsResponse; + } + export interface UserActivityCollection { + // Returns User Activity data. + search(resource: Schema.SearchUserActivityRequest): Analyticsreporting_v4.Schema.SearchUserActivityResponse; + } + } + namespace Schema { + export interface Activity { + activityTime?: string; + activityType?: string; + appview?: Analyticsreporting_v4.Schema.ScreenviewData; + campaign?: string; + channelGrouping?: string; + customDimension?: Analyticsreporting_v4.Schema.CustomDimension[]; + ecommerce?: Analyticsreporting_v4.Schema.EcommerceData; + event?: Analyticsreporting_v4.Schema.EventData; + goals?: Analyticsreporting_v4.Schema.GoalSetData; + hostname?: string; + keyword?: string; + landingPagePath?: string; + medium?: string; + pageview?: Analyticsreporting_v4.Schema.PageviewData; + source?: string; + } + export interface Cohort { + dateRange?: Analyticsreporting_v4.Schema.DateRange; + name?: string; + type?: string; + } + export interface CohortGroup { + cohorts?: Analyticsreporting_v4.Schema.Cohort[]; + lifetimeValue?: boolean; + } + export interface ColumnHeader { + dimensions?: string[]; + metricHeader?: Analyticsreporting_v4.Schema.MetricHeader; + } + export interface CustomDimension { + index?: number; + value?: string; + } + export interface DateRange { + endDate?: string; + startDate?: string; + } + export interface DateRangeValues { + pivotValueRegions?: Analyticsreporting_v4.Schema.PivotValueRegion[]; + values?: string[]; + } + export interface Dimension { + histogramBuckets?: string[]; + name?: string; + } + export interface DimensionFilter { + caseSensitive?: boolean; + dimensionName?: string; + expressions?: string[]; + not?: boolean; + operator?: string; + } + export interface DimensionFilterClause { + filters?: Analyticsreporting_v4.Schema.DimensionFilter[]; + operator?: string; + } + export interface DynamicSegment { + name?: string; + sessionSegment?: Analyticsreporting_v4.Schema.SegmentDefinition; + userSegment?: Analyticsreporting_v4.Schema.SegmentDefinition; + } + export interface EcommerceData { + actionType?: string; + ecommerceType?: string; + products?: Analyticsreporting_v4.Schema.ProductData[]; + transaction?: Analyticsreporting_v4.Schema.TransactionData; + } + export interface EventData { + eventAction?: string; + eventCategory?: string; + eventCount?: string; + eventLabel?: string; + eventValue?: string; + } + export interface GetReportsRequest { + reportRequests?: Analyticsreporting_v4.Schema.ReportRequest[]; + useResourceQuotas?: boolean; + } + export interface GetReportsResponse { + queryCost?: number; + reports?: Analyticsreporting_v4.Schema.Report[]; + resourceQuotasRemaining?: Analyticsreporting_v4.Schema.ResourceQuotasRemaining; + } + export interface GoalData { + goalCompletionLocation?: string; + goalCompletions?: string; + goalIndex?: number; + goalName?: string; + goalPreviousStep1?: string; + goalPreviousStep2?: string; + goalPreviousStep3?: string; + goalValue?: Number; + } + export interface GoalSetData { + goals?: Analyticsreporting_v4.Schema.GoalData[]; + } + export interface Metric { + alias?: string; + expression?: string; + formattingType?: string; + } + export interface MetricFilter { + comparisonValue?: string; + metricName?: string; + not?: boolean; + operator?: string; + } + export interface MetricFilterClause { + filters?: Analyticsreporting_v4.Schema.MetricFilter[]; + operator?: string; + } + export interface MetricHeader { + metricHeaderEntries?: Analyticsreporting_v4.Schema.MetricHeaderEntry[]; + pivotHeaders?: Analyticsreporting_v4.Schema.PivotHeader[]; + } + export interface MetricHeaderEntry { + name?: string; + type?: string; + } + export interface OrFiltersForSegment { + segmentFilterClauses?: Analyticsreporting_v4.Schema.SegmentFilterClause[]; + } + export interface OrderBy { + fieldName?: string; + orderType?: string; + sortOrder?: string; + } + export interface PageviewData { + pagePath?: string; + pageTitle?: string; + } + export interface Pivot { + dimensionFilterClauses?: Analyticsreporting_v4.Schema.DimensionFilterClause[]; + dimensions?: Analyticsreporting_v4.Schema.Dimension[]; + maxGroupCount?: number; + metrics?: Analyticsreporting_v4.Schema.Metric[]; + startGroup?: number; + } + export interface PivotHeader { + pivotHeaderEntries?: Analyticsreporting_v4.Schema.PivotHeaderEntry[]; + totalPivotGroupsCount?: number; + } + export interface PivotHeaderEntry { + dimensionNames?: string[]; + dimensionValues?: string[]; + metric?: Analyticsreporting_v4.Schema.MetricHeaderEntry; + } + export interface PivotValueRegion { + values?: string[]; + } + export interface ProductData { + itemRevenue?: Number; + productName?: string; + productQuantity?: string; + productSku?: string; + } + export interface Report { + columnHeader?: Analyticsreporting_v4.Schema.ColumnHeader; + data?: Analyticsreporting_v4.Schema.ReportData; + nextPageToken?: string; + } + export interface ReportData { + dataLastRefreshed?: string; + isDataGolden?: boolean; + maximums?: Analyticsreporting_v4.Schema.DateRangeValues[]; + minimums?: Analyticsreporting_v4.Schema.DateRangeValues[]; + rowCount?: number; + rows?: Analyticsreporting_v4.Schema.ReportRow[]; + samplesReadCounts?: string[]; + samplingSpaceSizes?: string[]; + totals?: Analyticsreporting_v4.Schema.DateRangeValues[]; + } + export interface ReportRequest { + cohortGroup?: Analyticsreporting_v4.Schema.CohortGroup; + dateRanges?: Analyticsreporting_v4.Schema.DateRange[]; + dimensionFilterClauses?: Analyticsreporting_v4.Schema.DimensionFilterClause[]; + dimensions?: Analyticsreporting_v4.Schema.Dimension[]; + filtersExpression?: string; + hideTotals?: boolean; + hideValueRanges?: boolean; + includeEmptyRows?: boolean; + metricFilterClauses?: Analyticsreporting_v4.Schema.MetricFilterClause[]; + metrics?: Analyticsreporting_v4.Schema.Metric[]; + orderBys?: Analyticsreporting_v4.Schema.OrderBy[]; + pageSize?: number; + pageToken?: string; + pivots?: Analyticsreporting_v4.Schema.Pivot[]; + samplingLevel?: string; + segments?: Analyticsreporting_v4.Schema.Segment[]; + viewId?: string; + } + export interface ReportRow { + dimensions?: string[]; + metrics?: Analyticsreporting_v4.Schema.DateRangeValues[]; + } + export interface ResourceQuotasRemaining { + dailyQuotaTokensRemaining?: number; + hourlyQuotaTokensRemaining?: number; + } + export interface ScreenviewData { + appName?: string; + mobileDeviceBranding?: string; + mobileDeviceModel?: string; + screenName?: string; + } + export interface SearchUserActivityRequest { + activityTypes?: string[]; + dateRange?: Analyticsreporting_v4.Schema.DateRange; + pageSize?: number; + pageToken?: string; + user?: Analyticsreporting_v4.Schema.User; + viewId?: string; + } + export interface SearchUserActivityResponse { + nextPageToken?: string; + sampleRate?: Number; + sessions?: Analyticsreporting_v4.Schema.UserActivitySession[]; + totalRows?: number; + } + export interface Segment { + dynamicSegment?: Analyticsreporting_v4.Schema.DynamicSegment; + segmentId?: string; + } + export interface SegmentDefinition { + segmentFilters?: Analyticsreporting_v4.Schema.SegmentFilter[]; + } + export interface SegmentDimensionFilter { + caseSensitive?: boolean; + dimensionName?: string; + expressions?: string[]; + maxComparisonValue?: string; + minComparisonValue?: string; + operator?: string; + } + export interface SegmentFilter { + not?: boolean; + sequenceSegment?: Analyticsreporting_v4.Schema.SequenceSegment; + simpleSegment?: Analyticsreporting_v4.Schema.SimpleSegment; + } + export interface SegmentFilterClause { + dimensionFilter?: Analyticsreporting_v4.Schema.SegmentDimensionFilter; + metricFilter?: Analyticsreporting_v4.Schema.SegmentMetricFilter; + not?: boolean; + } + export interface SegmentMetricFilter { + comparisonValue?: string; + maxComparisonValue?: string; + metricName?: string; + operator?: string; + scope?: string; + } + export interface SegmentSequenceStep { + matchType?: string; + orFiltersForSegment?: Analyticsreporting_v4.Schema.OrFiltersForSegment[]; + } + export interface SequenceSegment { + firstStepShouldMatchFirstHit?: boolean; + segmentSequenceSteps?: Analyticsreporting_v4.Schema.SegmentSequenceStep[]; + } + export interface SimpleSegment { + orFiltersForSegment?: Analyticsreporting_v4.Schema.OrFiltersForSegment[]; + } + export interface TransactionData { + transactionId?: string; + transactionRevenue?: Number; + transactionShipping?: Number; + transactionTax?: Number; + } + export interface User { + type?: string; + userId?: string; + } + export interface UserActivitySession { + activities?: Analyticsreporting_v4.Schema.Activity[]; + dataSource?: string; + deviceCategory?: string; + platform?: string; + sessionDate?: string; + sessionId?: string; + } + } + } + export interface Analyticsreporting_v4 { + Reports?: Analyticsreporting_v4.Collection.ReportsCollection; + UserActivity?: Analyticsreporting_v4.Collection.UserActivityCollection; + // Create a new instance of Cohort + newCohort(): Analyticsreporting_v4.Schema.Cohort; + // Create a new instance of CohortGroup + newCohortGroup(): Analyticsreporting_v4.Schema.CohortGroup; + // Create a new instance of DateRange + newDateRange(): Analyticsreporting_v4.Schema.DateRange; + // Create a new instance of Dimension + newDimension(): Analyticsreporting_v4.Schema.Dimension; + // Create a new instance of DimensionFilter + newDimensionFilter(): Analyticsreporting_v4.Schema.DimensionFilter; + // Create a new instance of DimensionFilterClause + newDimensionFilterClause(): Analyticsreporting_v4.Schema.DimensionFilterClause; + // Create a new instance of DynamicSegment + newDynamicSegment(): Analyticsreporting_v4.Schema.DynamicSegment; + // Create a new instance of GetReportsRequest + newGetReportsRequest(): Analyticsreporting_v4.Schema.GetReportsRequest; + // Create a new instance of Metric + newMetric(): Analyticsreporting_v4.Schema.Metric; + // Create a new instance of MetricFilter + newMetricFilter(): Analyticsreporting_v4.Schema.MetricFilter; + // Create a new instance of MetricFilterClause + newMetricFilterClause(): Analyticsreporting_v4.Schema.MetricFilterClause; + // Create a new instance of OrFiltersForSegment + newOrFiltersForSegment(): Analyticsreporting_v4.Schema.OrFiltersForSegment; + // Create a new instance of OrderBy + newOrderBy(): Analyticsreporting_v4.Schema.OrderBy; + // Create a new instance of Pivot + newPivot(): Analyticsreporting_v4.Schema.Pivot; + // Create a new instance of ReportRequest + newReportRequest(): Analyticsreporting_v4.Schema.ReportRequest; + // Create a new instance of SearchUserActivityRequest + newSearchUserActivityRequest(): Analyticsreporting_v4.Schema.SearchUserActivityRequest; + // Create a new instance of Segment + newSegment(): Analyticsreporting_v4.Schema.Segment; + // Create a new instance of SegmentDefinition + newSegmentDefinition(): Analyticsreporting_v4.Schema.SegmentDefinition; + // Create a new instance of SegmentDimensionFilter + newSegmentDimensionFilter(): Analyticsreporting_v4.Schema.SegmentDimensionFilter; + // Create a new instance of SegmentFilter + newSegmentFilter(): Analyticsreporting_v4.Schema.SegmentFilter; + // Create a new instance of SegmentFilterClause + newSegmentFilterClause(): Analyticsreporting_v4.Schema.SegmentFilterClause; + // Create a new instance of SegmentMetricFilter + newSegmentMetricFilter(): Analyticsreporting_v4.Schema.SegmentMetricFilter; + // Create a new instance of SegmentSequenceStep + newSegmentSequenceStep(): Analyticsreporting_v4.Schema.SegmentSequenceStep; + // Create a new instance of SequenceSegment + newSequenceSegment(): Analyticsreporting_v4.Schema.SequenceSegment; + // Create a new instance of SimpleSegment + newSimpleSegment(): Analyticsreporting_v4.Schema.SimpleSegment; + // Create a new instance of User + newUser(): Analyticsreporting_v4.Schema.User; + } +} + +declare var Analyticsreporting_v4: GoogleAppsScript.Analyticsreporting_v4; \ No newline at end of file diff --git a/types/google-apps-script/apis/appsactivity/v1.d.ts b/types/google-apps-script/apis/appsactivity/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/appsactivity_v1.d.ts b/types/google-apps-script/apis/appsactivity_v1.d.ts new file mode 100644 index 0000000000..4ac06a4dc9 --- /dev/null +++ b/types/google-apps-script/apis/appsactivity_v1.d.ts @@ -0,0 +1,84 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Appsactivity_v1 { + namespace Collection { + export 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_v1.Schema.ListActivitiesResponse; + // Returns a list of activities visible to the current logged in user. Visible activities are determined by the visiblity settings of the object that was acted on, e.g. Drive files a user can see. An activity is a record of past events. Multiple events may be merged if they are similar. A request is scoped to activities from a given Google service using the source parameter. + list(optionalArgs: object): Appsactivity_v1.Schema.ListActivitiesResponse; + } + } + namespace Schema { + export interface Activity { + combinedEvent?: Appsactivity_v1.Schema.Event; + singleEvents?: Appsactivity_v1.Schema.Event[]; + } + export interface Event { + additionalEventTypes?: string[]; + eventTimeMillis?: string; + fromUserDeletion?: boolean; + move?: Appsactivity_v1.Schema.Move; + permissionChanges?: Appsactivity_v1.Schema.PermissionChange[]; + primaryEventType?: string; + rename?: Appsactivity_v1.Schema.Rename; + target?: Appsactivity_v1.Schema.Target; + user?: Appsactivity_v1.Schema.User; + } + export interface ListActivitiesResponse { + activities?: Appsactivity_v1.Schema.Activity[]; + nextPageToken?: string; + } + export interface Move { + addedParents?: Appsactivity_v1.Schema.Parent[]; + removedParents?: Appsactivity_v1.Schema.Parent[]; + } + export interface Parent { + id?: string; + isRoot?: boolean; + title?: string; + } + export interface Permission { + name?: string; + permissionId?: string; + role?: string; + type?: string; + user?: Appsactivity_v1.Schema.User; + withLink?: boolean; + } + export interface PermissionChange { + addedPermissions?: Appsactivity_v1.Schema.Permission[]; + removedPermissions?: Appsactivity_v1.Schema.Permission[]; + } + export interface Photo { + url?: string; + } + export interface Rename { + newTitle?: string; + oldTitle?: string; + } + export interface Target { + id?: string; + mimeType?: string; + name?: string; + } + export interface User { + isDeleted?: boolean; + isMe?: boolean; + name?: string; + permissionId?: string; + photo?: Appsactivity_v1.Schema.Photo; + } + } + } + export interface Appsactivity_v1 { + Activities?: Appsactivity_v1.Collection.ActivitiesCollection; + } +} + +declare var Appsactivity_v1: GoogleAppsScript.Appsactivity_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/bigquery/v2.d.ts b/types/google-apps-script/apis/bigquery/v2.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/bigquery_v2.d.ts b/types/google-apps-script/apis/bigquery_v2.d.ts new file mode 100644 index 0000000000..74bbfe8562 --- /dev/null +++ b/types/google-apps-script/apis/bigquery_v2.d.ts @@ -0,0 +1,799 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Bigquery_v2 { + namespace Collection { + export interface DatasetsCollection { + // Returns the dataset specified by datasetID. + get(projectId: string, datasetId: string): Bigquery_v2.Schema.Dataset; + // Creates a new empty dataset. + insert(resource: Bigquery_v2.Schema.Dataset, projectId: string): Bigquery_v2.Schema.Dataset; + // Lists all datasets in the specified project to which you have been granted the READER dataset role. + list(projectId: string): Bigquery_v2.Schema.DatasetList; + // Lists all datasets in the specified project to which you have been granted the READER dataset role. + list(projectId: string, optionalArgs: object): Bigquery_v2.Schema.DatasetList; + // Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. This method supports patch semantics. + patch(resource: Bigquery_v2.Schema.Dataset, projectId: string, datasetId: string): Bigquery_v2.Schema.Dataset; + // Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. + remove(projectId: string, datasetId: string): void; + // Deletes the dataset specified by the datasetId value. Before you can delete a dataset, you must delete all its tables, either manually or by specifying deleteContents. Immediately after deletion, you can create another dataset with the same name. + remove(projectId: string, datasetId: string, optionalArgs: object): void; + // Updates information in an existing dataset. The update method replaces the entire dataset resource, whereas the patch method only replaces fields that are provided in the submitted dataset resource. + update(resource: Bigquery_v2.Schema.Dataset, projectId: string, datasetId: string): Bigquery_v2.Schema.Dataset; + } + export 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_v2.Schema.JobCancelResponse; + // Requests that a job be cancelled. This call will return immediately, and the client will need to poll for the job status to see if the cancel completed successfully. Cancelled jobs may still incur costs. + cancel(projectId: string, jobId: string, optionalArgs: object): Bigquery_v2.Schema.JobCancelResponse; + // Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. + get(projectId: string, jobId: string): Bigquery_v2.Schema.Job; + // Returns information about a specific job. Job information is available for a six month period after creation. Requires that you're the person who ran the job, or have the Is Owner project role. + get(projectId: string, jobId: string, optionalArgs: object): Bigquery_v2.Schema.Job; + // Retrieves the results of a query job. + getQueryResults(projectId: string, jobId: string): Bigquery_v2.Schema.GetQueryResultsResponse; + // Retrieves the results of a query job. + getQueryResults(projectId: string, jobId: string, optionalArgs: object): Bigquery_v2.Schema.GetQueryResultsResponse; + // Starts a new asynchronous job. Requires the Can View project role. + insert(resource: Bigquery_v2.Schema.Job, projectId: string): Bigquery_v2.Schema.Job; + // Starts a new asynchronous job. Requires the Can View project role. + insert(resource: Bigquery_v2.Schema.Job, projectId: string, mediaData: any): Bigquery_v2.Schema.Job; + // Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. + list(projectId: string): Bigquery_v2.Schema.JobList; + // Lists all jobs that you started in the specified project. Job information is available for a six month period after creation. The job list is sorted in reverse chronological order, by job creation time. Requires the Can View project role, or the Is Owner project role if you set the allUsers property. + list(projectId: string, optionalArgs: object): Bigquery_v2.Schema.JobList; + // Runs a BigQuery SQL query synchronously and returns query results if the query completes within a specified timeout. + query(resource: Bigquery_v2.Schema.QueryRequest, projectId: string): Bigquery_v2.Schema.QueryResponse; + } + export interface ProjectsCollection { + // Returns the email address of the service account for your project used for interactions with Google Cloud KMS. + getServiceAccount(projectId: string): Bigquery_v2.Schema.GetServiceAccountResponse; + // Lists all projects to which you have been granted any project role. + list(): Bigquery_v2.Schema.ProjectList; + // Lists all projects to which you have been granted any project role. + list(optionalArgs: object): Bigquery_v2.Schema.ProjectList; + } + export 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_v2.Schema.TableDataInsertAllRequest, projectId: string, datasetId: string, tableId: string): Bigquery_v2.Schema.TableDataInsertAllResponse; + // Retrieves table data from a specified set of rows. Requires the READER dataset role. + list(projectId: string, datasetId: string, tableId: string): Bigquery_v2.Schema.TableDataList; + // Retrieves table data from a specified set of rows. Requires the READER dataset role. + list(projectId: string, datasetId: string, tableId: string, optionalArgs: object): Bigquery_v2.Schema.TableDataList; + } + export 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_v2.Schema.Table; + // Gets the specified table resource by table ID. This method does not return the data in the table, it only returns the table resource, which describes the structure of this table. + get(projectId: string, datasetId: string, tableId: string, optionalArgs: object): Bigquery_v2.Schema.Table; + // Creates a new, empty table in the dataset. + insert(resource: Bigquery_v2.Schema.Table, projectId: string, datasetId: string): Bigquery_v2.Schema.Table; + // Lists all tables in the specified dataset. Requires the READER dataset role. + list(projectId: string, datasetId: string): Bigquery_v2.Schema.TableList; + // Lists all tables in the specified dataset. Requires the READER dataset role. + list(projectId: string, datasetId: string, optionalArgs: object): Bigquery_v2.Schema.TableList; + // Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. This method supports patch semantics. + patch(resource: Bigquery_v2.Schema.Table, projectId: string, datasetId: string, tableId: string): Bigquery_v2.Schema.Table; + // Deletes the table specified by tableId from the dataset. If the table contains data, all the data will be deleted. + remove(projectId: string, datasetId: string, tableId: string): void; + // Updates information in an existing table. The update method replaces the entire table resource, whereas the patch method only replaces fields that are provided in the submitted table resource. + update(resource: Bigquery_v2.Schema.Table, projectId: string, datasetId: string, tableId: string): Bigquery_v2.Schema.Table; + } + } + namespace Schema { + export interface BigQueryModelTraining { + currentIteration?: number; + expectedTotalIterations?: string; + } + export interface BigtableColumn { + encoding?: string; + fieldName?: string; + onlyReadLatest?: boolean; + qualifierEncoded?: string; + qualifierString?: string; + type?: string; + } + export interface BigtableColumnFamily { + columns?: Bigquery_v2.Schema.BigtableColumn[]; + encoding?: string; + familyId?: string; + onlyReadLatest?: boolean; + type?: string; + } + export interface BigtableOptions { + columnFamilies?: Bigquery_v2.Schema.BigtableColumnFamily[]; + ignoreUnspecifiedColumnFamilies?: boolean; + readRowkeyAsString?: boolean; + } + export interface BqmlIterationResult { + durationMs?: string; + evalLoss?: Number; + index?: number; + learnRate?: Number; + trainingLoss?: Number; + } + export interface BqmlTrainingRun { + iterationResults?: Bigquery_v2.Schema.BqmlIterationResult[]; + startTime?: string; + state?: string; + trainingOptions?: Bigquery_v2.Schema.BqmlTrainingRunTrainingOptions; + } + export interface BqmlTrainingRunTrainingOptions { + earlyStop?: boolean; + l1Reg?: Number; + l2Reg?: Number; + learnRate?: Number; + learnRateStrategy?: string; + lineSearchInitLearnRate?: Number; + maxIteration?: string; + minRelProgress?: Number; + warmStart?: boolean; + } + export interface Clustering { + fields?: string[]; + } + export interface CsvOptions { + allowJaggedRows?: boolean; + allowQuotedNewlines?: boolean; + encoding?: string; + fieldDelimiter?: string; + quote?: string; + skipLeadingRows?: string; + } + export interface Dataset { + access?: Bigquery_v2.Schema.DatasetAccess[]; + creationTime?: string; + datasetReference?: Bigquery_v2.Schema.DatasetReference; + defaultPartitionExpirationMs?: string; + defaultTableExpirationMs?: string; + description?: string; + etag?: string; + friendlyName?: string; + id?: string; + kind?: string; + labels?: object; + lastModifiedTime?: string; + location?: string; + selfLink?: string; + } + export interface DatasetAccess { + domain?: string; + groupByEmail?: string; + iamMember?: string; + role?: string; + specialGroup?: string; + userByEmail?: string; + view?: Bigquery_v2.Schema.TableReference; + } + export interface DatasetList { + datasets?: Bigquery_v2.Schema.DatasetListDatasets[]; + etag?: string; + kind?: string; + nextPageToken?: string; + } + export interface DatasetListDatasets { + datasetReference?: Bigquery_v2.Schema.DatasetReference; + friendlyName?: string; + id?: string; + kind?: string; + labels?: object; + location?: string; + } + export interface DatasetReference { + datasetId?: string; + projectId?: string; + } + export interface DestinationTableProperties { + description?: string; + friendlyName?: string; + labels?: object; + } + export interface EncryptionConfiguration { + kmsKeyName?: string; + } + export interface ErrorProto { + debugInfo?: string; + location?: string; + message?: string; + reason?: string; + } + export interface ExplainQueryStage { + completedParallelInputs?: string; + computeMsAvg?: string; + computeMsMax?: string; + computeRatioAvg?: Number; + computeRatioMax?: Number; + endMs?: string; + id?: string; + inputStages?: string[]; + name?: string; + parallelInputs?: string; + readMsAvg?: string; + readMsMax?: string; + readRatioAvg?: Number; + readRatioMax?: Number; + recordsRead?: string; + recordsWritten?: string; + shuffleOutputBytes?: string; + shuffleOutputBytesSpilled?: string; + startMs?: string; + status?: string; + steps?: Bigquery_v2.Schema.ExplainQueryStep[]; + waitMsAvg?: string; + waitMsMax?: string; + waitRatioAvg?: Number; + waitRatioMax?: Number; + writeMsAvg?: string; + writeMsMax?: string; + writeRatioAvg?: Number; + writeRatioMax?: Number; + } + export interface ExplainQueryStep { + kind?: string; + substeps?: string[]; + } + export interface ExternalDataConfiguration { + autodetect?: boolean; + bigtableOptions?: Bigquery_v2.Schema.BigtableOptions; + compression?: string; + csvOptions?: Bigquery_v2.Schema.CsvOptions; + googleSheetsOptions?: Bigquery_v2.Schema.GoogleSheetsOptions; + hivePartitioningMode?: string; + ignoreUnknownValues?: boolean; + maxBadRecords?: number; + schema?: Bigquery_v2.Schema.TableSchema; + sourceFormat?: string; + sourceUris?: string[]; + } + export interface GetQueryResultsResponse { + cacheHit?: boolean; + errors?: Bigquery_v2.Schema.ErrorProto[]; + etag?: string; + jobComplete?: boolean; + jobReference?: Bigquery_v2.Schema.JobReference; + kind?: string; + numDmlAffectedRows?: string; + pageToken?: string; + rows?: Bigquery_v2.Schema.TableRow[]; + schema?: Bigquery_v2.Schema.TableSchema; + totalBytesProcessed?: string; + totalRows?: string; + } + export interface GetServiceAccountResponse { + email?: string; + kind?: string; + } + export interface GoogleSheetsOptions { + range?: string; + skipLeadingRows?: string; + } + export interface Job { + configuration?: Bigquery_v2.Schema.JobConfiguration; + etag?: string; + id?: string; + jobReference?: Bigquery_v2.Schema.JobReference; + kind?: string; + selfLink?: string; + statistics?: Bigquery_v2.Schema.JobStatistics; + status?: Bigquery_v2.Schema.JobStatus; + user_email?: string; + } + export interface JobCancelResponse { + job?: Bigquery_v2.Schema.Job; + kind?: string; + } + export interface JobConfiguration { + copy?: Bigquery_v2.Schema.JobConfigurationTableCopy; + dryRun?: boolean; + extract?: Bigquery_v2.Schema.JobConfigurationExtract; + jobTimeoutMs?: string; + jobType?: string; + labels?: object; + load?: Bigquery_v2.Schema.JobConfigurationLoad; + query?: Bigquery_v2.Schema.JobConfigurationQuery; + } + export interface JobConfigurationExtract { + compression?: string; + destinationFormat?: string; + destinationUri?: string; + destinationUris?: string[]; + fieldDelimiter?: string; + printHeader?: boolean; + sourceTable?: Bigquery_v2.Schema.TableReference; + } + export interface JobConfigurationLoad { + allowJaggedRows?: boolean; + allowQuotedNewlines?: boolean; + autodetect?: boolean; + clustering?: Bigquery_v2.Schema.Clustering; + createDisposition?: string; + destinationEncryptionConfiguration?: Bigquery_v2.Schema.EncryptionConfiguration; + destinationTable?: Bigquery_v2.Schema.TableReference; + destinationTableProperties?: Bigquery_v2.Schema.DestinationTableProperties; + encoding?: string; + fieldDelimiter?: string; + hivePartitioningMode?: string; + ignoreUnknownValues?: boolean; + maxBadRecords?: number; + nullMarker?: string; + projectionFields?: string[]; + quote?: string; + rangePartitioning?: Bigquery_v2.Schema.RangePartitioning; + schema?: Bigquery_v2.Schema.TableSchema; + schemaInline?: string; + schemaInlineFormat?: string; + schemaUpdateOptions?: string[]; + skipLeadingRows?: number; + sourceFormat?: string; + sourceUris?: string[]; + timePartitioning?: Bigquery_v2.Schema.TimePartitioning; + useAvroLogicalTypes?: boolean; + writeDisposition?: string; + } + export interface JobConfigurationQuery { + allowLargeResults?: boolean; + clustering?: Bigquery_v2.Schema.Clustering; + createDisposition?: string; + defaultDataset?: Bigquery_v2.Schema.DatasetReference; + destinationEncryptionConfiguration?: Bigquery_v2.Schema.EncryptionConfiguration; + destinationTable?: Bigquery_v2.Schema.TableReference; + flattenResults?: boolean; + maximumBillingTier?: number; + maximumBytesBilled?: string; + parameterMode?: string; + preserveNulls?: boolean; + priority?: string; + query?: string; + queryParameters?: Bigquery_v2.Schema.QueryParameter[]; + rangePartitioning?: Bigquery_v2.Schema.RangePartitioning; + schemaUpdateOptions?: string[]; + tableDefinitions?: object; + timePartitioning?: Bigquery_v2.Schema.TimePartitioning; + useLegacySql?: boolean; + useQueryCache?: boolean; + userDefinedFunctionResources?: Bigquery_v2.Schema.UserDefinedFunctionResource[]; + writeDisposition?: string; + } + export interface JobConfigurationTableCopy { + createDisposition?: string; + destinationEncryptionConfiguration?: Bigquery_v2.Schema.EncryptionConfiguration; + destinationTable?: Bigquery_v2.Schema.TableReference; + sourceTable?: Bigquery_v2.Schema.TableReference; + sourceTables?: Bigquery_v2.Schema.TableReference[]; + writeDisposition?: string; + } + export interface JobList { + etag?: string; + jobs?: Bigquery_v2.Schema.JobListJobs[]; + kind?: string; + nextPageToken?: string; + } + export interface JobListJobs { + configuration?: Bigquery_v2.Schema.JobConfiguration; + errorResult?: Bigquery_v2.Schema.ErrorProto; + id?: string; + jobReference?: Bigquery_v2.Schema.JobReference; + kind?: string; + state?: string; + statistics?: Bigquery_v2.Schema.JobStatistics; + status?: Bigquery_v2.Schema.JobStatus; + user_email?: string; + } + export interface JobReference { + jobId?: string; + location?: string; + projectId?: string; + } + export interface JobStatistics { + completionRatio?: Number; + creationTime?: string; + endTime?: string; + extract?: Bigquery_v2.Schema.JobStatistics4; + load?: Bigquery_v2.Schema.JobStatistics3; + numChildJobs?: string; + parentJobId?: string; + query?: Bigquery_v2.Schema.JobStatistics2; + quotaDeferments?: string[]; + reservationUsage?: Bigquery_v2.Schema.JobStatisticsReservationUsage[]; + startTime?: string; + totalBytesProcessed?: string; + totalSlotMs?: string; + } + export interface JobStatistics2 { + billingTier?: number; + cacheHit?: boolean; + ddlOperationPerformed?: string; + ddlTargetRoutine?: Bigquery_v2.Schema.RoutineReference; + ddlTargetTable?: Bigquery_v2.Schema.TableReference; + estimatedBytesProcessed?: string; + modelTraining?: Bigquery_v2.Schema.BigQueryModelTraining; + modelTrainingCurrentIteration?: number; + modelTrainingExpectedTotalIteration?: string; + numDmlAffectedRows?: string; + queryPlan?: Bigquery_v2.Schema.ExplainQueryStage[]; + referencedTables?: Bigquery_v2.Schema.TableReference[]; + reservationUsage?: Bigquery_v2.Schema.JobStatistics2ReservationUsage[]; + schema?: Bigquery_v2.Schema.TableSchema; + statementType?: string; + timeline?: Bigquery_v2.Schema.QueryTimelineSample[]; + totalBytesBilled?: string; + totalBytesProcessed?: string; + totalBytesProcessedAccuracy?: string; + totalPartitionsProcessed?: string; + totalSlotMs?: string; + undeclaredQueryParameters?: Bigquery_v2.Schema.QueryParameter[]; + } + export interface JobStatistics2ReservationUsage { + name?: string; + slotMs?: string; + } + export interface JobStatistics3 { + badRecords?: string; + inputFileBytes?: string; + inputFiles?: string; + outputBytes?: string; + outputRows?: string; + } + export interface JobStatistics4 { + destinationUriFileCounts?: string[]; + inputBytes?: string; + } + export interface JobStatisticsReservationUsage { + name?: string; + slotMs?: string; + } + export interface JobStatus { + errorResult?: Bigquery_v2.Schema.ErrorProto; + errors?: Bigquery_v2.Schema.ErrorProto[]; + state?: string; + } + export interface MaterializedViewDefinition { + lastRefreshTime?: string; + query?: string; + } + export interface ModelDefinition { + modelOptions?: Bigquery_v2.Schema.ModelDefinitionModelOptions; + trainingRuns?: Bigquery_v2.Schema.BqmlTrainingRun[]; + } + export interface ModelDefinitionModelOptions { + labels?: string[]; + lossType?: string; + modelType?: string; + } + export interface ProjectList { + etag?: string; + kind?: string; + nextPageToken?: string; + projects?: Bigquery_v2.Schema.ProjectListProjects[]; + totalItems?: number; + } + export interface ProjectListProjects { + friendlyName?: string; + id?: string; + kind?: string; + numericId?: string; + projectReference?: Bigquery_v2.Schema.ProjectReference; + } + export interface ProjectReference { + projectId?: string; + } + export interface QueryParameter { + name?: string; + parameterType?: Bigquery_v2.Schema.QueryParameterType; + parameterValue?: Bigquery_v2.Schema.QueryParameterValue; + } + export interface QueryParameterType { + arrayType?: Bigquery_v2.Schema.QueryParameterType; + structTypes?: Bigquery_v2.Schema.QueryParameterTypeStructTypes[]; + type?: string; + } + export interface QueryParameterTypeStructTypes { + description?: string; + name?: string; + type?: Bigquery_v2.Schema.QueryParameterType; + } + export interface QueryParameterValue { + arrayValues?: Bigquery_v2.Schema.QueryParameterValue[]; + structValues?: object; + value?: string; + } + export interface QueryRequest { + defaultDataset?: Bigquery_v2.Schema.DatasetReference; + dryRun?: boolean; + kind?: string; + location?: string; + maxResults?: number; + parameterMode?: string; + preserveNulls?: boolean; + query?: string; + queryParameters?: Bigquery_v2.Schema.QueryParameter[]; + timeoutMs?: number; + useLegacySql?: boolean; + useQueryCache?: boolean; + } + export interface QueryResponse { + cacheHit?: boolean; + errors?: Bigquery_v2.Schema.ErrorProto[]; + jobComplete?: boolean; + jobReference?: Bigquery_v2.Schema.JobReference; + kind?: string; + numDmlAffectedRows?: string; + pageToken?: string; + rows?: Bigquery_v2.Schema.TableRow[]; + schema?: Bigquery_v2.Schema.TableSchema; + totalBytesProcessed?: string; + totalRows?: string; + } + export interface QueryTimelineSample { + activeUnits?: string; + completedUnits?: string; + elapsedMs?: string; + pendingUnits?: string; + totalSlotMs?: string; + } + export interface RangePartitioning { + field?: string; + range?: Bigquery_v2.Schema.RangePartitioningRange; + } + export interface RangePartitioningRange { + end?: string; + interval?: string; + start?: string; + } + export interface RoutineReference { + datasetId?: string; + projectId?: string; + routineId?: string; + } + export interface Streamingbuffer { + estimatedBytes?: string; + estimatedRows?: string; + oldestEntryTime?: string; + } + export interface Table { + clustering?: Bigquery_v2.Schema.Clustering; + creationTime?: string; + description?: string; + encryptionConfiguration?: Bigquery_v2.Schema.EncryptionConfiguration; + etag?: string; + expirationTime?: string; + externalDataConfiguration?: Bigquery_v2.Schema.ExternalDataConfiguration; + friendlyName?: string; + id?: string; + kind?: string; + labels?: object; + lastModifiedTime?: string; + location?: string; + materializedView?: Bigquery_v2.Schema.MaterializedViewDefinition; + model?: Bigquery_v2.Schema.ModelDefinition; + numBytes?: string; + numLongTermBytes?: string; + numPhysicalBytes?: string; + numRows?: string; + rangePartitioning?: Bigquery_v2.Schema.RangePartitioning; + requirePartitionFilter?: boolean; + schema?: Bigquery_v2.Schema.TableSchema; + selfLink?: string; + streamingBuffer?: Bigquery_v2.Schema.Streamingbuffer; + tableReference?: Bigquery_v2.Schema.TableReference; + timePartitioning?: Bigquery_v2.Schema.TimePartitioning; + type?: string; + view?: Bigquery_v2.Schema.ViewDefinition; + } + export interface TableCell { + v?: object; + } + export interface TableDataInsertAllRequest { + ignoreUnknownValues?: boolean; + kind?: string; + rows?: Bigquery_v2.Schema.TableDataInsertAllRequestRows[]; + skipInvalidRows?: boolean; + templateSuffix?: string; + } + export interface TableDataInsertAllRequestRows { + insertId?: string; + json?: object; + } + export interface TableDataInsertAllResponse { + insertErrors?: Bigquery_v2.Schema.TableDataInsertAllResponseInsertErrors[]; + kind?: string; + } + export interface TableDataInsertAllResponseInsertErrors { + errors?: Bigquery_v2.Schema.ErrorProto[]; + index?: number; + } + export interface TableDataList { + etag?: string; + kind?: string; + pageToken?: string; + rows?: Bigquery_v2.Schema.TableRow[]; + totalRows?: string; + } + export interface TableFieldSchema { + categories?: Bigquery_v2.Schema.TableFieldSchemaCategories; + description?: string; + fields?: Bigquery_v2.Schema.TableFieldSchema[]; + mode?: string; + name?: string; + type?: string; + } + export interface TableFieldSchemaCategories { + names?: string[]; + } + export interface TableList { + etag?: string; + kind?: string; + nextPageToken?: string; + tables?: Bigquery_v2.Schema.TableListTables[]; + totalItems?: number; + } + export interface TableListTables { + clustering?: Bigquery_v2.Schema.Clustering; + creationTime?: string; + expirationTime?: string; + friendlyName?: string; + id?: string; + kind?: string; + labels?: object; + tableReference?: Bigquery_v2.Schema.TableReference; + timePartitioning?: Bigquery_v2.Schema.TimePartitioning; + type?: string; + view?: Bigquery_v2.Schema.TableListTablesView; + } + export interface TableListTablesView { + useLegacySql?: boolean; + } + export interface TableReference { + datasetId?: string; + projectId?: string; + tableId?: string; + } + export interface TableRow { + f?: Bigquery_v2.Schema.TableCell[]; + } + export interface TableSchema { + fields?: Bigquery_v2.Schema.TableFieldSchema[]; + } + export interface TimePartitioning { + expirationMs?: string; + field?: string; + requirePartitionFilter?: boolean; + type?: string; + } + export interface UserDefinedFunctionResource { + inlineCode?: string; + resourceUri?: string; + } + export interface ViewDefinition { + query?: string; + useLegacySql?: boolean; + userDefinedFunctionResources?: Bigquery_v2.Schema.UserDefinedFunctionResource[]; + } + } + } + export interface Bigquery_v2 { + Datasets?: Bigquery_v2.Collection.DatasetsCollection; + Jobs?: Bigquery_v2.Collection.JobsCollection; + Projects?: Bigquery_v2.Collection.ProjectsCollection; + Tabledata?: Bigquery_v2.Collection.TabledataCollection; + Tables?: Bigquery_v2.Collection.TablesCollection; + // Create a new instance of BigQueryModelTraining + newBigQueryModelTraining(): Bigquery_v2.Schema.BigQueryModelTraining; + // Create a new instance of BigtableColumn + newBigtableColumn(): Bigquery_v2.Schema.BigtableColumn; + // Create a new instance of BigtableColumnFamily + newBigtableColumnFamily(): Bigquery_v2.Schema.BigtableColumnFamily; + // Create a new instance of BigtableOptions + newBigtableOptions(): Bigquery_v2.Schema.BigtableOptions; + // Create a new instance of BqmlIterationResult + newBqmlIterationResult(): Bigquery_v2.Schema.BqmlIterationResult; + // Create a new instance of BqmlTrainingRun + newBqmlTrainingRun(): Bigquery_v2.Schema.BqmlTrainingRun; + // Create a new instance of BqmlTrainingRunTrainingOptions + newBqmlTrainingRunTrainingOptions(): Bigquery_v2.Schema.BqmlTrainingRunTrainingOptions; + // Create a new instance of Clustering + newClustering(): Bigquery_v2.Schema.Clustering; + // Create a new instance of CsvOptions + newCsvOptions(): Bigquery_v2.Schema.CsvOptions; + // Create a new instance of Dataset + newDataset(): Bigquery_v2.Schema.Dataset; + // Create a new instance of DatasetAccess + newDatasetAccess(): Bigquery_v2.Schema.DatasetAccess; + // Create a new instance of DatasetReference + newDatasetReference(): Bigquery_v2.Schema.DatasetReference; + // Create a new instance of DestinationTableProperties + newDestinationTableProperties(): Bigquery_v2.Schema.DestinationTableProperties; + // Create a new instance of EncryptionConfiguration + newEncryptionConfiguration(): Bigquery_v2.Schema.EncryptionConfiguration; + // Create a new instance of ErrorProto + newErrorProto(): Bigquery_v2.Schema.ErrorProto; + // Create a new instance of ExplainQueryStage + newExplainQueryStage(): Bigquery_v2.Schema.ExplainQueryStage; + // Create a new instance of ExplainQueryStep + newExplainQueryStep(): Bigquery_v2.Schema.ExplainQueryStep; + // Create a new instance of ExternalDataConfiguration + newExternalDataConfiguration(): Bigquery_v2.Schema.ExternalDataConfiguration; + // Create a new instance of GoogleSheetsOptions + newGoogleSheetsOptions(): Bigquery_v2.Schema.GoogleSheetsOptions; + // Create a new instance of Job + newJob(): Bigquery_v2.Schema.Job; + // Create a new instance of JobConfiguration + newJobConfiguration(): Bigquery_v2.Schema.JobConfiguration; + // Create a new instance of JobConfigurationExtract + newJobConfigurationExtract(): Bigquery_v2.Schema.JobConfigurationExtract; + // Create a new instance of JobConfigurationLoad + newJobConfigurationLoad(): Bigquery_v2.Schema.JobConfigurationLoad; + // Create a new instance of JobConfigurationQuery + newJobConfigurationQuery(): Bigquery_v2.Schema.JobConfigurationQuery; + // Create a new instance of JobConfigurationTableCopy + newJobConfigurationTableCopy(): Bigquery_v2.Schema.JobConfigurationTableCopy; + // Create a new instance of JobReference + newJobReference(): Bigquery_v2.Schema.JobReference; + // Create a new instance of JobStatistics + newJobStatistics(): Bigquery_v2.Schema.JobStatistics; + // Create a new instance of JobStatistics2 + newJobStatistics2(): Bigquery_v2.Schema.JobStatistics2; + // Create a new instance of JobStatistics2ReservationUsage + newJobStatistics2ReservationUsage(): Bigquery_v2.Schema.JobStatistics2ReservationUsage; + // Create a new instance of JobStatistics3 + newJobStatistics3(): Bigquery_v2.Schema.JobStatistics3; + // Create a new instance of JobStatistics4 + newJobStatistics4(): Bigquery_v2.Schema.JobStatistics4; + // Create a new instance of JobStatisticsReservationUsage + newJobStatisticsReservationUsage(): Bigquery_v2.Schema.JobStatisticsReservationUsage; + // Create a new instance of JobStatus + newJobStatus(): Bigquery_v2.Schema.JobStatus; + // Create a new instance of MaterializedViewDefinition + newMaterializedViewDefinition(): Bigquery_v2.Schema.MaterializedViewDefinition; + // Create a new instance of ModelDefinition + newModelDefinition(): Bigquery_v2.Schema.ModelDefinition; + // Create a new instance of ModelDefinitionModelOptions + newModelDefinitionModelOptions(): Bigquery_v2.Schema.ModelDefinitionModelOptions; + // Create a new instance of QueryParameter + newQueryParameter(): Bigquery_v2.Schema.QueryParameter; + // Create a new instance of QueryParameterType + newQueryParameterType(): Bigquery_v2.Schema.QueryParameterType; + // Create a new instance of QueryParameterTypeStructTypes + newQueryParameterTypeStructTypes(): Bigquery_v2.Schema.QueryParameterTypeStructTypes; + // Create a new instance of QueryParameterValue + newQueryParameterValue(): Bigquery_v2.Schema.QueryParameterValue; + // Create a new instance of QueryRequest + newQueryRequest(): Bigquery_v2.Schema.QueryRequest; + // Create a new instance of QueryTimelineSample + newQueryTimelineSample(): Bigquery_v2.Schema.QueryTimelineSample; + // Create a new instance of RangePartitioning + newRangePartitioning(): Bigquery_v2.Schema.RangePartitioning; + // Create a new instance of RangePartitioningRange + newRangePartitioningRange(): Bigquery_v2.Schema.RangePartitioningRange; + // Create a new instance of RoutineReference + newRoutineReference(): Bigquery_v2.Schema.RoutineReference; + // Create a new instance of Streamingbuffer + newStreamingbuffer(): Bigquery_v2.Schema.Streamingbuffer; + // Create a new instance of Table + newTable(): Bigquery_v2.Schema.Table; + // Create a new instance of TableDataInsertAllRequest + newTableDataInsertAllRequest(): Bigquery_v2.Schema.TableDataInsertAllRequest; + // Create a new instance of TableDataInsertAllRequestRows + newTableDataInsertAllRequestRows(): Bigquery_v2.Schema.TableDataInsertAllRequestRows; + // Create a new instance of TableFieldSchema + newTableFieldSchema(): Bigquery_v2.Schema.TableFieldSchema; + // Create a new instance of TableFieldSchemaCategories + newTableFieldSchemaCategories(): Bigquery_v2.Schema.TableFieldSchemaCategories; + // Create a new instance of TableReference + newTableReference(): Bigquery_v2.Schema.TableReference; + // Create a new instance of TableSchema + newTableSchema(): Bigquery_v2.Schema.TableSchema; + // Create a new instance of TimePartitioning + newTimePartitioning(): Bigquery_v2.Schema.TimePartitioning; + // Create a new instance of UserDefinedFunctionResource + newUserDefinedFunctionResource(): Bigquery_v2.Schema.UserDefinedFunctionResource; + // Create a new instance of ViewDefinition + newViewDefinition(): Bigquery_v2.Schema.ViewDefinition; + } +} + +declare var Bigquery_v2: GoogleAppsScript.Bigquery_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/calendar/v3.d.ts b/types/google-apps-script/apis/calendar/v3.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/calendar_v3.d.ts b/types/google-apps-script/apis/calendar_v3.d.ts new file mode 100644 index 0000000000..53aa4f03ea --- /dev/null +++ b/types/google-apps-script/apis/calendar_v3.d.ts @@ -0,0 +1,587 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Calendar_v3 { + namespace Collection { + export interface AclCollection { + // Returns an access control rule. + get(calendarId: string, ruleId: string): Calendar_v3.Schema.AclRule; + // Returns an access control rule. + get(calendarId: string, ruleId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.AclRule; + // Creates an access control rule. + insert(resource: Schema.AclRule, calendarId: string): Calendar_v3.Schema.AclRule; + // Creates an access control rule. + insert(resource: Schema.AclRule, calendarId: string, optionalArgs: object): Calendar_v3.Schema.AclRule; + // Creates an access control rule. + insert(resource: Schema.AclRule, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.AclRule; + // Returns the rules in the access control list for the calendar. + list(calendarId: string): Calendar_v3.Schema.Acl; + // Returns the rules in the access control list for the calendar. + list(calendarId: string, optionalArgs: object): Calendar_v3.Schema.Acl; + // Returns the rules in the access control list for the calendar. + list(calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Acl; + // Updates an access control rule. This method supports patch semantics. + patch(resource: Schema.AclRule, calendarId: string, ruleId: string): Calendar_v3.Schema.AclRule; + // Updates an access control rule. This method supports patch semantics. + patch(resource: Schema.AclRule, calendarId: string, ruleId: string, optionalArgs: object): Calendar_v3.Schema.AclRule; + // Updates an access control rule. This method supports patch semantics. + patch(resource: Schema.AclRule, calendarId: string, ruleId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.AclRule; + // Deletes an access control rule. + remove(calendarId: string, ruleId: string): void; + // Deletes an access control rule. + remove(calendarId: string, ruleId: string, optionalArgs: object, headers: object): void; + // Updates an access control rule. + update(resource: Schema.AclRule, calendarId: string, ruleId: string): Calendar_v3.Schema.AclRule; + // Updates an access control rule. + update(resource: Schema.AclRule, calendarId: string, ruleId: string, optionalArgs: object): Calendar_v3.Schema.AclRule; + // Updates an access control rule. + update(resource: Schema.AclRule, calendarId: string, ruleId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.AclRule; + // Watch for changes to ACL resources. + watch(resource: Schema.Channel, calendarId: string): Calendar_v3.Schema.Channel; + // Watch for changes to ACL resources. + watch(resource: Schema.Channel, calendarId: string, optionalArgs: object): Calendar_v3.Schema.Channel; + // Watch for changes to ACL resources. + watch(resource: Schema.Channel, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Channel; + } + export interface CalendarListCollection { + // Returns a calendar from the user's calendar list. + get(calendarId: string): Calendar_v3.Schema.CalendarListEntry; + // Returns a calendar from the user's calendar list. + get(calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.CalendarListEntry; + // Inserts an existing calendar into the user's calendar list. + insert(resource: Schema.CalendarListEntry): Calendar_v3.Schema.CalendarListEntry; + // Inserts an existing calendar into the user's calendar list. + insert(resource: Schema.CalendarListEntry, optionalArgs: object): Calendar_v3.Schema.CalendarListEntry; + // Inserts an existing calendar into the user's calendar list. + insert(resource: Schema.CalendarListEntry, optionalArgs: object, headers: object): Calendar_v3.Schema.CalendarListEntry; + // Returns the calendars on the user's calendar list. + list(): Calendar_v3.Schema.CalendarList; + // Returns the calendars on the user's calendar list. + list(optionalArgs: object): Calendar_v3.Schema.CalendarList; + // Returns the calendars on the user's calendar list. + list(optionalArgs: object, headers: object): Calendar_v3.Schema.CalendarList; + // Updates an existing calendar on the user's calendar list. This method supports patch semantics. + patch(resource: Schema.CalendarListEntry, calendarId: string): Calendar_v3.Schema.CalendarListEntry; + // Updates an existing calendar on the user's calendar list. This method supports patch semantics. + patch(resource: Schema.CalendarListEntry, calendarId: string, optionalArgs: object): Calendar_v3.Schema.CalendarListEntry; + // Updates an existing calendar on the user's calendar list. This method supports patch semantics. + patch(resource: Schema.CalendarListEntry, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.CalendarListEntry; + // Removes a calendar from the user's calendar list. + remove(calendarId: string): void; + // Removes a calendar from the user's calendar list. + remove(calendarId: string, optionalArgs: object, headers: object): void; + // Updates an existing calendar on the user's calendar list. + update(resource: Schema.CalendarListEntry, calendarId: string): Calendar_v3.Schema.CalendarListEntry; + // Updates an existing calendar on the user's calendar list. + update(resource: Schema.CalendarListEntry, calendarId: string, optionalArgs: object): Calendar_v3.Schema.CalendarListEntry; + // Updates an existing calendar on the user's calendar list. + update(resource: Schema.CalendarListEntry, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.CalendarListEntry; + // Watch for changes to CalendarList resources. + watch(resource: Schema.Channel): Calendar_v3.Schema.Channel; + // Watch for changes to CalendarList resources. + watch(resource: Schema.Channel, optionalArgs: object): Calendar_v3.Schema.Channel; + // Watch for changes to CalendarList resources. + watch(resource: Schema.Channel, optionalArgs: object, headers: object): Calendar_v3.Schema.Channel; + } + export interface CalendarsCollection { + // Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. + clear(calendarId: string): void; + // Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. + clear(calendarId: string, optionalArgs: object, headers: object): void; + // Returns metadata for a calendar. + get(calendarId: string): Calendar_v3.Schema.Calendar; + // Returns metadata for a calendar. + get(calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Calendar; + // Creates a secondary calendar. + insert(resource: Schema.Calendar): Calendar_v3.Schema.Calendar; + // Creates a secondary calendar. + insert(resource: Schema.Calendar, optionalArgs: object, headers: object): Calendar_v3.Schema.Calendar; + // Updates metadata for a calendar. This method supports patch semantics. + patch(resource: Schema.Calendar, calendarId: string): Calendar_v3.Schema.Calendar; + // Updates metadata for a calendar. This method supports patch semantics. + patch(resource: Schema.Calendar, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Calendar; + // Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. + remove(calendarId: string): void; + // Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. + remove(calendarId: string, optionalArgs: object, headers: object): void; + // Updates metadata for a calendar. + update(resource: Schema.Calendar, calendarId: string): Calendar_v3.Schema.Calendar; + // Updates metadata for a calendar. + update(resource: Schema.Calendar, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Calendar; + } + export 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 { + // Returns the color definitions for calendars and events. + get(): Calendar_v3.Schema.Colors; + // Returns the color definitions for calendars and events. + get(optionalArgs: object, headers: object): Calendar_v3.Schema.Colors; + } + export interface EventsCollection { + // Returns an event. + get(calendarId: string, eventId: string): Calendar_v3.Schema.Event; + // Returns an event. + get(calendarId: string, eventId: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Returns an event. + get(calendarId: string, eventId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Imports an event. This operation is used to add a private copy of an existing event to a calendar. + import(resource: Schema.Event, calendarId: string): Calendar_v3.Schema.Event; + // Imports an event. This operation is used to add a private copy of an existing event to a calendar. + import(resource: Schema.Event, calendarId: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Imports an event. This operation is used to add a private copy of an existing event to a calendar. + import(resource: Schema.Event, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Creates an event. + insert(resource: Schema.Event, calendarId: string): Calendar_v3.Schema.Event; + // Creates an event. + insert(resource: Schema.Event, calendarId: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Creates an event. + insert(resource: Schema.Event, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Returns instances of the specified recurring event. + instances(calendarId: string, eventId: string): Calendar_v3.Schema.Events; + // Returns instances of the specified recurring event. + instances(calendarId: string, eventId: string, optionalArgs: object): Calendar_v3.Schema.Events; + // Returns instances of the specified recurring event. + instances(calendarId: string, eventId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Events; + // Returns events on the specified calendar. + list(calendarId: string): Calendar_v3.Schema.Events; + // Returns events on the specified calendar. + list(calendarId: string, optionalArgs: object): Calendar_v3.Schema.Events; + // Returns events on the specified calendar. + list(calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Events; + // Moves an event to another calendar, i.e. changes an event's organizer. + move(calendarId: string, eventId: string, destination: string): Calendar_v3.Schema.Event; + // Moves an event to another calendar, i.e. changes an event's organizer. + move(calendarId: string, eventId: string, destination: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Moves an event to another calendar, i.e. changes an event's organizer. + move(calendarId: string, eventId: string, destination: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Updates an event. This method supports patch semantics. + patch(resource: Schema.Event, calendarId: string, eventId: string): Calendar_v3.Schema.Event; + // Updates an event. This method supports patch semantics. + patch(resource: Schema.Event, calendarId: string, eventId: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Updates an event. This method supports patch semantics. + patch(resource: Schema.Event, calendarId: string, eventId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Creates an event based on a simple text string. + quickAdd(calendarId: string, text: string): Calendar_v3.Schema.Event; + // Creates an event based on a simple text string. + quickAdd(calendarId: string, text: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Creates an event based on a simple text string. + quickAdd(calendarId: string, text: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Deletes an event. + remove(calendarId: string, eventId: string): void; + // Deletes an event. + remove(calendarId: string, eventId: string, optionalArgs: object): void; + // Deletes an event. + remove(calendarId: string, eventId: string, optionalArgs: object, headers: object): void; + // Updates an event. + update(resource: Schema.Event, calendarId: string, eventId: string): Calendar_v3.Schema.Event; + // Updates an event. + update(resource: Schema.Event, calendarId: string, eventId: string, optionalArgs: object): Calendar_v3.Schema.Event; + // Updates an event. + update(resource: Schema.Event, calendarId: string, eventId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Event; + // Watch for changes to Events resources. + watch(resource: Schema.Channel, calendarId: string): Calendar_v3.Schema.Channel; + // Watch for changes to Events resources. + watch(resource: Schema.Channel, calendarId: string, optionalArgs: object): Calendar_v3.Schema.Channel; + // Watch for changes to Events resources. + watch(resource: Schema.Channel, calendarId: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Channel; + } + export interface FreebusyCollection { + // Returns free/busy information for a set of calendars. + query(resource: Schema.FreeBusyRequest): Calendar_v3.Schema.FreeBusyResponse; + // Returns free/busy information for a set of calendars. + query(resource: Schema.FreeBusyRequest, optionalArgs: object, headers: object): Calendar_v3.Schema.FreeBusyResponse; + } + export interface SettingsCollection { + // Returns a single user setting. + get(setting: string): Calendar_v3.Schema.Setting; + // Returns a single user setting. + get(setting: string, optionalArgs: object, headers: object): Calendar_v3.Schema.Setting; + // Returns all user settings for the authenticated user. + list(): Calendar_v3.Schema.Settings; + // Returns all user settings for the authenticated user. + list(optionalArgs: object): Calendar_v3.Schema.Settings; + // Returns all user settings for the authenticated user. + list(optionalArgs: object, headers: object): Calendar_v3.Schema.Settings; + // Watch for changes to Settings resources. + watch(resource: Schema.Channel): Calendar_v3.Schema.Channel; + // Watch for changes to Settings resources. + watch(resource: Schema.Channel, optionalArgs: object): Calendar_v3.Schema.Channel; + // Watch for changes to Settings resources. + watch(resource: Schema.Channel, optionalArgs: object, headers: object): Calendar_v3.Schema.Channel; + } + } + namespace Schema { + export interface Acl { + etag?: string; + items?: Calendar_v3.Schema.AclRule[]; + kind?: string; + nextPageToken?: string; + nextSyncToken?: string; + } + export interface AclRule { + etag?: string; + id?: string; + kind?: string; + role?: string; + scope?: Calendar_v3.Schema.AclRuleScope; + } + export interface AclRuleScope { + type?: string; + value?: string; + } + export interface Calendar { + conferenceProperties?: Calendar_v3.Schema.ConferenceProperties; + description?: string; + etag?: string; + id?: string; + kind?: string; + location?: string; + summary?: string; + timeZone?: string; + } + export interface CalendarList { + etag?: string; + items?: Calendar_v3.Schema.CalendarListEntry[]; + kind?: string; + nextPageToken?: string; + nextSyncToken?: string; + } + export interface CalendarListEntry { + accessRole?: string; + backgroundColor?: string; + colorId?: string; + conferenceProperties?: Calendar_v3.Schema.ConferenceProperties; + defaultReminders?: Calendar_v3.Schema.EventReminder[]; + deleted?: boolean; + description?: string; + etag?: string; + foregroundColor?: string; + hidden?: boolean; + id?: string; + kind?: string; + location?: string; + notificationSettings?: Calendar_v3.Schema.CalendarListEntryNotificationSettings; + primary?: boolean; + selected?: boolean; + summary?: string; + summaryOverride?: string; + timeZone?: string; + } + export interface CalendarListEntryNotificationSettings { + notifications?: Calendar_v3.Schema.CalendarNotification[]; + } + export interface CalendarNotification { + method?: string; + type?: string; + } + export interface Channel { + address?: string; + expiration?: string; + id?: string; + kind?: string; + params?: object; + payload?: boolean; + resourceId?: string; + resourceUri?: string; + token?: string; + type?: string; + } + export interface ColorDefinition { + background?: string; + foreground?: string; + } + export interface Colors { + calendar?: object; + event?: object; + kind?: string; + updated?: string; + } + export interface ConferenceData { + conferenceId?: string; + conferenceSolution?: Calendar_v3.Schema.ConferenceSolution; + createRequest?: Calendar_v3.Schema.CreateConferenceRequest; + entryPoints?: Calendar_v3.Schema.EntryPoint[]; + notes?: string; + parameters?: Calendar_v3.Schema.ConferenceParameters; + signature?: string; + } + export interface ConferenceParameters { + addOnParameters?: Calendar_v3.Schema.ConferenceParametersAddOnParameters; + } + export interface ConferenceParametersAddOnParameters { + parameters?: object; + } + export interface ConferenceProperties { + allowedConferenceSolutionTypes?: string[]; + } + export interface ConferenceRequestStatus { + statusCode?: string; + } + export interface ConferenceSolution { + iconUri?: string; + key?: Calendar_v3.Schema.ConferenceSolutionKey; + name?: string; + } + export interface ConferenceSolutionKey { + type?: string; + } + export interface CreateConferenceRequest { + conferenceSolutionKey?: Calendar_v3.Schema.ConferenceSolutionKey; + requestId?: string; + status?: Calendar_v3.Schema.ConferenceRequestStatus; + } + export interface EntryPoint { + accessCode?: string; + entryPointFeatures?: string[]; + entryPointType?: string; + label?: string; + meetingCode?: string; + passcode?: string; + password?: string; + pin?: string; + regionCode?: string; + uri?: string; + } + export interface Error { + domain?: string; + reason?: string; + } + export interface Event { + anyoneCanAddSelf?: boolean; + attachments?: Calendar_v3.Schema.EventAttachment[]; + attendees?: Calendar_v3.Schema.EventAttendee[]; + attendeesOmitted?: boolean; + colorId?: string; + conferenceData?: Calendar_v3.Schema.ConferenceData; + created?: string; + creator?: Calendar_v3.Schema.EventCreator; + description?: string; + end?: Calendar_v3.Schema.EventDateTime; + endTimeUnspecified?: boolean; + etag?: string; + extendedProperties?: Calendar_v3.Schema.EventExtendedProperties; + gadget?: Calendar_v3.Schema.EventGadget; + guestsCanInviteOthers?: boolean; + guestsCanModify?: boolean; + guestsCanSeeOtherGuests?: boolean; + hangoutLink?: string; + htmlLink?: string; + iCalUID?: string; + id?: string; + kind?: string; + location?: string; + locked?: boolean; + organizer?: Calendar_v3.Schema.EventOrganizer; + originalStartTime?: Calendar_v3.Schema.EventDateTime; + privateCopy?: boolean; + recurrence?: string[]; + recurringEventId?: string; + reminders?: Calendar_v3.Schema.EventReminders; + sequence?: number; + source?: Calendar_v3.Schema.EventSource; + start?: Calendar_v3.Schema.EventDateTime; + status?: string; + summary?: string; + transparency?: string; + updated?: string; + visibility?: string; + } + export interface EventAttachment { + fileId?: string; + fileUrl?: string; + iconLink?: string; + mimeType?: string; + title?: string; + } + export interface EventAttendee { + additionalGuests?: number; + comment?: string; + displayName?: string; + email?: string; + id?: string; + optional?: boolean; + organizer?: boolean; + resource?: boolean; + responseStatus?: string; + self?: boolean; + } + export interface EventCreator { + displayName?: string; + email?: string; + id?: string; + self?: boolean; + } + export interface EventDateTime { + date?: string; + dateTime?: string; + timeZone?: string; + } + export interface EventExtendedProperties { + private?: object; + shared?: object; + } + export interface EventGadget { + display?: string; + height?: number; + iconLink?: string; + link?: string; + preferences?: object; + title?: string; + type?: string; + width?: number; + } + export interface EventOrganizer { + displayName?: string; + email?: string; + id?: string; + self?: boolean; + } + export interface EventReminder { + method?: string; + minutes?: number; + } + export interface EventReminders { + overrides?: Calendar_v3.Schema.EventReminder[]; + useDefault?: boolean; + } + export interface EventSource { + title?: string; + url?: string; + } + export interface Events { + accessRole?: string; + defaultReminders?: Calendar_v3.Schema.EventReminder[]; + description?: string; + etag?: string; + items?: Calendar_v3.Schema.Event[]; + kind?: string; + nextPageToken?: string; + nextSyncToken?: string; + summary?: string; + timeZone?: string; + updated?: string; + } + export interface FreeBusyCalendar { + busy?: Calendar_v3.Schema.TimePeriod[]; + errors?: Calendar_v3.Schema.Error[]; + } + export interface FreeBusyGroup { + calendars?: string[]; + errors?: Calendar_v3.Schema.Error[]; + } + export interface FreeBusyRequest { + calendarExpansionMax?: number; + groupExpansionMax?: number; + items?: Calendar_v3.Schema.FreeBusyRequestItem[]; + timeMax?: string; + timeMin?: string; + timeZone?: string; + } + export interface FreeBusyRequestItem { + id?: string; + } + export interface FreeBusyResponse { + calendars?: object; + groups?: object; + kind?: string; + timeMax?: string; + timeMin?: string; + } + export interface Setting { + etag?: string; + id?: string; + kind?: string; + value?: string; + } + export interface Settings { + etag?: string; + items?: Calendar_v3.Schema.Setting[]; + kind?: string; + nextPageToken?: string; + nextSyncToken?: string; + } + export interface TimePeriod { + end?: string; + start?: string; + } + } + } + export interface Calendar_v3 { + Acl?: Calendar_v3.Collection.AclCollection; + CalendarList?: Calendar_v3.Collection.CalendarListCollection; + Calendars?: Calendar_v3.Collection.CalendarsCollection; + Channels?: Calendar_v3.Collection.ChannelsCollection; + Colors?: Calendar_v3.Collection.ColorsCollection; + Events?: Calendar_v3.Collection.EventsCollection; + Freebusy?: Calendar_v3.Collection.FreebusyCollection; + Settings?: Calendar_v3.Collection.SettingsCollection; + // Create a new instance of AclRule + newAclRule(): Calendar_v3.Schema.AclRule; + // Create a new instance of AclRuleScope + newAclRuleScope(): Calendar_v3.Schema.AclRuleScope; + // Create a new instance of Calendar + newCalendar(): Calendar_v3.Schema.Calendar; + // Create a new instance of CalendarListEntry + newCalendarListEntry(): Calendar_v3.Schema.CalendarListEntry; + // Create a new instance of CalendarListEntryNotificationSettings + newCalendarListEntryNotificationSettings(): Calendar_v3.Schema.CalendarListEntryNotificationSettings; + // Create a new instance of CalendarNotification + newCalendarNotification(): Calendar_v3.Schema.CalendarNotification; + // Create a new instance of Channel + newChannel(): Calendar_v3.Schema.Channel; + // Create a new instance of ConferenceData + newConferenceData(): Calendar_v3.Schema.ConferenceData; + // Create a new instance of ConferenceParameters + newConferenceParameters(): Calendar_v3.Schema.ConferenceParameters; + // Create a new instance of ConferenceParametersAddOnParameters + newConferenceParametersAddOnParameters(): Calendar_v3.Schema.ConferenceParametersAddOnParameters; + // Create a new instance of ConferenceProperties + newConferenceProperties(): Calendar_v3.Schema.ConferenceProperties; + // Create a new instance of ConferenceRequestStatus + newConferenceRequestStatus(): Calendar_v3.Schema.ConferenceRequestStatus; + // Create a new instance of ConferenceSolution + newConferenceSolution(): Calendar_v3.Schema.ConferenceSolution; + // Create a new instance of ConferenceSolutionKey + newConferenceSolutionKey(): Calendar_v3.Schema.ConferenceSolutionKey; + // Create a new instance of CreateConferenceRequest + newCreateConferenceRequest(): Calendar_v3.Schema.CreateConferenceRequest; + // Create a new instance of EntryPoint + newEntryPoint(): Calendar_v3.Schema.EntryPoint; + // Create a new instance of Event + newEvent(): Calendar_v3.Schema.Event; + // Create a new instance of EventAttachment + newEventAttachment(): Calendar_v3.Schema.EventAttachment; + // Create a new instance of EventAttendee + newEventAttendee(): Calendar_v3.Schema.EventAttendee; + // Create a new instance of EventCreator + newEventCreator(): Calendar_v3.Schema.EventCreator; + // Create a new instance of EventDateTime + newEventDateTime(): Calendar_v3.Schema.EventDateTime; + // Create a new instance of EventExtendedProperties + newEventExtendedProperties(): Calendar_v3.Schema.EventExtendedProperties; + // Create a new instance of EventGadget + newEventGadget(): Calendar_v3.Schema.EventGadget; + // Create a new instance of EventOrganizer + newEventOrganizer(): Calendar_v3.Schema.EventOrganizer; + // Create a new instance of EventReminder + newEventReminder(): Calendar_v3.Schema.EventReminder; + // Create a new instance of EventReminders + newEventReminders(): Calendar_v3.Schema.EventReminders; + // Create a new instance of EventSource + newEventSource(): Calendar_v3.Schema.EventSource; + // Create a new instance of FreeBusyRequest + newFreeBusyRequest(): Calendar_v3.Schema.FreeBusyRequest; + // Create a new instance of FreeBusyRequestItem + newFreeBusyRequestItem(): Calendar_v3.Schema.FreeBusyRequestItem; + } +} + +declare var Calendar_v3: GoogleAppsScript.Calendar_v3; \ No newline at end of file diff --git a/types/google-apps-script/apis/classroom/v1.d.ts b/types/google-apps-script/apis/classroom/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/classroom_v1.d.ts b/types/google-apps-script/apis/classroom_v1.d.ts new file mode 100644 index 0000000000..bf0151793d --- /dev/null +++ b/types/google-apps-script/apis/classroom_v1.d.ts @@ -0,0 +1,1195 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Classroom_v1 { + namespace Collection { + namespace Courses { + namespace CourseWork { + export interface StudentSubmissionsCollection { + // Returns a student submission. + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course, course work, or student submission or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + get(courseId: string, courseWorkId: string, id: string): Classroom_v1.Schema.StudentSubmission; + // Returns a list of student submissions that the requester is permitted to + // view, factoring in the OAuth scopes of the request. + // `-` may be specified as the `course_work_id` to include student + // submissions for multiple course work items. + // Course students may only view their own work. Course teachers + // and domain administrators may view all student submissions. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string, courseWorkId: string): Classroom_v1.Schema.ListStudentSubmissionsResponse; + // Returns a list of student submissions that the requester is permitted to + // view, factoring in the OAuth scopes of the request. + // `-` may be specified as the `course_work_id` to include student + // submissions for multiple course work items. + // Course students may only view their own work. Course teachers + // and domain administrators may view all student submissions. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string, courseWorkId: string, optionalArgs: object): Classroom_v1.Schema.ListStudentSubmissionsResponse; + // Modifies attachments of student submission. + // Attachments may only be added to student submissions belonging to course + // work objects with a `workType` of `ASSIGNMENT`. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, if the user is not permitted to modify + // attachments on the requested student submission, or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + modifyAttachments(resource: Schema.ModifyAttachmentsRequest, courseId: string, courseWorkId: string, id: string): Classroom_v1.Schema.StudentSubmission; + // Updates one or more fields of a student submission. + // See google.StudentSubmission for details + // of which fields may be updated and who may change them. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding course work, if the user is not permitted to make the + // requested modification to the student submission, or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + patch(resource: Schema.StudentSubmission, courseId: string, courseWorkId: string, id: string): Classroom_v1.Schema.StudentSubmission; + // Updates one or more fields of a student submission. + // See google.StudentSubmission for details + // of which fields may be updated and who may change them. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding course work, if the user is not permitted to make the + // requested modification to the student submission, or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + patch(resource: Schema.StudentSubmission, courseId: string, courseWorkId: string, id: string, optionalArgs: object): Classroom_v1.Schema.StudentSubmission; + // Reclaims a student submission on behalf of the student that owns it. + // Reclaiming a student submission transfers ownership of attached Drive + // files to the student and updates the submission state. + // Only the student that owns the requested student submission may call this + // method, and only for a student submission that has been turned in. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, unsubmit the requested student submission, + // or for access errors. + // * `FAILED_PRECONDITION` if the student submission has not been turned in. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + reclaim(resource: any, courseId: string, courseWorkId: string, id: string): void; + // Returns a student submission. + // Returning a student submission transfers ownership of attached Drive + // files to the student and may also update the submission state. + // Unlike the Classroom application, returning a student submission does not + // set assignedGrade to the draftGrade value. + // Only a teacher of the course that contains the requested student submission + // may call this method. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, return the requested student submission, + // or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + return(resource: any, courseId: string, courseWorkId: string, id: string): void; + // Turns in a student submission. + // Turning in a student submission transfers ownership of attached Drive + // files to the teacher and may also update the submission state. + // This may only be called by the student that owns the specified student + // submission. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, turn in the requested student submission, + // or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + turnIn(resource: any, courseId: string, courseWorkId: string, id: string): void; + } + } + export interface AliasesCollection { + // Creates an alias for a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create the + // alias or for access errors. + // * `NOT_FOUND` if the course does not exist. + // * `ALREADY_EXISTS` if the alias already exists. + // * `FAILED_PRECONDITION` if the alias requested does not make sense for the + // requesting user or course (for example, if a user not in a domain + // attempts to access a domain-scoped alias). + create(resource: Schema.CourseAlias, courseId: string): Classroom_v1.Schema.CourseAlias; + // Returns a list of aliases for a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // course or for access errors. + // * `NOT_FOUND` if the course does not exist. + list(courseId: string): Classroom_v1.Schema.ListCourseAliasesResponse; + // Returns a list of aliases for a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // course or for access errors. + // * `NOT_FOUND` if the course does not exist. + list(courseId: string, optionalArgs: object): Classroom_v1.Schema.ListCourseAliasesResponse; + // Deletes an alias of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to remove the + // alias or for access errors. + // * `NOT_FOUND` if the alias does not exist. + // * `FAILED_PRECONDITION` if the alias requested does not make sense for the + // requesting user or course (for example, if a user not in a domain + // attempts to delete a domain-scoped alias). + remove(courseId: string, alias: string): void; + } + export interface AnnouncementsCollection { + // Creates an announcement. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course, create announcements in the requested course, share a + // Drive attachment, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + // * `FAILED_PRECONDITION` for the following request error: + // * AttachmentNotVisible + create(resource: Schema.Announcement, courseId: string): Classroom_v1.Schema.Announcement; + // Returns an announcement. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or announcement, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course or announcement does not exist. + get(courseId: string, id: string): Classroom_v1.Schema.Announcement; + // Returns a list of announcements that the requester is permitted to view. + // Course students may only view `PUBLISHED` announcements. Course teachers + // and domain administrators may view all announcements. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access + // the requested course or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string): Classroom_v1.Schema.ListAnnouncementsResponse; + // Returns a list of announcements that the requester is permitted to view. + // Course students may only view `PUBLISHED` announcements. Course teachers + // and domain administrators may view all announcements. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access + // the requested course or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string, optionalArgs: object): Classroom_v1.Schema.ListAnnouncementsResponse; + // Modifies assignee mode and options of an announcement. + // Only a teacher of the course that contains the announcement may + // call this method. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course or course work does not exist. + modifyAssignees(resource: Schema.ModifyAnnouncementAssigneesRequest, courseId: string, id: string): Classroom_v1.Schema.Announcement; + // Updates one or more fields of an announcement. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding announcement or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `FAILED_PRECONDITION` if the requested announcement has already been + // deleted. + // * `NOT_FOUND` if the requested course or announcement does not exist + patch(resource: Schema.Announcement, courseId: string, id: string): Classroom_v1.Schema.Announcement; + // Updates one or more fields of an announcement. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding announcement or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `FAILED_PRECONDITION` if the requested announcement has already been + // deleted. + // * `NOT_FOUND` if the requested course or announcement does not exist + patch(resource: Schema.Announcement, courseId: string, id: string, optionalArgs: object): Classroom_v1.Schema.Announcement; + // Deletes an announcement. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding announcement item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding announcement, if the requesting user is not permitted + // to delete the requested course or for access errors. + // * `FAILED_PRECONDITION` if the requested announcement has already been + // deleted. + // * `NOT_FOUND` if no course exists with the requested ID. + remove(courseId: string, id: string): void; + } + export interface CourseWorkCollection { + StudentSubmissions?: Classroom_v1.Collection.Courses.CourseWork.StudentSubmissionsCollection; + // Creates course work. + // The resulting course work (and corresponding student submissions) are + // associated with the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // make the request. Classroom API requests to modify course work and student + // submissions must be made with an OAuth client ID from the associated + // Developer Console project. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course, create course work in the requested course, share a + // Drive attachment, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + // * `FAILED_PRECONDITION` for the following request error: + // * AttachmentNotVisible + create(resource: Schema.CourseWork, courseId: string): Classroom_v1.Schema.CourseWork; + // Returns course work. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work, or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course or course work does not exist. + get(courseId: string, id: string): Classroom_v1.Schema.CourseWork; + // Returns a list of course work that the requester is permitted to view. + // Course students may only view `PUBLISHED` course work. Course teachers + // and domain administrators may view all course work. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access + // the requested course or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string): Classroom_v1.Schema.ListCourseWorkResponse; + // Returns a list of course work that the requester is permitted to view. + // Course students may only view `PUBLISHED` course work. Course teachers + // and domain administrators may view all course work. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access + // the requested course or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course does not exist. + list(courseId: string, optionalArgs: object): Classroom_v1.Schema.ListCourseWorkResponse; + // Modifies assignee mode and options of a coursework. + // Only a teacher of the course that contains the coursework may + // call this method. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or course work or for access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `NOT_FOUND` if the requested course or course work does not exist. + modifyAssignees(resource: Schema.ModifyCourseWorkAssigneesRequest, courseId: string, id: string): Classroom_v1.Schema.CourseWork; + // Updates one or more fields of a course work. + // See google.CourseWork for details + // of which fields may be updated and who may change them. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding course work, if the user is not permitted to make the + // requested modification to the student submission, or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `FAILED_PRECONDITION` if the requested course work has already been + // deleted. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + patch(resource: Schema.CourseWork, courseId: string, id: string): Classroom_v1.Schema.CourseWork; + // Updates one or more fields of a course work. + // See google.CourseWork for details + // of which fields may be updated and who may change them. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding course work, if the user is not permitted to make the + // requested modification to the student submission, or for + // access errors. + // * `INVALID_ARGUMENT` if the request is malformed. + // * `FAILED_PRECONDITION` if the requested course work has already been + // deleted. + // * `NOT_FOUND` if the requested course, course work, or student submission + // does not exist. + patch(resource: Schema.CourseWork, courseId: string, id: string, optionalArgs: object): Classroom_v1.Schema.CourseWork; + // Deletes a course work. + // This request must be made by the Developer Console project of the + // [OAuth client ID](https://support.google.com/cloud/answer/6158849) used to + // create the corresponding course work item. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting developer project did not create + // the corresponding course work, if the requesting user is not permitted + // to delete the requested course or for access errors. + // * `FAILED_PRECONDITION` if the requested course work has already been + // deleted. + // * `NOT_FOUND` if no course exists with the requested ID. + remove(courseId: string, id: string): void; + } + export interface StudentsCollection { + // Adds a user as a student of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create + // students in this course or for access errors. + // * `NOT_FOUND` if the requested course ID does not exist. + // * `FAILED_PRECONDITION` if the requested user's account is disabled, + // for the following request errors: + // * CourseMemberLimitReached + // * CourseNotModifiable + // * UserGroupsMembershipLimitReached + // * `ALREADY_EXISTS` if the user is already a student or teacher in the + // course. + create(resource: Schema.Student, courseId: string): Classroom_v1.Schema.Student; + // Adds a user as a student of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create + // students in this course or for access errors. + // * `NOT_FOUND` if the requested course ID does not exist. + // * `FAILED_PRECONDITION` if the requested user's account is disabled, + // for the following request errors: + // * CourseMemberLimitReached + // * CourseNotModifiable + // * UserGroupsMembershipLimitReached + // * `ALREADY_EXISTS` if the user is already a student or teacher in the + // course. + create(resource: Schema.Student, courseId: string, optionalArgs: object): Classroom_v1.Schema.Student; + // Returns a student of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to view + // students of this course or for access errors. + // * `NOT_FOUND` if no student of this course has the requested ID or if the + // course does not exist. + get(courseId: string, userId: string): Classroom_v1.Schema.Student; + // Returns a list of students of this course that the requester + // is permitted to view. + // This method returns the following error codes: + // * `NOT_FOUND` if the course does not exist. + // * `PERMISSION_DENIED` for access errors. + list(courseId: string): Classroom_v1.Schema.ListStudentsResponse; + // Returns a list of students of this course that the requester + // is permitted to view. + // This method returns the following error codes: + // * `NOT_FOUND` if the course does not exist. + // * `PERMISSION_DENIED` for access errors. + list(courseId: string, optionalArgs: object): Classroom_v1.Schema.ListStudentsResponse; + // Deletes a student of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to delete + // students of this course or for access errors. + // * `NOT_FOUND` if no student of this course has the requested ID or if the + // course does not exist. + remove(courseId: string, userId: string): void; + } + export interface TeachersCollection { + // Creates a teacher of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create + // teachers in this course or for access errors. + // * `NOT_FOUND` if the requested course ID does not exist. + // * `FAILED_PRECONDITION` if the requested user's account is disabled, + // for the following request errors: + // * CourseMemberLimitReached + // * CourseNotModifiable + // * CourseTeacherLimitReached + // * UserGroupsMembershipLimitReached + // * `ALREADY_EXISTS` if the user is already a teacher or student in the + // course. + create(resource: Schema.Teacher, courseId: string): Classroom_v1.Schema.Teacher; + // Returns a teacher of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to view + // teachers of this course or for access errors. + // * `NOT_FOUND` if no teacher of this course has the requested ID or if the + // course does not exist. + get(courseId: string, userId: string): Classroom_v1.Schema.Teacher; + // Returns a list of teachers of this course that the requester + // is permitted to view. + // This method returns the following error codes: + // * `NOT_FOUND` if the course does not exist. + // * `PERMISSION_DENIED` for access errors. + list(courseId: string): Classroom_v1.Schema.ListTeachersResponse; + // Returns a list of teachers of this course that the requester + // is permitted to view. + // This method returns the following error codes: + // * `NOT_FOUND` if the course does not exist. + // * `PERMISSION_DENIED` for access errors. + list(courseId: string, optionalArgs: object): Classroom_v1.Schema.ListTeachersResponse; + // Deletes a teacher of a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to delete + // teachers of this course or for access errors. + // * `NOT_FOUND` if no teacher of this course has the requested ID or if the + // course does not exist. + // * `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher + // of this course. + remove(courseId: string, userId: string): void; + } + } + namespace UserProfiles { + export interface GuardianInvitationsCollection { + // Creates a guardian invitation, and sends an email to the guardian asking + // them to confirm that they are the student's guardian. + // Once the guardian accepts the invitation, their `state` will change to + // `COMPLETED` and they will start receiving guardian notifications. A + // `Guardian` resource will also be created to represent the active guardian. + // The request object must have the `student_id` and + // `invited_email_address` fields set. Failing to set these fields, or + // setting any other fields in the request, will result in an error. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the current user does not have permission to + // manage guardians, if the guardian in question has already rejected + // too many requests for that student, if guardians are not enabled for the + // domain in question, or for other access errors. + // * `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian + // link limit. + // * `INVALID_ARGUMENT` if the guardian email address is not valid (for + // example, if it is too long), or if the format of the student ID provided + // cannot be recognized (it is not an email address, nor a `user_id` from + // this API). This error will also be returned if read-only fields are set, + // or if the `state` field is set to to a value other than `PENDING`. + // * `NOT_FOUND` if the student ID provided is a valid student ID, but + // Classroom has no record of that student. + // * `ALREADY_EXISTS` if there is already a pending guardian invitation for + // the student and `invited_email_address` provided, or if the provided + // `invited_email_address` matches the Google account of an existing + // `Guardian` for this user. + create(resource: Schema.GuardianInvitation, studentId: string): Classroom_v1.Schema.GuardianInvitation; + // Returns a specific guardian invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to view + // guardian invitations for the student identified by the `student_id`, if + // guardians are not enabled for the domain in question, or for other + // access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). + // * `NOT_FOUND` if Classroom cannot find any record of the given student or + // `invitation_id`. May also be returned if the student exists, but the + // requesting user does not have access to see that student. + get(studentId: string, invitationId: string): Classroom_v1.Schema.GuardianInvitation; + // Returns a list of guardian invitations that the requesting user is + // permitted to view, filtered by the parameters provided. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting + // user is not permitted to view guardian invitations for that student, if + // `"-"` is specified as the `student_id` and the user is not a domain + // administrator, if guardians are not enabled for the domain in question, + // or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). May also be returned if an invalid + // `page_token` or `state` is provided. + // * `NOT_FOUND` if a `student_id` is specified, and its format can be + // recognized, but Classroom has no record of that student. + list(studentId: string): Classroom_v1.Schema.ListGuardianInvitationsResponse; + // Returns a list of guardian invitations that the requesting user is + // permitted to view, filtered by the parameters provided. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting + // user is not permitted to view guardian invitations for that student, if + // `"-"` is specified as the `student_id` and the user is not a domain + // administrator, if guardians are not enabled for the domain in question, + // or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). May also be returned if an invalid + // `page_token` or `state` is provided. + // * `NOT_FOUND` if a `student_id` is specified, and its format can be + // recognized, but Classroom has no record of that student. + list(studentId: string, optionalArgs: object): Classroom_v1.Schema.ListGuardianInvitationsResponse; + // Modifies a guardian invitation. + // Currently, the only valid modification is to change the `state` from + // `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the current user does not have permission to + // manage guardians, if guardians are not enabled for the domain in question + // or for other access errors. + // * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. + // * `INVALID_ARGUMENT` if the format of the student ID provided + // cannot be recognized (it is not an email address, nor a `user_id` from + // this API), or if the passed `GuardianInvitation` has a `state` other than + // `COMPLETE`, or if it modifies fields other than `state`. + // * `NOT_FOUND` if the student ID provided is a valid student ID, but + // Classroom has no record of that student, or if the `id` field does not + // refer to a guardian invitation known to Classroom. + patch(resource: Schema.GuardianInvitation, studentId: string, invitationId: string): Classroom_v1.Schema.GuardianInvitation; + // Modifies a guardian invitation. + // Currently, the only valid modification is to change the `state` from + // `PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the current user does not have permission to + // manage guardians, if guardians are not enabled for the domain in question + // or for other access errors. + // * `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state. + // * `INVALID_ARGUMENT` if the format of the student ID provided + // cannot be recognized (it is not an email address, nor a `user_id` from + // this API), or if the passed `GuardianInvitation` has a `state` other than + // `COMPLETE`, or if it modifies fields other than `state`. + // * `NOT_FOUND` if the student ID provided is a valid student ID, but + // Classroom has no record of that student, or if the `id` field does not + // refer to a guardian invitation known to Classroom. + patch(resource: Schema.GuardianInvitation, studentId: string, invitationId: string, optionalArgs: object): Classroom_v1.Schema.GuardianInvitation; + } + export interface GuardiansCollection { + // Returns a specific guardian. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if no user that matches the provided `student_id` + // is visible to the requesting user, if the requesting user is not + // permitted to view guardian information for the student identified by the + // `student_id`, if guardians are not enabled for the domain in question, + // or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). + // * `NOT_FOUND` if the requesting user is permitted to view guardians for + // the requested `student_id`, but no `Guardian` record exists for that + // student that matches the provided `guardian_id`. + get(studentId: string, guardianId: string): Classroom_v1.Schema.Guardian; + // Returns a list of guardians that the requesting user is permitted to + // view, restricted to those that match the request. + // To list guardians for any student that the requesting user may view + // guardians for, use the literal character `-` for the student ID. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting + // user is not permitted to view guardian information for that student, if + // `"-"` is specified as the `student_id` and the user is not a domain + // administrator, if guardians are not enabled for the domain in question, + // if the `invited_email_address` filter is set by a user who is not a + // domain administrator, or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). May also be returned if an invalid + // `page_token` is provided. + // * `NOT_FOUND` if a `student_id` is specified, and its format can be + // recognized, but Classroom has no record of that student. + list(studentId: string): Classroom_v1.Schema.ListGuardiansResponse; + // Returns a list of guardians that the requesting user is permitted to + // view, restricted to those that match the request. + // To list guardians for any student that the requesting user may view + // guardians for, use the literal character `-` for the student ID. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if a `student_id` is specified, and the requesting + // user is not permitted to view guardian information for that student, if + // `"-"` is specified as the `student_id` and the user is not a domain + // administrator, if guardians are not enabled for the domain in question, + // if the `invited_email_address` filter is set by a user who is not a + // domain administrator, or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API, nor the literal string `me`). May also be returned if an invalid + // `page_token` is provided. + // * `NOT_FOUND` if a `student_id` is specified, and its format can be + // recognized, but Classroom has no record of that student. + list(studentId: string, optionalArgs: object): Classroom_v1.Schema.ListGuardiansResponse; + // Deletes a guardian. + // The guardian will no longer receive guardian notifications and the guardian + // will no longer be accessible via the API. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if no user that matches the provided `student_id` + // is visible to the requesting user, if the requesting user is not + // permitted to manage guardians for the student identified by the + // `student_id`, if guardians are not enabled for the domain in question, + // or for other access errors. + // * `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot + // be recognized (it is not an email address, nor a `student_id` from the + // API). + // * `NOT_FOUND` if the requesting user is permitted to modify guardians for + // the requested `student_id`, but no `Guardian` record exists for that + // student with the provided `guardian_id`. + remove(studentId: string, guardianId: string): void; + } + } + export interface CoursesCollection { + Aliases?: Classroom_v1.Collection.Courses.AliasesCollection; + Announcements?: Classroom_v1.Collection.Courses.AnnouncementsCollection; + CourseWork?: Classroom_v1.Collection.Courses.CourseWorkCollection; + Students?: Classroom_v1.Collection.Courses.StudentsCollection; + Teachers?: Classroom_v1.Collection.Courses.TeachersCollection; + // Creates a course. + // The user specified in `ownerId` is the owner of the created course + // and added as a teacher. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create + // courses or for access errors. + // * `NOT_FOUND` if the primary teacher is not a valid user. + // * `FAILED_PRECONDITION` if the course owner's account is disabled or for + // the following request errors: + // * UserGroupsMembershipLimitReached + // * `ALREADY_EXISTS` if an alias was specified in the `id` and + // already exists. + create(resource: Schema.Course): Classroom_v1.Schema.Course; + // Returns a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access the + // requested course or for access errors. + // * `NOT_FOUND` if no course exists with the requested ID. + get(id: string): Classroom_v1.Schema.Course; + // Returns a list of courses that the requesting user is permitted to view, + // restricted to those that match the request. Returned courses are ordered by + // creation time, with the most recently created coming first. + // This method returns the following error codes: + // * `PERMISSION_DENIED` for access errors. + // * `INVALID_ARGUMENT` if the query argument is malformed. + // * `NOT_FOUND` if any users specified in the query arguments do not exist. + list(): Classroom_v1.Schema.ListCoursesResponse; + // Returns a list of courses that the requesting user is permitted to view, + // restricted to those that match the request. Returned courses are ordered by + // creation time, with the most recently created coming first. + // This method returns the following error codes: + // * `PERMISSION_DENIED` for access errors. + // * `INVALID_ARGUMENT` if the query argument is malformed. + // * `NOT_FOUND` if any users specified in the query arguments do not exist. + list(optionalArgs: object): Classroom_v1.Schema.ListCoursesResponse; + // Updates one or more fields in a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to modify the + // requested course or for access errors. + // * `NOT_FOUND` if no course exists with the requested ID. + // * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or + // if no update mask is supplied. + // * `FAILED_PRECONDITION` for the following request errors: + // * CourseNotModifiable + patch(resource: Schema.Course, id: string): Classroom_v1.Schema.Course; + // Updates one or more fields in a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to modify the + // requested course or for access errors. + // * `NOT_FOUND` if no course exists with the requested ID. + // * `INVALID_ARGUMENT` if invalid fields are specified in the update mask or + // if no update mask is supplied. + // * `FAILED_PRECONDITION` for the following request errors: + // * CourseNotModifiable + patch(resource: Schema.Course, id: string, optionalArgs: object): Classroom_v1.Schema.Course; + // Deletes a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to delete the + // requested course or for access errors. + // * `NOT_FOUND` if no course exists with the requested ID. + remove(id: string): void; + // Updates a course. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to modify the + // requested course or for access errors. + // * `NOT_FOUND` if no course exists with the requested ID. + // * `FAILED_PRECONDITION` for the following request errors: + // * CourseNotModifiable + update(resource: Schema.Course, id: string): Classroom_v1.Schema.Course; + } + export interface InvitationsCollection { + // Accepts an invitation, removing it and adding the invited user to the + // teachers or students (as appropriate) of the specified course. Only the + // invited user may accept an invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to accept the + // requested invitation or for access errors. + // * `FAILED_PRECONDITION` for the following request errors: + // * CourseMemberLimitReached + // * CourseNotModifiable + // * CourseTeacherLimitReached + // * UserGroupsMembershipLimitReached + // * `NOT_FOUND` if no invitation exists with the requested ID. + accept(id: string): void; + // Creates an invitation. Only one invitation for a user and course may exist + // at a time. Delete and re-create an invitation to make changes. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to create + // invitations for this course or for access errors. + // * `NOT_FOUND` if the course or the user does not exist. + // * `FAILED_PRECONDITION` if the requested user's account is disabled or if + // the user already has this role or a role with greater permissions. + // * `ALREADY_EXISTS` if an invitation for the specified user and course + // already exists. + create(resource: Schema.Invitation): Classroom_v1.Schema.Invitation; + // Returns an invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to view the + // requested invitation or for access errors. + // * `NOT_FOUND` if no invitation exists with the requested ID. + get(id: string): Classroom_v1.Schema.Invitation; + // Returns a list of invitations that the requesting user is permitted to + // view, restricted to those that match the list request. + // *Note:* At least one of `user_id` or `course_id` must be supplied. Both + // fields can be supplied. + // This method returns the following error codes: + // * `PERMISSION_DENIED` for access errors. + list(): Classroom_v1.Schema.ListInvitationsResponse; + // Returns a list of invitations that the requesting user is permitted to + // view, restricted to those that match the list request. + // *Note:* At least one of `user_id` or `course_id` must be supplied. Both + // fields can be supplied. + // This method returns the following error codes: + // * `PERMISSION_DENIED` for access errors. + list(optionalArgs: object): Classroom_v1.Schema.ListInvitationsResponse; + // Deletes an invitation. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to delete the + // requested invitation or for access errors. + // * `NOT_FOUND` if no invitation exists with the requested ID. + remove(id: string): void; + } + export interface RegistrationsCollection { + // Creates a `Registration`, causing Classroom to start sending notifications + // from the provided `feed` to the destination provided in `cloudPubSubTopic`. + // Returns the created `Registration`. Currently, this will be the same as + // the argument, but with server-assigned fields such as `expiry_time` and + // `id` filled in. + // Note that any value specified for the `expiry_time` or `id` fields will be + // ignored. + // While Classroom may validate the `cloudPubSubTopic` and return errors on a + // best effort basis, it is the caller's responsibility to ensure that it + // exists and that Classroom has permission to publish to it. + // This method may return the following error codes: + // * `PERMISSION_DENIED` if: + // * the authenticated user does not have permission to receive + // notifications from the requested field; or + // * the credential provided does not include the appropriate scope for + // the requested feed. + // * another access error is encountered. + // * `INVALID_ARGUMENT` if: + // * no `cloudPubsubTopic` is specified, or the specified + // `cloudPubsubTopic` is not valid; or + // * no `feed` is specified, or the specified `feed` is not valid. + // * `NOT_FOUND` if: + // * the specified `feed` cannot be located, or the requesting user does + // not have permission to determine whether or not it exists; or + // * the specified `cloudPubsubTopic` cannot be located, or Classroom has + // not been granted permission to publish to it. + create(resource: Schema.Registration): Classroom_v1.Schema.Registration; + // Deletes a `Registration`, causing Classroom to stop sending notifications + // for that `Registration`. + remove(registrationId: string): void; + } + export interface UserProfilesCollection { + GuardianInvitations?: Classroom_v1.Collection.UserProfiles.GuardianInvitationsCollection; + Guardians?: Classroom_v1.Collection.UserProfiles.GuardiansCollection; + // Returns a user profile. + // This method returns the following error codes: + // * `PERMISSION_DENIED` if the requesting user is not permitted to access + // this user profile, if no profile exists with the requested ID, or for + // access errors. + get(userId: string): Classroom_v1.Schema.UserProfile; + } + } + namespace Schema { + export interface Announcement { + alternateLink?: string; + assigneeMode?: string; + courseId?: string; + creationTime?: string; + creatorUserId?: string; + id?: string; + individualStudentsOptions?: Classroom_v1.Schema.IndividualStudentsOptions; + materials?: Classroom_v1.Schema.Material[]; + scheduledTime?: string; + state?: string; + text?: string; + updateTime?: string; + } + export interface Assignment { + studentWorkFolder?: Classroom_v1.Schema.DriveFolder; + } + export interface AssignmentSubmission { + attachments?: Classroom_v1.Schema.Attachment[]; + } + export interface Attachment { + driveFile?: Classroom_v1.Schema.DriveFile; + form?: Classroom_v1.Schema.Form; + link?: Classroom_v1.Schema.Link; + youTubeVideo?: Classroom_v1.Schema.YouTubeVideo; + } + export interface CloudPubsubTopic { + topicName?: string; + } + export interface Course { + alternateLink?: string; + calendarId?: string; + courseGroupEmail?: string; + courseMaterialSets?: Classroom_v1.Schema.CourseMaterialSet[]; + courseState?: string; + creationTime?: string; + description?: string; + descriptionHeading?: string; + enrollmentCode?: string; + guardiansEnabled?: boolean; + id?: string; + name?: string; + ownerId?: string; + room?: string; + section?: string; + teacherFolder?: Classroom_v1.Schema.DriveFolder; + teacherGroupEmail?: string; + updateTime?: string; + } + export interface CourseAlias { + alias?: string; + } + export interface CourseMaterial { + driveFile?: Classroom_v1.Schema.DriveFile; + form?: Classroom_v1.Schema.Form; + link?: Classroom_v1.Schema.Link; + youTubeVideo?: Classroom_v1.Schema.YouTubeVideo; + } + export interface CourseMaterialSet { + materials?: Classroom_v1.Schema.CourseMaterial[]; + title?: string; + } + export interface CourseRosterChangesInfo { + courseId?: string; + } + export interface CourseWork { + alternateLink?: string; + assigneeMode?: string; + assignment?: Classroom_v1.Schema.Assignment; + associatedWithDeveloper?: boolean; + courseId?: string; + creationTime?: string; + creatorUserId?: string; + description?: string; + dueDate?: Classroom_v1.Schema.Date; + dueTime?: Classroom_v1.Schema.TimeOfDay; + id?: string; + individualStudentsOptions?: Classroom_v1.Schema.IndividualStudentsOptions; + materials?: Classroom_v1.Schema.Material[]; + maxPoints?: Number; + multipleChoiceQuestion?: Classroom_v1.Schema.MultipleChoiceQuestion; + scheduledTime?: string; + state?: string; + submissionModificationMode?: string; + title?: string; + updateTime?: string; + workType?: string; + } + export interface CourseWorkChangesInfo { + courseId?: string; + } + export interface Date { + day?: number; + month?: number; + year?: number; + } + export interface DriveFile { + alternateLink?: string; + id?: string; + thumbnailUrl?: string; + title?: string; + } + export interface DriveFolder { + alternateLink?: string; + id?: string; + title?: string; + } + export interface Feed { + courseRosterChangesInfo?: Classroom_v1.Schema.CourseRosterChangesInfo; + courseWorkChangesInfo?: Classroom_v1.Schema.CourseWorkChangesInfo; + feedType?: string; + } + export interface Form { + formUrl?: string; + responseUrl?: string; + thumbnailUrl?: string; + title?: string; + } + export interface GlobalPermission { + permission?: string; + } + export interface GradeHistory { + actorUserId?: string; + gradeChangeType?: string; + gradeTimestamp?: string; + maxPoints?: Number; + pointsEarned?: Number; + } + export interface Guardian { + guardianId?: string; + guardianProfile?: Classroom_v1.Schema.UserProfile; + invitedEmailAddress?: string; + studentId?: string; + } + export interface GuardianInvitation { + creationTime?: string; + invitationId?: string; + invitedEmailAddress?: string; + state?: string; + studentId?: string; + } + export interface IndividualStudentsOptions { + studentIds?: string[]; + } + export interface Invitation { + courseId?: string; + id?: string; + role?: string; + userId?: string; + } + export interface Link { + thumbnailUrl?: string; + title?: string; + url?: string; + } + export interface ListAnnouncementsResponse { + announcements?: Classroom_v1.Schema.Announcement[]; + nextPageToken?: string; + } + export interface ListCourseAliasesResponse { + aliases?: Classroom_v1.Schema.CourseAlias[]; + nextPageToken?: string; + } + export interface ListCourseWorkResponse { + courseWork?: Classroom_v1.Schema.CourseWork[]; + nextPageToken?: string; + } + export interface ListCoursesResponse { + courses?: Classroom_v1.Schema.Course[]; + nextPageToken?: string; + } + export interface ListGuardianInvitationsResponse { + guardianInvitations?: Classroom_v1.Schema.GuardianInvitation[]; + nextPageToken?: string; + } + export interface ListGuardiansResponse { + guardians?: Classroom_v1.Schema.Guardian[]; + nextPageToken?: string; + } + export interface ListInvitationsResponse { + invitations?: Classroom_v1.Schema.Invitation[]; + nextPageToken?: string; + } + export interface ListStudentSubmissionsResponse { + nextPageToken?: string; + studentSubmissions?: Classroom_v1.Schema.StudentSubmission[]; + } + export interface ListStudentsResponse { + nextPageToken?: string; + students?: Classroom_v1.Schema.Student[]; + } + export interface ListTeachersResponse { + nextPageToken?: string; + teachers?: Classroom_v1.Schema.Teacher[]; + } + export interface Material { + driveFile?: Classroom_v1.Schema.SharedDriveFile; + form?: Classroom_v1.Schema.Form; + link?: Classroom_v1.Schema.Link; + youtubeVideo?: Classroom_v1.Schema.YouTubeVideo; + } + export interface ModifyAnnouncementAssigneesRequest { + assigneeMode?: string; + modifyIndividualStudentsOptions?: Classroom_v1.Schema.ModifyIndividualStudentsOptions; + } + export interface ModifyAttachmentsRequest { + addAttachments?: Classroom_v1.Schema.Attachment[]; + } + export interface ModifyCourseWorkAssigneesRequest { + assigneeMode?: string; + modifyIndividualStudentsOptions?: Classroom_v1.Schema.ModifyIndividualStudentsOptions; + } + export interface ModifyIndividualStudentsOptions { + addStudentIds?: string[]; + removeStudentIds?: string[]; + } + export interface MultipleChoiceQuestion { + choices?: string[]; + } + export interface MultipleChoiceSubmission { + answer?: string; + } + export interface Name { + familyName?: string; + fullName?: string; + givenName?: string; + } + export interface Registration { + cloudPubsubTopic?: Classroom_v1.Schema.CloudPubsubTopic; + expiryTime?: string; + feed?: Classroom_v1.Schema.Feed; + registrationId?: string; + } + export interface SharedDriveFile { + driveFile?: Classroom_v1.Schema.DriveFile; + shareMode?: string; + } + export interface ShortAnswerSubmission { + answer?: string; + } + export interface StateHistory { + actorUserId?: string; + state?: string; + stateTimestamp?: string; + } + export interface Student { + courseId?: string; + profile?: Classroom_v1.Schema.UserProfile; + studentWorkFolder?: Classroom_v1.Schema.DriveFolder; + userId?: string; + } + export interface StudentSubmission { + alternateLink?: string; + assignedGrade?: Number; + assignmentSubmission?: Classroom_v1.Schema.AssignmentSubmission; + associatedWithDeveloper?: boolean; + courseId?: string; + courseWorkId?: string; + courseWorkType?: string; + creationTime?: string; + draftGrade?: Number; + id?: string; + late?: boolean; + multipleChoiceSubmission?: Classroom_v1.Schema.MultipleChoiceSubmission; + shortAnswerSubmission?: Classroom_v1.Schema.ShortAnswerSubmission; + state?: string; + submissionHistory?: Classroom_v1.Schema.SubmissionHistory[]; + updateTime?: string; + userId?: string; + } + export interface SubmissionHistory { + gradeHistory?: Classroom_v1.Schema.GradeHistory; + stateHistory?: Classroom_v1.Schema.StateHistory; + } + export interface Teacher { + courseId?: string; + profile?: Classroom_v1.Schema.UserProfile; + userId?: string; + } + export interface TimeOfDay { + hours?: number; + minutes?: number; + nanos?: number; + seconds?: number; + } + export interface UserProfile { + emailAddress?: string; + id?: string; + name?: Classroom_v1.Schema.Name; + permissions?: Classroom_v1.Schema.GlobalPermission[]; + photoUrl?: string; + verifiedTeacher?: boolean; + } + export interface YouTubeVideo { + alternateLink?: string; + id?: string; + thumbnailUrl?: string; + title?: string; + } + } + } + export interface Classroom_v1 { + Courses?: Classroom_v1.Collection.CoursesCollection; + Invitations?: Classroom_v1.Collection.InvitationsCollection; + Registrations?: Classroom_v1.Collection.RegistrationsCollection; + UserProfiles?: Classroom_v1.Collection.UserProfilesCollection; + // Create a new instance of Announcement + newAnnouncement(): Classroom_v1.Schema.Announcement; + // Create a new instance of Assignment + newAssignment(): Classroom_v1.Schema.Assignment; + // Create a new instance of AssignmentSubmission + newAssignmentSubmission(): Classroom_v1.Schema.AssignmentSubmission; + // Create a new instance of Attachment + newAttachment(): Classroom_v1.Schema.Attachment; + // Create a new instance of CloudPubsubTopic + newCloudPubsubTopic(): Classroom_v1.Schema.CloudPubsubTopic; + // Create a new instance of Course + newCourse(): Classroom_v1.Schema.Course; + // Create a new instance of CourseAlias + newCourseAlias(): Classroom_v1.Schema.CourseAlias; + // Create a new instance of CourseMaterial + newCourseMaterial(): Classroom_v1.Schema.CourseMaterial; + // Create a new instance of CourseMaterialSet + newCourseMaterialSet(): Classroom_v1.Schema.CourseMaterialSet; + // Create a new instance of CourseRosterChangesInfo + newCourseRosterChangesInfo(): Classroom_v1.Schema.CourseRosterChangesInfo; + // Create a new instance of CourseWork + newCourseWork(): Classroom_v1.Schema.CourseWork; + // Create a new instance of CourseWorkChangesInfo + newCourseWorkChangesInfo(): Classroom_v1.Schema.CourseWorkChangesInfo; + // Create a new instance of Date + newDate(): Classroom_v1.Schema.Date; + // Create a new instance of DriveFile + newDriveFile(): Classroom_v1.Schema.DriveFile; + // Create a new instance of DriveFolder + newDriveFolder(): Classroom_v1.Schema.DriveFolder; + // Create a new instance of Feed + newFeed(): Classroom_v1.Schema.Feed; + // Create a new instance of Form + newForm(): Classroom_v1.Schema.Form; + // Create a new instance of GlobalPermission + newGlobalPermission(): Classroom_v1.Schema.GlobalPermission; + // Create a new instance of GradeHistory + newGradeHistory(): Classroom_v1.Schema.GradeHistory; + // Create a new instance of GuardianInvitation + newGuardianInvitation(): Classroom_v1.Schema.GuardianInvitation; + // Create a new instance of IndividualStudentsOptions + newIndividualStudentsOptions(): Classroom_v1.Schema.IndividualStudentsOptions; + // Create a new instance of Invitation + newInvitation(): Classroom_v1.Schema.Invitation; + // Create a new instance of Link + newLink(): Classroom_v1.Schema.Link; + // Create a new instance of Material + newMaterial(): Classroom_v1.Schema.Material; + // Create a new instance of ModifyAnnouncementAssigneesRequest + newModifyAnnouncementAssigneesRequest(): Classroom_v1.Schema.ModifyAnnouncementAssigneesRequest; + // Create a new instance of ModifyAttachmentsRequest + newModifyAttachmentsRequest(): Classroom_v1.Schema.ModifyAttachmentsRequest; + // Create a new instance of ModifyCourseWorkAssigneesRequest + newModifyCourseWorkAssigneesRequest(): Classroom_v1.Schema.ModifyCourseWorkAssigneesRequest; + // Create a new instance of ModifyIndividualStudentsOptions + newModifyIndividualStudentsOptions(): Classroom_v1.Schema.ModifyIndividualStudentsOptions; + // Create a new instance of MultipleChoiceQuestion + newMultipleChoiceQuestion(): Classroom_v1.Schema.MultipleChoiceQuestion; + // Create a new instance of MultipleChoiceSubmission + newMultipleChoiceSubmission(): Classroom_v1.Schema.MultipleChoiceSubmission; + // Create a new instance of Name + newName(): Classroom_v1.Schema.Name; + // Create a new instance of ReclaimStudentSubmissionRequest + newReclaimStudentSubmissionRequest(): any; + // Create a new instance of Registration + newRegistration(): Classroom_v1.Schema.Registration; + // Create a new instance of ReturnStudentSubmissionRequest + newReturnStudentSubmissionRequest(): any; + // Create a new instance of SharedDriveFile + newSharedDriveFile(): Classroom_v1.Schema.SharedDriveFile; + // Create a new instance of ShortAnswerSubmission + newShortAnswerSubmission(): Classroom_v1.Schema.ShortAnswerSubmission; + // Create a new instance of StateHistory + newStateHistory(): Classroom_v1.Schema.StateHistory; + // Create a new instance of Student + newStudent(): Classroom_v1.Schema.Student; + // Create a new instance of StudentSubmission + newStudentSubmission(): Classroom_v1.Schema.StudentSubmission; + // Create a new instance of SubmissionHistory + newSubmissionHistory(): Classroom_v1.Schema.SubmissionHistory; + // Create a new instance of Teacher + newTeacher(): Classroom_v1.Schema.Teacher; + // Create a new instance of TimeOfDay + newTimeOfDay(): Classroom_v1.Schema.TimeOfDay; + // Create a new instance of TurnInStudentSubmissionRequest + newTurnInStudentSubmissionRequest(): any; + // Create a new instance of UserProfile + newUserProfile(): Classroom_v1.Schema.UserProfile; + // Create a new instance of YouTubeVideo + newYouTubeVideo(): Classroom_v1.Schema.YouTubeVideo; + } +} + +declare var Classroom_v1: GoogleAppsScript.Classroom_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/content/v2.d.ts b/types/google-apps-script/apis/content/v2.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/content_v2.d.ts b/types/google-apps-script/apis/content_v2.d.ts new file mode 100644 index 0000000000..8cf4129511 --- /dev/null +++ b/types/google-apps-script/apis/content_v2.d.ts @@ -0,0 +1,2366 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Content_v2 { + namespace Collection { + export interface AccountsCollection { + // Returns information about the authenticated user. + authinfo(): Content_v2.Schema.AccountsAuthInfoResponse; + // Claims the website of a Merchant Center sub-account. + claimwebsite(merchantId: string, accountId: string): Content_v2.Schema.AccountsClaimWebsiteResponse; + // Claims the website of a Merchant Center sub-account. + claimwebsite(merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.AccountsClaimWebsiteResponse; + // Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. + custombatch(resource: Schema.AccountsCustomBatchRequest): Content_v2.Schema.AccountsCustomBatchResponse; + // Retrieves, inserts, updates, and deletes multiple Merchant Center (sub-)accounts in a single request. + custombatch(resource: Schema.AccountsCustomBatchRequest, optionalArgs: object): Content_v2.Schema.AccountsCustomBatchResponse; + // Retrieves a Merchant Center account. + get(merchantId: string, accountId: string): Content_v2.Schema.Account; + // Creates a Merchant Center sub-account. + insert(resource: Schema.Account, merchantId: string): Content_v2.Schema.Account; + // Creates a Merchant Center sub-account. + insert(resource: Schema.Account, merchantId: string, optionalArgs: object): Content_v2.Schema.Account; + // Performs an action on a link between a Merchant Center account and another account. + link(resource: Schema.AccountsLinkRequest, merchantId: string, accountId: string): Content_v2.Schema.AccountsLinkResponse; + // Lists the sub-accounts in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.AccountsListResponse; + // Lists the sub-accounts in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.AccountsListResponse; + // Updates a Merchant Center account. This method supports patch semantics. + patch(resource: Schema.Account, merchantId: string, accountId: string): Content_v2.Schema.Account; + // Updates a Merchant Center account. This method supports patch semantics. + patch(resource: Schema.Account, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.Account; + // Deletes a Merchant Center sub-account. + remove(merchantId: string, accountId: string): void; + // Deletes a Merchant Center sub-account. + remove(merchantId: string, accountId: string, optionalArgs: object): void; + // Updates a Merchant Center account. + update(resource: Schema.Account, merchantId: string, accountId: string): Content_v2.Schema.Account; + // Updates a Merchant Center account. + update(resource: Schema.Account, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.Account; + } + export interface AccountstatusesCollection { + // Retrieves multiple Merchant Center account statuses in a single request. + custombatch(resource: Schema.AccountstatusesCustomBatchRequest): Content_v2.Schema.AccountstatusesCustomBatchResponse; + // Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. + get(merchantId: string, accountId: string): Content_v2.Schema.AccountStatus; + // Retrieves the status of a Merchant Center account. No itemLevelIssues are returned for multi-client accounts. + get(merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.AccountStatus; + // Lists the statuses of the sub-accounts in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.AccountstatusesListResponse; + // Lists the statuses of the sub-accounts in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.AccountstatusesListResponse; + } + export interface AccounttaxCollection { + // Retrieves and updates tax settings of multiple accounts in a single request. + custombatch(resource: Schema.AccounttaxCustomBatchRequest): Content_v2.Schema.AccounttaxCustomBatchResponse; + // Retrieves and updates tax settings of multiple accounts in a single request. + custombatch(resource: Schema.AccounttaxCustomBatchRequest, optionalArgs: object): Content_v2.Schema.AccounttaxCustomBatchResponse; + // Retrieves the tax settings of the account. + get(merchantId: string, accountId: string): Content_v2.Schema.AccountTax; + // Lists the tax settings of the sub-accounts in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.AccounttaxListResponse; + // Lists the tax settings of the sub-accounts in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.AccounttaxListResponse; + // Updates the tax settings of the account. This method supports patch semantics. + patch(resource: Schema.AccountTax, merchantId: string, accountId: string): Content_v2.Schema.AccountTax; + // Updates the tax settings of the account. This method supports patch semantics. + patch(resource: Schema.AccountTax, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.AccountTax; + // Updates the tax settings of the account. + update(resource: Schema.AccountTax, merchantId: string, accountId: string): Content_v2.Schema.AccountTax; + // Updates the tax settings of the account. + update(resource: Schema.AccountTax, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.AccountTax; + } + export interface DatafeedsCollection { + // Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. + custombatch(resource: Schema.DatafeedsCustomBatchRequest): Content_v2.Schema.DatafeedsCustomBatchResponse; + // Deletes, fetches, gets, inserts and updates multiple datafeeds in a single request. + custombatch(resource: Schema.DatafeedsCustomBatchRequest, optionalArgs: object): Content_v2.Schema.DatafeedsCustomBatchResponse; + // Invokes a fetch for the datafeed in your Merchant Center account. + fetchnow(merchantId: string, datafeedId: string): Content_v2.Schema.DatafeedsFetchNowResponse; + // Invokes a fetch for the datafeed in your Merchant Center account. + fetchnow(merchantId: string, datafeedId: string, optionalArgs: object): Content_v2.Schema.DatafeedsFetchNowResponse; + // Retrieves a datafeed configuration from your Merchant Center account. + get(merchantId: string, datafeedId: string): Content_v2.Schema.Datafeed; + // Registers a datafeed configuration with your Merchant Center account. + insert(resource: Schema.Datafeed, merchantId: string): Content_v2.Schema.Datafeed; + // Registers a datafeed configuration with your Merchant Center account. + insert(resource: Schema.Datafeed, merchantId: string, optionalArgs: object): Content_v2.Schema.Datafeed; + // Lists the configurations for datafeeds in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.DatafeedsListResponse; + // Lists the configurations for datafeeds in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.DatafeedsListResponse; + // Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. + patch(resource: Schema.Datafeed, merchantId: string, datafeedId: string): Content_v2.Schema.Datafeed; + // Updates a datafeed configuration of your Merchant Center account. This method supports patch semantics. + patch(resource: Schema.Datafeed, merchantId: string, datafeedId: string, optionalArgs: object): Content_v2.Schema.Datafeed; + // Deletes a datafeed configuration from your Merchant Center account. + remove(merchantId: string, datafeedId: string): void; + // Deletes a datafeed configuration from your Merchant Center account. + remove(merchantId: string, datafeedId: string, optionalArgs: object): void; + // Updates a datafeed configuration of your Merchant Center account. + update(resource: Schema.Datafeed, merchantId: string, datafeedId: string): Content_v2.Schema.Datafeed; + // Updates a datafeed configuration of your Merchant Center account. + update(resource: Schema.Datafeed, merchantId: string, datafeedId: string, optionalArgs: object): Content_v2.Schema.Datafeed; + } + export interface DatafeedstatusesCollection { + // Gets multiple Merchant Center datafeed statuses in a single request. + custombatch(resource: Schema.DatafeedstatusesCustomBatchRequest): Content_v2.Schema.DatafeedstatusesCustomBatchResponse; + // Retrieves the status of a datafeed from your Merchant Center account. + get(merchantId: string, datafeedId: string): Content_v2.Schema.DatafeedStatus; + // Retrieves the status of a datafeed from your Merchant Center account. + get(merchantId: string, datafeedId: string, optionalArgs: object): Content_v2.Schema.DatafeedStatus; + // Lists the statuses of the datafeeds in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.DatafeedstatusesListResponse; + // Lists the statuses of the datafeeds in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.DatafeedstatusesListResponse; + } + export interface InventoryCollection { + // Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. + custombatch(resource: Schema.InventoryCustomBatchRequest): Content_v2.Schema.InventoryCustomBatchResponse; + // Updates price and availability for multiple products or stores in a single request. This operation does not update the expiration date of the products. + custombatch(resource: Schema.InventoryCustomBatchRequest, optionalArgs: object): Content_v2.Schema.InventoryCustomBatchResponse; + // Updates price and availability of a product in your Merchant Center account. + set(resource: Schema.InventorySetRequest, merchantId: string, storeCode: string, productId: string): Content_v2.Schema.InventorySetResponse; + // Updates price and availability of a product in your Merchant Center account. + set(resource: Schema.InventorySetRequest, merchantId: string, storeCode: string, productId: string, optionalArgs: object): Content_v2.Schema.InventorySetResponse; + } + export interface LiasettingsCollection { + // Retrieves and/or updates the LIA settings of multiple accounts in a single request. + custombatch(resource: Schema.LiasettingsCustomBatchRequest): Content_v2.Schema.LiasettingsCustomBatchResponse; + // Retrieves and/or updates the LIA settings of multiple accounts in a single request. + custombatch(resource: Schema.LiasettingsCustomBatchRequest, optionalArgs: object): Content_v2.Schema.LiasettingsCustomBatchResponse; + // Retrieves the LIA settings of the account. + get(merchantId: string, accountId: string): Content_v2.Schema.LiaSettings; + // Retrieves the list of accessible Google My Business accounts. + getaccessiblegmbaccounts(merchantId: string, accountId: string): Content_v2.Schema.LiasettingsGetAccessibleGmbAccountsResponse; + // Lists the LIA settings of the sub-accounts in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.LiasettingsListResponse; + // Lists the LIA settings of the sub-accounts in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.LiasettingsListResponse; + // Retrieves the list of POS data providers that have active settings for the all eiligible countries. + listposdataproviders(): Content_v2.Schema.LiasettingsListPosDataProvidersResponse; + // Updates the LIA settings of the account. This method supports patch semantics. + patch(resource: Schema.LiaSettings, merchantId: string, accountId: string): Content_v2.Schema.LiaSettings; + // Updates the LIA settings of the account. This method supports patch semantics. + patch(resource: Schema.LiaSettings, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.LiaSettings; + // Requests access to a specified Google My Business account. + requestgmbaccess(merchantId: string, accountId: string, gmbEmail: string): Content_v2.Schema.LiasettingsRequestGmbAccessResponse; + // Requests inventory validation for the specified country. + requestinventoryverification(merchantId: string, accountId: string, country: string): Content_v2.Schema.LiasettingsRequestInventoryVerificationResponse; + // Sets the inventory verification contract for the specified country. + setinventoryverificationcontact(merchantId: string, accountId: string, contactEmail: string, contactName: string, country: string, language: string): Content_v2.Schema.LiasettingsSetInventoryVerificationContactResponse; + // Sets the POS data provider for the specified country. + setposdataprovider(merchantId: string, accountId: string, country: string): Content_v2.Schema.LiasettingsSetPosDataProviderResponse; + // Sets the POS data provider for the specified country. + setposdataprovider(merchantId: string, accountId: string, country: string, optionalArgs: object): Content_v2.Schema.LiasettingsSetPosDataProviderResponse; + // Updates the LIA settings of the account. + update(resource: Schema.LiaSettings, merchantId: string, accountId: string): Content_v2.Schema.LiaSettings; + // Updates the LIA settings of the account. + update(resource: Schema.LiaSettings, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.LiaSettings; + } + export interface OrderinvoicesCollection { + // Creates a charge invoice for a shipment group, and triggers a charge capture for non-facilitated payment orders. + createchargeinvoice(resource: Schema.OrderinvoicesCreateChargeInvoiceRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderinvoicesCreateChargeInvoiceResponse; + // Creates a refund invoice for one or more shipment groups, and triggers a refund for non-facilitated payment orders. This can only be used for line items that have previously been charged using createChargeInvoice. All amounts (except for the summary) are incremental with respect to the previous invoice. + createrefundinvoice(resource: Schema.OrderinvoicesCreateRefundInvoiceRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderinvoicesCreateRefundInvoiceResponse; + } + export interface OrderpaymentsCollection { + // Notify about successfully authorizing user's payment method for a given amount. + notifyauthapproved(resource: Schema.OrderpaymentsNotifyAuthApprovedRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderpaymentsNotifyAuthApprovedResponse; + // Notify about failure to authorize user's payment method. + notifyauthdeclined(resource: Schema.OrderpaymentsNotifyAuthDeclinedRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderpaymentsNotifyAuthDeclinedResponse; + // Notify about charge on user's selected payments method. + notifycharge(resource: Schema.OrderpaymentsNotifyChargeRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderpaymentsNotifyChargeResponse; + // Notify about refund on user's selected payments method. + notifyrefund(resource: Schema.OrderpaymentsNotifyRefundRequest, merchantId: string, orderId: string): Content_v2.Schema.OrderpaymentsNotifyRefundResponse; + } + export interface OrderreportsCollection { + // Retrieves a report for disbursements from your Merchant Center account. + listdisbursements(merchantId: string, disbursementStartDate: string): Content_v2.Schema.OrderreportsListDisbursementsResponse; + // Retrieves a report for disbursements from your Merchant Center account. + listdisbursements(merchantId: string, disbursementStartDate: string, optionalArgs: object): Content_v2.Schema.OrderreportsListDisbursementsResponse; + // Retrieves a list of transactions for a disbursement from your Merchant Center account. + listtransactions(merchantId: string, disbursementId: string, transactionStartDate: string): Content_v2.Schema.OrderreportsListTransactionsResponse; + // Retrieves a list of transactions for a disbursement from your Merchant Center account. + listtransactions(merchantId: string, disbursementId: string, transactionStartDate: string, optionalArgs: object): Content_v2.Schema.OrderreportsListTransactionsResponse; + } + export interface OrderreturnsCollection { + // Retrieves an order return from your Merchant Center account. + get(merchantId: string, returnId: string): Content_v2.Schema.MerchantOrderReturn; + // Lists order returns in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.OrderreturnsListResponse; + // Lists order returns in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.OrderreturnsListResponse; + } + export interface OrdersCollection { + // Marks an order as acknowledged. + acknowledge(resource: Schema.OrdersAcknowledgeRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersAcknowledgeResponse; + // Sandbox only. Moves a test order from state "inProgress" to state "pendingShipment". + advancetestorder(merchantId: string, orderId: string): Content_v2.Schema.OrdersAdvanceTestOrderResponse; + // Cancels all line items in an order, making a full refund. + cancel(resource: Schema.OrdersCancelRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersCancelResponse; + // Cancels a line item, making a full refund. + cancellineitem(resource: Schema.OrdersCancelLineItemRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersCancelLineItemResponse; + // Sandbox only. Cancels a test order for customer-initiated cancellation. + canceltestorderbycustomer(resource: Schema.OrdersCancelTestOrderByCustomerRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersCancelTestOrderByCustomerResponse; + // Sandbox only. Creates a test order. + createtestorder(resource: Schema.OrdersCreateTestOrderRequest, merchantId: string): Content_v2.Schema.OrdersCreateTestOrderResponse; + // Sandbox only. Creates a test return. + createtestreturn(resource: Schema.OrdersCreateTestReturnRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersCreateTestReturnResponse; + // Retrieves or modifies multiple orders in a single request. + custombatch(resource: Schema.OrdersCustomBatchRequest): Content_v2.Schema.OrdersCustomBatchResponse; + // Retrieves an order from your Merchant Center account. + get(merchantId: string, orderId: string): Content_v2.Schema.Order; + // Retrieves an order using merchant order ID. + getbymerchantorderid(merchantId: string, merchantOrderId: string): Content_v2.Schema.OrdersGetByMerchantOrderIdResponse; + // Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. + gettestordertemplate(merchantId: string, templateName: string): Content_v2.Schema.OrdersGetTestOrderTemplateResponse; + // Sandbox only. Retrieves an order template that can be used to quickly create a new order in sandbox. + gettestordertemplate(merchantId: string, templateName: string, optionalArgs: object): Content_v2.Schema.OrdersGetTestOrderTemplateResponse; + // Notifies that item return and refund was handled directly by merchant outside of Google payments processing (e.g. cash refund done in store). + // Note: We recommend calling the returnrefundlineitem method to refund in-store returns. We will issue the refund directly to the customer. This helps to prevent possible differences arising between merchant and Google transaction records. We also recommend having the point of sale system communicate with Google to ensure that customers do not receive a double refund by first refunding via Google then via an in-store return. + instorerefundlineitem(resource: Schema.OrdersInStoreRefundLineItemRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersInStoreRefundLineItemResponse; + // Lists the orders in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.OrdersListResponse; + // Lists the orders in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.OrdersListResponse; + // Deprecated, please use returnRefundLineItem instead. + refund(resource: Schema.OrdersRefundRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersRefundResponse; + // Rejects return on an line item. + rejectreturnlineitem(resource: Schema.OrdersRejectReturnLineItemRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersRejectReturnLineItemResponse; + // Returns a line item. + returnlineitem(resource: Schema.OrdersReturnLineItemRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersReturnLineItemResponse; + // Returns and refunds a line item. Note that this method can only be called on fully shipped orders. + returnrefundlineitem(resource: Schema.OrdersReturnRefundLineItemRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersReturnRefundLineItemResponse; + // Sets (or overrides if it already exists) merchant provided annotations in the form of key-value pairs. A common use case would be to supply us with additional structured information about a line item that cannot be provided via other methods. Submitted key-value pairs can be retrieved as part of the orders resource. + setlineitemmetadata(resource: Schema.OrdersSetLineItemMetadataRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersSetLineItemMetadataResponse; + // Marks line item(s) as shipped. + shiplineitems(resource: Schema.OrdersShipLineItemsRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersShipLineItemsResponse; + // Updates ship by and delivery by dates for a line item. + updatelineitemshippingdetails(resource: Schema.OrdersUpdateLineItemShippingDetailsRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersUpdateLineItemShippingDetailsResponse; + // Updates the merchant order ID for a given order. + updatemerchantorderid(resource: Schema.OrdersUpdateMerchantOrderIdRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersUpdateMerchantOrderIdResponse; + // Updates a shipment's status, carrier, and/or tracking ID. + updateshipment(resource: Schema.OrdersUpdateShipmentRequest, merchantId: string, orderId: string): Content_v2.Schema.OrdersUpdateShipmentResponse; + } + export interface PosCollection { + // Batches multiple POS-related calls in a single request. + custombatch(resource: Schema.PosCustomBatchRequest): Content_v2.Schema.PosCustomBatchResponse; + // Batches multiple POS-related calls in a single request. + custombatch(resource: Schema.PosCustomBatchRequest, optionalArgs: object): Content_v2.Schema.PosCustomBatchResponse; + // Retrieves information about the given store. + get(merchantId: string, targetMerchantId: string, storeCode: string): Content_v2.Schema.PosStore; + // Creates a store for the given merchant. + insert(resource: Schema.PosStore, merchantId: string, targetMerchantId: string): Content_v2.Schema.PosStore; + // Creates a store for the given merchant. + insert(resource: Schema.PosStore, merchantId: string, targetMerchantId: string, optionalArgs: object): Content_v2.Schema.PosStore; + // Submit inventory for the given merchant. + inventory(resource: Schema.PosInventoryRequest, merchantId: string, targetMerchantId: string): Content_v2.Schema.PosInventoryResponse; + // Submit inventory for the given merchant. + inventory(resource: Schema.PosInventoryRequest, merchantId: string, targetMerchantId: string, optionalArgs: object): Content_v2.Schema.PosInventoryResponse; + // Lists the stores of the target merchant. + list(merchantId: string, targetMerchantId: string): Content_v2.Schema.PosListResponse; + // Deletes a store for the given merchant. + remove(merchantId: string, targetMerchantId: string, storeCode: string): void; + // Deletes a store for the given merchant. + remove(merchantId: string, targetMerchantId: string, storeCode: string, optionalArgs: object): void; + // Submit a sale event for the given merchant. + sale(resource: Schema.PosSaleRequest, merchantId: string, targetMerchantId: string): Content_v2.Schema.PosSaleResponse; + // Submit a sale event for the given merchant. + sale(resource: Schema.PosSaleRequest, merchantId: string, targetMerchantId: string, optionalArgs: object): Content_v2.Schema.PosSaleResponse; + } + export interface ProductsCollection { + // Retrieves, inserts, and deletes multiple products in a single request. + custombatch(resource: Schema.ProductsCustomBatchRequest): Content_v2.Schema.ProductsCustomBatchResponse; + // Retrieves, inserts, and deletes multiple products in a single request. + custombatch(resource: Schema.ProductsCustomBatchRequest, optionalArgs: object): Content_v2.Schema.ProductsCustomBatchResponse; + // Retrieves a product from your Merchant Center account. + get(merchantId: string, productId: string): Content_v2.Schema.Product; + // Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. + insert(resource: Schema.Product, merchantId: string): Content_v2.Schema.Product; + // Uploads a product to your Merchant Center account. If an item with the same channel, contentLanguage, offerId, and targetCountry already exists, this method updates that entry. + insert(resource: Schema.Product, merchantId: string, optionalArgs: object): Content_v2.Schema.Product; + // Lists the products in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.ProductsListResponse; + // Lists the products in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.ProductsListResponse; + // Deletes a product from your Merchant Center account. + remove(merchantId: string, productId: string): void; + // Deletes a product from your Merchant Center account. + remove(merchantId: string, productId: string, optionalArgs: object): void; + } + export interface ProductstatusesCollection { + // Gets the statuses of multiple products in a single request. + custombatch(resource: Schema.ProductstatusesCustomBatchRequest): Content_v2.Schema.ProductstatusesCustomBatchResponse; + // Gets the statuses of multiple products in a single request. + custombatch(resource: Schema.ProductstatusesCustomBatchRequest, optionalArgs: object): Content_v2.Schema.ProductstatusesCustomBatchResponse; + // Gets the status of a product from your Merchant Center account. + get(merchantId: string, productId: string): Content_v2.Schema.ProductStatus; + // Gets the status of a product from your Merchant Center account. + get(merchantId: string, productId: string, optionalArgs: object): Content_v2.Schema.ProductStatus; + // Lists the statuses of the products in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.ProductstatusesListResponse; + // Lists the statuses of the products in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.ProductstatusesListResponse; + } + export interface ShippingsettingsCollection { + // Retrieves and updates the shipping settings of multiple accounts in a single request. + custombatch(resource: Schema.ShippingsettingsCustomBatchRequest): Content_v2.Schema.ShippingsettingsCustomBatchResponse; + // Retrieves and updates the shipping settings of multiple accounts in a single request. + custombatch(resource: Schema.ShippingsettingsCustomBatchRequest, optionalArgs: object): Content_v2.Schema.ShippingsettingsCustomBatchResponse; + // Retrieves the shipping settings of the account. + get(merchantId: string, accountId: string): Content_v2.Schema.ShippingSettings; + // Retrieves supported carriers and carrier services for an account. + getsupportedcarriers(merchantId: string): Content_v2.Schema.ShippingsettingsGetSupportedCarriersResponse; + // Retrieves supported holidays for an account. + getsupportedholidays(merchantId: string): Content_v2.Schema.ShippingsettingsGetSupportedHolidaysResponse; + // Lists the shipping settings of the sub-accounts in your Merchant Center account. + list(merchantId: string): Content_v2.Schema.ShippingsettingsListResponse; + // Lists the shipping settings of the sub-accounts in your Merchant Center account. + list(merchantId: string, optionalArgs: object): Content_v2.Schema.ShippingsettingsListResponse; + // Updates the shipping settings of the account. This method supports patch semantics. + patch(resource: Schema.ShippingSettings, merchantId: string, accountId: string): Content_v2.Schema.ShippingSettings; + // Updates the shipping settings of the account. This method supports patch semantics. + patch(resource: Schema.ShippingSettings, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.ShippingSettings; + // Updates the shipping settings of the account. + update(resource: Schema.ShippingSettings, merchantId: string, accountId: string): Content_v2.Schema.ShippingSettings; + // Updates the shipping settings of the account. + update(resource: Schema.ShippingSettings, merchantId: string, accountId: string, optionalArgs: object): Content_v2.Schema.ShippingSettings; + } + } + namespace Schema { + export interface Account { + adultContent?: boolean; + adwordsLinks?: Content_v2.Schema.AccountAdwordsLink[]; + businessInformation?: Content_v2.Schema.AccountBusinessInformation; + googleMyBusinessLink?: Content_v2.Schema.AccountGoogleMyBusinessLink; + id?: string; + kind?: string; + name?: string; + reviewsUrl?: string; + sellerId?: string; + users?: Content_v2.Schema.AccountUser[]; + websiteUrl?: string; + youtubeChannelLinks?: Content_v2.Schema.AccountYouTubeChannelLink[]; + } + export interface AccountAddress { + country?: string; + locality?: string; + postalCode?: string; + region?: string; + streetAddress?: string; + } + export interface AccountAdwordsLink { + adwordsId?: string; + status?: string; + } + export interface AccountBusinessInformation { + address?: Content_v2.Schema.AccountAddress; + customerService?: Content_v2.Schema.AccountCustomerService; + phoneNumber?: string; + } + export interface AccountCustomerService { + email?: string; + phoneNumber?: string; + url?: string; + } + export interface AccountGoogleMyBusinessLink { + gmbEmail?: string; + status?: string; + } + export interface AccountIdentifier { + aggregatorId?: string; + merchantId?: string; + } + export interface AccountStatus { + accountId?: string; + accountLevelIssues?: Content_v2.Schema.AccountStatusAccountLevelIssue[]; + dataQualityIssues?: Content_v2.Schema.AccountStatusDataQualityIssue[]; + kind?: string; + products?: Content_v2.Schema.AccountStatusProducts[]; + websiteClaimed?: boolean; + } + export interface AccountStatusAccountLevelIssue { + country?: string; + destination?: string; + detail?: string; + documentation?: string; + id?: string; + severity?: string; + title?: string; + } + export interface AccountStatusDataQualityIssue { + country?: string; + destination?: string; + detail?: string; + displayedValue?: string; + exampleItems?: Content_v2.Schema.AccountStatusExampleItem[]; + id?: string; + lastChecked?: string; + location?: string; + numItems?: number; + severity?: string; + submittedValue?: string; + } + export interface AccountStatusExampleItem { + itemId?: string; + link?: string; + submittedValue?: string; + title?: string; + valueOnLandingPage?: string; + } + export interface AccountStatusItemLevelIssue { + attributeName?: string; + code?: string; + description?: string; + detail?: string; + documentation?: string; + numItems?: string; + resolution?: string; + servability?: string; + } + export interface AccountStatusProducts { + channel?: string; + country?: string; + destination?: string; + itemLevelIssues?: Content_v2.Schema.AccountStatusItemLevelIssue[]; + statistics?: Content_v2.Schema.AccountStatusStatistics; + } + export interface AccountStatusStatistics { + active?: string; + disapproved?: string; + expiring?: string; + pending?: string; + } + export interface AccountTax { + accountId?: string; + kind?: string; + rules?: Content_v2.Schema.AccountTaxTaxRule[]; + } + export interface AccountTaxTaxRule { + country?: string; + locationId?: string; + ratePercent?: string; + shippingTaxed?: boolean; + useGlobalRate?: boolean; + } + export interface AccountUser { + admin?: boolean; + emailAddress?: string; + orderManager?: boolean; + paymentsAnalyst?: boolean; + paymentsManager?: boolean; + } + export interface AccountYouTubeChannelLink { + channelId?: string; + status?: string; + } + export interface AccountsAuthInfoResponse { + accountIdentifiers?: Content_v2.Schema.AccountIdentifier[]; + kind?: string; + } + export interface AccountsClaimWebsiteResponse { + kind?: string; + } + export interface AccountsCustomBatchRequest { + entries?: Content_v2.Schema.AccountsCustomBatchRequestEntry[]; + } + export interface AccountsCustomBatchRequestEntry { + account?: Content_v2.Schema.Account; + accountId?: string; + batchId?: number; + force?: boolean; + linkRequest?: Content_v2.Schema.AccountsCustomBatchRequestEntryLinkRequest; + merchantId?: string; + method?: string; + overwrite?: boolean; + } + export interface AccountsCustomBatchRequestEntryLinkRequest { + action?: string; + linkType?: string; + linkedAccountId?: string; + } + export interface AccountsCustomBatchResponse { + entries?: Content_v2.Schema.AccountsCustomBatchResponseEntry[]; + kind?: string; + } + export interface AccountsCustomBatchResponseEntry { + account?: Content_v2.Schema.Account; + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + linkStatus?: string; + } + export interface AccountsLinkRequest { + action?: string; + linkType?: string; + linkedAccountId?: string; + } + export interface AccountsLinkResponse { + kind?: string; + } + export interface AccountsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.Account[]; + } + export interface AccountstatusesCustomBatchRequest { + entries?: Content_v2.Schema.AccountstatusesCustomBatchRequestEntry[]; + } + export interface AccountstatusesCustomBatchRequestEntry { + accountId?: string; + batchId?: number; + destinations?: string[]; + merchantId?: string; + method?: string; + } + export interface AccountstatusesCustomBatchResponse { + entries?: Content_v2.Schema.AccountstatusesCustomBatchResponseEntry[]; + kind?: string; + } + export interface AccountstatusesCustomBatchResponseEntry { + accountStatus?: Content_v2.Schema.AccountStatus; + batchId?: number; + errors?: Content_v2.Schema.Errors; + } + export interface AccountstatusesListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.AccountStatus[]; + } + export interface AccounttaxCustomBatchRequest { + entries?: Content_v2.Schema.AccounttaxCustomBatchRequestEntry[]; + } + export interface AccounttaxCustomBatchRequestEntry { + accountId?: string; + accountTax?: Content_v2.Schema.AccountTax; + batchId?: number; + merchantId?: string; + method?: string; + } + export interface AccounttaxCustomBatchResponse { + entries?: Content_v2.Schema.AccounttaxCustomBatchResponseEntry[]; + kind?: string; + } + export interface AccounttaxCustomBatchResponseEntry { + accountTax?: Content_v2.Schema.AccountTax; + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + } + export interface AccounttaxListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.AccountTax[]; + } + export interface Amount { + pretax?: Content_v2.Schema.Price; + tax?: Content_v2.Schema.Price; + } + export interface CarrierRate { + carrierName?: string; + carrierService?: string; + flatAdjustment?: Content_v2.Schema.Price; + name?: string; + originPostalCode?: string; + percentageAdjustment?: string; + } + export interface CarriersCarrier { + country?: string; + name?: string; + services?: string[]; + } + export interface CustomAttribute { + name?: string; + type?: string; + unit?: string; + value?: string; + } + export interface CustomGroup { + attributes?: Content_v2.Schema.CustomAttribute[]; + name?: string; + } + export interface CustomerReturnReason { + description?: string; + reasonCode?: string; + } + export interface CutoffTime { + hour?: number; + minute?: number; + timezone?: string; + } + export interface Datafeed { + attributeLanguage?: string; + contentLanguage?: string; + contentType?: string; + fetchSchedule?: Content_v2.Schema.DatafeedFetchSchedule; + fileName?: string; + format?: Content_v2.Schema.DatafeedFormat; + id?: string; + intendedDestinations?: string[]; + kind?: string; + name?: string; + targetCountry?: string; + targets?: Content_v2.Schema.DatafeedTarget[]; + } + export interface DatafeedFetchSchedule { + dayOfMonth?: number; + fetchUrl?: string; + hour?: number; + minuteOfHour?: number; + password?: string; + paused?: boolean; + timeZone?: string; + username?: string; + weekday?: string; + } + export interface DatafeedFormat { + columnDelimiter?: string; + fileEncoding?: string; + quotingMode?: string; + } + export interface DatafeedStatus { + country?: string; + datafeedId?: string; + errors?: Content_v2.Schema.DatafeedStatusError[]; + itemsTotal?: string; + itemsValid?: string; + kind?: string; + language?: string; + lastUploadDate?: string; + processingStatus?: string; + warnings?: Content_v2.Schema.DatafeedStatusError[]; + } + export interface DatafeedStatusError { + code?: string; + count?: string; + examples?: Content_v2.Schema.DatafeedStatusExample[]; + message?: string; + } + export interface DatafeedStatusExample { + itemId?: string; + lineNumber?: string; + value?: string; + } + export interface DatafeedTarget { + country?: string; + excludedDestinations?: string[]; + includedDestinations?: string[]; + language?: string; + } + export interface DatafeedsCustomBatchRequest { + entries?: Content_v2.Schema.DatafeedsCustomBatchRequestEntry[]; + } + export interface DatafeedsCustomBatchRequestEntry { + batchId?: number; + datafeed?: Content_v2.Schema.Datafeed; + datafeedId?: string; + merchantId?: string; + method?: string; + } + export interface DatafeedsCustomBatchResponse { + entries?: Content_v2.Schema.DatafeedsCustomBatchResponseEntry[]; + kind?: string; + } + export interface DatafeedsCustomBatchResponseEntry { + batchId?: number; + datafeed?: Content_v2.Schema.Datafeed; + errors?: Content_v2.Schema.Errors; + } + export interface DatafeedsFetchNowResponse { + kind?: string; + } + export interface DatafeedsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.Datafeed[]; + } + export interface DatafeedstatusesCustomBatchRequest { + entries?: Content_v2.Schema.DatafeedstatusesCustomBatchRequestEntry[]; + } + export interface DatafeedstatusesCustomBatchRequestEntry { + batchId?: number; + country?: string; + datafeedId?: string; + language?: string; + merchantId?: string; + method?: string; + } + export interface DatafeedstatusesCustomBatchResponse { + entries?: Content_v2.Schema.DatafeedstatusesCustomBatchResponseEntry[]; + kind?: string; + } + export interface DatafeedstatusesCustomBatchResponseEntry { + batchId?: number; + datafeedStatus?: Content_v2.Schema.DatafeedStatus; + errors?: Content_v2.Schema.Errors; + } + export interface DatafeedstatusesListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.DatafeedStatus[]; + } + export interface DeliveryTime { + cutoffTime?: Content_v2.Schema.CutoffTime; + holidayCutoffs?: Content_v2.Schema.HolidayCutoff[]; + maxHandlingTimeInDays?: number; + maxTransitTimeInDays?: number; + minHandlingTimeInDays?: number; + minTransitTimeInDays?: number; + transitTimeTable?: Content_v2.Schema.TransitTable; + } + export interface Error { + domain?: string; + message?: string; + reason?: string; + } + export interface Errors { + code?: number; + errors?: Content_v2.Schema.Error[]; + message?: string; + } + export interface GmbAccounts { + accountId?: string; + gmbAccounts?: Content_v2.Schema.GmbAccountsGmbAccount[]; + } + export interface GmbAccountsGmbAccount { + email?: string; + listingCount?: string; + name?: string; + type?: string; + } + export interface Headers { + locations?: Content_v2.Schema.LocationIdSet[]; + numberOfItems?: string[]; + postalCodeGroupNames?: string[]; + prices?: Content_v2.Schema.Price[]; + weights?: Content_v2.Schema.Weight[]; + } + export interface HolidayCutoff { + deadlineDate?: string; + deadlineHour?: number; + deadlineTimezone?: string; + holidayId?: string; + visibleFromDate?: string; + } + export interface HolidaysHoliday { + countryCode?: string; + date?: string; + deliveryGuaranteeDate?: string; + deliveryGuaranteeHour?: string; + id?: string; + type?: string; + } + export interface Installment { + amount?: Content_v2.Schema.Price; + months?: string; + } + export interface Inventory { + availability?: string; + customLabel0?: string; + customLabel1?: string; + customLabel2?: string; + customLabel3?: string; + customLabel4?: string; + installment?: Content_v2.Schema.Installment; + instoreProductLocation?: string; + kind?: string; + loyaltyPoints?: Content_v2.Schema.LoyaltyPoints; + pickup?: Content_v2.Schema.InventoryPickup; + price?: Content_v2.Schema.Price; + quantity?: number; + salePrice?: Content_v2.Schema.Price; + salePriceEffectiveDate?: string; + sellOnGoogleQuantity?: number; + } + export interface InventoryCustomBatchRequest { + entries?: Content_v2.Schema.InventoryCustomBatchRequestEntry[]; + } + export interface InventoryCustomBatchRequestEntry { + batchId?: number; + inventory?: Content_v2.Schema.Inventory; + merchantId?: string; + productId?: string; + storeCode?: string; + } + export interface InventoryCustomBatchResponse { + entries?: Content_v2.Schema.InventoryCustomBatchResponseEntry[]; + kind?: string; + } + export interface InventoryCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + } + export interface InventoryPickup { + pickupMethod?: string; + pickupSla?: string; + } + export interface InventorySetRequest { + availability?: string; + customLabel0?: string; + customLabel1?: string; + customLabel2?: string; + customLabel3?: string; + customLabel4?: string; + installment?: Content_v2.Schema.Installment; + instoreProductLocation?: string; + loyaltyPoints?: Content_v2.Schema.LoyaltyPoints; + pickup?: Content_v2.Schema.InventoryPickup; + price?: Content_v2.Schema.Price; + quantity?: number; + salePrice?: Content_v2.Schema.Price; + salePriceEffectiveDate?: string; + sellOnGoogleQuantity?: number; + } + export interface InventorySetResponse { + kind?: string; + } + export interface InvoiceSummary { + additionalChargeSummaries?: Content_v2.Schema.InvoiceSummaryAdditionalChargeSummary[]; + customerBalance?: Content_v2.Schema.Amount; + googleBalance?: Content_v2.Schema.Amount; + merchantBalance?: Content_v2.Schema.Amount; + productTotal?: Content_v2.Schema.Amount; + promotionSummaries?: Content_v2.Schema.Promotion[]; + } + export interface InvoiceSummaryAdditionalChargeSummary { + totalAmount?: Content_v2.Schema.Amount; + type?: string; + } + export interface LiaAboutPageSettings { + status?: string; + url?: string; + } + export interface LiaCountrySettings { + about?: Content_v2.Schema.LiaAboutPageSettings; + country?: string; + hostedLocalStorefrontActive?: boolean; + inventory?: Content_v2.Schema.LiaInventorySettings; + onDisplayToOrder?: Content_v2.Schema.LiaOnDisplayToOrderSettings; + posDataProvider?: Content_v2.Schema.LiaPosDataProvider; + storePickupActive?: boolean; + } + export interface LiaInventorySettings { + inventoryVerificationContactEmail?: string; + inventoryVerificationContactName?: string; + inventoryVerificationContactStatus?: string; + status?: string; + } + export interface LiaOnDisplayToOrderSettings { + shippingCostPolicyUrl?: string; + status?: string; + } + export interface LiaPosDataProvider { + posDataProviderId?: string; + posExternalAccountId?: string; + } + export interface LiaSettings { + accountId?: string; + countrySettings?: Content_v2.Schema.LiaCountrySettings[]; + kind?: string; + } + export interface LiasettingsCustomBatchRequest { + entries?: Content_v2.Schema.LiasettingsCustomBatchRequestEntry[]; + } + export interface LiasettingsCustomBatchRequestEntry { + accountId?: string; + batchId?: number; + contactEmail?: string; + contactName?: string; + country?: string; + gmbEmail?: string; + liaSettings?: Content_v2.Schema.LiaSettings; + merchantId?: string; + method?: string; + posDataProviderId?: string; + posExternalAccountId?: string; + } + export interface LiasettingsCustomBatchResponse { + entries?: Content_v2.Schema.LiasettingsCustomBatchResponseEntry[]; + kind?: string; + } + export interface LiasettingsCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + gmbAccounts?: Content_v2.Schema.GmbAccounts; + kind?: string; + liaSettings?: Content_v2.Schema.LiaSettings; + posDataProviders?: Content_v2.Schema.PosDataProviders[]; + } + export interface LiasettingsGetAccessibleGmbAccountsResponse { + accountId?: string; + gmbAccounts?: Content_v2.Schema.GmbAccountsGmbAccount[]; + kind?: string; + } + export interface LiasettingsListPosDataProvidersResponse { + kind?: string; + posDataProviders?: Content_v2.Schema.PosDataProviders[]; + } + export interface LiasettingsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.LiaSettings[]; + } + export interface LiasettingsRequestGmbAccessResponse { + kind?: string; + } + export interface LiasettingsRequestInventoryVerificationResponse { + kind?: string; + } + export interface LiasettingsSetInventoryVerificationContactResponse { + kind?: string; + } + export interface LiasettingsSetPosDataProviderResponse { + kind?: string; + } + export interface LocationIdSet { + locationIds?: string[]; + } + export interface LoyaltyPoints { + name?: string; + pointsValue?: string; + ratio?: Number; + } + export interface MerchantOrderReturn { + creationDate?: string; + merchantOrderId?: string; + orderId?: string; + orderReturnId?: string; + returnItems?: Content_v2.Schema.MerchantOrderReturnItem[]; + returnShipments?: Content_v2.Schema.ReturnShipment[]; + } + export interface MerchantOrderReturnItem { + customerReturnReason?: Content_v2.Schema.CustomerReturnReason; + itemId?: string; + merchantReturnReason?: Content_v2.Schema.RefundReason; + product?: Content_v2.Schema.OrderLineItemProduct; + returnShipmentIds?: string[]; + state?: string; + } + export interface Order { + acknowledged?: boolean; + channelType?: string; + customer?: Content_v2.Schema.OrderCustomer; + deliveryDetails?: Content_v2.Schema.OrderDeliveryDetails; + id?: string; + kind?: string; + lineItems?: Content_v2.Schema.OrderLineItem[]; + merchantId?: string; + merchantOrderId?: string; + netAmount?: Content_v2.Schema.Price; + paymentMethod?: Content_v2.Schema.OrderPaymentMethod; + paymentStatus?: string; + placedDate?: string; + promotions?: Content_v2.Schema.OrderLegacyPromotion[]; + refunds?: Content_v2.Schema.OrderRefund[]; + shipments?: Content_v2.Schema.OrderShipment[]; + shippingCost?: Content_v2.Schema.Price; + shippingCostTax?: Content_v2.Schema.Price; + shippingOption?: string; + status?: string; + taxCollector?: string; + } + export interface OrderAddress { + country?: string; + fullAddress?: string[]; + isPostOfficeBox?: boolean; + locality?: string; + postalCode?: string; + recipientName?: string; + region?: string; + streetAddress?: string[]; + } + export interface OrderCancellation { + actor?: string; + creationDate?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrderCustomer { + email?: string; + explicitMarketingPreference?: boolean; + fullName?: string; + marketingRightsInfo?: Content_v2.Schema.OrderCustomerMarketingRightsInfo; + } + export interface OrderCustomerMarketingRightsInfo { + explicitMarketingPreference?: string; + lastUpdatedTimestamp?: string; + marketingEmailAddress?: string; + } + export interface OrderDeliveryDetails { + address?: Content_v2.Schema.OrderAddress; + phoneNumber?: string; + } + export interface OrderLegacyPromotion { + benefits?: Content_v2.Schema.OrderLegacyPromotionBenefit[]; + effectiveDates?: string; + genericRedemptionCode?: string; + id?: string; + longTitle?: string; + productApplicability?: string; + redemptionChannel?: string; + } + export interface OrderLegacyPromotionBenefit { + discount?: Content_v2.Schema.Price; + offerIds?: string[]; + subType?: string; + taxImpact?: Content_v2.Schema.Price; + type?: string; + } + export interface OrderLineItem { + annotations?: Content_v2.Schema.OrderMerchantProvidedAnnotation[]; + cancellations?: Content_v2.Schema.OrderCancellation[]; + id?: string; + price?: Content_v2.Schema.Price; + product?: Content_v2.Schema.OrderLineItemProduct; + quantityCanceled?: number; + quantityDelivered?: number; + quantityOrdered?: number; + quantityPending?: number; + quantityReturned?: number; + quantityShipped?: number; + returnInfo?: Content_v2.Schema.OrderLineItemReturnInfo; + returns?: Content_v2.Schema.OrderReturn[]; + shippingDetails?: Content_v2.Schema.OrderLineItemShippingDetails; + tax?: Content_v2.Schema.Price; + } + export interface OrderLineItemProduct { + brand?: string; + channel?: string; + condition?: string; + contentLanguage?: string; + fees?: Content_v2.Schema.OrderLineItemProductFee[]; + gtin?: string; + id?: string; + imageLink?: string; + itemGroupId?: string; + mpn?: string; + offerId?: string; + price?: Content_v2.Schema.Price; + shownImage?: string; + targetCountry?: string; + title?: string; + variantAttributes?: Content_v2.Schema.OrderLineItemProductVariantAttribute[]; + } + export interface OrderLineItemProductFee { + amount?: Content_v2.Schema.Price; + name?: string; + } + export interface OrderLineItemProductVariantAttribute { + dimension?: string; + value?: string; + } + export interface OrderLineItemReturnInfo { + daysToReturn?: number; + isReturnable?: boolean; + policyUrl?: string; + } + export interface OrderLineItemShippingDetails { + deliverByDate?: string; + method?: Content_v2.Schema.OrderLineItemShippingDetailsMethod; + shipByDate?: string; + } + export interface OrderLineItemShippingDetailsMethod { + carrier?: string; + maxDaysInTransit?: number; + methodName?: string; + minDaysInTransit?: number; + } + export interface OrderMerchantProvidedAnnotation { + key?: string; + value?: string; + } + export interface OrderPaymentMethod { + billingAddress?: Content_v2.Schema.OrderAddress; + expirationMonth?: number; + expirationYear?: number; + lastFourDigits?: string; + phoneNumber?: string; + type?: string; + } + export interface OrderRefund { + actor?: string; + amount?: Content_v2.Schema.Price; + creationDate?: string; + reason?: string; + reasonText?: string; + } + export interface OrderReportDisbursement { + disbursementAmount?: Content_v2.Schema.Price; + disbursementCreationDate?: string; + disbursementDate?: string; + disbursementId?: string; + merchantId?: string; + } + export interface OrderReportTransaction { + disbursementAmount?: Content_v2.Schema.Price; + disbursementCreationDate?: string; + disbursementDate?: string; + disbursementId?: string; + merchantId?: string; + merchantOrderId?: string; + orderId?: string; + productAmount?: Content_v2.Schema.Amount; + productAmountWithRemittedTax?: Content_v2.Schema.ProductAmount; + transactionDate?: string; + } + export interface OrderReturn { + actor?: string; + creationDate?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrderShipment { + carrier?: string; + creationDate?: string; + deliveryDate?: string; + id?: string; + lineItems?: Content_v2.Schema.OrderShipmentLineItemShipment[]; + status?: string; + trackingId?: string; + } + export interface OrderShipmentLineItemShipment { + lineItemId?: string; + productId?: string; + quantity?: number; + } + export interface OrderinvoicesCreateChargeInvoiceRequest { + invoiceId?: string; + invoiceSummary?: Content_v2.Schema.InvoiceSummary; + lineItemInvoices?: Content_v2.Schema.ShipmentInvoiceLineItemInvoice[]; + operationId?: string; + shipmentGroupId?: string; + } + export interface OrderinvoicesCreateChargeInvoiceResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderinvoicesCreateRefundInvoiceRequest { + invoiceId?: string; + operationId?: string; + refundOnlyOption?: Content_v2.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; + returnOption?: Content_v2.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; + shipmentInvoices?: Content_v2.Schema.ShipmentInvoice[]; + } + export interface OrderinvoicesCreateRefundInvoiceResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption { + description?: string; + reason?: string; + } + export interface OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption { + description?: string; + reason?: string; + } + export interface OrderpaymentsNotifyAuthApprovedRequest { + authAmountPretax?: Content_v2.Schema.Price; + authAmountTax?: Content_v2.Schema.Price; + } + export interface OrderpaymentsNotifyAuthApprovedResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderpaymentsNotifyAuthDeclinedRequest { + declineReason?: string; + } + export interface OrderpaymentsNotifyAuthDeclinedResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderpaymentsNotifyChargeRequest { + chargeState?: string; + invoiceId?: string; + invoiceIds?: string[]; + } + export interface OrderpaymentsNotifyChargeResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderpaymentsNotifyRefundRequest { + invoiceId?: string; + invoiceIds?: string[]; + refundState?: string; + } + export interface OrderpaymentsNotifyRefundResponse { + executionStatus?: string; + kind?: string; + } + export interface OrderreportsListDisbursementsResponse { + disbursements?: Content_v2.Schema.OrderReportDisbursement[]; + kind?: string; + nextPageToken?: string; + } + export interface OrderreportsListTransactionsResponse { + kind?: string; + nextPageToken?: string; + transactions?: Content_v2.Schema.OrderReportTransaction[]; + } + export interface OrderreturnsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.MerchantOrderReturn[]; + } + export interface OrdersAcknowledgeRequest { + operationId?: string; + } + export interface OrdersAcknowledgeResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersAdvanceTestOrderResponse { + kind?: string; + } + export interface OrdersCancelLineItemRequest { + amount?: Content_v2.Schema.Price; + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + operationId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCancelLineItemResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersCancelRequest { + operationId?: string; + reason?: string; + reasonText?: string; + } + export interface OrdersCancelResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersCancelTestOrderByCustomerRequest { + reason?: string; + } + export interface OrdersCancelTestOrderByCustomerResponse { + kind?: string; + } + export interface OrdersCreateTestOrderRequest { + country?: string; + templateName?: string; + testOrder?: Content_v2.Schema.TestOrder; + } + export interface OrdersCreateTestOrderResponse { + kind?: string; + orderId?: string; + } + export interface OrdersCreateTestReturnRequest { + items?: Content_v2.Schema.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem[]; + } + export interface OrdersCreateTestReturnResponse { + kind?: string; + returnId?: string; + } + export interface OrdersCustomBatchRequest { + entries?: Content_v2.Schema.OrdersCustomBatchRequestEntry[]; + } + export interface OrdersCustomBatchRequestEntry { + batchId?: number; + cancel?: Content_v2.Schema.OrdersCustomBatchRequestEntryCancel; + cancelLineItem?: Content_v2.Schema.OrdersCustomBatchRequestEntryCancelLineItem; + inStoreRefundLineItem?: Content_v2.Schema.OrdersCustomBatchRequestEntryInStoreRefundLineItem; + merchantId?: string; + merchantOrderId?: string; + method?: string; + operationId?: string; + orderId?: string; + refund?: Content_v2.Schema.OrdersCustomBatchRequestEntryRefund; + rejectReturnLineItem?: Content_v2.Schema.OrdersCustomBatchRequestEntryRejectReturnLineItem; + returnLineItem?: Content_v2.Schema.OrdersCustomBatchRequestEntryReturnLineItem; + returnRefundLineItem?: Content_v2.Schema.OrdersCustomBatchRequestEntryReturnRefundLineItem; + setLineItemMetadata?: Content_v2.Schema.OrdersCustomBatchRequestEntrySetLineItemMetadata; + shipLineItems?: Content_v2.Schema.OrdersCustomBatchRequestEntryShipLineItems; + updateLineItemShippingDetails?: Content_v2.Schema.OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails; + updateShipment?: Content_v2.Schema.OrdersCustomBatchRequestEntryUpdateShipment; + } + export interface OrdersCustomBatchRequestEntryCancel { + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryCancelLineItem { + amount?: Content_v2.Schema.Price; + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryCreateTestReturnReturnItem { + lineItemId?: string; + quantity?: number; + } + export interface OrdersCustomBatchRequestEntryInStoreRefundLineItem { + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryRefund { + amount?: Content_v2.Schema.Price; + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryRejectReturnLineItem { + lineItemId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryReturnLineItem { + lineItemId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntryReturnRefundLineItem { + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersCustomBatchRequestEntrySetLineItemMetadata { + annotations?: Content_v2.Schema.OrderMerchantProvidedAnnotation[]; + lineItemId?: string; + productId?: string; + } + export interface OrdersCustomBatchRequestEntryShipLineItems { + carrier?: string; + lineItems?: Content_v2.Schema.OrderShipmentLineItemShipment[]; + shipmentGroupId?: string; + shipmentId?: string; + shipmentInfos?: Content_v2.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; + trackingId?: string; + } + export interface OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo { + carrier?: string; + shipmentId?: string; + trackingId?: string; + } + export interface OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails { + deliverByDate?: string; + lineItemId?: string; + productId?: string; + shipByDate?: string; + } + export interface OrdersCustomBatchRequestEntryUpdateShipment { + carrier?: string; + deliveryDate?: string; + shipmentId?: string; + status?: string; + trackingId?: string; + } + export interface OrdersCustomBatchResponse { + entries?: Content_v2.Schema.OrdersCustomBatchResponseEntry[]; + kind?: string; + } + export interface OrdersCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + executionStatus?: string; + kind?: string; + order?: Content_v2.Schema.Order; + } + export interface OrdersGetByMerchantOrderIdResponse { + kind?: string; + order?: Content_v2.Schema.Order; + } + export interface OrdersGetTestOrderTemplateResponse { + kind?: string; + template?: Content_v2.Schema.TestOrder; + } + export interface OrdersInStoreRefundLineItemRequest { + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + operationId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersInStoreRefundLineItemResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.Order[]; + } + export interface OrdersRefundRequest { + amount?: Content_v2.Schema.Price; + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + operationId?: string; + reason?: string; + reasonText?: string; + } + export interface OrdersRefundResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersRejectReturnLineItemRequest { + lineItemId?: string; + operationId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersRejectReturnLineItemResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersReturnLineItemRequest { + lineItemId?: string; + operationId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersReturnLineItemResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersReturnRefundLineItemRequest { + amountPretax?: Content_v2.Schema.Price; + amountTax?: Content_v2.Schema.Price; + lineItemId?: string; + operationId?: string; + productId?: string; + quantity?: number; + reason?: string; + reasonText?: string; + } + export interface OrdersReturnRefundLineItemResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersSetLineItemMetadataRequest { + annotations?: Content_v2.Schema.OrderMerchantProvidedAnnotation[]; + lineItemId?: string; + operationId?: string; + productId?: string; + } + export interface OrdersSetLineItemMetadataResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersShipLineItemsRequest { + carrier?: string; + lineItems?: Content_v2.Schema.OrderShipmentLineItemShipment[]; + operationId?: string; + shipmentGroupId?: string; + shipmentId?: string; + shipmentInfos?: Content_v2.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo[]; + trackingId?: string; + } + export interface OrdersShipLineItemsResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersUpdateLineItemShippingDetailsRequest { + deliverByDate?: string; + lineItemId?: string; + operationId?: string; + productId?: string; + shipByDate?: string; + } + export interface OrdersUpdateLineItemShippingDetailsResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersUpdateMerchantOrderIdRequest { + merchantOrderId?: string; + operationId?: string; + } + export interface OrdersUpdateMerchantOrderIdResponse { + executionStatus?: string; + kind?: string; + } + export interface OrdersUpdateShipmentRequest { + carrier?: string; + deliveryDate?: string; + operationId?: string; + shipmentId?: string; + status?: string; + trackingId?: string; + } + export interface OrdersUpdateShipmentResponse { + executionStatus?: string; + kind?: string; + } + export interface PosCustomBatchRequest { + entries?: Content_v2.Schema.PosCustomBatchRequestEntry[]; + } + export interface PosCustomBatchRequestEntry { + batchId?: number; + inventory?: Content_v2.Schema.PosInventory; + merchantId?: string; + method?: string; + sale?: Content_v2.Schema.PosSale; + store?: Content_v2.Schema.PosStore; + storeCode?: string; + targetMerchantId?: string; + } + export interface PosCustomBatchResponse { + entries?: Content_v2.Schema.PosCustomBatchResponseEntry[]; + kind?: string; + } + export interface PosCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + inventory?: Content_v2.Schema.PosInventory; + kind?: string; + sale?: Content_v2.Schema.PosSale; + store?: Content_v2.Schema.PosStore; + } + export interface PosDataProviders { + country?: string; + posDataProviders?: Content_v2.Schema.PosDataProvidersPosDataProvider[]; + } + export interface PosDataProvidersPosDataProvider { + displayName?: string; + fullName?: string; + providerId?: string; + } + export interface PosInventory { + contentLanguage?: string; + gtin?: string; + itemId?: string; + kind?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosInventoryRequest { + contentLanguage?: string; + gtin?: string; + itemId?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosInventoryResponse { + contentLanguage?: string; + gtin?: string; + itemId?: string; + kind?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosListResponse { + kind?: string; + resources?: Content_v2.Schema.PosStore[]; + } + export interface PosSale { + contentLanguage?: string; + gtin?: string; + itemId?: string; + kind?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + saleId?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosSaleRequest { + contentLanguage?: string; + gtin?: string; + itemId?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + saleId?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosSaleResponse { + contentLanguage?: string; + gtin?: string; + itemId?: string; + kind?: string; + price?: Content_v2.Schema.Price; + quantity?: string; + saleId?: string; + storeCode?: string; + targetCountry?: string; + timestamp?: string; + } + export interface PosStore { + kind?: string; + storeAddress?: string; + storeCode?: string; + } + export interface PostalCodeGroup { + country?: string; + name?: string; + postalCodeRanges?: Content_v2.Schema.PostalCodeRange[]; + } + export interface PostalCodeRange { + postalCodeRangeBegin?: string; + postalCodeRangeEnd?: string; + } + export interface Price { + currency?: string; + value?: string; + } + export interface Product { + additionalImageLinks?: string[]; + additionalProductTypes?: string[]; + adult?: boolean; + adwordsGrouping?: string; + adwordsLabels?: string[]; + adwordsRedirect?: string; + ageGroup?: string; + aspects?: Content_v2.Schema.ProductAspect[]; + availability?: string; + availabilityDate?: string; + brand?: string; + channel?: string; + color?: string; + condition?: string; + contentLanguage?: string; + costOfGoodsSold?: Content_v2.Schema.Price; + customAttributes?: Content_v2.Schema.CustomAttribute[]; + customGroups?: Content_v2.Schema.CustomGroup[]; + customLabel0?: string; + customLabel1?: string; + customLabel2?: string; + customLabel3?: string; + customLabel4?: string; + description?: string; + destinations?: Content_v2.Schema.ProductDestination[]; + displayAdsId?: string; + displayAdsLink?: string; + displayAdsSimilarIds?: string[]; + displayAdsTitle?: string; + displayAdsValue?: Number; + energyEfficiencyClass?: string; + expirationDate?: string; + gender?: string; + googleProductCategory?: string; + gtin?: string; + id?: string; + identifierExists?: boolean; + imageLink?: string; + installment?: Content_v2.Schema.Installment; + isBundle?: boolean; + itemGroupId?: string; + kind?: string; + link?: string; + loyaltyPoints?: Content_v2.Schema.LoyaltyPoints; + material?: string; + maxEnergyEfficiencyClass?: string; + maxHandlingTime?: string; + minEnergyEfficiencyClass?: string; + minHandlingTime?: string; + mobileLink?: string; + mpn?: string; + multipack?: string; + offerId?: string; + onlineOnly?: boolean; + pattern?: string; + price?: Content_v2.Schema.Price; + productType?: string; + promotionIds?: string[]; + salePrice?: Content_v2.Schema.Price; + salePriceEffectiveDate?: string; + sellOnGoogleQuantity?: string; + shipping?: Content_v2.Schema.ProductShipping[]; + shippingHeight?: Content_v2.Schema.ProductShippingDimension; + shippingLabel?: string; + shippingLength?: Content_v2.Schema.ProductShippingDimension; + shippingWeight?: Content_v2.Schema.ProductShippingWeight; + shippingWidth?: Content_v2.Schema.ProductShippingDimension; + sizeSystem?: string; + sizeType?: string; + sizes?: string[]; + source?: string; + targetCountry?: string; + taxes?: Content_v2.Schema.ProductTax[]; + title?: string; + unitPricingBaseMeasure?: Content_v2.Schema.ProductUnitPricingBaseMeasure; + unitPricingMeasure?: Content_v2.Schema.ProductUnitPricingMeasure; + validatedDestinations?: string[]; + warnings?: Content_v2.Schema.Error[]; + } + export interface ProductAmount { + priceAmount?: Content_v2.Schema.Price; + remittedTaxAmount?: Content_v2.Schema.Price; + taxAmount?: Content_v2.Schema.Price; + } + export interface ProductAspect { + aspectName?: string; + destinationName?: string; + intention?: string; + } + export interface ProductDestination { + destinationName?: string; + intention?: string; + } + export interface ProductShipping { + country?: string; + locationGroupName?: string; + locationId?: string; + postalCode?: string; + price?: Content_v2.Schema.Price; + region?: string; + service?: string; + } + export interface ProductShippingDimension { + unit?: string; + value?: Number; + } + export interface ProductShippingWeight { + unit?: string; + value?: Number; + } + export interface ProductStatus { + creationDate?: string; + dataQualityIssues?: Content_v2.Schema.ProductStatusDataQualityIssue[]; + destinationStatuses?: Content_v2.Schema.ProductStatusDestinationStatus[]; + googleExpirationDate?: string; + itemLevelIssues?: Content_v2.Schema.ProductStatusItemLevelIssue[]; + kind?: string; + lastUpdateDate?: string; + link?: string; + product?: Content_v2.Schema.Product; + productId?: string; + title?: string; + } + export interface ProductStatusDataQualityIssue { + destination?: string; + detail?: string; + fetchStatus?: string; + id?: string; + location?: string; + severity?: string; + timestamp?: string; + valueOnLandingPage?: string; + valueProvided?: string; + } + export interface ProductStatusDestinationStatus { + approvalPending?: boolean; + approvalStatus?: string; + destination?: string; + intention?: string; + } + export interface ProductStatusItemLevelIssue { + attributeName?: string; + code?: string; + description?: string; + destination?: string; + detail?: string; + documentation?: string; + resolution?: string; + servability?: string; + } + export interface ProductTax { + country?: string; + locationId?: string; + postalCode?: string; + rate?: Number; + region?: string; + taxShip?: boolean; + } + export interface ProductUnitPricingBaseMeasure { + unit?: string; + value?: string; + } + export interface ProductUnitPricingMeasure { + unit?: string; + value?: Number; + } + export interface ProductsCustomBatchRequest { + entries?: Content_v2.Schema.ProductsCustomBatchRequestEntry[]; + } + export interface ProductsCustomBatchRequestEntry { + batchId?: number; + merchantId?: string; + method?: string; + product?: Content_v2.Schema.Product; + productId?: string; + } + export interface ProductsCustomBatchResponse { + entries?: Content_v2.Schema.ProductsCustomBatchResponseEntry[]; + kind?: string; + } + export interface ProductsCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + product?: Content_v2.Schema.Product; + } + export interface ProductsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.Product[]; + } + export interface ProductstatusesCustomBatchRequest { + entries?: Content_v2.Schema.ProductstatusesCustomBatchRequestEntry[]; + } + export interface ProductstatusesCustomBatchRequestEntry { + batchId?: number; + destinations?: string[]; + includeAttributes?: boolean; + merchantId?: string; + method?: string; + productId?: string; + } + export interface ProductstatusesCustomBatchResponse { + entries?: Content_v2.Schema.ProductstatusesCustomBatchResponseEntry[]; + kind?: string; + } + export interface ProductstatusesCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + productStatus?: Content_v2.Schema.ProductStatus; + } + export interface ProductstatusesListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.ProductStatus[]; + } + export interface Promotion { + promotionAmount?: Content_v2.Schema.Amount; + promotionId?: string; + } + export interface RateGroup { + applicableShippingLabels?: string[]; + carrierRates?: Content_v2.Schema.CarrierRate[]; + mainTable?: Content_v2.Schema.Table; + name?: string; + singleValue?: Content_v2.Schema.Value; + subtables?: Content_v2.Schema.Table[]; + } + export interface RefundReason { + description?: string; + reasonCode?: string; + } + export interface ReturnShipment { + creationDate?: string; + deliveryDate?: string; + returnMethodType?: string; + shipmentId?: string; + shipmentTrackingInfos?: Content_v2.Schema.ShipmentTrackingInfo[]; + shippingDate?: string; + state?: string; + } + export interface Row { + cells?: Content_v2.Schema.Value[]; + } + export interface Service { + active?: boolean; + currency?: string; + deliveryCountry?: string; + deliveryTime?: Content_v2.Schema.DeliveryTime; + eligibility?: string; + minimumOrderValue?: Content_v2.Schema.Price; + name?: string; + rateGroups?: Content_v2.Schema.RateGroup[]; + } + export interface ShipmentInvoice { + invoiceSummary?: Content_v2.Schema.InvoiceSummary; + lineItemInvoices?: Content_v2.Schema.ShipmentInvoiceLineItemInvoice[]; + shipmentGroupId?: string; + } + export interface ShipmentInvoiceLineItemInvoice { + lineItemId?: string; + productId?: string; + shipmentUnitIds?: string[]; + unitInvoice?: Content_v2.Schema.UnitInvoice; + } + export interface ShipmentTrackingInfo { + carrier?: string; + trackingNumber?: string; + } + export interface ShippingSettings { + accountId?: string; + postalCodeGroups?: Content_v2.Schema.PostalCodeGroup[]; + services?: Content_v2.Schema.Service[]; + } + export interface ShippingsettingsCustomBatchRequest { + entries?: Content_v2.Schema.ShippingsettingsCustomBatchRequestEntry[]; + } + export interface ShippingsettingsCustomBatchRequestEntry { + accountId?: string; + batchId?: number; + merchantId?: string; + method?: string; + shippingSettings?: Content_v2.Schema.ShippingSettings; + } + export interface ShippingsettingsCustomBatchResponse { + entries?: Content_v2.Schema.ShippingsettingsCustomBatchResponseEntry[]; + kind?: string; + } + export interface ShippingsettingsCustomBatchResponseEntry { + batchId?: number; + errors?: Content_v2.Schema.Errors; + kind?: string; + shippingSettings?: Content_v2.Schema.ShippingSettings; + } + export interface ShippingsettingsGetSupportedCarriersResponse { + carriers?: Content_v2.Schema.CarriersCarrier[]; + kind?: string; + } + export interface ShippingsettingsGetSupportedHolidaysResponse { + holidays?: Content_v2.Schema.HolidaysHoliday[]; + kind?: string; + } + export interface ShippingsettingsListResponse { + kind?: string; + nextPageToken?: string; + resources?: Content_v2.Schema.ShippingSettings[]; + } + export interface Table { + columnHeaders?: Content_v2.Schema.Headers; + name?: string; + rowHeaders?: Content_v2.Schema.Headers; + rows?: Content_v2.Schema.Row[]; + } + export interface TestOrder { + customer?: Content_v2.Schema.TestOrderCustomer; + enableOrderinvoices?: boolean; + kind?: string; + lineItems?: Content_v2.Schema.TestOrderLineItem[]; + notificationMode?: string; + paymentMethod?: Content_v2.Schema.TestOrderPaymentMethod; + predefinedDeliveryAddress?: string; + promotions?: Content_v2.Schema.OrderLegacyPromotion[]; + shippingCost?: Content_v2.Schema.Price; + shippingCostTax?: Content_v2.Schema.Price; + shippingOption?: string; + } + export interface TestOrderCustomer { + email?: string; + explicitMarketingPreference?: boolean; + fullName?: string; + marketingRightsInfo?: Content_v2.Schema.TestOrderCustomerMarketingRightsInfo; + } + export interface TestOrderCustomerMarketingRightsInfo { + explicitMarketingPreference?: string; + lastUpdatedTimestamp?: string; + } + export interface TestOrderLineItem { + product?: Content_v2.Schema.TestOrderLineItemProduct; + quantityOrdered?: number; + returnInfo?: Content_v2.Schema.OrderLineItemReturnInfo; + shippingDetails?: Content_v2.Schema.OrderLineItemShippingDetails; + unitTax?: Content_v2.Schema.Price; + } + export interface TestOrderLineItemProduct { + brand?: string; + channel?: string; + condition?: string; + contentLanguage?: string; + gtin?: string; + imageLink?: string; + itemGroupId?: string; + mpn?: string; + offerId?: string; + price?: Content_v2.Schema.Price; + targetCountry?: string; + title?: string; + variantAttributes?: Content_v2.Schema.OrderLineItemProductVariantAttribute[]; + } + export interface TestOrderPaymentMethod { + expirationMonth?: number; + expirationYear?: number; + lastFourDigits?: string; + predefinedBillingAddress?: string; + type?: string; + } + export interface TransitTable { + postalCodeGroupNames?: string[]; + rows?: Content_v2.Schema.TransitTableTransitTimeRow[]; + transitTimeLabels?: string[]; + } + export interface TransitTableTransitTimeRow { + values?: Content_v2.Schema.TransitTableTransitTimeRowTransitTimeValue[]; + } + export interface TransitTableTransitTimeRowTransitTimeValue { + maxTransitTimeInDays?: number; + minTransitTimeInDays?: number; + } + export interface UnitInvoice { + additionalCharges?: Content_v2.Schema.UnitInvoiceAdditionalCharge[]; + promotions?: Content_v2.Schema.Promotion[]; + unitPricePretax?: Content_v2.Schema.Price; + unitPriceTaxes?: Content_v2.Schema.UnitInvoiceTaxLine[]; + } + export interface UnitInvoiceAdditionalCharge { + additionalChargeAmount?: Content_v2.Schema.Amount; + additionalChargePromotions?: Content_v2.Schema.Promotion[]; + type?: string; + } + export interface UnitInvoiceTaxLine { + taxAmount?: Content_v2.Schema.Price; + taxName?: string; + taxType?: string; + } + export interface Value { + carrierRateName?: string; + flatRate?: Content_v2.Schema.Price; + noShipping?: boolean; + pricePercentage?: string; + subtableName?: string; + } + export interface Weight { + unit?: string; + value?: string; + } + } + } + export interface Content_v2 { + Accounts?: Content_v2.Collection.AccountsCollection; + Accountstatuses?: Content_v2.Collection.AccountstatusesCollection; + Accounttax?: Content_v2.Collection.AccounttaxCollection; + Datafeeds?: Content_v2.Collection.DatafeedsCollection; + Datafeedstatuses?: Content_v2.Collection.DatafeedstatusesCollection; + Inventory?: Content_v2.Collection.InventoryCollection; + Liasettings?: Content_v2.Collection.LiasettingsCollection; + Orderinvoices?: Content_v2.Collection.OrderinvoicesCollection; + Orderpayments?: Content_v2.Collection.OrderpaymentsCollection; + Orderreports?: Content_v2.Collection.OrderreportsCollection; + Orderreturns?: Content_v2.Collection.OrderreturnsCollection; + Orders?: Content_v2.Collection.OrdersCollection; + Pos?: Content_v2.Collection.PosCollection; + Products?: Content_v2.Collection.ProductsCollection; + Productstatuses?: Content_v2.Collection.ProductstatusesCollection; + Shippingsettings?: Content_v2.Collection.ShippingsettingsCollection; + // Create a new instance of Account + newAccount(): Content_v2.Schema.Account; + // Create a new instance of AccountAddress + newAccountAddress(): Content_v2.Schema.AccountAddress; + // Create a new instance of AccountAdwordsLink + newAccountAdwordsLink(): Content_v2.Schema.AccountAdwordsLink; + // Create a new instance of AccountBusinessInformation + newAccountBusinessInformation(): Content_v2.Schema.AccountBusinessInformation; + // Create a new instance of AccountCustomerService + newAccountCustomerService(): Content_v2.Schema.AccountCustomerService; + // Create a new instance of AccountGoogleMyBusinessLink + newAccountGoogleMyBusinessLink(): Content_v2.Schema.AccountGoogleMyBusinessLink; + // Create a new instance of AccountTax + newAccountTax(): Content_v2.Schema.AccountTax; + // Create a new instance of AccountTaxTaxRule + newAccountTaxTaxRule(): Content_v2.Schema.AccountTaxTaxRule; + // Create a new instance of AccountUser + newAccountUser(): Content_v2.Schema.AccountUser; + // Create a new instance of AccountYouTubeChannelLink + newAccountYouTubeChannelLink(): Content_v2.Schema.AccountYouTubeChannelLink; + // Create a new instance of AccountsCustomBatchRequest + newAccountsCustomBatchRequest(): Content_v2.Schema.AccountsCustomBatchRequest; + // Create a new instance of AccountsCustomBatchRequestEntry + newAccountsCustomBatchRequestEntry(): Content_v2.Schema.AccountsCustomBatchRequestEntry; + // Create a new instance of AccountsCustomBatchRequestEntryLinkRequest + newAccountsCustomBatchRequestEntryLinkRequest(): Content_v2.Schema.AccountsCustomBatchRequestEntryLinkRequest; + // Create a new instance of AccountsLinkRequest + newAccountsLinkRequest(): Content_v2.Schema.AccountsLinkRequest; + // Create a new instance of AccountstatusesCustomBatchRequest + newAccountstatusesCustomBatchRequest(): Content_v2.Schema.AccountstatusesCustomBatchRequest; + // Create a new instance of AccountstatusesCustomBatchRequestEntry + newAccountstatusesCustomBatchRequestEntry(): Content_v2.Schema.AccountstatusesCustomBatchRequestEntry; + // Create a new instance of AccounttaxCustomBatchRequest + newAccounttaxCustomBatchRequest(): Content_v2.Schema.AccounttaxCustomBatchRequest; + // Create a new instance of AccounttaxCustomBatchRequestEntry + newAccounttaxCustomBatchRequestEntry(): Content_v2.Schema.AccounttaxCustomBatchRequestEntry; + // Create a new instance of Amount + newAmount(): Content_v2.Schema.Amount; + // Create a new instance of CarrierRate + newCarrierRate(): Content_v2.Schema.CarrierRate; + // Create a new instance of CustomAttribute + newCustomAttribute(): Content_v2.Schema.CustomAttribute; + // Create a new instance of CustomGroup + newCustomGroup(): Content_v2.Schema.CustomGroup; + // Create a new instance of CutoffTime + newCutoffTime(): Content_v2.Schema.CutoffTime; + // Create a new instance of Datafeed + newDatafeed(): Content_v2.Schema.Datafeed; + // Create a new instance of DatafeedFetchSchedule + newDatafeedFetchSchedule(): Content_v2.Schema.DatafeedFetchSchedule; + // Create a new instance of DatafeedFormat + newDatafeedFormat(): Content_v2.Schema.DatafeedFormat; + // Create a new instance of DatafeedTarget + newDatafeedTarget(): Content_v2.Schema.DatafeedTarget; + // Create a new instance of DatafeedsCustomBatchRequest + newDatafeedsCustomBatchRequest(): Content_v2.Schema.DatafeedsCustomBatchRequest; + // Create a new instance of DatafeedsCustomBatchRequestEntry + newDatafeedsCustomBatchRequestEntry(): Content_v2.Schema.DatafeedsCustomBatchRequestEntry; + // Create a new instance of DatafeedstatusesCustomBatchRequest + newDatafeedstatusesCustomBatchRequest(): Content_v2.Schema.DatafeedstatusesCustomBatchRequest; + // Create a new instance of DatafeedstatusesCustomBatchRequestEntry + newDatafeedstatusesCustomBatchRequestEntry(): Content_v2.Schema.DatafeedstatusesCustomBatchRequestEntry; + // Create a new instance of DeliveryTime + newDeliveryTime(): Content_v2.Schema.DeliveryTime; + // Create a new instance of Error + newError(): Content_v2.Schema.Error; + // Create a new instance of Headers + newHeaders(): Content_v2.Schema.Headers; + // Create a new instance of HolidayCutoff + newHolidayCutoff(): Content_v2.Schema.HolidayCutoff; + // Create a new instance of Installment + newInstallment(): Content_v2.Schema.Installment; + // Create a new instance of Inventory + newInventory(): Content_v2.Schema.Inventory; + // Create a new instance of InventoryCustomBatchRequest + newInventoryCustomBatchRequest(): Content_v2.Schema.InventoryCustomBatchRequest; + // Create a new instance of InventoryCustomBatchRequestEntry + newInventoryCustomBatchRequestEntry(): Content_v2.Schema.InventoryCustomBatchRequestEntry; + // Create a new instance of InventoryPickup + newInventoryPickup(): Content_v2.Schema.InventoryPickup; + // Create a new instance of InventorySetRequest + newInventorySetRequest(): Content_v2.Schema.InventorySetRequest; + // Create a new instance of InvoiceSummary + newInvoiceSummary(): Content_v2.Schema.InvoiceSummary; + // Create a new instance of InvoiceSummaryAdditionalChargeSummary + newInvoiceSummaryAdditionalChargeSummary(): Content_v2.Schema.InvoiceSummaryAdditionalChargeSummary; + // Create a new instance of LiaAboutPageSettings + newLiaAboutPageSettings(): Content_v2.Schema.LiaAboutPageSettings; + // Create a new instance of LiaCountrySettings + newLiaCountrySettings(): Content_v2.Schema.LiaCountrySettings; + // Create a new instance of LiaInventorySettings + newLiaInventorySettings(): Content_v2.Schema.LiaInventorySettings; + // Create a new instance of LiaOnDisplayToOrderSettings + newLiaOnDisplayToOrderSettings(): Content_v2.Schema.LiaOnDisplayToOrderSettings; + // Create a new instance of LiaPosDataProvider + newLiaPosDataProvider(): Content_v2.Schema.LiaPosDataProvider; + // Create a new instance of LiaSettings + newLiaSettings(): Content_v2.Schema.LiaSettings; + // Create a new instance of LiasettingsCustomBatchRequest + newLiasettingsCustomBatchRequest(): Content_v2.Schema.LiasettingsCustomBatchRequest; + // Create a new instance of LiasettingsCustomBatchRequestEntry + newLiasettingsCustomBatchRequestEntry(): Content_v2.Schema.LiasettingsCustomBatchRequestEntry; + // Create a new instance of LocationIdSet + newLocationIdSet(): Content_v2.Schema.LocationIdSet; + // Create a new instance of LoyaltyPoints + newLoyaltyPoints(): Content_v2.Schema.LoyaltyPoints; + // Create a new instance of OrderLegacyPromotion + newOrderLegacyPromotion(): Content_v2.Schema.OrderLegacyPromotion; + // Create a new instance of OrderLegacyPromotionBenefit + newOrderLegacyPromotionBenefit(): Content_v2.Schema.OrderLegacyPromotionBenefit; + // Create a new instance of OrderLineItemProductVariantAttribute + newOrderLineItemProductVariantAttribute(): Content_v2.Schema.OrderLineItemProductVariantAttribute; + // Create a new instance of OrderLineItemReturnInfo + newOrderLineItemReturnInfo(): Content_v2.Schema.OrderLineItemReturnInfo; + // Create a new instance of OrderLineItemShippingDetails + newOrderLineItemShippingDetails(): Content_v2.Schema.OrderLineItemShippingDetails; + // Create a new instance of OrderLineItemShippingDetailsMethod + newOrderLineItemShippingDetailsMethod(): Content_v2.Schema.OrderLineItemShippingDetailsMethod; + // Create a new instance of OrderMerchantProvidedAnnotation + newOrderMerchantProvidedAnnotation(): Content_v2.Schema.OrderMerchantProvidedAnnotation; + // Create a new instance of OrderShipmentLineItemShipment + newOrderShipmentLineItemShipment(): Content_v2.Schema.OrderShipmentLineItemShipment; + // Create a new instance of OrderinvoicesCreateChargeInvoiceRequest + newOrderinvoicesCreateChargeInvoiceRequest(): Content_v2.Schema.OrderinvoicesCreateChargeInvoiceRequest; + // Create a new instance of OrderinvoicesCreateRefundInvoiceRequest + newOrderinvoicesCreateRefundInvoiceRequest(): Content_v2.Schema.OrderinvoicesCreateRefundInvoiceRequest; + // Create a new instance of OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption + newOrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption(): Content_v2.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceRefundOption; + // Create a new instance of OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption + newOrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption(): Content_v2.Schema.OrderinvoicesCustomBatchRequestEntryCreateRefundInvoiceReturnOption; + // Create a new instance of OrderpaymentsNotifyAuthApprovedRequest + newOrderpaymentsNotifyAuthApprovedRequest(): Content_v2.Schema.OrderpaymentsNotifyAuthApprovedRequest; + // Create a new instance of OrderpaymentsNotifyAuthDeclinedRequest + newOrderpaymentsNotifyAuthDeclinedRequest(): Content_v2.Schema.OrderpaymentsNotifyAuthDeclinedRequest; + // Create a new instance of OrderpaymentsNotifyChargeRequest + newOrderpaymentsNotifyChargeRequest(): Content_v2.Schema.OrderpaymentsNotifyChargeRequest; + // Create a new instance of OrderpaymentsNotifyRefundRequest + newOrderpaymentsNotifyRefundRequest(): Content_v2.Schema.OrderpaymentsNotifyRefundRequest; + // Create a new instance of OrdersAcknowledgeRequest + newOrdersAcknowledgeRequest(): Content_v2.Schema.OrdersAcknowledgeRequest; + // Create a new instance of OrdersCancelLineItemRequest + newOrdersCancelLineItemRequest(): Content_v2.Schema.OrdersCancelLineItemRequest; + // Create a new instance of OrdersCancelRequest + newOrdersCancelRequest(): Content_v2.Schema.OrdersCancelRequest; + // Create a new instance of OrdersCancelTestOrderByCustomerRequest + newOrdersCancelTestOrderByCustomerRequest(): Content_v2.Schema.OrdersCancelTestOrderByCustomerRequest; + // Create a new instance of OrdersCreateTestOrderRequest + newOrdersCreateTestOrderRequest(): Content_v2.Schema.OrdersCreateTestOrderRequest; + // Create a new instance of OrdersCreateTestReturnRequest + newOrdersCreateTestReturnRequest(): Content_v2.Schema.OrdersCreateTestReturnRequest; + // Create a new instance of OrdersCustomBatchRequest + newOrdersCustomBatchRequest(): Content_v2.Schema.OrdersCustomBatchRequest; + // Create a new instance of OrdersCustomBatchRequestEntry + newOrdersCustomBatchRequestEntry(): Content_v2.Schema.OrdersCustomBatchRequestEntry; + // Create a new instance of OrdersCustomBatchRequestEntryCancel + newOrdersCustomBatchRequestEntryCancel(): Content_v2.Schema.OrdersCustomBatchRequestEntryCancel; + // Create a new instance of OrdersCustomBatchRequestEntryCancelLineItem + newOrdersCustomBatchRequestEntryCancelLineItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryCancelLineItem; + // Create a new instance of OrdersCustomBatchRequestEntryCreateTestReturnReturnItem + newOrdersCustomBatchRequestEntryCreateTestReturnReturnItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryCreateTestReturnReturnItem; + // Create a new instance of OrdersCustomBatchRequestEntryInStoreRefundLineItem + newOrdersCustomBatchRequestEntryInStoreRefundLineItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryInStoreRefundLineItem; + // Create a new instance of OrdersCustomBatchRequestEntryRefund + newOrdersCustomBatchRequestEntryRefund(): Content_v2.Schema.OrdersCustomBatchRequestEntryRefund; + // Create a new instance of OrdersCustomBatchRequestEntryRejectReturnLineItem + newOrdersCustomBatchRequestEntryRejectReturnLineItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryRejectReturnLineItem; + // Create a new instance of OrdersCustomBatchRequestEntryReturnLineItem + newOrdersCustomBatchRequestEntryReturnLineItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryReturnLineItem; + // Create a new instance of OrdersCustomBatchRequestEntryReturnRefundLineItem + newOrdersCustomBatchRequestEntryReturnRefundLineItem(): Content_v2.Schema.OrdersCustomBatchRequestEntryReturnRefundLineItem; + // Create a new instance of OrdersCustomBatchRequestEntrySetLineItemMetadata + newOrdersCustomBatchRequestEntrySetLineItemMetadata(): Content_v2.Schema.OrdersCustomBatchRequestEntrySetLineItemMetadata; + // Create a new instance of OrdersCustomBatchRequestEntryShipLineItems + newOrdersCustomBatchRequestEntryShipLineItems(): Content_v2.Schema.OrdersCustomBatchRequestEntryShipLineItems; + // Create a new instance of OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo + newOrdersCustomBatchRequestEntryShipLineItemsShipmentInfo(): Content_v2.Schema.OrdersCustomBatchRequestEntryShipLineItemsShipmentInfo; + // Create a new instance of OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails + newOrdersCustomBatchRequestEntryUpdateLineItemShippingDetails(): Content_v2.Schema.OrdersCustomBatchRequestEntryUpdateLineItemShippingDetails; + // Create a new instance of OrdersCustomBatchRequestEntryUpdateShipment + newOrdersCustomBatchRequestEntryUpdateShipment(): Content_v2.Schema.OrdersCustomBatchRequestEntryUpdateShipment; + // Create a new instance of OrdersInStoreRefundLineItemRequest + newOrdersInStoreRefundLineItemRequest(): Content_v2.Schema.OrdersInStoreRefundLineItemRequest; + // Create a new instance of OrdersRefundRequest + newOrdersRefundRequest(): Content_v2.Schema.OrdersRefundRequest; + // Create a new instance of OrdersRejectReturnLineItemRequest + newOrdersRejectReturnLineItemRequest(): Content_v2.Schema.OrdersRejectReturnLineItemRequest; + // Create a new instance of OrdersReturnLineItemRequest + newOrdersReturnLineItemRequest(): Content_v2.Schema.OrdersReturnLineItemRequest; + // Create a new instance of OrdersReturnRefundLineItemRequest + newOrdersReturnRefundLineItemRequest(): Content_v2.Schema.OrdersReturnRefundLineItemRequest; + // Create a new instance of OrdersSetLineItemMetadataRequest + newOrdersSetLineItemMetadataRequest(): Content_v2.Schema.OrdersSetLineItemMetadataRequest; + // Create a new instance of OrdersShipLineItemsRequest + newOrdersShipLineItemsRequest(): Content_v2.Schema.OrdersShipLineItemsRequest; + // Create a new instance of OrdersUpdateLineItemShippingDetailsRequest + newOrdersUpdateLineItemShippingDetailsRequest(): Content_v2.Schema.OrdersUpdateLineItemShippingDetailsRequest; + // Create a new instance of OrdersUpdateMerchantOrderIdRequest + newOrdersUpdateMerchantOrderIdRequest(): Content_v2.Schema.OrdersUpdateMerchantOrderIdRequest; + // Create a new instance of OrdersUpdateShipmentRequest + newOrdersUpdateShipmentRequest(): Content_v2.Schema.OrdersUpdateShipmentRequest; + // Create a new instance of PosCustomBatchRequest + newPosCustomBatchRequest(): Content_v2.Schema.PosCustomBatchRequest; + // Create a new instance of PosCustomBatchRequestEntry + newPosCustomBatchRequestEntry(): Content_v2.Schema.PosCustomBatchRequestEntry; + // Create a new instance of PosInventory + newPosInventory(): Content_v2.Schema.PosInventory; + // Create a new instance of PosInventoryRequest + newPosInventoryRequest(): Content_v2.Schema.PosInventoryRequest; + // Create a new instance of PosSale + newPosSale(): Content_v2.Schema.PosSale; + // Create a new instance of PosSaleRequest + newPosSaleRequest(): Content_v2.Schema.PosSaleRequest; + // Create a new instance of PosStore + newPosStore(): Content_v2.Schema.PosStore; + // Create a new instance of PostalCodeGroup + newPostalCodeGroup(): Content_v2.Schema.PostalCodeGroup; + // Create a new instance of PostalCodeRange + newPostalCodeRange(): Content_v2.Schema.PostalCodeRange; + // Create a new instance of Price + newPrice(): Content_v2.Schema.Price; + // Create a new instance of Product + newProduct(): Content_v2.Schema.Product; + // Create a new instance of ProductAspect + newProductAspect(): Content_v2.Schema.ProductAspect; + // Create a new instance of ProductDestination + newProductDestination(): Content_v2.Schema.ProductDestination; + // Create a new instance of ProductShipping + newProductShipping(): Content_v2.Schema.ProductShipping; + // Create a new instance of ProductShippingDimension + newProductShippingDimension(): Content_v2.Schema.ProductShippingDimension; + // Create a new instance of ProductShippingWeight + newProductShippingWeight(): Content_v2.Schema.ProductShippingWeight; + // Create a new instance of ProductTax + newProductTax(): Content_v2.Schema.ProductTax; + // Create a new instance of ProductUnitPricingBaseMeasure + newProductUnitPricingBaseMeasure(): Content_v2.Schema.ProductUnitPricingBaseMeasure; + // Create a new instance of ProductUnitPricingMeasure + newProductUnitPricingMeasure(): Content_v2.Schema.ProductUnitPricingMeasure; + // Create a new instance of ProductsCustomBatchRequest + newProductsCustomBatchRequest(): Content_v2.Schema.ProductsCustomBatchRequest; + // Create a new instance of ProductsCustomBatchRequestEntry + newProductsCustomBatchRequestEntry(): Content_v2.Schema.ProductsCustomBatchRequestEntry; + // Create a new instance of ProductstatusesCustomBatchRequest + newProductstatusesCustomBatchRequest(): Content_v2.Schema.ProductstatusesCustomBatchRequest; + // Create a new instance of ProductstatusesCustomBatchRequestEntry + newProductstatusesCustomBatchRequestEntry(): Content_v2.Schema.ProductstatusesCustomBatchRequestEntry; + // Create a new instance of Promotion + newPromotion(): Content_v2.Schema.Promotion; + // Create a new instance of RateGroup + newRateGroup(): Content_v2.Schema.RateGroup; + // Create a new instance of Row + newRow(): Content_v2.Schema.Row; + // Create a new instance of Service + newService(): Content_v2.Schema.Service; + // Create a new instance of ShipmentInvoice + newShipmentInvoice(): Content_v2.Schema.ShipmentInvoice; + // Create a new instance of ShipmentInvoiceLineItemInvoice + newShipmentInvoiceLineItemInvoice(): Content_v2.Schema.ShipmentInvoiceLineItemInvoice; + // Create a new instance of ShippingSettings + newShippingSettings(): Content_v2.Schema.ShippingSettings; + // Create a new instance of ShippingsettingsCustomBatchRequest + newShippingsettingsCustomBatchRequest(): Content_v2.Schema.ShippingsettingsCustomBatchRequest; + // Create a new instance of ShippingsettingsCustomBatchRequestEntry + newShippingsettingsCustomBatchRequestEntry(): Content_v2.Schema.ShippingsettingsCustomBatchRequestEntry; + // Create a new instance of Table + newTable(): Content_v2.Schema.Table; + // Create a new instance of TestOrder + newTestOrder(): Content_v2.Schema.TestOrder; + // Create a new instance of TestOrderCustomer + newTestOrderCustomer(): Content_v2.Schema.TestOrderCustomer; + // Create a new instance of TestOrderCustomerMarketingRightsInfo + newTestOrderCustomerMarketingRightsInfo(): Content_v2.Schema.TestOrderCustomerMarketingRightsInfo; + // Create a new instance of TestOrderLineItem + newTestOrderLineItem(): Content_v2.Schema.TestOrderLineItem; + // Create a new instance of TestOrderLineItemProduct + newTestOrderLineItemProduct(): Content_v2.Schema.TestOrderLineItemProduct; + // Create a new instance of TestOrderPaymentMethod + newTestOrderPaymentMethod(): Content_v2.Schema.TestOrderPaymentMethod; + // Create a new instance of TransitTable + newTransitTable(): Content_v2.Schema.TransitTable; + // Create a new instance of TransitTableTransitTimeRow + newTransitTableTransitTimeRow(): Content_v2.Schema.TransitTableTransitTimeRow; + // Create a new instance of TransitTableTransitTimeRowTransitTimeValue + newTransitTableTransitTimeRowTransitTimeValue(): Content_v2.Schema.TransitTableTransitTimeRowTransitTimeValue; + // Create a new instance of UnitInvoice + newUnitInvoice(): Content_v2.Schema.UnitInvoice; + // Create a new instance of UnitInvoiceAdditionalCharge + newUnitInvoiceAdditionalCharge(): Content_v2.Schema.UnitInvoiceAdditionalCharge; + // Create a new instance of UnitInvoiceTaxLine + newUnitInvoiceTaxLine(): Content_v2.Schema.UnitInvoiceTaxLine; + // Create a new instance of Value + newValue(): Content_v2.Schema.Value; + // Create a new instance of Weight + newWeight(): Content_v2.Schema.Weight; + } +} + +declare var Content_v2: GoogleAppsScript.Content_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/dfareporting/v2.8.d.ts b/types/google-apps-script/apis/dfareporting/v2.8.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/dfareporting/v3.0.d.ts b/types/google-apps-script/apis/dfareporting/v3.0.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/dfareporting/v3.1.d.ts b/types/google-apps-script/apis/dfareporting/v3.1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/dfareporting/v3.2.d.ts b/types/google-apps-script/apis/dfareporting/v3.2.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/dfareporting_v3_3.d.ts b/types/google-apps-script/apis/dfareporting_v3_3.d.ts new file mode 100644 index 0000000000..b1f464973f --- /dev/null +++ b/types/google-apps-script/apis/dfareporting_v3_3.d.ts @@ -0,0 +1,2761 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Dfareporting_v3_3 { + namespace Collection { + namespace Reports { + export interface CompatibleFieldsCollection { + // Returns the fields that are compatible to be selected in the respective sections of a report criteria, given the fields already selected in the input report and user permissions. + query(resource: Schema.Report, profileId: string): Dfareporting_v3_3.Schema.CompatibleFields; + } + export interface FilesCollection { + // Retrieves a report file. This method supports media download. + get(profileId: string, reportId: string, fileId: string): Dfareporting_v3_3.Schema.File; + // Lists files for a report. + list(profileId: string, reportId: string): Dfareporting_v3_3.Schema.FileList; + // Lists files for a report. + list(profileId: string, reportId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FileList; + } + } + export interface AccountActiveAdSummariesCollection { + // Gets the account's active ad summary by account ID. + get(profileId: string, summaryAccountId: string): Dfareporting_v3_3.Schema.AccountActiveAdSummary; + } + export interface AccountPermissionGroupsCollection { + // Gets one account permission group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.AccountPermissionGroup; + // Retrieves the list of account permission groups. + list(profileId: string): Dfareporting_v3_3.Schema.AccountPermissionGroupsListResponse; + } + export interface AccountPermissionsCollection { + // Gets one account permission by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.AccountPermission; + // Retrieves the list of account permissions. + list(profileId: string): Dfareporting_v3_3.Schema.AccountPermissionsListResponse; + } + export interface AccountUserProfilesCollection { + // Gets one account user profile by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.AccountUserProfile; + // Inserts a new account user profile. + insert(resource: Schema.AccountUserProfile, profileId: string): Dfareporting_v3_3.Schema.AccountUserProfile; + // Retrieves a list of account user profiles, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.AccountUserProfilesListResponse; + // Retrieves a list of account user profiles, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AccountUserProfilesListResponse; + // Updates an existing account user profile. This method supports patch semantics. + patch(resource: Schema.AccountUserProfile, profileId: string, id: string): Dfareporting_v3_3.Schema.AccountUserProfile; + // Updates an existing account user profile. + update(resource: Schema.AccountUserProfile, profileId: string): Dfareporting_v3_3.Schema.AccountUserProfile; + } + export interface AccountsCollection { + // Gets one account by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Account; + // Retrieves the list of accounts, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.AccountsListResponse; + // Retrieves the list of accounts, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AccountsListResponse; + // Updates an existing account. This method supports patch semantics. + patch(resource: Schema.Account, profileId: string, id: string): Dfareporting_v3_3.Schema.Account; + // Updates an existing account. + update(resource: Schema.Account, profileId: string): Dfareporting_v3_3.Schema.Account; + } + export interface AdsCollection { + // Gets one ad by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Ad; + // Inserts a new ad. + insert(resource: Schema.Ad, profileId: string): Dfareporting_v3_3.Schema.Ad; + // Retrieves a list of ads, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.AdsListResponse; + // Retrieves a list of ads, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AdsListResponse; + // Updates an existing ad. This method supports patch semantics. + patch(resource: Schema.Ad, profileId: string, id: string): Dfareporting_v3_3.Schema.Ad; + // Updates an existing ad. + update(resource: Schema.Ad, profileId: string): Dfareporting_v3_3.Schema.Ad; + } + export interface AdvertiserGroupsCollection { + // Gets one advertiser group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.AdvertiserGroup; + // Inserts a new advertiser group. + insert(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting_v3_3.Schema.AdvertiserGroup; + // Retrieves a list of advertiser groups, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.AdvertiserGroupsListResponse; + // Retrieves a list of advertiser groups, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AdvertiserGroupsListResponse; + // Updates an existing advertiser group. This method supports patch semantics. + patch(resource: Schema.AdvertiserGroup, profileId: string, id: string): Dfareporting_v3_3.Schema.AdvertiserGroup; + // Deletes an existing advertiser group. + remove(profileId: string, id: string): void; + // Updates an existing advertiser group. + update(resource: Schema.AdvertiserGroup, profileId: string): Dfareporting_v3_3.Schema.AdvertiserGroup; + } + export interface AdvertiserLandingPagesCollection { + // Gets one landing page by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.LandingPage; + // Inserts a new landing page. + insert(resource: Schema.LandingPage, profileId: string): Dfareporting_v3_3.Schema.LandingPage; + // Retrieves a list of landing pages. + list(profileId: string): Dfareporting_v3_3.Schema.AdvertiserLandingPagesListResponse; + // Retrieves a list of landing pages. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AdvertiserLandingPagesListResponse; + // Updates an existing landing page. This method supports patch semantics. + patch(resource: Schema.LandingPage, profileId: string, id: string): Dfareporting_v3_3.Schema.LandingPage; + // Updates an existing landing page. + update(resource: Schema.LandingPage, profileId: string): Dfareporting_v3_3.Schema.LandingPage; + } + export interface AdvertisersCollection { + // Gets one advertiser by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Advertiser; + // Inserts a new advertiser. + insert(resource: Schema.Advertiser, profileId: string): Dfareporting_v3_3.Schema.Advertiser; + // Retrieves a list of advertisers, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.AdvertisersListResponse; + // Retrieves a list of advertisers, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.AdvertisersListResponse; + // Updates an existing advertiser. This method supports patch semantics. + patch(resource: Schema.Advertiser, profileId: string, id: string): Dfareporting_v3_3.Schema.Advertiser; + // Updates an existing advertiser. + update(resource: Schema.Advertiser, profileId: string): Dfareporting_v3_3.Schema.Advertiser; + } + export interface BrowsersCollection { + // Retrieves a list of browsers. + list(profileId: string): Dfareporting_v3_3.Schema.BrowsersListResponse; + } + export interface CampaignCreativeAssociationsCollection { + // Associates a creative with the specified campaign. This method creates a default ad with dimensions matching the creative in the campaign if such a default ad does not exist already. + insert(resource: Schema.CampaignCreativeAssociation, profileId: string, campaignId: string): Dfareporting_v3_3.Schema.CampaignCreativeAssociation; + // Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. + list(profileId: string, campaignId: string): Dfareporting_v3_3.Schema.CampaignCreativeAssociationsListResponse; + // Retrieves the list of creative IDs associated with the specified campaign. This method supports paging. + list(profileId: string, campaignId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CampaignCreativeAssociationsListResponse; + } + export interface CampaignsCollection { + // Gets one campaign by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Campaign; + // Inserts a new campaign. + insert(resource: Schema.Campaign, profileId: string): Dfareporting_v3_3.Schema.Campaign; + // Retrieves a list of campaigns, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.CampaignsListResponse; + // Retrieves a list of campaigns, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CampaignsListResponse; + // Updates an existing campaign. This method supports patch semantics. + patch(resource: Schema.Campaign, profileId: string, id: string): Dfareporting_v3_3.Schema.Campaign; + // Updates an existing campaign. + update(resource: Schema.Campaign, profileId: string): Dfareporting_v3_3.Schema.Campaign; + } + export interface ChangeLogsCollection { + // Gets one change log by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.ChangeLog; + // Retrieves a list of change logs. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.ChangeLogsListResponse; + // Retrieves a list of change logs. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.ChangeLogsListResponse; + } + export interface CitiesCollection { + // Retrieves a list of cities, possibly filtered. + list(profileId: string): Dfareporting_v3_3.Schema.CitiesListResponse; + // Retrieves a list of cities, possibly filtered. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CitiesListResponse; + } + export interface ConnectionTypesCollection { + // Gets one connection type by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.ConnectionType; + // Retrieves a list of connection types. + list(profileId: string): Dfareporting_v3_3.Schema.ConnectionTypesListResponse; + } + export interface ContentCategoriesCollection { + // Gets one content category by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.ContentCategory; + // Inserts a new content category. + insert(resource: Schema.ContentCategory, profileId: string): Dfareporting_v3_3.Schema.ContentCategory; + // Retrieves a list of content categories, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.ContentCategoriesListResponse; + // Retrieves a list of content categories, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.ContentCategoriesListResponse; + // Updates an existing content category. This method supports patch semantics. + patch(resource: Schema.ContentCategory, profileId: string, id: string): Dfareporting_v3_3.Schema.ContentCategory; + // Deletes an existing content category. + remove(profileId: string, id: string): void; + // Updates an existing content category. + update(resource: Schema.ContentCategory, profileId: string): Dfareporting_v3_3.Schema.ContentCategory; + } + export interface ConversionsCollection { + // Inserts conversions. + batchinsert(resource: Schema.ConversionsBatchInsertRequest, profileId: string): Dfareporting_v3_3.Schema.ConversionsBatchInsertResponse; + // Updates existing conversions. + batchupdate(resource: Schema.ConversionsBatchUpdateRequest, profileId: string): Dfareporting_v3_3.Schema.ConversionsBatchUpdateResponse; + } + export interface CountriesCollection { + // Gets one country by ID. + get(profileId: string, dartId: string): Dfareporting_v3_3.Schema.Country; + // Retrieves a list of countries. + list(profileId: string): Dfareporting_v3_3.Schema.CountriesListResponse; + } + export interface CreativeAssetsCollection { + // Inserts a new creative asset. + insert(resource: Schema.CreativeAssetMetadata, profileId: string, advertiserId: string): Dfareporting_v3_3.Schema.CreativeAssetMetadata; + // Inserts a new creative asset. + insert(resource: Schema.CreativeAssetMetadata, profileId: string, advertiserId: string, mediaData: any): Dfareporting_v3_3.Schema.CreativeAssetMetadata; + } + export interface CreativeFieldValuesCollection { + // Gets one creative field value by ID. + get(profileId: string, creativeFieldId: string, id: string): Dfareporting_v3_3.Schema.CreativeFieldValue; + // Inserts a new creative field value. + insert(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string): Dfareporting_v3_3.Schema.CreativeFieldValue; + // Retrieves a list of creative field values, possibly filtered. This method supports paging. + list(profileId: string, creativeFieldId: string): Dfareporting_v3_3.Schema.CreativeFieldValuesListResponse; + // Retrieves a list of creative field values, possibly filtered. This method supports paging. + list(profileId: string, creativeFieldId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CreativeFieldValuesListResponse; + // Updates an existing creative field value. This method supports patch semantics. + patch(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string, id: string): Dfareporting_v3_3.Schema.CreativeFieldValue; + // Deletes an existing creative field value. + remove(profileId: string, creativeFieldId: string, id: string): void; + // Updates an existing creative field value. + update(resource: Schema.CreativeFieldValue, profileId: string, creativeFieldId: string): Dfareporting_v3_3.Schema.CreativeFieldValue; + } + export interface CreativeFieldsCollection { + // Gets one creative field by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.CreativeField; + // Inserts a new creative field. + insert(resource: Schema.CreativeField, profileId: string): Dfareporting_v3_3.Schema.CreativeField; + // Retrieves a list of creative fields, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.CreativeFieldsListResponse; + // Retrieves a list of creative fields, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CreativeFieldsListResponse; + // Updates an existing creative field. This method supports patch semantics. + patch(resource: Schema.CreativeField, profileId: string, id: string): Dfareporting_v3_3.Schema.CreativeField; + // Deletes an existing creative field. + remove(profileId: string, id: string): void; + // Updates an existing creative field. + update(resource: Schema.CreativeField, profileId: string): Dfareporting_v3_3.Schema.CreativeField; + } + export interface CreativeGroupsCollection { + // Gets one creative group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.CreativeGroup; + // Inserts a new creative group. + insert(resource: Schema.CreativeGroup, profileId: string): Dfareporting_v3_3.Schema.CreativeGroup; + // Retrieves a list of creative groups, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.CreativeGroupsListResponse; + // Retrieves a list of creative groups, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CreativeGroupsListResponse; + // Updates an existing creative group. This method supports patch semantics. + patch(resource: Schema.CreativeGroup, profileId: string, id: string): Dfareporting_v3_3.Schema.CreativeGroup; + // Updates an existing creative group. + update(resource: Schema.CreativeGroup, profileId: string): Dfareporting_v3_3.Schema.CreativeGroup; + } + export interface CreativesCollection { + // Gets one creative by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Creative; + // Inserts a new creative. + insert(resource: Schema.Creative, profileId: string): Dfareporting_v3_3.Schema.Creative; + // Retrieves a list of creatives, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.CreativesListResponse; + // Retrieves a list of creatives, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.CreativesListResponse; + // Updates an existing creative. This method supports patch semantics. + patch(resource: Schema.Creative, profileId: string, id: string): Dfareporting_v3_3.Schema.Creative; + // Updates an existing creative. + update(resource: Schema.Creative, profileId: string): Dfareporting_v3_3.Schema.Creative; + } + export interface DimensionValuesCollection { + // Retrieves list of report dimension values for a list of filters. + query(resource: Schema.DimensionValueRequest, profileId: string): Dfareporting_v3_3.Schema.DimensionValueList; + // Retrieves list of report dimension values for a list of filters. + query(resource: Schema.DimensionValueRequest, profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.DimensionValueList; + } + export interface DirectorySitesCollection { + // Gets one directory site by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.DirectorySite; + // Inserts a new directory site. + insert(resource: Schema.DirectorySite, profileId: string): Dfareporting_v3_3.Schema.DirectorySite; + // Retrieves a list of directory sites, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.DirectorySitesListResponse; + // Retrieves a list of directory sites, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.DirectorySitesListResponse; + } + export interface DynamicTargetingKeysCollection { + // Inserts a new dynamic targeting key. Keys must be created at the advertiser level before being assigned to the advertiser's ads, creatives, or placements. There is a maximum of 1000 keys per advertiser, out of which a maximum of 20 keys can be assigned per ad, creative, or placement. + insert(resource: Schema.DynamicTargetingKey, profileId: string): Dfareporting_v3_3.Schema.DynamicTargetingKey; + // Retrieves a list of dynamic targeting keys. + list(profileId: string): Dfareporting_v3_3.Schema.DynamicTargetingKeysListResponse; + // Retrieves a list of dynamic targeting keys. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.DynamicTargetingKeysListResponse; + // Deletes an existing dynamic targeting key. + remove(profileId: string, objectId: string, name: string, objectType: string): void; + } + export interface EventTagsCollection { + // Gets one event tag by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.EventTag; + // Inserts a new event tag. + insert(resource: Schema.EventTag, profileId: string): Dfareporting_v3_3.Schema.EventTag; + // Retrieves a list of event tags, possibly filtered. + list(profileId: string): Dfareporting_v3_3.Schema.EventTagsListResponse; + // Retrieves a list of event tags, possibly filtered. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.EventTagsListResponse; + // Updates an existing event tag. This method supports patch semantics. + patch(resource: Schema.EventTag, profileId: string, id: string): Dfareporting_v3_3.Schema.EventTag; + // Deletes an existing event tag. + remove(profileId: string, id: string): void; + // Updates an existing event tag. + update(resource: Schema.EventTag, profileId: string): Dfareporting_v3_3.Schema.EventTag; + } + export interface FilesCollection { + // Retrieves a report file by its report ID and file ID. This method supports media download. + get(reportId: string, fileId: string): Dfareporting_v3_3.Schema.File; + // Lists files for a user profile. + list(profileId: string): Dfareporting_v3_3.Schema.FileList; + // Lists files for a user profile. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FileList; + } + export interface FloodlightActivitiesCollection { + // Generates a tag for a floodlight activity. + generatetag(profileId: string): Dfareporting_v3_3.Schema.FloodlightActivitiesGenerateTagResponse; + // Generates a tag for a floodlight activity. + generatetag(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FloodlightActivitiesGenerateTagResponse; + // Gets one floodlight activity by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightActivity; + // Inserts a new floodlight activity. + insert(resource: Schema.FloodlightActivity, profileId: string): Dfareporting_v3_3.Schema.FloodlightActivity; + // Retrieves a list of floodlight activities, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.FloodlightActivitiesListResponse; + // Retrieves a list of floodlight activities, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FloodlightActivitiesListResponse; + // Updates an existing floodlight activity. This method supports patch semantics. + patch(resource: Schema.FloodlightActivity, profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightActivity; + // Deletes an existing floodlight activity. + remove(profileId: string, id: string): void; + // Updates an existing floodlight activity. + update(resource: Schema.FloodlightActivity, profileId: string): Dfareporting_v3_3.Schema.FloodlightActivity; + } + export interface FloodlightActivityGroupsCollection { + // Gets one floodlight activity group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightActivityGroup; + // Inserts a new floodlight activity group. + insert(resource: Schema.FloodlightActivityGroup, profileId: string): Dfareporting_v3_3.Schema.FloodlightActivityGroup; + // Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.FloodlightActivityGroupsListResponse; + // Retrieves a list of floodlight activity groups, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FloodlightActivityGroupsListResponse; + // Updates an existing floodlight activity group. This method supports patch semantics. + patch(resource: Schema.FloodlightActivityGroup, profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightActivityGroup; + // Updates an existing floodlight activity group. + update(resource: Schema.FloodlightActivityGroup, profileId: string): Dfareporting_v3_3.Schema.FloodlightActivityGroup; + } + export interface FloodlightConfigurationsCollection { + // Gets one floodlight configuration by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightConfiguration; + // Retrieves a list of floodlight configurations, possibly filtered. + list(profileId: string): Dfareporting_v3_3.Schema.FloodlightConfigurationsListResponse; + // Retrieves a list of floodlight configurations, possibly filtered. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.FloodlightConfigurationsListResponse; + // Updates an existing floodlight configuration. This method supports patch semantics. + patch(resource: Schema.FloodlightConfiguration, profileId: string, id: string): Dfareporting_v3_3.Schema.FloodlightConfiguration; + // Updates an existing floodlight configuration. + update(resource: Schema.FloodlightConfiguration, profileId: string): Dfareporting_v3_3.Schema.FloodlightConfiguration; + } + export interface InventoryItemsCollection { + // Gets one inventory item by ID. + get(profileId: string, projectId: string, id: string): Dfareporting_v3_3.Schema.InventoryItem; + // Retrieves a list of inventory items, possibly filtered. This method supports paging. + list(profileId: string, projectId: string): Dfareporting_v3_3.Schema.InventoryItemsListResponse; + // Retrieves a list of inventory items, possibly filtered. This method supports paging. + list(profileId: string, projectId: string, optionalArgs: object): Dfareporting_v3_3.Schema.InventoryItemsListResponse; + } + export interface LanguagesCollection { + // Retrieves a list of languages. + list(profileId: string): Dfareporting_v3_3.Schema.LanguagesListResponse; + } + export interface MetrosCollection { + // Retrieves a list of metros. + list(profileId: string): Dfareporting_v3_3.Schema.MetrosListResponse; + } + export interface MobileAppsCollection { + // Gets one mobile app by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.MobileApp; + // Retrieves list of available mobile apps. + list(profileId: string): Dfareporting_v3_3.Schema.MobileAppsListResponse; + // Retrieves list of available mobile apps. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.MobileAppsListResponse; + } + export interface MobileCarriersCollection { + // Gets one mobile carrier by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.MobileCarrier; + // Retrieves a list of mobile carriers. + list(profileId: string): Dfareporting_v3_3.Schema.MobileCarriersListResponse; + } + export interface OperatingSystemVersionsCollection { + // Gets one operating system version by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.OperatingSystemVersion; + // Retrieves a list of operating system versions. + list(profileId: string): Dfareporting_v3_3.Schema.OperatingSystemVersionsListResponse; + } + export interface OperatingSystemsCollection { + // Gets one operating system by DART ID. + get(profileId: string, dartId: string): Dfareporting_v3_3.Schema.OperatingSystem; + // Retrieves a list of operating systems. + list(profileId: string): Dfareporting_v3_3.Schema.OperatingSystemsListResponse; + } + export interface OrderDocumentsCollection { + // Gets one order document by ID. + get(profileId: string, projectId: string, id: string): Dfareporting_v3_3.Schema.OrderDocument; + // Retrieves a list of order documents, possibly filtered. This method supports paging. + list(profileId: string, projectId: string): Dfareporting_v3_3.Schema.OrderDocumentsListResponse; + // Retrieves a list of order documents, possibly filtered. This method supports paging. + list(profileId: string, projectId: string, optionalArgs: object): Dfareporting_v3_3.Schema.OrderDocumentsListResponse; + } + export interface OrdersCollection { + // Gets one order by ID. + get(profileId: string, projectId: string, id: string): Dfareporting_v3_3.Schema.Order; + // Retrieves a list of orders, possibly filtered. This method supports paging. + list(profileId: string, projectId: string): Dfareporting_v3_3.Schema.OrdersListResponse; + // Retrieves a list of orders, possibly filtered. This method supports paging. + list(profileId: string, projectId: string, optionalArgs: object): Dfareporting_v3_3.Schema.OrdersListResponse; + } + export interface PlacementGroupsCollection { + // Gets one placement group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.PlacementGroup; + // Inserts a new placement group. + insert(resource: Schema.PlacementGroup, profileId: string): Dfareporting_v3_3.Schema.PlacementGroup; + // Retrieves a list of placement groups, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.PlacementGroupsListResponse; + // Retrieves a list of placement groups, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.PlacementGroupsListResponse; + // Updates an existing placement group. This method supports patch semantics. + patch(resource: Schema.PlacementGroup, profileId: string, id: string): Dfareporting_v3_3.Schema.PlacementGroup; + // Updates an existing placement group. + update(resource: Schema.PlacementGroup, profileId: string): Dfareporting_v3_3.Schema.PlacementGroup; + } + export interface PlacementStrategiesCollection { + // Gets one placement strategy by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.PlacementStrategy; + // Inserts a new placement strategy. + insert(resource: Schema.PlacementStrategy, profileId: string): Dfareporting_v3_3.Schema.PlacementStrategy; + // Retrieves a list of placement strategies, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.PlacementStrategiesListResponse; + // Retrieves a list of placement strategies, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.PlacementStrategiesListResponse; + // Updates an existing placement strategy. This method supports patch semantics. + patch(resource: Schema.PlacementStrategy, profileId: string, id: string): Dfareporting_v3_3.Schema.PlacementStrategy; + // Deletes an existing placement strategy. + remove(profileId: string, id: string): void; + // Updates an existing placement strategy. + update(resource: Schema.PlacementStrategy, profileId: string): Dfareporting_v3_3.Schema.PlacementStrategy; + } + export interface PlacementsCollection { + // Generates tags for a placement. + generatetags(profileId: string): Dfareporting_v3_3.Schema.PlacementsGenerateTagsResponse; + // Generates tags for a placement. + generatetags(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.PlacementsGenerateTagsResponse; + // Gets one placement by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Placement; + // Inserts a new placement. + insert(resource: Schema.Placement, profileId: string): Dfareporting_v3_3.Schema.Placement; + // Retrieves a list of placements, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.PlacementsListResponse; + // Retrieves a list of placements, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.PlacementsListResponse; + // Updates an existing placement. This method supports patch semantics. + patch(resource: Schema.Placement, profileId: string, id: string): Dfareporting_v3_3.Schema.Placement; + // Updates an existing placement. + update(resource: Schema.Placement, profileId: string): Dfareporting_v3_3.Schema.Placement; + } + export interface PlatformTypesCollection { + // Gets one platform type by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.PlatformType; + // Retrieves a list of platform types. + list(profileId: string): Dfareporting_v3_3.Schema.PlatformTypesListResponse; + } + export interface PostalCodesCollection { + // Gets one postal code by ID. + get(profileId: string, code: string): Dfareporting_v3_3.Schema.PostalCode; + // Retrieves a list of postal codes. + list(profileId: string): Dfareporting_v3_3.Schema.PostalCodesListResponse; + } + export interface ProjectsCollection { + // Gets one project by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Project; + // Retrieves a list of projects, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.ProjectsListResponse; + // Retrieves a list of projects, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.ProjectsListResponse; + } + export interface RegionsCollection { + // Retrieves a list of regions. + list(profileId: string): Dfareporting_v3_3.Schema.RegionsListResponse; + } + export interface RemarketingListSharesCollection { + // Gets one remarketing list share by remarketing list ID. + get(profileId: string, remarketingListId: string): Dfareporting_v3_3.Schema.RemarketingListShare; + // Updates an existing remarketing list share. This method supports patch semantics. + patch(resource: Schema.RemarketingListShare, profileId: string, remarketingListId: string): Dfareporting_v3_3.Schema.RemarketingListShare; + // Updates an existing remarketing list share. + update(resource: Schema.RemarketingListShare, profileId: string): Dfareporting_v3_3.Schema.RemarketingListShare; + } + export interface RemarketingListsCollection { + // Gets one remarketing list by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.RemarketingList; + // Inserts a new remarketing list. + insert(resource: Schema.RemarketingList, profileId: string): Dfareporting_v3_3.Schema.RemarketingList; + // Retrieves a list of remarketing lists, possibly filtered. This method supports paging. + list(profileId: string, advertiserId: string): Dfareporting_v3_3.Schema.RemarketingListsListResponse; + // Retrieves a list of remarketing lists, possibly filtered. This method supports paging. + list(profileId: string, advertiserId: string, optionalArgs: object): Dfareporting_v3_3.Schema.RemarketingListsListResponse; + // Updates an existing remarketing list. This method supports patch semantics. + patch(resource: Schema.RemarketingList, profileId: string, id: string): Dfareporting_v3_3.Schema.RemarketingList; + // Updates an existing remarketing list. + update(resource: Schema.RemarketingList, profileId: string): Dfareporting_v3_3.Schema.RemarketingList; + } + export interface ReportsCollection { + CompatibleFields?: Dfareporting_v3_3.Collection.Reports.CompatibleFieldsCollection; + Files?: Dfareporting_v3_3.Collection.Reports.FilesCollection; + // Retrieves a report by its ID. + get(profileId: string, reportId: string): Dfareporting_v3_3.Schema.Report; + // Creates a report. + insert(resource: Schema.Report, profileId: string): Dfareporting_v3_3.Schema.Report; + // Retrieves list of reports. + list(profileId: string): Dfareporting_v3_3.Schema.ReportList; + // Retrieves list of reports. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.ReportList; + // Updates a report. This method supports patch semantics. + patch(resource: Schema.Report, profileId: string, reportId: string): Dfareporting_v3_3.Schema.Report; + // Deletes a report by its ID. + remove(profileId: string, reportId: string): void; + // Runs a report. + run(profileId: string, reportId: string): Dfareporting_v3_3.Schema.File; + // Runs a report. + run(profileId: string, reportId: string, optionalArgs: object): Dfareporting_v3_3.Schema.File; + // Updates a report. + update(resource: Schema.Report, profileId: string, reportId: string): Dfareporting_v3_3.Schema.Report; + } + export interface SitesCollection { + // Gets one site by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Site; + // Inserts a new site. + insert(resource: Schema.Site, profileId: string): Dfareporting_v3_3.Schema.Site; + // Retrieves a list of sites, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.SitesListResponse; + // Retrieves a list of sites, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.SitesListResponse; + // Updates an existing site. This method supports patch semantics. + patch(resource: Schema.Site, profileId: string, id: string): Dfareporting_v3_3.Schema.Site; + // Updates an existing site. + update(resource: Schema.Site, profileId: string): Dfareporting_v3_3.Schema.Site; + } + export interface SizesCollection { + // Gets one size by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Size; + // Inserts a new size. + insert(resource: Schema.Size, profileId: string): Dfareporting_v3_3.Schema.Size; + // Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. + list(profileId: string): Dfareporting_v3_3.Schema.SizesListResponse; + // Retrieves a list of sizes, possibly filtered. Retrieved sizes are globally unique and may include values not currently in use by your account. Due to this, the list of sizes returned by this method may differ from the list seen in the Trafficking UI. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.SizesListResponse; + } + export interface SubaccountsCollection { + // Gets one subaccount by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.Subaccount; + // Inserts a new subaccount. + insert(resource: Schema.Subaccount, profileId: string): Dfareporting_v3_3.Schema.Subaccount; + // Gets a list of subaccounts, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.SubaccountsListResponse; + // Gets a list of subaccounts, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.SubaccountsListResponse; + // Updates an existing subaccount. This method supports patch semantics. + patch(resource: Schema.Subaccount, profileId: string, id: string): Dfareporting_v3_3.Schema.Subaccount; + // Updates an existing subaccount. + update(resource: Schema.Subaccount, profileId: string): Dfareporting_v3_3.Schema.Subaccount; + } + export interface TargetableRemarketingListsCollection { + // Gets one remarketing list by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.TargetableRemarketingList; + // Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. + list(profileId: string, advertiserId: string): Dfareporting_v3_3.Schema.TargetableRemarketingListsListResponse; + // Retrieves a list of targetable remarketing lists, possibly filtered. This method supports paging. + list(profileId: string, advertiserId: string, optionalArgs: object): Dfareporting_v3_3.Schema.TargetableRemarketingListsListResponse; + } + export interface TargetingTemplatesCollection { + // Gets one targeting template by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.TargetingTemplate; + // Inserts a new targeting template. + insert(resource: Schema.TargetingTemplate, profileId: string): Dfareporting_v3_3.Schema.TargetingTemplate; + // Retrieves a list of targeting templates, optionally filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.TargetingTemplatesListResponse; + // Retrieves a list of targeting templates, optionally filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.TargetingTemplatesListResponse; + // Updates an existing targeting template. This method supports patch semantics. + patch(resource: Schema.TargetingTemplate, profileId: string, id: string): Dfareporting_v3_3.Schema.TargetingTemplate; + // Updates an existing targeting template. + update(resource: Schema.TargetingTemplate, profileId: string): Dfareporting_v3_3.Schema.TargetingTemplate; + } + export interface UserProfilesCollection { + // Gets one user profile by ID. + get(profileId: string): Dfareporting_v3_3.Schema.UserProfile; + // Retrieves list of user profiles for a user. + list(): Dfareporting_v3_3.Schema.UserProfileList; + } + export interface UserRolePermissionGroupsCollection { + // Gets one user role permission group by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.UserRolePermissionGroup; + // Gets a list of all supported user role permission groups. + list(profileId: string): Dfareporting_v3_3.Schema.UserRolePermissionGroupsListResponse; + } + export interface UserRolePermissionsCollection { + // Gets one user role permission by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.UserRolePermission; + // Gets a list of user role permissions, possibly filtered. + list(profileId: string): Dfareporting_v3_3.Schema.UserRolePermissionsListResponse; + // Gets a list of user role permissions, possibly filtered. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.UserRolePermissionsListResponse; + } + export interface UserRolesCollection { + // Gets one user role by ID. + get(profileId: string, id: string): Dfareporting_v3_3.Schema.UserRole; + // Inserts a new user role. + insert(resource: Schema.UserRole, profileId: string): Dfareporting_v3_3.Schema.UserRole; + // Retrieves a list of user roles, possibly filtered. This method supports paging. + list(profileId: string): Dfareporting_v3_3.Schema.UserRolesListResponse; + // Retrieves a list of user roles, possibly filtered. This method supports paging. + list(profileId: string, optionalArgs: object): Dfareporting_v3_3.Schema.UserRolesListResponse; + // Updates an existing user role. This method supports patch semantics. + patch(resource: Schema.UserRole, profileId: string, id: string): Dfareporting_v3_3.Schema.UserRole; + // Deletes an existing user role. + remove(profileId: string, id: string): void; + // Updates an existing user role. + update(resource: Schema.UserRole, profileId: string): Dfareporting_v3_3.Schema.UserRole; + } + export interface VideoFormatsCollection { + // Gets one video format by ID. + get(profileId: string, id: number): Dfareporting_v3_3.Schema.VideoFormat; + // Lists available video formats. + list(profileId: string): Dfareporting_v3_3.Schema.VideoFormatsListResponse; + } + } + namespace Schema { + export interface Account { + accountPermissionIds?: string[]; + accountProfile?: string; + active?: boolean; + activeAdsLimitTier?: string; + activeViewOptOut?: boolean; + availablePermissionIds?: string[]; + countryId?: string; + currencyId?: string; + defaultCreativeSizeId?: string; + description?: string; + id?: string; + kind?: string; + locale?: string; + maximumImageSize?: string; + name?: string; + nielsenOcrEnabled?: boolean; + reportsConfiguration?: Dfareporting_v3_3.Schema.ReportsConfiguration; + shareReportsWithTwitter?: boolean; + teaserSizeLimit?: string; + } + export interface AccountActiveAdSummary { + accountId?: string; + activeAds?: string; + activeAdsLimitTier?: string; + availableAds?: string; + kind?: string; + } + export interface AccountPermission { + accountProfiles?: string[]; + id?: string; + kind?: string; + level?: string; + name?: string; + permissionGroupId?: string; + } + export interface AccountPermissionGroup { + id?: string; + kind?: string; + name?: string; + } + export interface AccountPermissionGroupsListResponse { + accountPermissionGroups?: Dfareporting_v3_3.Schema.AccountPermissionGroup[]; + kind?: string; + } + export interface AccountPermissionsListResponse { + accountPermissions?: Dfareporting_v3_3.Schema.AccountPermission[]; + kind?: string; + } + export interface AccountUserProfile { + accountId?: string; + active?: boolean; + advertiserFilter?: Dfareporting_v3_3.Schema.ObjectFilter; + campaignFilter?: Dfareporting_v3_3.Schema.ObjectFilter; + comments?: string; + email?: string; + id?: string; + kind?: string; + locale?: string; + name?: string; + siteFilter?: Dfareporting_v3_3.Schema.ObjectFilter; + subaccountId?: string; + traffickerType?: string; + userAccessType?: string; + userRoleFilter?: Dfareporting_v3_3.Schema.ObjectFilter; + userRoleId?: string; + } + export interface AccountUserProfilesListResponse { + accountUserProfiles?: Dfareporting_v3_3.Schema.AccountUserProfile[]; + kind?: string; + nextPageToken?: string; + } + export interface AccountsListResponse { + accounts?: Dfareporting_v3_3.Schema.Account[]; + kind?: string; + nextPageToken?: string; + } + export interface Activities { + filters?: Dfareporting_v3_3.Schema.DimensionValue[]; + kind?: string; + metricNames?: string[]; + } + export interface Ad { + accountId?: string; + active?: boolean; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + archived?: boolean; + audienceSegmentId?: string; + campaignId?: string; + campaignIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + clickThroughUrl?: Dfareporting_v3_3.Schema.ClickThroughUrl; + clickThroughUrlSuffixProperties?: Dfareporting_v3_3.Schema.ClickThroughUrlSuffixProperties; + comments?: string; + compatibility?: string; + createInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + creativeGroupAssignments?: Dfareporting_v3_3.Schema.CreativeGroupAssignment[]; + creativeRotation?: Dfareporting_v3_3.Schema.CreativeRotation; + dayPartTargeting?: Dfareporting_v3_3.Schema.DayPartTargeting; + defaultClickThroughEventTagProperties?: Dfareporting_v3_3.Schema.DefaultClickThroughEventTagProperties; + deliverySchedule?: Dfareporting_v3_3.Schema.DeliverySchedule; + dynamicClickTracker?: boolean; + endTime?: string; + eventTagOverrides?: Dfareporting_v3_3.Schema.EventTagOverride[]; + geoTargeting?: Dfareporting_v3_3.Schema.GeoTargeting; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + keyValueTargetingExpression?: Dfareporting_v3_3.Schema.KeyValueTargetingExpression; + kind?: string; + languageTargeting?: Dfareporting_v3_3.Schema.LanguageTargeting; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + placementAssignments?: Dfareporting_v3_3.Schema.PlacementAssignment[]; + remarketingListExpression?: Dfareporting_v3_3.Schema.ListTargetingExpression; + size?: Dfareporting_v3_3.Schema.Size; + sslCompliant?: boolean; + sslRequired?: boolean; + startTime?: string; + subaccountId?: string; + targetingTemplateId?: string; + technologyTargeting?: Dfareporting_v3_3.Schema.TechnologyTargeting; + type?: string; + } + export interface AdBlockingConfiguration { + clickThroughUrl?: string; + creativeBundleId?: string; + enabled?: boolean; + overrideClickThroughUrl?: boolean; + } + export interface AdSlot { + comment?: string; + compatibility?: string; + height?: string; + linkedPlacementId?: string; + name?: string; + paymentSourceType?: string; + primary?: boolean; + width?: string; + } + export interface AdsListResponse { + ads?: Dfareporting_v3_3.Schema.Ad[]; + kind?: string; + nextPageToken?: string; + } + export interface Advertiser { + accountId?: string; + advertiserGroupId?: string; + clickThroughUrlSuffix?: string; + defaultClickThroughEventTagId?: string; + defaultEmail?: string; + floodlightConfigurationId?: string; + floodlightConfigurationIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + name?: string; + originalFloodlightConfigurationId?: string; + status?: string; + subaccountId?: string; + suspended?: boolean; + } + export interface AdvertiserGroup { + accountId?: string; + id?: string; + kind?: string; + name?: string; + } + export interface AdvertiserGroupsListResponse { + advertiserGroups?: Dfareporting_v3_3.Schema.AdvertiserGroup[]; + kind?: string; + nextPageToken?: string; + } + export interface AdvertiserLandingPagesListResponse { + kind?: string; + landingPages?: Dfareporting_v3_3.Schema.LandingPage[]; + nextPageToken?: string; + } + export interface AdvertisersListResponse { + advertisers?: Dfareporting_v3_3.Schema.Advertiser[]; + kind?: string; + nextPageToken?: string; + } + export interface AudienceSegment { + allocation?: number; + id?: string; + name?: string; + } + export interface AudienceSegmentGroup { + audienceSegments?: Dfareporting_v3_3.Schema.AudienceSegment[]; + id?: string; + name?: string; + } + export interface Browser { + browserVersionId?: string; + dartId?: string; + kind?: string; + majorVersion?: string; + minorVersion?: string; + name?: string; + } + export interface BrowsersListResponse { + browsers?: Dfareporting_v3_3.Schema.Browser[]; + kind?: string; + } + export interface Campaign { + accountId?: string; + adBlockingConfiguration?: Dfareporting_v3_3.Schema.AdBlockingConfiguration; + additionalCreativeOptimizationConfigurations?: Dfareporting_v3_3.Schema.CreativeOptimizationConfiguration[]; + advertiserGroupId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + archived?: boolean; + audienceSegmentGroups?: Dfareporting_v3_3.Schema.AudienceSegmentGroup[]; + billingInvoiceCode?: string; + clickThroughUrlSuffixProperties?: Dfareporting_v3_3.Schema.ClickThroughUrlSuffixProperties; + comment?: string; + createInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + creativeGroupIds?: string[]; + creativeOptimizationConfiguration?: Dfareporting_v3_3.Schema.CreativeOptimizationConfiguration; + defaultClickThroughEventTagProperties?: Dfareporting_v3_3.Schema.DefaultClickThroughEventTagProperties; + defaultLandingPageId?: string; + endDate?: string; + eventTagOverrides?: Dfareporting_v3_3.Schema.EventTagOverride[]; + externalId?: string; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + nielsenOcrEnabled?: boolean; + startDate?: string; + subaccountId?: string; + traffickerEmails?: string[]; + } + export interface CampaignCreativeAssociation { + creativeId?: string; + kind?: string; + } + export interface CampaignCreativeAssociationsListResponse { + campaignCreativeAssociations?: Dfareporting_v3_3.Schema.CampaignCreativeAssociation[]; + kind?: string; + nextPageToken?: string; + } + export interface CampaignsListResponse { + campaigns?: Dfareporting_v3_3.Schema.Campaign[]; + kind?: string; + nextPageToken?: string; + } + export interface ChangeLog { + accountId?: string; + action?: string; + changeTime?: string; + fieldName?: string; + id?: string; + kind?: string; + newValue?: string; + objectId?: string; + objectType?: string; + oldValue?: string; + subaccountId?: string; + transactionId?: string; + userProfileId?: string; + userProfileName?: string; + } + export interface ChangeLogsListResponse { + changeLogs?: Dfareporting_v3_3.Schema.ChangeLog[]; + kind?: string; + nextPageToken?: string; + } + export interface CitiesListResponse { + cities?: Dfareporting_v3_3.Schema.City[]; + kind?: string; + } + export interface City { + countryCode?: string; + countryDartId?: string; + dartId?: string; + kind?: string; + metroCode?: string; + metroDmaId?: string; + name?: string; + regionCode?: string; + regionDartId?: string; + } + export interface ClickTag { + clickThroughUrl?: Dfareporting_v3_3.Schema.CreativeClickThroughUrl; + eventName?: string; + name?: string; + } + export interface ClickThroughUrl { + computedClickThroughUrl?: string; + customClickThroughUrl?: string; + defaultLandingPage?: boolean; + landingPageId?: string; + } + export interface ClickThroughUrlSuffixProperties { + clickThroughUrlSuffix?: string; + overrideInheritedSuffix?: boolean; + } + export interface CompanionClickThroughOverride { + clickThroughUrl?: Dfareporting_v3_3.Schema.ClickThroughUrl; + creativeId?: string; + } + export interface CompanionSetting { + companionsDisabled?: boolean; + enabledSizes?: Dfareporting_v3_3.Schema.Size[]; + imageOnly?: boolean; + kind?: string; + } + export interface CompatibleFields { + crossDimensionReachReportCompatibleFields?: Dfareporting_v3_3.Schema.CrossDimensionReachReportCompatibleFields; + floodlightReportCompatibleFields?: Dfareporting_v3_3.Schema.FloodlightReportCompatibleFields; + kind?: string; + pathToConversionReportCompatibleFields?: Dfareporting_v3_3.Schema.PathToConversionReportCompatibleFields; + reachReportCompatibleFields?: Dfareporting_v3_3.Schema.ReachReportCompatibleFields; + reportCompatibleFields?: Dfareporting_v3_3.Schema.ReportCompatibleFields; + } + export interface ConnectionType { + id?: string; + kind?: string; + name?: string; + } + export interface ConnectionTypesListResponse { + connectionTypes?: Dfareporting_v3_3.Schema.ConnectionType[]; + kind?: string; + } + export interface ContentCategoriesListResponse { + contentCategories?: Dfareporting_v3_3.Schema.ContentCategory[]; + kind?: string; + nextPageToken?: string; + } + export interface ContentCategory { + accountId?: string; + id?: string; + kind?: string; + name?: string; + } + export interface Conversion { + childDirectedTreatment?: boolean; + customVariables?: Dfareporting_v3_3.Schema.CustomFloodlightVariable[]; + encryptedUserId?: string; + encryptedUserIdCandidates?: string[]; + floodlightActivityId?: string; + floodlightConfigurationId?: string; + gclid?: string; + kind?: string; + limitAdTracking?: boolean; + mobileDeviceId?: string; + nonPersonalizedAd?: boolean; + ordinal?: string; + quantity?: string; + timestampMicros?: string; + treatmentForUnderage?: boolean; + value?: Number; + } + export interface ConversionError { + code?: string; + kind?: string; + message?: string; + } + export interface ConversionStatus { + conversion?: Dfareporting_v3_3.Schema.Conversion; + errors?: Dfareporting_v3_3.Schema.ConversionError[]; + kind?: string; + } + export interface ConversionsBatchInsertRequest { + conversions?: Dfareporting_v3_3.Schema.Conversion[]; + encryptionInfo?: Dfareporting_v3_3.Schema.EncryptionInfo; + kind?: string; + } + export interface ConversionsBatchInsertResponse { + hasFailures?: boolean; + kind?: string; + status?: Dfareporting_v3_3.Schema.ConversionStatus[]; + } + export interface ConversionsBatchUpdateRequest { + conversions?: Dfareporting_v3_3.Schema.Conversion[]; + encryptionInfo?: Dfareporting_v3_3.Schema.EncryptionInfo; + kind?: string; + } + export interface ConversionsBatchUpdateResponse { + hasFailures?: boolean; + kind?: string; + status?: Dfareporting_v3_3.Schema.ConversionStatus[]; + } + export interface CountriesListResponse { + countries?: Dfareporting_v3_3.Schema.Country[]; + kind?: string; + } + export interface Country { + countryCode?: string; + dartId?: string; + kind?: string; + name?: string; + sslEnabled?: boolean; + } + export interface Creative { + accountId?: string; + active?: boolean; + adParameters?: string; + adTagKeys?: string[]; + additionalSizes?: Dfareporting_v3_3.Schema.Size[]; + advertiserId?: string; + allowScriptAccess?: boolean; + archived?: boolean; + artworkType?: string; + authoringSource?: string; + authoringTool?: string; + autoAdvanceImages?: boolean; + backgroundColor?: string; + backupImageClickThroughUrl?: Dfareporting_v3_3.Schema.CreativeClickThroughUrl; + backupImageFeatures?: string[]; + backupImageReportingLabel?: string; + backupImageTargetWindow?: Dfareporting_v3_3.Schema.TargetWindow; + clickTags?: Dfareporting_v3_3.Schema.ClickTag[]; + commercialId?: string; + companionCreatives?: string[]; + compatibility?: string[]; + convertFlashToHtml5?: boolean; + counterCustomEvents?: Dfareporting_v3_3.Schema.CreativeCustomEvent[]; + creativeAssetSelection?: Dfareporting_v3_3.Schema.CreativeAssetSelection; + creativeAssets?: Dfareporting_v3_3.Schema.CreativeAsset[]; + creativeFieldAssignments?: Dfareporting_v3_3.Schema.CreativeFieldAssignment[]; + customKeyValues?: string[]; + dynamicAssetSelection?: boolean; + exitCustomEvents?: Dfareporting_v3_3.Schema.CreativeCustomEvent[]; + fsCommand?: Dfareporting_v3_3.Schema.FsCommand; + htmlCode?: string; + htmlCodeLocked?: boolean; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + latestTraffickedCreativeId?: string; + mediaDescription?: string; + mediaDuration?: Number; + name?: string; + overrideCss?: string; + progressOffset?: Dfareporting_v3_3.Schema.VideoOffset; + redirectUrl?: string; + renderingId?: string; + renderingIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + requiredFlashPluginVersion?: string; + requiredFlashVersion?: number; + size?: Dfareporting_v3_3.Schema.Size; + skipOffset?: Dfareporting_v3_3.Schema.VideoOffset; + skippable?: boolean; + sslCompliant?: boolean; + sslOverride?: boolean; + studioAdvertiserId?: string; + studioCreativeId?: string; + studioTraffickedCreativeId?: string; + subaccountId?: string; + thirdPartyBackupImageImpressionsUrl?: string; + thirdPartyRichMediaImpressionsUrl?: string; + thirdPartyUrls?: Dfareporting_v3_3.Schema.ThirdPartyTrackingUrl[]; + timerCustomEvents?: Dfareporting_v3_3.Schema.CreativeCustomEvent[]; + totalFileSize?: string; + type?: string; + universalAdId?: Dfareporting_v3_3.Schema.UniversalAdId; + version?: number; + } + export interface CreativeAsset { + actionScript3?: boolean; + active?: boolean; + additionalSizes?: Dfareporting_v3_3.Schema.Size[]; + alignment?: string; + artworkType?: string; + assetIdentifier?: Dfareporting_v3_3.Schema.CreativeAssetId; + audioBitRate?: number; + audioSampleRate?: number; + backupImageExit?: Dfareporting_v3_3.Schema.CreativeCustomEvent; + bitRate?: number; + childAssetType?: string; + collapsedSize?: Dfareporting_v3_3.Schema.Size; + companionCreativeIds?: string[]; + customStartTimeValue?: number; + detectedFeatures?: string[]; + displayType?: string; + duration?: number; + durationType?: string; + expandedDimension?: Dfareporting_v3_3.Schema.Size; + fileSize?: string; + flashVersion?: number; + frameRate?: Number; + hideFlashObjects?: boolean; + hideSelectionBoxes?: boolean; + horizontallyLocked?: boolean; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + mediaDuration?: Number; + mimeType?: string; + offset?: Dfareporting_v3_3.Schema.OffsetPosition; + orientation?: string; + originalBackup?: boolean; + politeLoad?: boolean; + position?: Dfareporting_v3_3.Schema.OffsetPosition; + positionLeftUnit?: string; + positionTopUnit?: string; + progressiveServingUrl?: string; + pushdown?: boolean; + pushdownDuration?: Number; + role?: string; + size?: Dfareporting_v3_3.Schema.Size; + sslCompliant?: boolean; + startTimeType?: string; + streamingServingUrl?: string; + transparency?: boolean; + verticallyLocked?: boolean; + windowMode?: string; + zIndex?: number; + zipFilename?: string; + zipFilesize?: string; + } + export interface CreativeAssetId { + name?: string; + type?: string; + } + export interface CreativeAssetMetadata { + assetIdentifier?: Dfareporting_v3_3.Schema.CreativeAssetId; + clickTags?: Dfareporting_v3_3.Schema.ClickTag[]; + detectedFeatures?: string[]; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + warnedValidationRules?: string[]; + } + export interface CreativeAssetSelection { + defaultAssetId?: string; + rules?: Dfareporting_v3_3.Schema.Rule[]; + } + export interface CreativeAssignment { + active?: boolean; + applyEventTags?: boolean; + clickThroughUrl?: Dfareporting_v3_3.Schema.ClickThroughUrl; + companionCreativeOverrides?: Dfareporting_v3_3.Schema.CompanionClickThroughOverride[]; + creativeGroupAssignments?: Dfareporting_v3_3.Schema.CreativeGroupAssignment[]; + creativeId?: string; + creativeIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + endTime?: string; + richMediaExitOverrides?: Dfareporting_v3_3.Schema.RichMediaExitOverride[]; + sequence?: number; + sslCompliant?: boolean; + startTime?: string; + weight?: number; + } + export interface CreativeClickThroughUrl { + computedClickThroughUrl?: string; + customClickThroughUrl?: string; + landingPageId?: string; + } + export interface CreativeCustomEvent { + advertiserCustomEventId?: string; + advertiserCustomEventName?: string; + advertiserCustomEventType?: string; + artworkLabel?: string; + artworkType?: string; + exitClickThroughUrl?: Dfareporting_v3_3.Schema.CreativeClickThroughUrl; + id?: string; + popupWindowProperties?: Dfareporting_v3_3.Schema.PopupWindowProperties; + targetType?: string; + videoReportingId?: string; + } + export interface CreativeField { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + id?: string; + kind?: string; + name?: string; + subaccountId?: string; + } + export interface CreativeFieldAssignment { + creativeFieldId?: string; + creativeFieldValueId?: string; + } + export interface CreativeFieldValue { + id?: string; + kind?: string; + value?: string; + } + export interface CreativeFieldValuesListResponse { + creativeFieldValues?: Dfareporting_v3_3.Schema.CreativeFieldValue[]; + kind?: string; + nextPageToken?: string; + } + export interface CreativeFieldsListResponse { + creativeFields?: Dfareporting_v3_3.Schema.CreativeField[]; + kind?: string; + nextPageToken?: string; + } + export interface CreativeGroup { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + groupNumber?: number; + id?: string; + kind?: string; + name?: string; + subaccountId?: string; + } + export interface CreativeGroupAssignment { + creativeGroupId?: string; + creativeGroupNumber?: string; + } + export interface CreativeGroupsListResponse { + creativeGroups?: Dfareporting_v3_3.Schema.CreativeGroup[]; + kind?: string; + nextPageToken?: string; + } + export interface CreativeOptimizationConfiguration { + id?: string; + name?: string; + optimizationActivitys?: Dfareporting_v3_3.Schema.OptimizationActivity[]; + optimizationModel?: string; + } + export interface CreativeRotation { + creativeAssignments?: Dfareporting_v3_3.Schema.CreativeAssignment[]; + creativeOptimizationConfigurationId?: string; + type?: string; + weightCalculationStrategy?: string; + } + export interface CreativesListResponse { + creatives?: Dfareporting_v3_3.Schema.Creative[]; + kind?: string; + nextPageToken?: string; + } + export interface CrossDimensionReachReportCompatibleFields { + breakdown?: Dfareporting_v3_3.Schema.Dimension[]; + dimensionFilters?: Dfareporting_v3_3.Schema.Dimension[]; + kind?: string; + metrics?: Dfareporting_v3_3.Schema.Metric[]; + overlapMetrics?: Dfareporting_v3_3.Schema.Metric[]; + } + export interface CustomFloodlightVariable { + kind?: string; + type?: string; + value?: string; + } + export interface CustomRichMediaEvents { + filteredEventIds?: Dfareporting_v3_3.Schema.DimensionValue[]; + kind?: string; + } + export interface CustomViewabilityMetric { + configuration?: Dfareporting_v3_3.Schema.CustomViewabilityMetricConfiguration; + id?: string; + name?: string; + } + export interface CustomViewabilityMetricConfiguration { + audible?: boolean; + timeMillis?: number; + timePercent?: number; + viewabilityPercent?: number; + } + export interface DateRange { + endDate?: string; + kind?: string; + relativeDateRange?: string; + startDate?: string; + } + export interface DayPartTargeting { + daysOfWeek?: string[]; + hoursOfDay?: number[]; + userLocalTime?: boolean; + } + export interface DeepLink { + appUrl?: string; + fallbackUrl?: string; + kind?: string; + mobileApp?: Dfareporting_v3_3.Schema.MobileApp; + remarketingListIds?: string[]; + } + export interface DefaultClickThroughEventTagProperties { + defaultClickThroughEventTagId?: string; + overrideInheritedEventTag?: boolean; + } + export interface DeliverySchedule { + frequencyCap?: Dfareporting_v3_3.Schema.FrequencyCap; + hardCutoff?: boolean; + impressionRatio?: string; + priority?: string; + } + export interface DfpSettings { + dfpNetworkCode?: string; + dfpNetworkName?: string; + programmaticPlacementAccepted?: boolean; + pubPaidPlacementAccepted?: boolean; + publisherPortalOnly?: boolean; + } + export interface Dimension { + kind?: string; + name?: string; + } + export interface DimensionFilter { + dimensionName?: string; + kind?: string; + value?: string; + } + export interface DimensionValue { + dimensionName?: string; + etag?: string; + id?: string; + kind?: string; + matchType?: string; + value?: string; + } + export interface DimensionValueList { + etag?: string; + items?: Dfareporting_v3_3.Schema.DimensionValue[]; + kind?: string; + nextPageToken?: string; + } + export interface DimensionValueRequest { + dimensionName?: string; + endDate?: string; + filters?: Dfareporting_v3_3.Schema.DimensionFilter[]; + kind?: string; + startDate?: string; + } + export interface DirectorySite { + active?: boolean; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + inpageTagFormats?: string[]; + interstitialTagFormats?: string[]; + kind?: string; + name?: string; + settings?: Dfareporting_v3_3.Schema.DirectorySiteSettings; + url?: string; + } + export interface DirectorySiteSettings { + activeViewOptOut?: boolean; + dfpSettings?: Dfareporting_v3_3.Schema.DfpSettings; + instreamVideoPlacementAccepted?: boolean; + interstitialPlacementAccepted?: boolean; + } + export interface DirectorySitesListResponse { + directorySites?: Dfareporting_v3_3.Schema.DirectorySite[]; + kind?: string; + nextPageToken?: string; + } + export interface DynamicTargetingKey { + kind?: string; + name?: string; + objectId?: string; + objectType?: string; + } + export interface DynamicTargetingKeysListResponse { + dynamicTargetingKeys?: Dfareporting_v3_3.Schema.DynamicTargetingKey[]; + kind?: string; + } + export interface EncryptionInfo { + encryptionEntityId?: string; + encryptionEntityType?: string; + encryptionSource?: string; + kind?: string; + } + export interface EventTag { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + campaignId?: string; + campaignIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + enabledByDefault?: boolean; + excludeFromAdxRequests?: boolean; + id?: string; + kind?: string; + name?: string; + siteFilterType?: string; + siteIds?: string[]; + sslCompliant?: boolean; + status?: string; + subaccountId?: string; + type?: string; + url?: string; + urlEscapeLevels?: number; + } + export interface EventTagOverride { + enabled?: boolean; + id?: string; + } + export interface EventTagsListResponse { + eventTags?: Dfareporting_v3_3.Schema.EventTag[]; + kind?: string; + } + export interface File { + dateRange?: Dfareporting_v3_3.Schema.DateRange; + etag?: string; + fileName?: string; + format?: string; + id?: string; + kind?: string; + lastModifiedTime?: string; + reportId?: string; + status?: string; + urls?: Dfareporting_v3_3.Schema.FileUrls; + } + export interface FileList { + etag?: string; + items?: Dfareporting_v3_3.Schema.File[]; + kind?: string; + nextPageToken?: string; + } + export interface FileUrls { + apiUrl?: string; + browserUrl?: string; + } + export interface Flight { + endDate?: string; + rateOrCost?: string; + startDate?: string; + units?: string; + } + export interface FloodlightActivitiesGenerateTagResponse { + floodlightActivityTag?: string; + globalSiteTagGlobalSnippet?: string; + kind?: string; + } + export interface FloodlightActivitiesListResponse { + floodlightActivities?: Dfareporting_v3_3.Schema.FloodlightActivity[]; + kind?: string; + nextPageToken?: string; + } + export interface FloodlightActivity { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + cacheBustingType?: string; + countingMethod?: string; + defaultTags?: Dfareporting_v3_3.Schema.FloodlightActivityDynamicTag[]; + expectedUrl?: string; + floodlightActivityGroupId?: string; + floodlightActivityGroupName?: string; + floodlightActivityGroupTagString?: string; + floodlightActivityGroupType?: string; + floodlightConfigurationId?: string; + floodlightConfigurationIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + floodlightTagType?: string; + hidden?: boolean; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + name?: string; + notes?: string; + publisherTags?: Dfareporting_v3_3.Schema.FloodlightActivityPublisherDynamicTag[]; + secure?: boolean; + sslCompliant?: boolean; + sslRequired?: boolean; + subaccountId?: string; + tagFormat?: string; + tagString?: string; + userDefinedVariableTypes?: string[]; + } + export interface FloodlightActivityDynamicTag { + id?: string; + name?: string; + tag?: string; + } + export interface FloodlightActivityGroup { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + floodlightConfigurationId?: string; + floodlightConfigurationIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + name?: string; + subaccountId?: string; + tagString?: string; + type?: string; + } + export interface FloodlightActivityGroupsListResponse { + floodlightActivityGroups?: Dfareporting_v3_3.Schema.FloodlightActivityGroup[]; + kind?: string; + nextPageToken?: string; + } + export interface FloodlightActivityPublisherDynamicTag { + clickThrough?: boolean; + directorySiteId?: string; + dynamicTag?: Dfareporting_v3_3.Schema.FloodlightActivityDynamicTag; + siteId?: string; + siteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + viewThrough?: boolean; + } + export interface FloodlightConfiguration { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + analyticsDataSharingEnabled?: boolean; + customViewabilityMetric?: Dfareporting_v3_3.Schema.CustomViewabilityMetric; + exposureToConversionEnabled?: boolean; + firstDayOfWeek?: string; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + inAppAttributionTrackingEnabled?: boolean; + kind?: string; + lookbackConfiguration?: Dfareporting_v3_3.Schema.LookbackConfiguration; + naturalSearchConversionAttributionOption?: string; + omnitureSettings?: Dfareporting_v3_3.Schema.OmnitureSettings; + subaccountId?: string; + tagSettings?: Dfareporting_v3_3.Schema.TagSettings; + thirdPartyAuthenticationTokens?: Dfareporting_v3_3.Schema.ThirdPartyAuthenticationToken[]; + userDefinedVariableConfigurations?: Dfareporting_v3_3.Schema.UserDefinedVariableConfiguration[]; + } + export interface FloodlightConfigurationsListResponse { + floodlightConfigurations?: Dfareporting_v3_3.Schema.FloodlightConfiguration[]; + kind?: string; + } + export interface FloodlightReportCompatibleFields { + dimensionFilters?: Dfareporting_v3_3.Schema.Dimension[]; + dimensions?: Dfareporting_v3_3.Schema.Dimension[]; + kind?: string; + metrics?: Dfareporting_v3_3.Schema.Metric[]; + } + export interface FrequencyCap { + duration?: string; + impressions?: string; + } + export interface FsCommand { + left?: number; + positionOption?: string; + top?: number; + windowHeight?: number; + windowWidth?: number; + } + export interface GeoTargeting { + cities?: Dfareporting_v3_3.Schema.City[]; + countries?: Dfareporting_v3_3.Schema.Country[]; + excludeCountries?: boolean; + metros?: Dfareporting_v3_3.Schema.Metro[]; + postalCodes?: Dfareporting_v3_3.Schema.PostalCode[]; + regions?: Dfareporting_v3_3.Schema.Region[]; + } + export interface InventoryItem { + accountId?: string; + adSlots?: Dfareporting_v3_3.Schema.AdSlot[]; + advertiserId?: string; + contentCategoryId?: string; + estimatedClickThroughRate?: string; + estimatedConversionRate?: string; + id?: string; + inPlan?: boolean; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + negotiationChannelId?: string; + orderId?: string; + placementStrategyId?: string; + pricing?: Dfareporting_v3_3.Schema.Pricing; + projectId?: string; + rfpId?: string; + siteId?: string; + subaccountId?: string; + type?: string; + } + export interface InventoryItemsListResponse { + inventoryItems?: Dfareporting_v3_3.Schema.InventoryItem[]; + kind?: string; + nextPageToken?: string; + } + export interface KeyValueTargetingExpression { + expression?: string; + } + export interface LandingPage { + advertiserId?: string; + archived?: boolean; + deepLinks?: Dfareporting_v3_3.Schema.DeepLink[]; + id?: string; + kind?: string; + name?: string; + url?: string; + } + export interface Language { + id?: string; + kind?: string; + languageCode?: string; + name?: string; + } + export interface LanguageTargeting { + languages?: Dfareporting_v3_3.Schema.Language[]; + } + export interface LanguagesListResponse { + kind?: string; + languages?: Dfareporting_v3_3.Schema.Language[]; + } + export interface LastModifiedInfo { + time?: string; + } + export interface ListPopulationClause { + terms?: Dfareporting_v3_3.Schema.ListPopulationTerm[]; + } + export interface ListPopulationRule { + floodlightActivityId?: string; + floodlightActivityName?: string; + listPopulationClauses?: Dfareporting_v3_3.Schema.ListPopulationClause[]; + } + export interface ListPopulationTerm { + contains?: boolean; + negation?: boolean; + operator?: string; + remarketingListId?: string; + type?: string; + value?: string; + variableFriendlyName?: string; + variableName?: string; + } + export interface ListTargetingExpression { + expression?: string; + } + export interface LookbackConfiguration { + clickDuration?: number; + postImpressionActivitiesDuration?: number; + } + export interface Metric { + kind?: string; + name?: string; + } + export interface Metro { + countryCode?: string; + countryDartId?: string; + dartId?: string; + dmaId?: string; + kind?: string; + metroCode?: string; + name?: string; + } + export interface MetrosListResponse { + kind?: string; + metros?: Dfareporting_v3_3.Schema.Metro[]; + } + export interface MobileApp { + directory?: string; + id?: string; + kind?: string; + publisherName?: string; + title?: string; + } + export interface MobileAppsListResponse { + kind?: string; + mobileApps?: Dfareporting_v3_3.Schema.MobileApp[]; + nextPageToken?: string; + } + export interface MobileCarrier { + countryCode?: string; + countryDartId?: string; + id?: string; + kind?: string; + name?: string; + } + export interface MobileCarriersListResponse { + kind?: string; + mobileCarriers?: Dfareporting_v3_3.Schema.MobileCarrier[]; + } + export interface ObjectFilter { + kind?: string; + objectIds?: string[]; + status?: string; + } + export interface OffsetPosition { + left?: number; + top?: number; + } + export interface OmnitureSettings { + omnitureCostDataEnabled?: boolean; + omnitureIntegrationEnabled?: boolean; + } + export interface OperatingSystem { + dartId?: string; + desktop?: boolean; + kind?: string; + mobile?: boolean; + name?: string; + } + export interface OperatingSystemVersion { + id?: string; + kind?: string; + majorVersion?: string; + minorVersion?: string; + name?: string; + operatingSystem?: Dfareporting_v3_3.Schema.OperatingSystem; + } + export interface OperatingSystemVersionsListResponse { + kind?: string; + operatingSystemVersions?: Dfareporting_v3_3.Schema.OperatingSystemVersion[]; + } + export interface OperatingSystemsListResponse { + kind?: string; + operatingSystems?: Dfareporting_v3_3.Schema.OperatingSystem[]; + } + export interface OptimizationActivity { + floodlightActivityId?: string; + floodlightActivityIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + weight?: number; + } + export interface Order { + accountId?: string; + advertiserId?: string; + approverUserProfileIds?: string[]; + buyerInvoiceId?: string; + buyerOrganizationName?: string; + comments?: string; + contacts?: Dfareporting_v3_3.Schema.OrderContact[]; + id?: string; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + notes?: string; + planningTermId?: string; + projectId?: string; + sellerOrderId?: string; + sellerOrganizationName?: string; + siteId?: string[]; + siteNames?: string[]; + subaccountId?: string; + termsAndConditions?: string; + } + export interface OrderContact { + contactInfo?: string; + contactName?: string; + contactTitle?: string; + contactType?: string; + signatureUserProfileId?: string; + } + export interface OrderDocument { + accountId?: string; + advertiserId?: string; + amendedOrderDocumentId?: string; + approvedByUserProfileIds?: string[]; + cancelled?: boolean; + createdInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + effectiveDate?: string; + id?: string; + kind?: string; + lastSentRecipients?: string[]; + lastSentTime?: string; + orderId?: string; + projectId?: string; + signed?: boolean; + subaccountId?: string; + title?: string; + type?: string; + } + export interface OrderDocumentsListResponse { + kind?: string; + nextPageToken?: string; + orderDocuments?: Dfareporting_v3_3.Schema.OrderDocument[]; + } + export interface OrdersListResponse { + kind?: string; + nextPageToken?: string; + orders?: Dfareporting_v3_3.Schema.Order[]; + } + export interface PathToConversionReportCompatibleFields { + conversionDimensions?: Dfareporting_v3_3.Schema.Dimension[]; + customFloodlightVariables?: Dfareporting_v3_3.Schema.Dimension[]; + kind?: string; + metrics?: Dfareporting_v3_3.Schema.Metric[]; + perInteractionDimensions?: Dfareporting_v3_3.Schema.Dimension[]; + } + export interface Placement { + accountId?: string; + adBlockingOptOut?: boolean; + additionalSizes?: Dfareporting_v3_3.Schema.Size[]; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + archived?: boolean; + campaignId?: string; + campaignIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + comment?: string; + compatibility?: string; + contentCategoryId?: string; + createInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + directorySiteId?: string; + directorySiteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + externalId?: string; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + keyName?: string; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + lookbackConfiguration?: Dfareporting_v3_3.Schema.LookbackConfiguration; + name?: string; + paymentApproved?: boolean; + paymentSource?: string; + placementGroupId?: string; + placementGroupIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + placementStrategyId?: string; + pricingSchedule?: Dfareporting_v3_3.Schema.PricingSchedule; + primary?: boolean; + publisherUpdateInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + siteId?: string; + siteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + size?: Dfareporting_v3_3.Schema.Size; + sslRequired?: boolean; + status?: string; + subaccountId?: string; + tagFormats?: string[]; + tagSetting?: Dfareporting_v3_3.Schema.TagSetting; + videoActiveViewOptOut?: boolean; + videoSettings?: Dfareporting_v3_3.Schema.VideoSettings; + vpaidAdapterChoice?: string; + } + export interface PlacementAssignment { + active?: boolean; + placementId?: string; + placementIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + sslRequired?: boolean; + } + export interface PlacementGroup { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + archived?: boolean; + campaignId?: string; + campaignIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + childPlacementIds?: string[]; + comment?: string; + contentCategoryId?: string; + createInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + directorySiteId?: string; + directorySiteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + externalId?: string; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + placementGroupType?: string; + placementStrategyId?: string; + pricingSchedule?: Dfareporting_v3_3.Schema.PricingSchedule; + primaryPlacementId?: string; + primaryPlacementIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + siteId?: string; + siteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + subaccountId?: string; + } + export interface PlacementGroupsListResponse { + kind?: string; + nextPageToken?: string; + placementGroups?: Dfareporting_v3_3.Schema.PlacementGroup[]; + } + export interface PlacementStrategiesListResponse { + kind?: string; + nextPageToken?: string; + placementStrategies?: Dfareporting_v3_3.Schema.PlacementStrategy[]; + } + export interface PlacementStrategy { + accountId?: string; + id?: string; + kind?: string; + name?: string; + } + export interface PlacementTag { + placementId?: string; + tagDatas?: Dfareporting_v3_3.Schema.TagData[]; + } + export interface PlacementsGenerateTagsResponse { + kind?: string; + placementTags?: Dfareporting_v3_3.Schema.PlacementTag[]; + } + export interface PlacementsListResponse { + kind?: string; + nextPageToken?: string; + placements?: Dfareporting_v3_3.Schema.Placement[]; + } + export interface PlatformType { + id?: string; + kind?: string; + name?: string; + } + export interface PlatformTypesListResponse { + kind?: string; + platformTypes?: Dfareporting_v3_3.Schema.PlatformType[]; + } + export interface PopupWindowProperties { + dimension?: Dfareporting_v3_3.Schema.Size; + offset?: Dfareporting_v3_3.Schema.OffsetPosition; + positionType?: string; + showAddressBar?: boolean; + showMenuBar?: boolean; + showScrollBar?: boolean; + showStatusBar?: boolean; + showToolBar?: boolean; + title?: string; + } + export interface PostalCode { + code?: string; + countryCode?: string; + countryDartId?: string; + id?: string; + kind?: string; + } + export interface PostalCodesListResponse { + kind?: string; + postalCodes?: Dfareporting_v3_3.Schema.PostalCode[]; + } + export interface Pricing { + capCostType?: string; + endDate?: string; + flights?: Dfareporting_v3_3.Schema.Flight[]; + groupType?: string; + pricingType?: string; + startDate?: string; + } + export interface PricingSchedule { + capCostOption?: string; + disregardOverdelivery?: boolean; + endDate?: string; + flighted?: boolean; + floodlightActivityId?: string; + pricingPeriods?: Dfareporting_v3_3.Schema.PricingSchedulePricingPeriod[]; + pricingType?: string; + startDate?: string; + testingStartDate?: string; + } + export interface PricingSchedulePricingPeriod { + endDate?: string; + pricingComment?: string; + rateOrCostNanos?: string; + startDate?: string; + units?: string; + } + export interface Project { + accountId?: string; + advertiserId?: string; + audienceAgeGroup?: string; + audienceGender?: string; + budget?: string; + clientBillingCode?: string; + clientName?: string; + endDate?: string; + id?: string; + kind?: string; + lastModifiedInfo?: Dfareporting_v3_3.Schema.LastModifiedInfo; + name?: string; + overview?: string; + startDate?: string; + subaccountId?: string; + targetClicks?: string; + targetConversions?: string; + targetCpaNanos?: string; + targetCpcNanos?: string; + targetCpmActiveViewNanos?: string; + targetCpmNanos?: string; + targetImpressions?: string; + } + export interface ProjectsListResponse { + kind?: string; + nextPageToken?: string; + projects?: Dfareporting_v3_3.Schema.Project[]; + } + export interface ReachReportCompatibleFields { + dimensionFilters?: Dfareporting_v3_3.Schema.Dimension[]; + dimensions?: Dfareporting_v3_3.Schema.Dimension[]; + kind?: string; + metrics?: Dfareporting_v3_3.Schema.Metric[]; + pivotedActivityMetrics?: Dfareporting_v3_3.Schema.Metric[]; + reachByFrequencyMetrics?: Dfareporting_v3_3.Schema.Metric[]; + } + export interface Recipient { + deliveryType?: string; + email?: string; + kind?: string; + } + export interface Region { + countryCode?: string; + countryDartId?: string; + dartId?: string; + kind?: string; + name?: string; + regionCode?: string; + } + export interface RegionsListResponse { + kind?: string; + regions?: Dfareporting_v3_3.Schema.Region[]; + } + export interface RemarketingList { + accountId?: string; + active?: boolean; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + description?: string; + id?: string; + kind?: string; + lifeSpan?: string; + listPopulationRule?: Dfareporting_v3_3.Schema.ListPopulationRule; + listSize?: string; + listSource?: string; + name?: string; + subaccountId?: string; + } + export interface RemarketingListShare { + kind?: string; + remarketingListId?: string; + sharedAccountIds?: string[]; + sharedAdvertiserIds?: string[]; + } + export interface RemarketingListsListResponse { + kind?: string; + nextPageToken?: string; + remarketingLists?: Dfareporting_v3_3.Schema.RemarketingList[]; + } + export interface Report { + accountId?: string; + criteria?: Dfareporting_v3_3.Schema.ReportCriteria; + crossDimensionReachCriteria?: Dfareporting_v3_3.Schema.ReportCrossDimensionReachCriteria; + delivery?: Dfareporting_v3_3.Schema.ReportDelivery; + etag?: string; + fileName?: string; + floodlightCriteria?: Dfareporting_v3_3.Schema.ReportFloodlightCriteria; + format?: string; + id?: string; + kind?: string; + lastModifiedTime?: string; + name?: string; + ownerProfileId?: string; + pathToConversionCriteria?: Dfareporting_v3_3.Schema.ReportPathToConversionCriteria; + reachCriteria?: Dfareporting_v3_3.Schema.ReportReachCriteria; + schedule?: Dfareporting_v3_3.Schema.ReportSchedule; + subAccountId?: string; + type?: string; + } + export interface ReportCompatibleFields { + dimensionFilters?: Dfareporting_v3_3.Schema.Dimension[]; + dimensions?: Dfareporting_v3_3.Schema.Dimension[]; + kind?: string; + metrics?: Dfareporting_v3_3.Schema.Metric[]; + pivotedActivityMetrics?: Dfareporting_v3_3.Schema.Metric[]; + } + export interface ReportCriteria { + activities?: Dfareporting_v3_3.Schema.Activities; + customRichMediaEvents?: Dfareporting_v3_3.Schema.CustomRichMediaEvents; + dateRange?: Dfareporting_v3_3.Schema.DateRange; + dimensionFilters?: Dfareporting_v3_3.Schema.DimensionValue[]; + dimensions?: Dfareporting_v3_3.Schema.SortedDimension[]; + metricNames?: string[]; + } + export interface ReportCrossDimensionReachCriteria { + breakdown?: Dfareporting_v3_3.Schema.SortedDimension[]; + dateRange?: Dfareporting_v3_3.Schema.DateRange; + dimension?: string; + dimensionFilters?: Dfareporting_v3_3.Schema.DimensionValue[]; + metricNames?: string[]; + overlapMetricNames?: string[]; + pivoted?: boolean; + } + export interface ReportDelivery { + emailOwner?: boolean; + emailOwnerDeliveryType?: string; + message?: string; + recipients?: Dfareporting_v3_3.Schema.Recipient[]; + } + export interface ReportFloodlightCriteria { + customRichMediaEvents?: Dfareporting_v3_3.Schema.DimensionValue[]; + dateRange?: Dfareporting_v3_3.Schema.DateRange; + dimensionFilters?: Dfareporting_v3_3.Schema.DimensionValue[]; + dimensions?: Dfareporting_v3_3.Schema.SortedDimension[]; + floodlightConfigId?: Dfareporting_v3_3.Schema.DimensionValue; + metricNames?: string[]; + reportProperties?: Dfareporting_v3_3.Schema.ReportFloodlightCriteriaReportProperties; + } + export interface ReportFloodlightCriteriaReportProperties { + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + } + export interface ReportList { + etag?: string; + items?: Dfareporting_v3_3.Schema.Report[]; + kind?: string; + nextPageToken?: string; + } + export interface ReportPathToConversionCriteria { + activityFilters?: Dfareporting_v3_3.Schema.DimensionValue[]; + conversionDimensions?: Dfareporting_v3_3.Schema.SortedDimension[]; + customFloodlightVariables?: Dfareporting_v3_3.Schema.SortedDimension[]; + customRichMediaEvents?: Dfareporting_v3_3.Schema.DimensionValue[]; + dateRange?: Dfareporting_v3_3.Schema.DateRange; + floodlightConfigId?: Dfareporting_v3_3.Schema.DimensionValue; + metricNames?: string[]; + perInteractionDimensions?: Dfareporting_v3_3.Schema.SortedDimension[]; + reportProperties?: Dfareporting_v3_3.Schema.ReportPathToConversionCriteriaReportProperties; + } + export interface ReportPathToConversionCriteriaReportProperties { + clicksLookbackWindow?: number; + impressionsLookbackWindow?: number; + includeAttributedIPConversions?: boolean; + includeUnattributedCookieConversions?: boolean; + includeUnattributedIPConversions?: boolean; + maximumClickInteractions?: number; + maximumImpressionInteractions?: number; + maximumInteractionGap?: number; + pivotOnInteractionPath?: boolean; + } + export interface ReportReachCriteria { + activities?: Dfareporting_v3_3.Schema.Activities; + customRichMediaEvents?: Dfareporting_v3_3.Schema.CustomRichMediaEvents; + dateRange?: Dfareporting_v3_3.Schema.DateRange; + dimensionFilters?: Dfareporting_v3_3.Schema.DimensionValue[]; + dimensions?: Dfareporting_v3_3.Schema.SortedDimension[]; + enableAllDimensionCombinations?: boolean; + metricNames?: string[]; + reachByFrequencyMetricNames?: string[]; + } + export interface ReportSchedule { + active?: boolean; + every?: number; + expirationDate?: string; + repeats?: string; + repeatsOnWeekDays?: string[]; + runsOnDayOfMonth?: string; + startDate?: string; + } + export interface ReportsConfiguration { + exposureToConversionEnabled?: boolean; + lookbackConfiguration?: Dfareporting_v3_3.Schema.LookbackConfiguration; + reportGenerationTimeZoneId?: string; + } + export interface RichMediaExitOverride { + clickThroughUrl?: Dfareporting_v3_3.Schema.ClickThroughUrl; + enabled?: boolean; + exitId?: string; + } + export interface Rule { + assetId?: string; + name?: string; + targetingTemplateId?: string; + } + export interface Site { + accountId?: string; + approved?: boolean; + directorySiteId?: string; + directorySiteIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + id?: string; + idDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + keyName?: string; + kind?: string; + name?: string; + siteContacts?: Dfareporting_v3_3.Schema.SiteContact[]; + siteSettings?: Dfareporting_v3_3.Schema.SiteSettings; + subaccountId?: string; + videoSettings?: Dfareporting_v3_3.Schema.SiteVideoSettings; + } + export interface SiteCompanionSetting { + companionsDisabled?: boolean; + enabledSizes?: Dfareporting_v3_3.Schema.Size[]; + imageOnly?: boolean; + kind?: string; + } + export interface SiteContact { + address?: string; + contactType?: string; + email?: string; + firstName?: string; + id?: string; + lastName?: string; + phone?: string; + title?: string; + } + export interface SiteSettings { + activeViewOptOut?: boolean; + adBlockingOptOut?: boolean; + disableNewCookie?: boolean; + tagSetting?: Dfareporting_v3_3.Schema.TagSetting; + videoActiveViewOptOutTemplate?: boolean; + vpaidAdapterChoiceTemplate?: string; + } + export interface SiteSkippableSetting { + kind?: string; + progressOffset?: Dfareporting_v3_3.Schema.VideoOffset; + skipOffset?: Dfareporting_v3_3.Schema.VideoOffset; + skippable?: boolean; + } + export interface SiteTranscodeSetting { + enabledVideoFormats?: number[]; + kind?: string; + } + export interface SiteVideoSettings { + companionSettings?: Dfareporting_v3_3.Schema.SiteCompanionSetting; + kind?: string; + orientation?: string; + skippableSettings?: Dfareporting_v3_3.Schema.SiteSkippableSetting; + transcodeSettings?: Dfareporting_v3_3.Schema.SiteTranscodeSetting; + } + export interface SitesListResponse { + kind?: string; + nextPageToken?: string; + sites?: Dfareporting_v3_3.Schema.Site[]; + } + export interface Size { + height?: number; + iab?: boolean; + id?: string; + kind?: string; + width?: number; + } + export interface SizesListResponse { + kind?: string; + sizes?: Dfareporting_v3_3.Schema.Size[]; + } + export interface SkippableSetting { + kind?: string; + progressOffset?: Dfareporting_v3_3.Schema.VideoOffset; + skipOffset?: Dfareporting_v3_3.Schema.VideoOffset; + skippable?: boolean; + } + export interface SortedDimension { + kind?: string; + name?: string; + sortOrder?: string; + } + export interface Subaccount { + accountId?: string; + availablePermissionIds?: string[]; + id?: string; + kind?: string; + name?: string; + } + export interface SubaccountsListResponse { + kind?: string; + nextPageToken?: string; + subaccounts?: Dfareporting_v3_3.Schema.Subaccount[]; + } + export interface TagData { + adId?: string; + clickTag?: string; + creativeId?: string; + format?: string; + impressionTag?: string; + } + export interface TagSetting { + additionalKeyValues?: string; + includeClickThroughUrls?: boolean; + includeClickTracking?: boolean; + keywordOption?: string; + } + export interface TagSettings { + dynamicTagEnabled?: boolean; + imageTagEnabled?: boolean; + } + export interface TargetWindow { + customHtml?: string; + targetWindowOption?: string; + } + export interface TargetableRemarketingList { + accountId?: string; + active?: boolean; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + description?: string; + id?: string; + kind?: string; + lifeSpan?: string; + listSize?: string; + listSource?: string; + name?: string; + subaccountId?: string; + } + export interface TargetableRemarketingListsListResponse { + kind?: string; + nextPageToken?: string; + targetableRemarketingLists?: Dfareporting_v3_3.Schema.TargetableRemarketingList[]; + } + export interface TargetingTemplate { + accountId?: string; + advertiserId?: string; + advertiserIdDimensionValue?: Dfareporting_v3_3.Schema.DimensionValue; + dayPartTargeting?: Dfareporting_v3_3.Schema.DayPartTargeting; + geoTargeting?: Dfareporting_v3_3.Schema.GeoTargeting; + id?: string; + keyValueTargetingExpression?: Dfareporting_v3_3.Schema.KeyValueTargetingExpression; + kind?: string; + languageTargeting?: Dfareporting_v3_3.Schema.LanguageTargeting; + listTargetingExpression?: Dfareporting_v3_3.Schema.ListTargetingExpression; + name?: string; + subaccountId?: string; + technologyTargeting?: Dfareporting_v3_3.Schema.TechnologyTargeting; + } + export interface TargetingTemplatesListResponse { + kind?: string; + nextPageToken?: string; + targetingTemplates?: Dfareporting_v3_3.Schema.TargetingTemplate[]; + } + export interface TechnologyTargeting { + browsers?: Dfareporting_v3_3.Schema.Browser[]; + connectionTypes?: Dfareporting_v3_3.Schema.ConnectionType[]; + mobileCarriers?: Dfareporting_v3_3.Schema.MobileCarrier[]; + operatingSystemVersions?: Dfareporting_v3_3.Schema.OperatingSystemVersion[]; + operatingSystems?: Dfareporting_v3_3.Schema.OperatingSystem[]; + platformTypes?: Dfareporting_v3_3.Schema.PlatformType[]; + } + export interface ThirdPartyAuthenticationToken { + name?: string; + value?: string; + } + export interface ThirdPartyTrackingUrl { + thirdPartyUrlType?: string; + url?: string; + } + export interface TranscodeSetting { + enabledVideoFormats?: number[]; + kind?: string; + } + export interface UniversalAdId { + registry?: string; + value?: string; + } + export interface UserDefinedVariableConfiguration { + dataType?: string; + reportName?: string; + variableType?: string; + } + export interface UserProfile { + accountId?: string; + accountName?: string; + etag?: string; + kind?: string; + profileId?: string; + subAccountId?: string; + subAccountName?: string; + userName?: string; + } + export interface UserProfileList { + etag?: string; + items?: Dfareporting_v3_3.Schema.UserProfile[]; + kind?: string; + } + export interface UserRole { + accountId?: string; + defaultUserRole?: boolean; + id?: string; + kind?: string; + name?: string; + parentUserRoleId?: string; + permissions?: Dfareporting_v3_3.Schema.UserRolePermission[]; + subaccountId?: string; + } + export interface UserRolePermission { + availability?: string; + id?: string; + kind?: string; + name?: string; + permissionGroupId?: string; + } + export interface UserRolePermissionGroup { + id?: string; + kind?: string; + name?: string; + } + export interface UserRolePermissionGroupsListResponse { + kind?: string; + userRolePermissionGroups?: Dfareporting_v3_3.Schema.UserRolePermissionGroup[]; + } + export interface UserRolePermissionsListResponse { + kind?: string; + userRolePermissions?: Dfareporting_v3_3.Schema.UserRolePermission[]; + } + export interface UserRolesListResponse { + kind?: string; + nextPageToken?: string; + userRoles?: Dfareporting_v3_3.Schema.UserRole[]; + } + export interface VideoFormat { + fileType?: string; + id?: number; + kind?: string; + resolution?: Dfareporting_v3_3.Schema.Size; + targetBitRate?: number; + } + export interface VideoFormatsListResponse { + kind?: string; + videoFormats?: Dfareporting_v3_3.Schema.VideoFormat[]; + } + export interface VideoOffset { + offsetPercentage?: number; + offsetSeconds?: number; + } + export interface VideoSettings { + companionSettings?: Dfareporting_v3_3.Schema.CompanionSetting; + kind?: string; + orientation?: string; + skippableSettings?: Dfareporting_v3_3.Schema.SkippableSetting; + transcodeSettings?: Dfareporting_v3_3.Schema.TranscodeSetting; + } + } + } + export interface Dfareporting_v3_3 { + AccountActiveAdSummaries?: Dfareporting_v3_3.Collection.AccountActiveAdSummariesCollection; + AccountPermissionGroups?: Dfareporting_v3_3.Collection.AccountPermissionGroupsCollection; + AccountPermissions?: Dfareporting_v3_3.Collection.AccountPermissionsCollection; + AccountUserProfiles?: Dfareporting_v3_3.Collection.AccountUserProfilesCollection; + Accounts?: Dfareporting_v3_3.Collection.AccountsCollection; + Ads?: Dfareporting_v3_3.Collection.AdsCollection; + AdvertiserGroups?: Dfareporting_v3_3.Collection.AdvertiserGroupsCollection; + AdvertiserLandingPages?: Dfareporting_v3_3.Collection.AdvertiserLandingPagesCollection; + Advertisers?: Dfareporting_v3_3.Collection.AdvertisersCollection; + Browsers?: Dfareporting_v3_3.Collection.BrowsersCollection; + CampaignCreativeAssociations?: Dfareporting_v3_3.Collection.CampaignCreativeAssociationsCollection; + Campaigns?: Dfareporting_v3_3.Collection.CampaignsCollection; + ChangeLogs?: Dfareporting_v3_3.Collection.ChangeLogsCollection; + Cities?: Dfareporting_v3_3.Collection.CitiesCollection; + ConnectionTypes?: Dfareporting_v3_3.Collection.ConnectionTypesCollection; + ContentCategories?: Dfareporting_v3_3.Collection.ContentCategoriesCollection; + Conversions?: Dfareporting_v3_3.Collection.ConversionsCollection; + Countries?: Dfareporting_v3_3.Collection.CountriesCollection; + CreativeAssets?: Dfareporting_v3_3.Collection.CreativeAssetsCollection; + CreativeFieldValues?: Dfareporting_v3_3.Collection.CreativeFieldValuesCollection; + CreativeFields?: Dfareporting_v3_3.Collection.CreativeFieldsCollection; + CreativeGroups?: Dfareporting_v3_3.Collection.CreativeGroupsCollection; + Creatives?: Dfareporting_v3_3.Collection.CreativesCollection; + DimensionValues?: Dfareporting_v3_3.Collection.DimensionValuesCollection; + DirectorySites?: Dfareporting_v3_3.Collection.DirectorySitesCollection; + DynamicTargetingKeys?: Dfareporting_v3_3.Collection.DynamicTargetingKeysCollection; + EventTags?: Dfareporting_v3_3.Collection.EventTagsCollection; + Files?: Dfareporting_v3_3.Collection.FilesCollection; + FloodlightActivities?: Dfareporting_v3_3.Collection.FloodlightActivitiesCollection; + FloodlightActivityGroups?: Dfareporting_v3_3.Collection.FloodlightActivityGroupsCollection; + FloodlightConfigurations?: Dfareporting_v3_3.Collection.FloodlightConfigurationsCollection; + InventoryItems?: Dfareporting_v3_3.Collection.InventoryItemsCollection; + Languages?: Dfareporting_v3_3.Collection.LanguagesCollection; + Metros?: Dfareporting_v3_3.Collection.MetrosCollection; + MobileApps?: Dfareporting_v3_3.Collection.MobileAppsCollection; + MobileCarriers?: Dfareporting_v3_3.Collection.MobileCarriersCollection; + OperatingSystemVersions?: Dfareporting_v3_3.Collection.OperatingSystemVersionsCollection; + OperatingSystems?: Dfareporting_v3_3.Collection.OperatingSystemsCollection; + OrderDocuments?: Dfareporting_v3_3.Collection.OrderDocumentsCollection; + Orders?: Dfareporting_v3_3.Collection.OrdersCollection; + PlacementGroups?: Dfareporting_v3_3.Collection.PlacementGroupsCollection; + PlacementStrategies?: Dfareporting_v3_3.Collection.PlacementStrategiesCollection; + Placements?: Dfareporting_v3_3.Collection.PlacementsCollection; + PlatformTypes?: Dfareporting_v3_3.Collection.PlatformTypesCollection; + PostalCodes?: Dfareporting_v3_3.Collection.PostalCodesCollection; + Projects?: Dfareporting_v3_3.Collection.ProjectsCollection; + Regions?: Dfareporting_v3_3.Collection.RegionsCollection; + RemarketingListShares?: Dfareporting_v3_3.Collection.RemarketingListSharesCollection; + RemarketingLists?: Dfareporting_v3_3.Collection.RemarketingListsCollection; + Reports?: Dfareporting_v3_3.Collection.ReportsCollection; + Sites?: Dfareporting_v3_3.Collection.SitesCollection; + Sizes?: Dfareporting_v3_3.Collection.SizesCollection; + Subaccounts?: Dfareporting_v3_3.Collection.SubaccountsCollection; + TargetableRemarketingLists?: Dfareporting_v3_3.Collection.TargetableRemarketingListsCollection; + TargetingTemplates?: Dfareporting_v3_3.Collection.TargetingTemplatesCollection; + UserProfiles?: Dfareporting_v3_3.Collection.UserProfilesCollection; + UserRolePermissionGroups?: Dfareporting_v3_3.Collection.UserRolePermissionGroupsCollection; + UserRolePermissions?: Dfareporting_v3_3.Collection.UserRolePermissionsCollection; + UserRoles?: Dfareporting_v3_3.Collection.UserRolesCollection; + VideoFormats?: Dfareporting_v3_3.Collection.VideoFormatsCollection; + // Create a new instance of Account + newAccount(): Dfareporting_v3_3.Schema.Account; + // Create a new instance of AccountUserProfile + newAccountUserProfile(): Dfareporting_v3_3.Schema.AccountUserProfile; + // Create a new instance of Activities + newActivities(): Dfareporting_v3_3.Schema.Activities; + // Create a new instance of Ad + newAd(): Dfareporting_v3_3.Schema.Ad; + // Create a new instance of AdBlockingConfiguration + newAdBlockingConfiguration(): Dfareporting_v3_3.Schema.AdBlockingConfiguration; + // Create a new instance of Advertiser + newAdvertiser(): Dfareporting_v3_3.Schema.Advertiser; + // Create a new instance of AdvertiserGroup + newAdvertiserGroup(): Dfareporting_v3_3.Schema.AdvertiserGroup; + // Create a new instance of AudienceSegment + newAudienceSegment(): Dfareporting_v3_3.Schema.AudienceSegment; + // Create a new instance of AudienceSegmentGroup + newAudienceSegmentGroup(): Dfareporting_v3_3.Schema.AudienceSegmentGroup; + // Create a new instance of Browser + newBrowser(): Dfareporting_v3_3.Schema.Browser; + // Create a new instance of Campaign + newCampaign(): Dfareporting_v3_3.Schema.Campaign; + // Create a new instance of CampaignCreativeAssociation + newCampaignCreativeAssociation(): Dfareporting_v3_3.Schema.CampaignCreativeAssociation; + // Create a new instance of City + newCity(): Dfareporting_v3_3.Schema.City; + // Create a new instance of ClickTag + newClickTag(): Dfareporting_v3_3.Schema.ClickTag; + // Create a new instance of ClickThroughUrl + newClickThroughUrl(): Dfareporting_v3_3.Schema.ClickThroughUrl; + // Create a new instance of ClickThroughUrlSuffixProperties + newClickThroughUrlSuffixProperties(): Dfareporting_v3_3.Schema.ClickThroughUrlSuffixProperties; + // Create a new instance of CompanionClickThroughOverride + newCompanionClickThroughOverride(): Dfareporting_v3_3.Schema.CompanionClickThroughOverride; + // Create a new instance of CompanionSetting + newCompanionSetting(): Dfareporting_v3_3.Schema.CompanionSetting; + // Create a new instance of ConnectionType + newConnectionType(): Dfareporting_v3_3.Schema.ConnectionType; + // Create a new instance of ContentCategory + newContentCategory(): Dfareporting_v3_3.Schema.ContentCategory; + // Create a new instance of Conversion + newConversion(): Dfareporting_v3_3.Schema.Conversion; + // Create a new instance of ConversionsBatchInsertRequest + newConversionsBatchInsertRequest(): Dfareporting_v3_3.Schema.ConversionsBatchInsertRequest; + // Create a new instance of ConversionsBatchUpdateRequest + newConversionsBatchUpdateRequest(): Dfareporting_v3_3.Schema.ConversionsBatchUpdateRequest; + // Create a new instance of Country + newCountry(): Dfareporting_v3_3.Schema.Country; + // Create a new instance of Creative + newCreative(): Dfareporting_v3_3.Schema.Creative; + // Create a new instance of CreativeAsset + newCreativeAsset(): Dfareporting_v3_3.Schema.CreativeAsset; + // Create a new instance of CreativeAssetId + newCreativeAssetId(): Dfareporting_v3_3.Schema.CreativeAssetId; + // Create a new instance of CreativeAssetMetadata + newCreativeAssetMetadata(): Dfareporting_v3_3.Schema.CreativeAssetMetadata; + // Create a new instance of CreativeAssetSelection + newCreativeAssetSelection(): Dfareporting_v3_3.Schema.CreativeAssetSelection; + // Create a new instance of CreativeAssignment + newCreativeAssignment(): Dfareporting_v3_3.Schema.CreativeAssignment; + // Create a new instance of CreativeClickThroughUrl + newCreativeClickThroughUrl(): Dfareporting_v3_3.Schema.CreativeClickThroughUrl; + // Create a new instance of CreativeCustomEvent + newCreativeCustomEvent(): Dfareporting_v3_3.Schema.CreativeCustomEvent; + // Create a new instance of CreativeField + newCreativeField(): Dfareporting_v3_3.Schema.CreativeField; + // Create a new instance of CreativeFieldAssignment + newCreativeFieldAssignment(): Dfareporting_v3_3.Schema.CreativeFieldAssignment; + // Create a new instance of CreativeFieldValue + newCreativeFieldValue(): Dfareporting_v3_3.Schema.CreativeFieldValue; + // Create a new instance of CreativeGroup + newCreativeGroup(): Dfareporting_v3_3.Schema.CreativeGroup; + // Create a new instance of CreativeGroupAssignment + newCreativeGroupAssignment(): Dfareporting_v3_3.Schema.CreativeGroupAssignment; + // Create a new instance of CreativeOptimizationConfiguration + newCreativeOptimizationConfiguration(): Dfareporting_v3_3.Schema.CreativeOptimizationConfiguration; + // Create a new instance of CreativeRotation + newCreativeRotation(): Dfareporting_v3_3.Schema.CreativeRotation; + // Create a new instance of CustomFloodlightVariable + newCustomFloodlightVariable(): Dfareporting_v3_3.Schema.CustomFloodlightVariable; + // Create a new instance of CustomRichMediaEvents + newCustomRichMediaEvents(): Dfareporting_v3_3.Schema.CustomRichMediaEvents; + // Create a new instance of CustomViewabilityMetric + newCustomViewabilityMetric(): Dfareporting_v3_3.Schema.CustomViewabilityMetric; + // Create a new instance of CustomViewabilityMetricConfiguration + newCustomViewabilityMetricConfiguration(): Dfareporting_v3_3.Schema.CustomViewabilityMetricConfiguration; + // Create a new instance of DateRange + newDateRange(): Dfareporting_v3_3.Schema.DateRange; + // Create a new instance of DayPartTargeting + newDayPartTargeting(): Dfareporting_v3_3.Schema.DayPartTargeting; + // Create a new instance of DeepLink + newDeepLink(): Dfareporting_v3_3.Schema.DeepLink; + // Create a new instance of DefaultClickThroughEventTagProperties + newDefaultClickThroughEventTagProperties(): Dfareporting_v3_3.Schema.DefaultClickThroughEventTagProperties; + // Create a new instance of DeliverySchedule + newDeliverySchedule(): Dfareporting_v3_3.Schema.DeliverySchedule; + // Create a new instance of DfpSettings + newDfpSettings(): Dfareporting_v3_3.Schema.DfpSettings; + // Create a new instance of DimensionFilter + newDimensionFilter(): Dfareporting_v3_3.Schema.DimensionFilter; + // Create a new instance of DimensionValue + newDimensionValue(): Dfareporting_v3_3.Schema.DimensionValue; + // Create a new instance of DimensionValueRequest + newDimensionValueRequest(): Dfareporting_v3_3.Schema.DimensionValueRequest; + // Create a new instance of DirectorySite + newDirectorySite(): Dfareporting_v3_3.Schema.DirectorySite; + // Create a new instance of DirectorySiteSettings + newDirectorySiteSettings(): Dfareporting_v3_3.Schema.DirectorySiteSettings; + // Create a new instance of DynamicTargetingKey + newDynamicTargetingKey(): Dfareporting_v3_3.Schema.DynamicTargetingKey; + // Create a new instance of EncryptionInfo + newEncryptionInfo(): Dfareporting_v3_3.Schema.EncryptionInfo; + // Create a new instance of EventTag + newEventTag(): Dfareporting_v3_3.Schema.EventTag; + // Create a new instance of EventTagOverride + newEventTagOverride(): Dfareporting_v3_3.Schema.EventTagOverride; + // Create a new instance of FloodlightActivity + newFloodlightActivity(): Dfareporting_v3_3.Schema.FloodlightActivity; + // Create a new instance of FloodlightActivityDynamicTag + newFloodlightActivityDynamicTag(): Dfareporting_v3_3.Schema.FloodlightActivityDynamicTag; + // Create a new instance of FloodlightActivityGroup + newFloodlightActivityGroup(): Dfareporting_v3_3.Schema.FloodlightActivityGroup; + // Create a new instance of FloodlightActivityPublisherDynamicTag + newFloodlightActivityPublisherDynamicTag(): Dfareporting_v3_3.Schema.FloodlightActivityPublisherDynamicTag; + // Create a new instance of FloodlightConfiguration + newFloodlightConfiguration(): Dfareporting_v3_3.Schema.FloodlightConfiguration; + // Create a new instance of FrequencyCap + newFrequencyCap(): Dfareporting_v3_3.Schema.FrequencyCap; + // Create a new instance of FsCommand + newFsCommand(): Dfareporting_v3_3.Schema.FsCommand; + // Create a new instance of GeoTargeting + newGeoTargeting(): Dfareporting_v3_3.Schema.GeoTargeting; + // Create a new instance of KeyValueTargetingExpression + newKeyValueTargetingExpression(): Dfareporting_v3_3.Schema.KeyValueTargetingExpression; + // Create a new instance of LandingPage + newLandingPage(): Dfareporting_v3_3.Schema.LandingPage; + // Create a new instance of Language + newLanguage(): Dfareporting_v3_3.Schema.Language; + // Create a new instance of LanguageTargeting + newLanguageTargeting(): Dfareporting_v3_3.Schema.LanguageTargeting; + // Create a new instance of LastModifiedInfo + newLastModifiedInfo(): Dfareporting_v3_3.Schema.LastModifiedInfo; + // Create a new instance of ListPopulationClause + newListPopulationClause(): Dfareporting_v3_3.Schema.ListPopulationClause; + // Create a new instance of ListPopulationRule + newListPopulationRule(): Dfareporting_v3_3.Schema.ListPopulationRule; + // Create a new instance of ListPopulationTerm + newListPopulationTerm(): Dfareporting_v3_3.Schema.ListPopulationTerm; + // Create a new instance of ListTargetingExpression + newListTargetingExpression(): Dfareporting_v3_3.Schema.ListTargetingExpression; + // Create a new instance of LookbackConfiguration + newLookbackConfiguration(): Dfareporting_v3_3.Schema.LookbackConfiguration; + // Create a new instance of Metro + newMetro(): Dfareporting_v3_3.Schema.Metro; + // Create a new instance of MobileApp + newMobileApp(): Dfareporting_v3_3.Schema.MobileApp; + // Create a new instance of MobileCarrier + newMobileCarrier(): Dfareporting_v3_3.Schema.MobileCarrier; + // Create a new instance of ObjectFilter + newObjectFilter(): Dfareporting_v3_3.Schema.ObjectFilter; + // Create a new instance of OffsetPosition + newOffsetPosition(): Dfareporting_v3_3.Schema.OffsetPosition; + // Create a new instance of OmnitureSettings + newOmnitureSettings(): Dfareporting_v3_3.Schema.OmnitureSettings; + // Create a new instance of OperatingSystem + newOperatingSystem(): Dfareporting_v3_3.Schema.OperatingSystem; + // Create a new instance of OperatingSystemVersion + newOperatingSystemVersion(): Dfareporting_v3_3.Schema.OperatingSystemVersion; + // Create a new instance of OptimizationActivity + newOptimizationActivity(): Dfareporting_v3_3.Schema.OptimizationActivity; + // Create a new instance of Placement + newPlacement(): Dfareporting_v3_3.Schema.Placement; + // Create a new instance of PlacementAssignment + newPlacementAssignment(): Dfareporting_v3_3.Schema.PlacementAssignment; + // Create a new instance of PlacementGroup + newPlacementGroup(): Dfareporting_v3_3.Schema.PlacementGroup; + // Create a new instance of PlacementStrategy + newPlacementStrategy(): Dfareporting_v3_3.Schema.PlacementStrategy; + // Create a new instance of PlatformType + newPlatformType(): Dfareporting_v3_3.Schema.PlatformType; + // Create a new instance of PopupWindowProperties + newPopupWindowProperties(): Dfareporting_v3_3.Schema.PopupWindowProperties; + // Create a new instance of PostalCode + newPostalCode(): Dfareporting_v3_3.Schema.PostalCode; + // Create a new instance of PricingSchedule + newPricingSchedule(): Dfareporting_v3_3.Schema.PricingSchedule; + // Create a new instance of PricingSchedulePricingPeriod + newPricingSchedulePricingPeriod(): Dfareporting_v3_3.Schema.PricingSchedulePricingPeriod; + // Create a new instance of Recipient + newRecipient(): Dfareporting_v3_3.Schema.Recipient; + // Create a new instance of Region + newRegion(): Dfareporting_v3_3.Schema.Region; + // Create a new instance of RemarketingList + newRemarketingList(): Dfareporting_v3_3.Schema.RemarketingList; + // Create a new instance of RemarketingListShare + newRemarketingListShare(): Dfareporting_v3_3.Schema.RemarketingListShare; + // Create a new instance of Report + newReport(): Dfareporting_v3_3.Schema.Report; + // Create a new instance of ReportCriteria + newReportCriteria(): Dfareporting_v3_3.Schema.ReportCriteria; + // Create a new instance of ReportCrossDimensionReachCriteria + newReportCrossDimensionReachCriteria(): Dfareporting_v3_3.Schema.ReportCrossDimensionReachCriteria; + // Create a new instance of ReportDelivery + newReportDelivery(): Dfareporting_v3_3.Schema.ReportDelivery; + // Create a new instance of ReportFloodlightCriteria + newReportFloodlightCriteria(): Dfareporting_v3_3.Schema.ReportFloodlightCriteria; + // Create a new instance of ReportFloodlightCriteriaReportProperties + newReportFloodlightCriteriaReportProperties(): Dfareporting_v3_3.Schema.ReportFloodlightCriteriaReportProperties; + // Create a new instance of ReportPathToConversionCriteria + newReportPathToConversionCriteria(): Dfareporting_v3_3.Schema.ReportPathToConversionCriteria; + // Create a new instance of ReportPathToConversionCriteriaReportProperties + newReportPathToConversionCriteriaReportProperties(): Dfareporting_v3_3.Schema.ReportPathToConversionCriteriaReportProperties; + // Create a new instance of ReportReachCriteria + newReportReachCriteria(): Dfareporting_v3_3.Schema.ReportReachCriteria; + // Create a new instance of ReportSchedule + newReportSchedule(): Dfareporting_v3_3.Schema.ReportSchedule; + // Create a new instance of ReportsConfiguration + newReportsConfiguration(): Dfareporting_v3_3.Schema.ReportsConfiguration; + // Create a new instance of RichMediaExitOverride + newRichMediaExitOverride(): Dfareporting_v3_3.Schema.RichMediaExitOverride; + // Create a new instance of Rule + newRule(): Dfareporting_v3_3.Schema.Rule; + // Create a new instance of Site + newSite(): Dfareporting_v3_3.Schema.Site; + // Create a new instance of SiteCompanionSetting + newSiteCompanionSetting(): Dfareporting_v3_3.Schema.SiteCompanionSetting; + // Create a new instance of SiteContact + newSiteContact(): Dfareporting_v3_3.Schema.SiteContact; + // Create a new instance of SiteSettings + newSiteSettings(): Dfareporting_v3_3.Schema.SiteSettings; + // Create a new instance of SiteSkippableSetting + newSiteSkippableSetting(): Dfareporting_v3_3.Schema.SiteSkippableSetting; + // Create a new instance of SiteTranscodeSetting + newSiteTranscodeSetting(): Dfareporting_v3_3.Schema.SiteTranscodeSetting; + // Create a new instance of SiteVideoSettings + newSiteVideoSettings(): Dfareporting_v3_3.Schema.SiteVideoSettings; + // Create a new instance of Size + newSize(): Dfareporting_v3_3.Schema.Size; + // Create a new instance of SkippableSetting + newSkippableSetting(): Dfareporting_v3_3.Schema.SkippableSetting; + // Create a new instance of SortedDimension + newSortedDimension(): Dfareporting_v3_3.Schema.SortedDimension; + // Create a new instance of Subaccount + newSubaccount(): Dfareporting_v3_3.Schema.Subaccount; + // Create a new instance of TagSetting + newTagSetting(): Dfareporting_v3_3.Schema.TagSetting; + // Create a new instance of TagSettings + newTagSettings(): Dfareporting_v3_3.Schema.TagSettings; + // Create a new instance of TargetWindow + newTargetWindow(): Dfareporting_v3_3.Schema.TargetWindow; + // Create a new instance of TargetingTemplate + newTargetingTemplate(): Dfareporting_v3_3.Schema.TargetingTemplate; + // Create a new instance of TechnologyTargeting + newTechnologyTargeting(): Dfareporting_v3_3.Schema.TechnologyTargeting; + // Create a new instance of ThirdPartyAuthenticationToken + newThirdPartyAuthenticationToken(): Dfareporting_v3_3.Schema.ThirdPartyAuthenticationToken; + // Create a new instance of ThirdPartyTrackingUrl + newThirdPartyTrackingUrl(): Dfareporting_v3_3.Schema.ThirdPartyTrackingUrl; + // Create a new instance of TranscodeSetting + newTranscodeSetting(): Dfareporting_v3_3.Schema.TranscodeSetting; + // Create a new instance of UniversalAdId + newUniversalAdId(): Dfareporting_v3_3.Schema.UniversalAdId; + // Create a new instance of UserDefinedVariableConfiguration + newUserDefinedVariableConfiguration(): Dfareporting_v3_3.Schema.UserDefinedVariableConfiguration; + // Create a new instance of UserRole + newUserRole(): Dfareporting_v3_3.Schema.UserRole; + // Create a new instance of UserRolePermission + newUserRolePermission(): Dfareporting_v3_3.Schema.UserRolePermission; + // Create a new instance of VideoOffset + newVideoOffset(): Dfareporting_v3_3.Schema.VideoOffset; + // Create a new instance of VideoSettings + newVideoSettings(): Dfareporting_v3_3.Schema.VideoSettings; + } +} + +declare var Dfareporting_v3_3: GoogleAppsScript.Dfareporting_v3_3; diff --git a/types/google-apps-script/apis/directory_v1.d.ts b/types/google-apps-script/apis/directory_v1.d.ts new file mode 100644 index 0000000000..a0181b2a8f --- /dev/null +++ b/types/google-apps-script/apis/directory_v1.d.ts @@ -0,0 +1,1141 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Admin_directory_v1 { + namespace Collection { + namespace Groups { + export interface AliasesCollection { + // Add a alias for the group + insert(resource: Schema.Alias, groupKey: string): Admin_directory_v1.Schema.Alias; + // List all aliases for a group + list(groupKey: string): Admin_directory_v1.Schema.Aliases; + // Remove a alias for the group + remove(groupKey: string, alias: string): void; + } + } + namespace Resources { + export interface BuildingsCollection { + // Retrieves a building. + get(customer: string, buildingId: string): Admin_directory_v1.Schema.Building; + // Inserts a building. + insert(resource: Schema.Building, customer: string): Admin_directory_v1.Schema.Building; + // Inserts a building. + insert(resource: Schema.Building, customer: string, optionalArgs: object): Admin_directory_v1.Schema.Building; + // Retrieves a list of buildings for an account. + list(customer: string): Admin_directory_v1.Schema.Buildings; + // Retrieves a list of buildings for an account. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.Buildings; + // Updates a building. This method supports patch semantics. + patch(resource: Schema.Building, customer: string, buildingId: string): Admin_directory_v1.Schema.Building; + // Updates a building. This method supports patch semantics. + patch(resource: Schema.Building, customer: string, buildingId: string, optionalArgs: object): Admin_directory_v1.Schema.Building; + // Deletes a building. + remove(customer: string, buildingId: string): void; + // Updates a building. + update(resource: Schema.Building, customer: string, buildingId: string): Admin_directory_v1.Schema.Building; + // Updates a building. + update(resource: Schema.Building, customer: string, buildingId: string, optionalArgs: object): Admin_directory_v1.Schema.Building; + } + export interface CalendarsCollection { + // Retrieves a calendar resource. + get(customer: string, calendarResourceId: string): Admin_directory_v1.Schema.CalendarResource; + // Inserts a calendar resource. + insert(resource: Schema.CalendarResource, customer: string): Admin_directory_v1.Schema.CalendarResource; + // Retrieves a list of calendar resources for an account. + list(customer: string): Admin_directory_v1.Schema.CalendarResources; + // Retrieves a list of calendar resources for an account. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.CalendarResources; + // Updates a calendar resource. + // This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. This method supports patch semantics. + patch(resource: Schema.CalendarResource, customer: string, calendarResourceId: string): Admin_directory_v1.Schema.CalendarResource; + // Deletes a calendar resource. + remove(customer: string, calendarResourceId: string): void; + // Updates a calendar resource. + // This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved. + update(resource: Schema.CalendarResource, customer: string, calendarResourceId: string): Admin_directory_v1.Schema.CalendarResource; + } + export interface FeaturesCollection { + // Retrieves a feature. + get(customer: string, featureKey: string): Admin_directory_v1.Schema.Feature; + // Inserts a feature. + insert(resource: Schema.Feature, customer: string): Admin_directory_v1.Schema.Feature; + // Retrieves a list of features for an account. + list(customer: string): Admin_directory_v1.Schema.Features; + // Retrieves a list of features for an account. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.Features; + // Updates a feature. This method supports patch semantics. + patch(resource: Schema.Feature, customer: string, featureKey: string): Admin_directory_v1.Schema.Feature; + // Deletes a feature. + remove(customer: string, featureKey: string): void; + // Renames a feature. + rename(resource: Schema.FeatureRename, customer: string, oldName: string): void; + // Updates a feature. + update(resource: Schema.Feature, customer: string, featureKey: string): Admin_directory_v1.Schema.Feature; + } + } + namespace Users { + export interface AliasesCollection { + // Add a alias for the user + insert(resource: Schema.Alias, userKey: string): Admin_directory_v1.Schema.Alias; + // List all aliases for a user + list(userKey: string): Admin_directory_v1.Schema.Aliases; + // List all aliases for a user + list(userKey: string, optionalArgs: object): Admin_directory_v1.Schema.Aliases; + // Remove a alias for the user + remove(userKey: string, alias: string): void; + // Watch for changes in user aliases list + watch(resource: Schema.Channel, userKey: string): Admin_directory_v1.Schema.Channel; + // Watch for changes in user aliases list + watch(resource: Schema.Channel, userKey: string, optionalArgs: object): Admin_directory_v1.Schema.Channel; + } + export interface PhotosCollection { + // Retrieve photo of a user + get(userKey: string): Admin_directory_v1.Schema.UserPhoto; + // Add a photo for the user. This method supports patch semantics. + patch(resource: Schema.UserPhoto, userKey: string): Admin_directory_v1.Schema.UserPhoto; + // Remove photos for the user + remove(userKey: string): void; + // Add a photo for the user + update(resource: Schema.UserPhoto, userKey: string): Admin_directory_v1.Schema.UserPhoto; + } + } + export interface AspsCollection { + // Get information about an ASP issued by a user. + get(userKey: string, codeId: number): Admin_directory_v1.Schema.Asp; + // List the ASPs issued by a user. + list(userKey: string): Admin_directory_v1.Schema.Asps; + // Delete an ASP issued by a user. + remove(userKey: string, codeId: number): void; + } + export interface ChannelsCollection { + // Stop watching resources through this channel + stop(resource: Schema.Channel): void; + } + export interface ChromeosdevicesCollection { + // Take action on Chrome OS Device + action(resource: Schema.ChromeOsDeviceAction, customerId: string, resourceId: string): void; + // Retrieve Chrome OS Device + get(customerId: string, deviceId: string): Admin_directory_v1.Schema.ChromeOsDevice; + // Retrieve Chrome OS Device + get(customerId: string, deviceId: string, optionalArgs: object): Admin_directory_v1.Schema.ChromeOsDevice; + // Retrieve all Chrome OS Devices of a customer (paginated) + list(customerId: string): Admin_directory_v1.Schema.ChromeOsDevices; + // Retrieve all Chrome OS Devices of a customer (paginated) + list(customerId: string, optionalArgs: object): Admin_directory_v1.Schema.ChromeOsDevices; + // Move or insert multiple Chrome OS Devices to organizational unit + moveDevicesToOu(resource: Schema.ChromeOsMoveDevicesToOu, customerId: string, orgUnitPath: string): void; + // Update Chrome OS Device. This method supports patch semantics. + patch(resource: Schema.ChromeOsDevice, customerId: string, deviceId: string): Admin_directory_v1.Schema.ChromeOsDevice; + // Update Chrome OS Device. This method supports patch semantics. + patch(resource: Schema.ChromeOsDevice, customerId: string, deviceId: string, optionalArgs: object): Admin_directory_v1.Schema.ChromeOsDevice; + // Update Chrome OS Device + update(resource: Schema.ChromeOsDevice, customerId: string, deviceId: string): Admin_directory_v1.Schema.ChromeOsDevice; + // Update Chrome OS Device + update(resource: Schema.ChromeOsDevice, customerId: string, deviceId: string, optionalArgs: object): Admin_directory_v1.Schema.ChromeOsDevice; + } + export interface CustomersCollection { + // Retrieves a customer. + get(customerKey: string): Admin_directory_v1.Schema.Customer; + // Updates a customer. This method supports patch semantics. + patch(resource: Schema.Customer, customerKey: string): Admin_directory_v1.Schema.Customer; + // Updates a customer. + update(resource: Schema.Customer, customerKey: string): Admin_directory_v1.Schema.Customer; + } + export interface DomainAliasesCollection { + // Retrieves a domain alias of the customer. + get(customer: string, domainAliasName: string): Admin_directory_v1.Schema.DomainAlias; + // Inserts a Domain alias of the customer. + insert(resource: Schema.DomainAlias, customer: string): Admin_directory_v1.Schema.DomainAlias; + // Lists the domain aliases of the customer. + list(customer: string): Admin_directory_v1.Schema.DomainAliases; + // Lists the domain aliases of the customer. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.DomainAliases; + // Deletes a Domain Alias of the customer. + remove(customer: string, domainAliasName: string): void; + } + export interface DomainsCollection { + // Retrieves a domain of the customer. + get(customer: string, domainName: string): Admin_directory_v1.Schema.Domains; + // Inserts a domain of the customer. + insert(resource: Schema.Domains, customer: string): Admin_directory_v1.Schema.Domains; + // Lists the domains of the customer. + list(customer: string): Admin_directory_v1.Schema.Domains2; + // Deletes a domain of the customer. + remove(customer: string, domainName: string): void; + } + export interface GroupsCollection { + Aliases?: Admin_directory_v1.Collection.Groups.AliasesCollection; + // Retrieve Group + get(groupKey: string): Admin_directory_v1.Schema.Group; + // Create Group + insert(resource: Schema.Group): Admin_directory_v1.Schema.Group; + // Retrieve all groups of a domain or of a user given a userKey (paginated) + list(): Admin_directory_v1.Schema.Groups; + // Retrieve all groups of a domain or of a user given a userKey (paginated) + list(optionalArgs: object): Admin_directory_v1.Schema.Groups; + // Update Group. This method supports patch semantics. + patch(resource: Schema.Group, groupKey: string): Admin_directory_v1.Schema.Group; + // Delete Group + remove(groupKey: string): void; + // Update Group + update(resource: Schema.Group, groupKey: string): Admin_directory_v1.Schema.Group; + } + export interface MembersCollection { + // Retrieve Group Member + get(groupKey: string, memberKey: string): Admin_directory_v1.Schema.Member; + // Checks whether the given user is a member of the group. Membership can be direct or nested. + hasMember(groupKey: string, memberKey: string): Admin_directory_v1.Schema.MembersHasMember; + // Add user to the specified group. + insert(resource: Schema.Member, groupKey: string): Admin_directory_v1.Schema.Member; + // Retrieve all members in a group (paginated) + list(groupKey: string): Admin_directory_v1.Schema.Members; + // Retrieve all members in a group (paginated) + list(groupKey: string, optionalArgs: object): Admin_directory_v1.Schema.Members; + // Update membership of a user in the specified group. This method supports patch semantics. + patch(resource: Schema.Member, groupKey: string, memberKey: string): Admin_directory_v1.Schema.Member; + // Remove membership. + remove(groupKey: string, memberKey: string): void; + // Update membership of a user in the specified group. + update(resource: Schema.Member, groupKey: string, memberKey: string): Admin_directory_v1.Schema.Member; + } + export interface MobiledevicesCollection { + // Take action on Mobile Device + action(resource: Schema.MobileDeviceAction, customerId: string, resourceId: string): void; + // Retrieve Mobile Device + get(customerId: string, resourceId: string): Admin_directory_v1.Schema.MobileDevice; + // Retrieve Mobile Device + get(customerId: string, resourceId: string, optionalArgs: object): Admin_directory_v1.Schema.MobileDevice; + // Retrieve all Mobile Devices of a customer (paginated) + list(customerId: string): Admin_directory_v1.Schema.MobileDevices; + // Retrieve all Mobile Devices of a customer (paginated) + list(customerId: string, optionalArgs: object): Admin_directory_v1.Schema.MobileDevices; + // Delete Mobile Device + remove(customerId: string, resourceId: string): void; + } + export interface NotificationsCollection { + // Retrieves a notification. + get(customer: string, notificationId: string): Admin_directory_v1.Schema.Notification; + // Retrieves a list of notifications. + list(customer: string): Admin_directory_v1.Schema.Notifications; + // Retrieves a list of notifications. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.Notifications; + // Updates a notification. This method supports patch semantics. + patch(resource: Schema.Notification, customer: string, notificationId: string): Admin_directory_v1.Schema.Notification; + // Deletes a notification + remove(customer: string, notificationId: string): void; + // Updates a notification. + update(resource: Schema.Notification, customer: string, notificationId: string): Admin_directory_v1.Schema.Notification; + } + export interface OrgunitsCollection { + // Retrieve organizational unit + get(customerId: string, orgUnitPath: string[]): Admin_directory_v1.Schema.OrgUnit; + // Add organizational unit + insert(resource: Schema.OrgUnit, customerId: string): Admin_directory_v1.Schema.OrgUnit; + // Retrieve all organizational units + list(customerId: string): Admin_directory_v1.Schema.OrgUnits; + // Retrieve all organizational units + list(customerId: string, optionalArgs: object): Admin_directory_v1.Schema.OrgUnits; + // Update organizational unit. This method supports patch semantics. + patch(resource: Schema.OrgUnit, customerId: string, orgUnitPath: string[]): Admin_directory_v1.Schema.OrgUnit; + // Remove organizational unit + remove(customerId: string, orgUnitPath: string[]): void; + // Update organizational unit + update(resource: Schema.OrgUnit, customerId: string, orgUnitPath: string[]): Admin_directory_v1.Schema.OrgUnit; + } + export interface PrivilegesCollection { + // Retrieves a paginated list of all privileges for a customer. + list(customer: string): Admin_directory_v1.Schema.Privileges; + } + export interface ResolvedAppAccessSettingsCollection { + // Retrieves resolved app access settings of the logged in user. + GetSettings(): Admin_directory_v1.Schema.AppAccessCollections; + // Retrieves the list of apps trusted by the admin of the logged in user. + ListTrustedApps(): Admin_directory_v1.Schema.TrustedApps; + } + export interface ResourcesCollection { + Buildings?: Admin_directory_v1.Collection.Resources.BuildingsCollection; + Calendars?: Admin_directory_v1.Collection.Resources.CalendarsCollection; + Features?: Admin_directory_v1.Collection.Resources.FeaturesCollection; + } + export interface RoleAssignmentsCollection { + // Retrieve a role assignment. + get(customer: string, roleAssignmentId: string): Admin_directory_v1.Schema.RoleAssignment; + // Creates a role assignment. + insert(resource: Schema.RoleAssignment, customer: string): Admin_directory_v1.Schema.RoleAssignment; + // Retrieves a paginated list of all roleAssignments. + list(customer: string): Admin_directory_v1.Schema.RoleAssignments; + // Retrieves a paginated list of all roleAssignments. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.RoleAssignments; + // Deletes a role assignment. + remove(customer: string, roleAssignmentId: string): void; + } + export interface RolesCollection { + // Retrieves a role. + get(customer: string, roleId: string): Admin_directory_v1.Schema.Role; + // Creates a role. + insert(resource: Schema.Role, customer: string): Admin_directory_v1.Schema.Role; + // Retrieves a paginated list of all the roles in a domain. + list(customer: string): Admin_directory_v1.Schema.Roles; + // Retrieves a paginated list of all the roles in a domain. + list(customer: string, optionalArgs: object): Admin_directory_v1.Schema.Roles; + // Updates a role. This method supports patch semantics. + patch(resource: Schema.Role, customer: string, roleId: string): Admin_directory_v1.Schema.Role; + // Deletes a role. + remove(customer: string, roleId: string): void; + // Updates a role. + update(resource: Schema.Role, customer: string, roleId: string): Admin_directory_v1.Schema.Role; + } + export interface SchemasCollection { + // Retrieve schema + get(customerId: string, schemaKey: string): Admin_directory_v1.Schema.Schema; + // Create schema. + insert(resource: Schema.Schema, customerId: string): Admin_directory_v1.Schema.Schema; + // Retrieve all schemas for a customer + list(customerId: string): Admin_directory_v1.Schema.Schemas; + // Update schema. This method supports patch semantics. + patch(resource: Schema.Schema, customerId: string, schemaKey: string): Admin_directory_v1.Schema.Schema; + // Delete schema + remove(customerId: string, schemaKey: string): void; + // Update schema + update(resource: Schema.Schema, customerId: string, schemaKey: string): Admin_directory_v1.Schema.Schema; + } + export interface TokensCollection { + // Get information about an access token issued by a user. + get(userKey: string, clientId: string): Admin_directory_v1.Schema.Token; + // Returns the set of tokens specified user has issued to 3rd party applications. + list(userKey: string): Admin_directory_v1.Schema.Tokens; + // Delete all access tokens issued by a user for an application. + remove(userKey: string, clientId: string): void; + } + export interface UsersCollection { + Aliases?: Admin_directory_v1.Collection.Users.AliasesCollection; + Photos?: Admin_directory_v1.Collection.Users.PhotosCollection; + // retrieve user + get(userKey: string): Admin_directory_v1.Schema.User; + // retrieve user + get(userKey: string, optionalArgs: object): Admin_directory_v1.Schema.User; + // create user. + insert(resource: Schema.User): Admin_directory_v1.Schema.User; + // Retrieve either deleted users or all users in a domain (paginated) + list(): Admin_directory_v1.Schema.Users; + // Retrieve either deleted users or all users in a domain (paginated) + list(optionalArgs: object): Admin_directory_v1.Schema.Users; + // change admin status of a user + makeAdmin(resource: Schema.UserMakeAdmin, userKey: string): void; + // update user. This method supports patch semantics. + patch(resource: Schema.User, userKey: string): Admin_directory_v1.Schema.User; + // Delete user + remove(userKey: string): void; + // Undelete a deleted user + undelete(resource: Schema.UserUndelete, userKey: string): void; + // update user + update(resource: Schema.User, userKey: string): Admin_directory_v1.Schema.User; + // Watch for changes in users list + watch(resource: Schema.Channel): Admin_directory_v1.Schema.Channel; + // Watch for changes in users list + watch(resource: Schema.Channel, optionalArgs: object): Admin_directory_v1.Schema.Channel; + } + export interface VerificationCodesCollection { + // Generate new backup verification codes for the user. + generate(userKey: string): void; + // Invalidate the current backup verification codes for the user. + invalidate(userKey: string): void; + // Returns the current set of valid backup verification codes for the specified user. + list(userKey: string): Admin_directory_v1.Schema.VerificationCodes; + } + } + namespace Schema { + export interface Alias { + alias?: string; + etag?: string; + id?: string; + kind?: string; + primaryEmail?: string; + } + export interface Aliases { + aliases?: Object[]; + etag?: string; + kind?: string; + } + export interface AppAccessCollections { + blockedApiAccessBuckets?: string[]; + enforceSettingsForAndroidDrive?: boolean; + errorMessage?: string; + etag?: string; + kind?: string; + resourceId?: string; + resourceName?: string; + trustDomainOwnedApps?: boolean; + } + export interface Asp { + codeId?: number; + creationTime?: string; + etag?: string; + kind?: string; + lastTimeUsed?: string; + name?: string; + userKey?: string; + } + export interface Asps { + etag?: string; + items?: Admin_directory_v1.Schema.Asp[]; + kind?: string; + } + export interface Building { + address?: Admin_directory_v1.Schema.BuildingAddress; + buildingId?: string; + buildingName?: string; + coordinates?: Admin_directory_v1.Schema.BuildingCoordinates; + description?: string; + etags?: string; + floorNames?: string[]; + kind?: string; + } + export interface BuildingAddress { + addressLines?: string[]; + administrativeArea?: string; + languageCode?: string; + locality?: string; + postalCode?: string; + regionCode?: string; + sublocality?: string; + } + export interface BuildingCoordinates { + latitude?: Number; + longitude?: Number; + } + export interface Buildings { + buildings?: Admin_directory_v1.Schema.Building[]; + etag?: string; + kind?: string; + nextPageToken?: string; + } + export interface CalendarResource { + buildingId?: string; + capacity?: number; + etags?: string; + featureInstances?: object; + floorName?: string; + floorSection?: string; + generatedResourceName?: string; + kind?: string; + resourceCategory?: string; + resourceDescription?: string; + resourceEmail?: string; + resourceId?: string; + resourceName?: string; + resourceType?: string; + userVisibleDescription?: string; + } + export interface CalendarResources { + etag?: string; + items?: Admin_directory_v1.Schema.CalendarResource[]; + kind?: string; + nextPageToken?: string; + } + export interface Channel { + address?: string; + expiration?: string; + id?: string; + kind?: string; + params?: object; + payload?: boolean; + resourceId?: string; + resourceUri?: string; + token?: string; + type?: string; + } + export interface ChromeOsDevice { + activeTimeRanges?: Admin_directory_v1.Schema.ChromeOsDeviceActiveTimeRanges[]; + annotatedAssetId?: string; + annotatedLocation?: string; + annotatedUser?: string; + bootMode?: string; + cpuStatusReports?: Admin_directory_v1.Schema.ChromeOsDeviceCpuStatusReports[]; + deviceFiles?: Admin_directory_v1.Schema.ChromeOsDeviceDeviceFiles[]; + deviceId?: string; + diskVolumeReports?: Admin_directory_v1.Schema.ChromeOsDeviceDiskVolumeReports[]; + etag?: string; + ethernetMacAddress?: string; + firmwareVersion?: string; + kind?: string; + lastEnrollmentTime?: string; + lastSync?: string; + macAddress?: string; + meid?: string; + model?: string; + notes?: string; + orderNumber?: string; + orgUnitPath?: string; + osVersion?: string; + platformVersion?: string; + recentUsers?: Admin_directory_v1.Schema.ChromeOsDeviceRecentUsers[]; + serialNumber?: string; + status?: string; + supportEndDate?: string; + systemRamFreeReports?: Admin_directory_v1.Schema.ChromeOsDeviceSystemRamFreeReports[]; + systemRamTotal?: string; + tpmVersionInfo?: Admin_directory_v1.Schema.ChromeOsDeviceTpmVersionInfo; + willAutoRenew?: boolean; + } + export interface ChromeOsDeviceAction { + action?: string; + deprovisionReason?: string; + } + export interface ChromeOsDeviceActiveTimeRanges { + activeTime?: number; + date?: string; + } + export interface ChromeOsDeviceCpuStatusReports { + cpuTemperatureInfo?: Admin_directory_v1.Schema.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo[]; + cpuUtilizationPercentageInfo?: number[]; + reportTime?: string; + } + export interface ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo { + label?: string; + temperature?: number; + } + export interface ChromeOsDeviceDeviceFiles { + createTime?: string; + downloadUrl?: string; + name?: string; + type?: string; + } + export interface ChromeOsDeviceDiskVolumeReports { + volumeInfo?: Admin_directory_v1.Schema.ChromeOsDeviceDiskVolumeReportsVolumeInfo[]; + } + export interface ChromeOsDeviceDiskVolumeReportsVolumeInfo { + storageFree?: string; + storageTotal?: string; + volumeId?: string; + } + export interface ChromeOsDeviceRecentUsers { + email?: string; + type?: string; + } + export interface ChromeOsDeviceSystemRamFreeReports { + reportTime?: string; + systemRamFreeInfo?: string[]; + } + export interface ChromeOsDeviceTpmVersionInfo { + family?: string; + firmwareVersion?: string; + manufacturer?: string; + specLevel?: string; + tpmModel?: string; + vendorSpecific?: string; + } + export interface ChromeOsDevices { + chromeosdevices?: Admin_directory_v1.Schema.ChromeOsDevice[]; + etag?: string; + kind?: string; + nextPageToken?: string; + } + export interface ChromeOsMoveDevicesToOu { + deviceIds?: string[]; + } + export interface Customer { + alternateEmail?: string; + customerCreationTime?: string; + customerDomain?: string; + etag?: string; + id?: string; + kind?: string; + language?: string; + phoneNumber?: string; + postalAddress?: Admin_directory_v1.Schema.CustomerPostalAddress; + } + export interface CustomerPostalAddress { + addressLine1?: string; + addressLine2?: string; + addressLine3?: string; + contactName?: string; + countryCode?: string; + locality?: string; + organizationName?: string; + postalCode?: string; + region?: string; + } + export interface DomainAlias { + creationTime?: string; + domainAliasName?: string; + etag?: string; + kind?: string; + parentDomainName?: string; + verified?: boolean; + } + export interface DomainAliases { + domainAliases?: Admin_directory_v1.Schema.DomainAlias[]; + etag?: string; + kind?: string; + } + export interface Domains { + creationTime?: string; + domainAliases?: Admin_directory_v1.Schema.DomainAlias[]; + domainName?: string; + etag?: string; + isPrimary?: boolean; + kind?: string; + verified?: boolean; + } + export interface Domains2 { + domains?: Admin_directory_v1.Schema.Domains[]; + etag?: string; + kind?: string; + } + export interface Feature { + etags?: string; + kind?: string; + name?: string; + } + export interface FeatureInstance { + feature?: Admin_directory_v1.Schema.Feature; + } + export interface FeatureRename { + newName?: string; + } + export interface Features { + etag?: string; + features?: Admin_directory_v1.Schema.Feature[]; + kind?: string; + nextPageToken?: string; + } + export interface Group { + adminCreated?: boolean; + aliases?: string[]; + description?: string; + directMembersCount?: string; + email?: string; + etag?: string; + id?: string; + kind?: string; + name?: string; + nonEditableAliases?: string[]; + } + export interface Groups { + etag?: string; + groups?: Admin_directory_v1.Schema.Group[]; + kind?: string; + nextPageToken?: string; + } + export interface Member { + delivery_settings?: string; + email?: string; + etag?: string; + id?: string; + kind?: string; + role?: string; + status?: string; + type?: string; + } + export interface Members { + etag?: string; + kind?: string; + members?: Admin_directory_v1.Schema.Member[]; + nextPageToken?: string; + } + export interface MembersHasMember { + isMember?: boolean; + } + export interface MobileDevice { + adbStatus?: boolean; + applications?: Admin_directory_v1.Schema.MobileDeviceApplications[]; + basebandVersion?: string; + bootloaderVersion?: string; + brand?: string; + buildNumber?: string; + defaultLanguage?: string; + developerOptionsStatus?: boolean; + deviceCompromisedStatus?: string; + deviceId?: string; + devicePasswordStatus?: string; + email?: string[]; + encryptionStatus?: string; + etag?: string; + firstSync?: string; + hardware?: string; + hardwareId?: string; + imei?: string; + kernelVersion?: string; + kind?: string; + lastSync?: string; + managedAccountIsOnOwnerProfile?: boolean; + manufacturer?: string; + meid?: string; + model?: string; + name?: string[]; + networkOperator?: string; + os?: string; + otherAccountsInfo?: string[]; + privilege?: string; + releaseVersion?: string; + resourceId?: string; + securityPatchLevel?: string; + serialNumber?: string; + status?: string; + supportsWorkProfile?: boolean; + type?: string; + unknownSourcesStatus?: boolean; + userAgent?: string; + wifiMacAddress?: string; + } + export interface MobileDeviceAction { + action?: string; + } + export interface MobileDeviceApplications { + displayName?: string; + packageName?: string; + permission?: string[]; + versionCode?: number; + versionName?: string; + } + export interface MobileDevices { + etag?: string; + kind?: string; + mobiledevices?: Admin_directory_v1.Schema.MobileDevice[]; + nextPageToken?: string; + } + export interface Notification { + body?: string; + etag?: string; + fromAddress?: string; + isUnread?: boolean; + kind?: string; + notificationId?: string; + sendTime?: string; + subject?: string; + } + export interface Notifications { + etag?: string; + items?: Admin_directory_v1.Schema.Notification[]; + kind?: string; + nextPageToken?: string; + unreadNotificationsCount?: number; + } + export interface OrgUnit { + blockInheritance?: boolean; + description?: string; + etag?: string; + kind?: string; + name?: string; + orgUnitId?: string; + orgUnitPath?: string; + parentOrgUnitId?: string; + parentOrgUnitPath?: string; + } + export interface OrgUnits { + etag?: string; + kind?: string; + organizationUnits?: Admin_directory_v1.Schema.OrgUnit[]; + } + export interface Privilege { + childPrivileges?: Admin_directory_v1.Schema.Privilege[]; + etag?: string; + isOuScopable?: boolean; + kind?: string; + privilegeName?: string; + serviceId?: string; + serviceName?: string; + } + export interface Privileges { + etag?: string; + items?: Admin_directory_v1.Schema.Privilege[]; + kind?: string; + } + export interface Role { + etag?: string; + isSuperAdminRole?: boolean; + isSystemRole?: boolean; + kind?: string; + roleDescription?: string; + roleId?: string; + roleName?: string; + rolePrivileges?: Admin_directory_v1.Schema.RoleRolePrivileges[]; + } + export interface RoleAssignment { + assignedTo?: string; + etag?: string; + kind?: string; + orgUnitId?: string; + roleAssignmentId?: string; + roleId?: string; + scopeType?: string; + } + export interface RoleAssignments { + etag?: string; + items?: Admin_directory_v1.Schema.RoleAssignment[]; + kind?: string; + nextPageToken?: string; + } + export interface RoleRolePrivileges { + privilegeName?: string; + serviceId?: string; + } + export interface Roles { + etag?: string; + items?: Admin_directory_v1.Schema.Role[]; + kind?: string; + nextPageToken?: string; + } + export interface Schema { + displayName?: string; + etag?: string; + fields?: Admin_directory_v1.Schema.SchemaFieldSpec[]; + kind?: string; + schemaId?: string; + schemaName?: string; + } + export interface SchemaFieldSpec { + displayName?: string; + etag?: string; + fieldId?: string; + fieldName?: string; + fieldType?: string; + indexed?: boolean; + kind?: string; + multiValued?: boolean; + numericIndexingSpec?: Admin_directory_v1.Schema.SchemaFieldSpecNumericIndexingSpec; + readAccessType?: string; + } + export interface SchemaFieldSpecNumericIndexingSpec { + maxValue?: Number; + minValue?: Number; + } + export interface Schemas { + etag?: string; + kind?: string; + schemas?: Admin_directory_v1.Schema.Schema[]; + } + export interface Token { + anonymous?: boolean; + clientId?: string; + displayText?: string; + etag?: string; + kind?: string; + nativeApp?: boolean; + scopes?: string[]; + userKey?: string; + } + export interface Tokens { + etag?: string; + items?: Admin_directory_v1.Schema.Token[]; + kind?: string; + } + export interface TrustedAppId { + androidPackageName?: string; + certificateHashSHA1?: string; + certificateHashSHA256?: string; + etag?: string; + kind?: string; + } + export interface TrustedApps { + etag?: string; + kind?: string; + nextPageToken?: string; + trustedApps?: Admin_directory_v1.Schema.TrustedAppId[]; + } + export interface User { + addresses?: object; + agreedToTerms?: boolean; + aliases?: string[]; + archived?: boolean; + changePasswordAtNextLogin?: boolean; + creationTime?: string; + customSchemas?: object; + customerId?: string; + deletionTime?: string; + emails?: object; + etag?: string; + externalIds?: object; + gender?: object; + hashFunction?: string; + id?: string; + ims?: object; + includeInGlobalAddressList?: boolean; + ipWhitelisted?: boolean; + isAdmin?: boolean; + isDelegatedAdmin?: boolean; + isEnforcedIn2Sv?: boolean; + isEnrolledIn2Sv?: boolean; + isMailboxSetup?: boolean; + keywords?: object; + kind?: string; + languages?: object; + lastLoginTime?: string; + locations?: object; + name?: Admin_directory_v1.Schema.UserName; + nonEditableAliases?: string[]; + notes?: object; + orgUnitPath?: string; + organizations?: object; + password?: string; + phones?: object; + posixAccounts?: object; + primaryEmail?: string; + relations?: object; + sshPublicKeys?: object; + suspended?: boolean; + suspensionReason?: string; + thumbnailPhotoEtag?: string; + thumbnailPhotoUrl?: string; + websites?: object; + } + export interface UserAbout { + contentType?: string; + value?: string; + } + export interface UserAddress { + country?: string; + countryCode?: string; + customType?: string; + extendedAddress?: string; + formatted?: string; + locality?: string; + poBox?: string; + postalCode?: string; + primary?: boolean; + region?: string; + sourceIsStructured?: boolean; + streetAddress?: string; + type?: string; + } + export interface UserEmail { + address?: string; + customType?: string; + primary?: boolean; + type?: string; + } + export interface UserExternalId { + customType?: string; + type?: string; + value?: string; + } + export interface UserGender { + addressMeAs?: string; + customGender?: string; + type?: string; + } + export interface UserIm { + customProtocol?: string; + customType?: string; + im?: string; + primary?: boolean; + protocol?: string; + type?: string; + } + export interface UserKeyword { + customType?: string; + type?: string; + value?: string; + } + export interface UserLanguage { + customLanguage?: string; + languageCode?: string; + } + export interface UserLocation { + area?: string; + buildingId?: string; + customType?: string; + deskCode?: string; + floorName?: string; + floorSection?: string; + type?: string; + } + export interface UserMakeAdmin { + status?: boolean; + } + export interface UserName { + familyName?: string; + fullName?: string; + givenName?: string; + } + export interface UserOrganization { + costCenter?: string; + customType?: string; + department?: string; + description?: string; + domain?: string; + fullTimeEquivalent?: number; + location?: string; + name?: string; + primary?: boolean; + symbol?: string; + title?: string; + type?: string; + } + export interface UserPhone { + customType?: string; + primary?: boolean; + type?: string; + value?: string; + } + export interface UserPhoto { + etag?: string; + height?: number; + id?: string; + kind?: string; + mimeType?: string; + photoData?: string; + primaryEmail?: string; + width?: number; + } + export interface UserPosixAccount { + accountId?: string; + gecos?: string; + gid?: string; + homeDirectory?: string; + operatingSystemType?: string; + primary?: boolean; + shell?: string; + systemId?: string; + uid?: string; + username?: string; + } + export interface UserRelation { + customType?: string; + type?: string; + value?: string; + } + export interface UserSshPublicKey { + expirationTimeUsec?: string; + fingerprint?: string; + key?: string; + } + export interface UserUndelete { + orgUnitPath?: string; + } + export interface UserWebsite { + customType?: string; + primary?: boolean; + type?: string; + value?: string; + } + export interface Users { + etag?: string; + kind?: string; + nextPageToken?: string; + trigger_event?: string; + users?: Admin_directory_v1.Schema.User[]; + } + export interface VerificationCode { + etag?: string; + kind?: string; + userId?: string; + verificationCode?: string; + } + export interface VerificationCodes { + etag?: string; + items?: Admin_directory_v1.Schema.VerificationCode[]; + kind?: string; + } + } + } + export interface Admin_directory_v1 { + Asps?: Admin_directory_v1.Collection.AspsCollection; + Channels?: Admin_directory_v1.Collection.ChannelsCollection; + Chromeosdevices?: Admin_directory_v1.Collection.ChromeosdevicesCollection; + Customers?: Admin_directory_v1.Collection.CustomersCollection; + DomainAliases?: Admin_directory_v1.Collection.DomainAliasesCollection; + Domains?: Admin_directory_v1.Collection.DomainsCollection; + Groups?: Admin_directory_v1.Collection.GroupsCollection; + Members?: Admin_directory_v1.Collection.MembersCollection; + Mobiledevices?: Admin_directory_v1.Collection.MobiledevicesCollection; + Notifications?: Admin_directory_v1.Collection.NotificationsCollection; + Orgunits?: Admin_directory_v1.Collection.OrgunitsCollection; + Privileges?: Admin_directory_v1.Collection.PrivilegesCollection; + ResolvedAppAccessSettings?: Admin_directory_v1.Collection.ResolvedAppAccessSettingsCollection; + Resources?: Admin_directory_v1.Collection.ResourcesCollection; + RoleAssignments?: Admin_directory_v1.Collection.RoleAssignmentsCollection; + Roles?: Admin_directory_v1.Collection.RolesCollection; + Schemas?: Admin_directory_v1.Collection.SchemasCollection; + Tokens?: Admin_directory_v1.Collection.TokensCollection; + Users?: Admin_directory_v1.Collection.UsersCollection; + VerificationCodes?: Admin_directory_v1.Collection.VerificationCodesCollection; + // Create a new instance of Alias + newAlias(): Admin_directory_v1.Schema.Alias; + // Create a new instance of Building + newBuilding(): Admin_directory_v1.Schema.Building; + // Create a new instance of BuildingAddress + newBuildingAddress(): Admin_directory_v1.Schema.BuildingAddress; + // Create a new instance of BuildingCoordinates + newBuildingCoordinates(): Admin_directory_v1.Schema.BuildingCoordinates; + // Create a new instance of CalendarResource + newCalendarResource(): Admin_directory_v1.Schema.CalendarResource; + // Create a new instance of Channel + newChannel(): Admin_directory_v1.Schema.Channel; + // Create a new instance of ChromeOsDevice + newChromeOsDevice(): Admin_directory_v1.Schema.ChromeOsDevice; + // Create a new instance of ChromeOsDeviceAction + newChromeOsDeviceAction(): Admin_directory_v1.Schema.ChromeOsDeviceAction; + // Create a new instance of ChromeOsDeviceActiveTimeRanges + newChromeOsDeviceActiveTimeRanges(): Admin_directory_v1.Schema.ChromeOsDeviceActiveTimeRanges; + // Create a new instance of ChromeOsDeviceCpuStatusReports + newChromeOsDeviceCpuStatusReports(): Admin_directory_v1.Schema.ChromeOsDeviceCpuStatusReports; + // Create a new instance of ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo + newChromeOsDeviceCpuStatusReportsCpuTemperatureInfo(): Admin_directory_v1.Schema.ChromeOsDeviceCpuStatusReportsCpuTemperatureInfo; + // Create a new instance of ChromeOsDeviceDeviceFiles + newChromeOsDeviceDeviceFiles(): Admin_directory_v1.Schema.ChromeOsDeviceDeviceFiles; + // Create a new instance of ChromeOsDeviceDiskVolumeReports + newChromeOsDeviceDiskVolumeReports(): Admin_directory_v1.Schema.ChromeOsDeviceDiskVolumeReports; + // Create a new instance of ChromeOsDeviceDiskVolumeReportsVolumeInfo + newChromeOsDeviceDiskVolumeReportsVolumeInfo(): Admin_directory_v1.Schema.ChromeOsDeviceDiskVolumeReportsVolumeInfo; + // Create a new instance of ChromeOsDeviceRecentUsers + newChromeOsDeviceRecentUsers(): Admin_directory_v1.Schema.ChromeOsDeviceRecentUsers; + // Create a new instance of ChromeOsDeviceSystemRamFreeReports + newChromeOsDeviceSystemRamFreeReports(): Admin_directory_v1.Schema.ChromeOsDeviceSystemRamFreeReports; + // Create a new instance of ChromeOsDeviceTpmVersionInfo + newChromeOsDeviceTpmVersionInfo(): Admin_directory_v1.Schema.ChromeOsDeviceTpmVersionInfo; + // Create a new instance of ChromeOsMoveDevicesToOu + newChromeOsMoveDevicesToOu(): Admin_directory_v1.Schema.ChromeOsMoveDevicesToOu; + // Create a new instance of Customer + newCustomer(): Admin_directory_v1.Schema.Customer; + // Create a new instance of CustomerPostalAddress + newCustomerPostalAddress(): Admin_directory_v1.Schema.CustomerPostalAddress; + // Create a new instance of DomainAlias + newDomainAlias(): Admin_directory_v1.Schema.DomainAlias; + // Create a new instance of Domains + newDomains(): Admin_directory_v1.Schema.Domains; + // Create a new instance of Feature + newFeature(): Admin_directory_v1.Schema.Feature; + // Create a new instance of FeatureRename + newFeatureRename(): Admin_directory_v1.Schema.FeatureRename; + // Create a new instance of Group + newGroup(): Admin_directory_v1.Schema.Group; + // Create a new instance of Member + newMember(): Admin_directory_v1.Schema.Member; + // Create a new instance of MobileDeviceAction + newMobileDeviceAction(): Admin_directory_v1.Schema.MobileDeviceAction; + // Create a new instance of Notification + newNotification(): Admin_directory_v1.Schema.Notification; + // Create a new instance of OrgUnit + newOrgUnit(): Admin_directory_v1.Schema.OrgUnit; + // Create a new instance of Role + newRole(): Admin_directory_v1.Schema.Role; + // Create a new instance of RoleAssignment + newRoleAssignment(): Admin_directory_v1.Schema.RoleAssignment; + // Create a new instance of RoleRolePrivileges + newRoleRolePrivileges(): Admin_directory_v1.Schema.RoleRolePrivileges; + // Create a new instance of Schema + newSchema(): Admin_directory_v1.Schema.Schema; + // Create a new instance of SchemaFieldSpec + newSchemaFieldSpec(): Admin_directory_v1.Schema.SchemaFieldSpec; + // Create a new instance of SchemaFieldSpecNumericIndexingSpec + newSchemaFieldSpecNumericIndexingSpec(): Admin_directory_v1.Schema.SchemaFieldSpecNumericIndexingSpec; + // Create a new instance of User + newUser(): Admin_directory_v1.Schema.User; + // Create a new instance of UserMakeAdmin + newUserMakeAdmin(): Admin_directory_v1.Schema.UserMakeAdmin; + // Create a new instance of UserName + newUserName(): Admin_directory_v1.Schema.UserName; + // Create a new instance of UserPhoto + newUserPhoto(): Admin_directory_v1.Schema.UserPhoto; + // Create a new instance of UserUndelete + newUserUndelete(): Admin_directory_v1.Schema.UserUndelete; + } +} + +declare var Admin_directory_v1: GoogleAppsScript.Admin_directory_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/docs_v1.d.ts b/types/google-apps-script/apis/docs_v1.d.ts new file mode 100644 index 0000000000..d74ccd5a75 --- /dev/null +++ b/types/google-apps-script/apis/docs_v1.d.ts @@ -0,0 +1,910 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Docs_v1 { + namespace Collection { + export interface DocumentsCollection { + // Applies one or more updates to the document. + // Each request is validated before + // being applied. If any request is not valid, then the entire request will + // fail and nothing will be applied. + // Some requests have replies to + // give you some information about how they are applied. Other requests do + // not need to return information; these each return an empty reply. + // The order of replies matches that of the requests. + // For example, suppose you call batchUpdate with four updates, and only the + // third one returns information. The response would have two empty replies, + // the reply to the third request, and another empty reply, in that order. + // Because other users may be editing the document, the document + // might not exactly reflect your changes: your changes may + // be altered with respect to collaborator changes. If there are no + // collaborators, the document should reflect your changes. In any case, + // the updates in your request are guaranteed to be applied together + // atomically. + batchUpdate(resource: Schema.BatchUpdateDocumentRequest, documentId: string): Docs_v1.Schema.BatchUpdateDocumentResponse; + // Creates a blank document using the title given in the request. Other fields + // in the request, including any provided content, are ignored. + // Returns the created document. + create(resource: Schema.Document): Docs_v1.Schema.Document; + // Gets the latest version of the specified document. + get(documentId: string): Docs_v1.Schema.Document; + // Gets the latest version of the specified document. + get(documentId: string, optionalArgs: object): Docs_v1.Schema.Document; + } + } + namespace Schema { + export interface AutoText { + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + type?: string; + } + export interface Background { + color?: Docs_v1.Schema.OptionalColor; + } + export interface BackgroundSuggestionState { + backgroundColorSuggested?: boolean; + } + export interface BatchUpdateDocumentRequest { + requests?: Docs_v1.Schema.Request[]; + writeControl?: Docs_v1.Schema.WriteControl; + } + export interface BatchUpdateDocumentResponse { + documentId?: string; + replies?: Docs_v1.Schema.Response[]; + writeControl?: Docs_v1.Schema.WriteControl; + } + export interface Body { + content?: Docs_v1.Schema.StructuralElement[]; + } + export interface Bullet { + listId?: string; + nestingLevel?: number; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface BulletSuggestionState { + listIdSuggested?: boolean; + nestingLevelSuggested?: boolean; + textStyleSuggestionState?: Docs_v1.Schema.TextStyleSuggestionState; + } + export interface Color { + rgbColor?: Docs_v1.Schema.RgbColor; + } + export interface ColumnBreak { + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface CreateNamedRangeRequest { + name?: string; + range?: Docs_v1.Schema.Range; + } + export interface CreateNamedRangeResponse { + namedRangeId?: string; + } + export interface CreateParagraphBulletsRequest { + bulletPreset?: string; + range?: Docs_v1.Schema.Range; + } + export interface CropProperties { + angle?: Number; + offsetBottom?: Number; + offsetLeft?: Number; + offsetRight?: Number; + offsetTop?: Number; + } + export interface CropPropertiesSuggestionState { + angleSuggested?: boolean; + offsetBottomSuggested?: boolean; + offsetLeftSuggested?: boolean; + offsetRightSuggested?: boolean; + offsetTopSuggested?: boolean; + } + export interface DeleteContentRangeRequest { + range?: Docs_v1.Schema.Range; + } + export interface DeleteNamedRangeRequest { + name?: string; + namedRangeId?: string; + } + export interface DeleteParagraphBulletsRequest { + range?: Docs_v1.Schema.Range; + } + export interface DeletePositionedObjectRequest { + objectId?: string; + } + export interface DeleteTableColumnRequest { + tableCellLocation?: Docs_v1.Schema.TableCellLocation; + } + export interface DeleteTableRowRequest { + tableCellLocation?: Docs_v1.Schema.TableCellLocation; + } + export interface Dimension { + magnitude?: Number; + unit?: string; + } + export interface Document { + body?: Docs_v1.Schema.Body; + documentId?: string; + documentStyle?: Docs_v1.Schema.DocumentStyle; + footers?: object; + footnotes?: object; + headers?: object; + inlineObjects?: object; + lists?: object; + namedRanges?: object; + namedStyles?: Docs_v1.Schema.NamedStyles; + positionedObjects?: object; + revisionId?: string; + suggestedDocumentStyleChanges?: object; + suggestedNamedStylesChanges?: object; + suggestionsViewMode?: string; + title?: string; + } + export interface DocumentStyle { + background?: Docs_v1.Schema.Background; + defaultFooterId?: string; + defaultHeaderId?: string; + evenPageFooterId?: string; + evenPageHeaderId?: string; + firstPageFooterId?: string; + firstPageHeaderId?: string; + marginBottom?: Docs_v1.Schema.Dimension; + marginLeft?: Docs_v1.Schema.Dimension; + marginRight?: Docs_v1.Schema.Dimension; + marginTop?: Docs_v1.Schema.Dimension; + pageNumberStart?: number; + pageSize?: Docs_v1.Schema.Size; + useEvenPageHeaderFooter?: boolean; + useFirstPageHeaderFooter?: boolean; + } + export interface DocumentStyleSuggestionState { + backgroundSuggestionState?: Docs_v1.Schema.BackgroundSuggestionState; + defaultFooterIdSuggested?: boolean; + defaultHeaderIdSuggested?: boolean; + evenPageFooterIdSuggested?: boolean; + evenPageHeaderIdSuggested?: boolean; + firstPageFooterIdSuggested?: boolean; + firstPageHeaderIdSuggested?: boolean; + marginBottomSuggested?: boolean; + marginLeftSuggested?: boolean; + marginRightSuggested?: boolean; + marginTopSuggested?: boolean; + pageNumberStartSuggested?: boolean; + pageSizeSuggestionState?: Docs_v1.Schema.SizeSuggestionState; + useEvenPageHeaderFooterSuggested?: boolean; + useFirstPageHeaderFooterSuggested?: boolean; + } + export interface EmbeddedObject { + description?: string; + embeddedDrawingProperties?: any; + embeddedObjectBorder?: Docs_v1.Schema.EmbeddedObjectBorder; + imageProperties?: Docs_v1.Schema.ImageProperties; + linkedContentReference?: Docs_v1.Schema.LinkedContentReference; + marginBottom?: Docs_v1.Schema.Dimension; + marginLeft?: Docs_v1.Schema.Dimension; + marginRight?: Docs_v1.Schema.Dimension; + marginTop?: Docs_v1.Schema.Dimension; + size?: Docs_v1.Schema.Size; + title?: string; + } + export interface EmbeddedObjectBorder { + color?: Docs_v1.Schema.OptionalColor; + dashStyle?: string; + propertyState?: string; + width?: Docs_v1.Schema.Dimension; + } + export interface EmbeddedObjectBorderSuggestionState { + colorSuggested?: boolean; + dashStyleSuggested?: boolean; + propertyStateSuggested?: boolean; + widthSuggested?: boolean; + } + export interface EmbeddedObjectSuggestionState { + descriptionSuggested?: boolean; + embeddedDrawingPropertiesSuggestionState?: any; + embeddedObjectBorderSuggestionState?: Docs_v1.Schema.EmbeddedObjectBorderSuggestionState; + imagePropertiesSuggestionState?: Docs_v1.Schema.ImagePropertiesSuggestionState; + linkedContentReferenceSuggestionState?: Docs_v1.Schema.LinkedContentReferenceSuggestionState; + marginBottomSuggested?: boolean; + marginLeftSuggested?: boolean; + marginRightSuggested?: boolean; + marginTopSuggested?: boolean; + sizeSuggestionState?: Docs_v1.Schema.SizeSuggestionState; + titleSuggested?: boolean; + } + export interface EndOfSegmentLocation { + segmentId?: string; + } + export interface Equation { + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + } + export interface Footer { + content?: Docs_v1.Schema.StructuralElement[]; + footerId?: string; + } + export interface Footnote { + content?: Docs_v1.Schema.StructuralElement[]; + footnoteId?: string; + } + export interface FootnoteReference { + footnoteId?: string; + footnoteNumber?: string; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface Header { + content?: Docs_v1.Schema.StructuralElement[]; + headerId?: string; + } + export interface HorizontalRule { + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface ImageProperties { + angle?: Number; + brightness?: Number; + contentUri?: string; + contrast?: Number; + cropProperties?: Docs_v1.Schema.CropProperties; + sourceUri?: string; + transparency?: Number; + } + export interface ImagePropertiesSuggestionState { + angleSuggested?: boolean; + brightnessSuggested?: boolean; + contentUriSuggested?: boolean; + contrastSuggested?: boolean; + cropPropertiesSuggestionState?: Docs_v1.Schema.CropPropertiesSuggestionState; + sourceUriSuggested?: boolean; + transparencySuggested?: boolean; + } + export interface InlineObject { + inlineObjectProperties?: Docs_v1.Schema.InlineObjectProperties; + objectId?: string; + suggestedDeletionIds?: string[]; + suggestedInlineObjectPropertiesChanges?: object; + suggestedInsertionId?: string; + } + export interface InlineObjectElement { + inlineObjectId?: string; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface InlineObjectProperties { + embeddedObject?: Docs_v1.Schema.EmbeddedObject; + } + export interface InlineObjectPropertiesSuggestionState { + embeddedObjectSuggestionState?: Docs_v1.Schema.EmbeddedObjectSuggestionState; + } + export interface InsertInlineImageRequest { + endOfSegmentLocation?: Docs_v1.Schema.EndOfSegmentLocation; + location?: Docs_v1.Schema.Location; + objectSize?: Docs_v1.Schema.Size; + uri?: string; + } + export interface InsertInlineImageResponse { + objectId?: string; + } + export interface InsertInlineSheetsChartResponse { + objectId?: string; + } + export interface InsertPageBreakRequest { + endOfSegmentLocation?: Docs_v1.Schema.EndOfSegmentLocation; + location?: Docs_v1.Schema.Location; + } + export interface InsertTableRequest { + columns?: number; + endOfSegmentLocation?: Docs_v1.Schema.EndOfSegmentLocation; + location?: Docs_v1.Schema.Location; + rows?: number; + } + export interface InsertTableRowRequest { + insertBelow?: boolean; + tableCellLocation?: Docs_v1.Schema.TableCellLocation; + } + export interface InsertTextRequest { + endOfSegmentLocation?: Docs_v1.Schema.EndOfSegmentLocation; + location?: Docs_v1.Schema.Location; + text?: string; + } + export interface Link { + bookmarkId?: string; + headingId?: string; + url?: string; + } + export interface LinkedContentReference { + sheetsChartReference?: Docs_v1.Schema.SheetsChartReference; + } + export interface LinkedContentReferenceSuggestionState { + sheetsChartReferenceSuggestionState?: Docs_v1.Schema.SheetsChartReferenceSuggestionState; + } + export interface List { + listProperties?: Docs_v1.Schema.ListProperties; + suggestedDeletionIds?: string[]; + suggestedInsertionId?: string; + suggestedListPropertiesChanges?: object; + } + export interface ListProperties { + nestingLevels?: Docs_v1.Schema.NestingLevel[]; + } + export interface ListPropertiesSuggestionState { + nestingLevelsSuggestionStates?: Docs_v1.Schema.NestingLevelSuggestionState[]; + } + export interface Location { + index?: number; + segmentId?: string; + } + export interface NamedRange { + name?: string; + namedRangeId?: string; + ranges?: Docs_v1.Schema.Range[]; + } + export interface NamedRanges { + name?: string; + namedRanges?: Docs_v1.Schema.NamedRange[]; + } + export interface NamedStyle { + namedStyleType?: string; + paragraphStyle?: Docs_v1.Schema.ParagraphStyle; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface NamedStyleSuggestionState { + namedStyleType?: string; + paragraphStyleSuggestionState?: Docs_v1.Schema.ParagraphStyleSuggestionState; + textStyleSuggestionState?: Docs_v1.Schema.TextStyleSuggestionState; + } + export interface NamedStyles { + styles?: Docs_v1.Schema.NamedStyle[]; + } + export interface NamedStylesSuggestionState { + stylesSuggestionStates?: Docs_v1.Schema.NamedStyleSuggestionState[]; + } + export interface NestingLevel { + bulletAlignment?: string; + glyphFormat?: string; + glyphSymbol?: string; + glyphType?: string; + indentFirstLine?: Docs_v1.Schema.Dimension; + indentStart?: Docs_v1.Schema.Dimension; + startNumber?: number; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface NestingLevelSuggestionState { + bulletAlignmentSuggested?: boolean; + glyphFormatSuggested?: boolean; + glyphSymbolSuggested?: boolean; + glyphTypeSuggested?: boolean; + indentFirstLineSuggested?: boolean; + indentStartSuggested?: boolean; + startNumberSuggested?: boolean; + textStyleSuggestionState?: Docs_v1.Schema.TextStyleSuggestionState; + } + export interface ObjectReferences { + objectIds?: string[]; + } + export interface OptionalColor { + color?: Docs_v1.Schema.Color; + } + export interface PageBreak { + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface Paragraph { + bullet?: Docs_v1.Schema.Bullet; + elements?: Docs_v1.Schema.ParagraphElement[]; + paragraphStyle?: Docs_v1.Schema.ParagraphStyle; + positionedObjectIds?: string[]; + suggestedBulletChanges?: object; + suggestedParagraphStyleChanges?: object; + suggestedPositionedObjectIds?: object; + } + export interface ParagraphBorder { + color?: Docs_v1.Schema.OptionalColor; + dashStyle?: string; + padding?: Docs_v1.Schema.Dimension; + width?: Docs_v1.Schema.Dimension; + } + export interface ParagraphElement { + autoText?: Docs_v1.Schema.AutoText; + columnBreak?: Docs_v1.Schema.ColumnBreak; + endIndex?: number; + equation?: Docs_v1.Schema.Equation; + footnoteReference?: Docs_v1.Schema.FootnoteReference; + horizontalRule?: Docs_v1.Schema.HorizontalRule; + inlineObjectElement?: Docs_v1.Schema.InlineObjectElement; + pageBreak?: Docs_v1.Schema.PageBreak; + startIndex?: number; + textRun?: Docs_v1.Schema.TextRun; + } + export interface ParagraphStyle { + alignment?: string; + avoidWidowAndOrphan?: boolean; + borderBetween?: Docs_v1.Schema.ParagraphBorder; + borderBottom?: Docs_v1.Schema.ParagraphBorder; + borderLeft?: Docs_v1.Schema.ParagraphBorder; + borderRight?: Docs_v1.Schema.ParagraphBorder; + borderTop?: Docs_v1.Schema.ParagraphBorder; + direction?: string; + headingId?: string; + indentEnd?: Docs_v1.Schema.Dimension; + indentFirstLine?: Docs_v1.Schema.Dimension; + indentStart?: Docs_v1.Schema.Dimension; + keepLinesTogether?: boolean; + keepWithNext?: boolean; + lineSpacing?: Number; + namedStyleType?: string; + shading?: Docs_v1.Schema.Shading; + spaceAbove?: Docs_v1.Schema.Dimension; + spaceBelow?: Docs_v1.Schema.Dimension; + spacingMode?: string; + tabStops?: Docs_v1.Schema.TabStop[]; + } + export interface ParagraphStyleSuggestionState { + alignmentSuggested?: boolean; + avoidWidowAndOrphanSuggested?: boolean; + borderBetweenSuggested?: boolean; + borderBottomSuggested?: boolean; + borderLeftSuggested?: boolean; + borderRightSuggested?: boolean; + borderTopSuggested?: boolean; + directionSuggested?: boolean; + headingIdSuggested?: boolean; + indentEndSuggested?: boolean; + indentFirstLineSuggested?: boolean; + indentStartSuggested?: boolean; + keepLinesTogetherSuggested?: boolean; + keepWithNextSuggested?: boolean; + lineSpacingSuggested?: boolean; + namedStyleTypeSuggested?: boolean; + shadingSuggestionState?: Docs_v1.Schema.ShadingSuggestionState; + spaceAboveSuggested?: boolean; + spaceBelowSuggested?: boolean; + spacingModeSuggested?: boolean; + } + export interface PositionedObject { + objectId?: string; + positionedObjectProperties?: Docs_v1.Schema.PositionedObjectProperties; + suggestedDeletionIds?: string[]; + suggestedInsertionId?: string; + suggestedPositionedObjectPropertiesChanges?: object; + } + export interface PositionedObjectPositioning { + layout?: string; + leftOffset?: Docs_v1.Schema.Dimension; + topOffset?: Docs_v1.Schema.Dimension; + } + export interface PositionedObjectPositioningSuggestionState { + layoutSuggested?: boolean; + leftOffsetSuggested?: boolean; + topOffsetSuggested?: boolean; + } + export interface PositionedObjectProperties { + embeddedObject?: Docs_v1.Schema.EmbeddedObject; + positioning?: Docs_v1.Schema.PositionedObjectPositioning; + } + export interface PositionedObjectPropertiesSuggestionState { + embeddedObjectSuggestionState?: Docs_v1.Schema.EmbeddedObjectSuggestionState; + positioningSuggestionState?: Docs_v1.Schema.PositionedObjectPositioningSuggestionState; + } + export interface Range { + endIndex?: number; + segmentId?: string; + startIndex?: number; + } + export interface ReplaceAllTextRequest { + containsText?: Docs_v1.Schema.SubstringMatchCriteria; + replaceText?: string; + } + export interface ReplaceAllTextResponse { + occurrencesChanged?: number; + } + export interface Request { + createNamedRange?: Docs_v1.Schema.CreateNamedRangeRequest; + createParagraphBullets?: Docs_v1.Schema.CreateParagraphBulletsRequest; + deleteContentRange?: Docs_v1.Schema.DeleteContentRangeRequest; + deleteNamedRange?: Docs_v1.Schema.DeleteNamedRangeRequest; + deleteParagraphBullets?: Docs_v1.Schema.DeleteParagraphBulletsRequest; + deletePositionedObject?: Docs_v1.Schema.DeletePositionedObjectRequest; + deleteTableColumn?: Docs_v1.Schema.DeleteTableColumnRequest; + deleteTableRow?: Docs_v1.Schema.DeleteTableRowRequest; + insertInlineImage?: Docs_v1.Schema.InsertInlineImageRequest; + insertPageBreak?: Docs_v1.Schema.InsertPageBreakRequest; + insertTable?: Docs_v1.Schema.InsertTableRequest; + insertTableRow?: Docs_v1.Schema.InsertTableRowRequest; + insertText?: Docs_v1.Schema.InsertTextRequest; + replaceAllText?: Docs_v1.Schema.ReplaceAllTextRequest; + updateParagraphStyle?: Docs_v1.Schema.UpdateParagraphStyleRequest; + updateTextStyle?: Docs_v1.Schema.UpdateTextStyleRequest; + } + export interface Response { + createNamedRange?: Docs_v1.Schema.CreateNamedRangeResponse; + insertInlineImage?: Docs_v1.Schema.InsertInlineImageResponse; + insertInlineSheetsChart?: Docs_v1.Schema.InsertInlineSheetsChartResponse; + replaceAllText?: Docs_v1.Schema.ReplaceAllTextResponse; + } + export interface RgbColor { + blue?: Number; + green?: Number; + red?: Number; + } + export interface SectionBreak { + sectionStyle?: Docs_v1.Schema.SectionStyle; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + } + export interface SectionColumnProperties { + paddingEnd?: Docs_v1.Schema.Dimension; + width?: Docs_v1.Schema.Dimension; + } + export interface SectionStyle { + columnProperties?: Docs_v1.Schema.SectionColumnProperties[]; + columnSeparatorStyle?: string; + contentDirection?: string; + } + export interface Shading { + backgroundColor?: Docs_v1.Schema.OptionalColor; + } + export interface ShadingSuggestionState { + backgroundColorSuggested?: boolean; + } + export interface SheetsChartReference { + chartId?: number; + spreadsheetId?: string; + } + export interface SheetsChartReferenceSuggestionState { + chartIdSuggested?: boolean; + spreadsheetIdSuggested?: boolean; + } + export interface Size { + height?: Docs_v1.Schema.Dimension; + width?: Docs_v1.Schema.Dimension; + } + export interface SizeSuggestionState { + heightSuggested?: boolean; + widthSuggested?: boolean; + } + export interface StructuralElement { + endIndex?: number; + paragraph?: Docs_v1.Schema.Paragraph; + sectionBreak?: Docs_v1.Schema.SectionBreak; + startIndex?: number; + table?: Docs_v1.Schema.Table; + tableOfContents?: Docs_v1.Schema.TableOfContents; + } + export interface SubstringMatchCriteria { + matchCase?: boolean; + text?: string; + } + export interface SuggestedBullet { + bullet?: Docs_v1.Schema.Bullet; + bulletSuggestionState?: Docs_v1.Schema.BulletSuggestionState; + } + export interface SuggestedDocumentStyle { + documentStyle?: Docs_v1.Schema.DocumentStyle; + documentStyleSuggestionState?: Docs_v1.Schema.DocumentStyleSuggestionState; + } + export interface SuggestedInlineObjectProperties { + inlineObjectProperties?: Docs_v1.Schema.InlineObjectProperties; + inlineObjectPropertiesSuggestionState?: Docs_v1.Schema.InlineObjectPropertiesSuggestionState; + } + export interface SuggestedListProperties { + listProperties?: Docs_v1.Schema.ListProperties; + listPropertiesSuggestionState?: Docs_v1.Schema.ListPropertiesSuggestionState; + } + export interface SuggestedNamedStyles { + namedStyles?: Docs_v1.Schema.NamedStyles; + namedStylesSuggestionState?: Docs_v1.Schema.NamedStylesSuggestionState; + } + export interface SuggestedParagraphStyle { + paragraphStyle?: Docs_v1.Schema.ParagraphStyle; + paragraphStyleSuggestionState?: Docs_v1.Schema.ParagraphStyleSuggestionState; + } + export interface SuggestedPositionedObjectProperties { + positionedObjectProperties?: Docs_v1.Schema.PositionedObjectProperties; + positionedObjectPropertiesSuggestionState?: Docs_v1.Schema.PositionedObjectPropertiesSuggestionState; + } + export interface SuggestedTableCellStyle { + tableCellStyle?: Docs_v1.Schema.TableCellStyle; + tableCellStyleSuggestionState?: Docs_v1.Schema.TableCellStyleSuggestionState; + } + export interface SuggestedTableRowStyle { + tableRowStyle?: Docs_v1.Schema.TableRowStyle; + tableRowStyleSuggestionState?: Docs_v1.Schema.TableRowStyleSuggestionState; + } + export interface SuggestedTextStyle { + textStyle?: Docs_v1.Schema.TextStyle; + textStyleSuggestionState?: Docs_v1.Schema.TextStyleSuggestionState; + } + export interface TabStop { + alignment?: string; + offset?: Docs_v1.Schema.Dimension; + } + export interface Table { + columns?: number; + rows?: number; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + tableRows?: Docs_v1.Schema.TableRow[]; + tableStyle?: Docs_v1.Schema.TableStyle; + } + export interface TableCell { + content?: Docs_v1.Schema.StructuralElement[]; + endIndex?: number; + startIndex?: number; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTableCellStyleChanges?: object; + tableCellStyle?: Docs_v1.Schema.TableCellStyle; + } + export interface TableCellBorder { + color?: Docs_v1.Schema.OptionalColor; + dashStyle?: string; + width?: Docs_v1.Schema.Dimension; + } + export interface TableCellLocation { + columnIndex?: number; + rowIndex?: number; + tableStartLocation?: Docs_v1.Schema.Location; + } + export interface TableCellStyle { + backgroundColor?: Docs_v1.Schema.OptionalColor; + borderBottom?: Docs_v1.Schema.TableCellBorder; + borderLeft?: Docs_v1.Schema.TableCellBorder; + borderRight?: Docs_v1.Schema.TableCellBorder; + borderTop?: Docs_v1.Schema.TableCellBorder; + columnSpan?: number; + contentAlignment?: string; + paddingBottom?: Docs_v1.Schema.Dimension; + paddingLeft?: Docs_v1.Schema.Dimension; + paddingRight?: Docs_v1.Schema.Dimension; + paddingTop?: Docs_v1.Schema.Dimension; + rowSpan?: number; + } + export interface TableCellStyleSuggestionState { + backgroundColorSuggested?: boolean; + borderBottomSuggested?: boolean; + borderLeftSuggested?: boolean; + borderRightSuggested?: boolean; + borderTopSuggested?: boolean; + columnSpanSuggested?: boolean; + contentAlignmentSuggested?: boolean; + paddingBottomSuggested?: boolean; + paddingLeftSuggested?: boolean; + paddingRightSuggested?: boolean; + paddingTopSuggested?: boolean; + rowSpanSuggested?: boolean; + } + export interface TableColumnProperties { + width?: Docs_v1.Schema.Dimension; + widthType?: string; + } + export interface TableOfContents { + content?: Docs_v1.Schema.StructuralElement[]; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + } + export interface TableRow { + endIndex?: number; + startIndex?: number; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTableRowStyleChanges?: object; + tableCells?: Docs_v1.Schema.TableCell[]; + tableRowStyle?: Docs_v1.Schema.TableRowStyle; + } + export interface TableRowStyle { + minRowHeight?: Docs_v1.Schema.Dimension; + } + export interface TableRowStyleSuggestionState { + minRowHeightSuggested?: boolean; + } + export interface TableStyle { + tableColumnProperties?: Docs_v1.Schema.TableColumnProperties[]; + } + export interface TextRun { + content?: string; + suggestedDeletionIds?: string[]; + suggestedInsertionIds?: string[]; + suggestedTextStyleChanges?: object; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface TextStyle { + backgroundColor?: Docs_v1.Schema.OptionalColor; + baselineOffset?: string; + bold?: boolean; + fontSize?: Docs_v1.Schema.Dimension; + foregroundColor?: Docs_v1.Schema.OptionalColor; + italic?: boolean; + link?: Docs_v1.Schema.Link; + smallCaps?: boolean; + strikethrough?: boolean; + underline?: boolean; + weightedFontFamily?: Docs_v1.Schema.WeightedFontFamily; + } + export interface TextStyleSuggestionState { + backgroundColorSuggested?: boolean; + baselineOffsetSuggested?: boolean; + boldSuggested?: boolean; + fontSizeSuggested?: boolean; + foregroundColorSuggested?: boolean; + italicSuggested?: boolean; + linkSuggested?: boolean; + smallCapsSuggested?: boolean; + strikethroughSuggested?: boolean; + underlineSuggested?: boolean; + weightedFontFamilySuggested?: boolean; + } + export interface UpdateParagraphStyleRequest { + fields?: string; + paragraphStyle?: Docs_v1.Schema.ParagraphStyle; + range?: Docs_v1.Schema.Range; + } + export interface UpdateTextStyleRequest { + fields?: string; + range?: Docs_v1.Schema.Range; + textStyle?: Docs_v1.Schema.TextStyle; + } + export interface WeightedFontFamily { + fontFamily?: string; + weight?: number; + } + export interface WriteControl { + requiredRevisionId?: string; + targetRevisionId?: string; + } + } + } + export interface Docs_v1 { + Documents?: Docs_v1.Collection.DocumentsCollection; + // Create a new instance of AutoText + newAutoText(): Docs_v1.Schema.AutoText; + // Create a new instance of Background + newBackground(): Docs_v1.Schema.Background; + // Create a new instance of BatchUpdateDocumentRequest + newBatchUpdateDocumentRequest(): Docs_v1.Schema.BatchUpdateDocumentRequest; + // Create a new instance of Body + newBody(): Docs_v1.Schema.Body; + // Create a new instance of Bullet + newBullet(): Docs_v1.Schema.Bullet; + // Create a new instance of Color + newColor(): Docs_v1.Schema.Color; + // Create a new instance of ColumnBreak + newColumnBreak(): Docs_v1.Schema.ColumnBreak; + // Create a new instance of CreateNamedRangeRequest + newCreateNamedRangeRequest(): Docs_v1.Schema.CreateNamedRangeRequest; + // Create a new instance of CreateParagraphBulletsRequest + newCreateParagraphBulletsRequest(): Docs_v1.Schema.CreateParagraphBulletsRequest; + // Create a new instance of DeleteContentRangeRequest + newDeleteContentRangeRequest(): Docs_v1.Schema.DeleteContentRangeRequest; + // Create a new instance of DeleteNamedRangeRequest + newDeleteNamedRangeRequest(): Docs_v1.Schema.DeleteNamedRangeRequest; + // Create a new instance of DeleteParagraphBulletsRequest + newDeleteParagraphBulletsRequest(): Docs_v1.Schema.DeleteParagraphBulletsRequest; + // Create a new instance of DeletePositionedObjectRequest + newDeletePositionedObjectRequest(): Docs_v1.Schema.DeletePositionedObjectRequest; + // Create a new instance of DeleteTableColumnRequest + newDeleteTableColumnRequest(): Docs_v1.Schema.DeleteTableColumnRequest; + // Create a new instance of DeleteTableRowRequest + newDeleteTableRowRequest(): Docs_v1.Schema.DeleteTableRowRequest; + // Create a new instance of Dimension + newDimension(): Docs_v1.Schema.Dimension; + // Create a new instance of Document + newDocument(): Docs_v1.Schema.Document; + // Create a new instance of DocumentStyle + newDocumentStyle(): Docs_v1.Schema.DocumentStyle; + // Create a new instance of EndOfSegmentLocation + newEndOfSegmentLocation(): Docs_v1.Schema.EndOfSegmentLocation; + // Create a new instance of Equation + newEquation(): Docs_v1.Schema.Equation; + // Create a new instance of FootnoteReference + newFootnoteReference(): Docs_v1.Schema.FootnoteReference; + // Create a new instance of HorizontalRule + newHorizontalRule(): Docs_v1.Schema.HorizontalRule; + // Create a new instance of InlineObjectElement + newInlineObjectElement(): Docs_v1.Schema.InlineObjectElement; + // Create a new instance of InsertInlineImageRequest + newInsertInlineImageRequest(): Docs_v1.Schema.InsertInlineImageRequest; + // Create a new instance of InsertPageBreakRequest + newInsertPageBreakRequest(): Docs_v1.Schema.InsertPageBreakRequest; + // Create a new instance of InsertTableRequest + newInsertTableRequest(): Docs_v1.Schema.InsertTableRequest; + // Create a new instance of InsertTableRowRequest + newInsertTableRowRequest(): Docs_v1.Schema.InsertTableRowRequest; + // Create a new instance of InsertTextRequest + newInsertTextRequest(): Docs_v1.Schema.InsertTextRequest; + // Create a new instance of Link + newLink(): Docs_v1.Schema.Link; + // Create a new instance of Location + newLocation(): Docs_v1.Schema.Location; + // Create a new instance of NamedStyle + newNamedStyle(): Docs_v1.Schema.NamedStyle; + // Create a new instance of NamedStyles + newNamedStyles(): Docs_v1.Schema.NamedStyles; + // Create a new instance of OptionalColor + newOptionalColor(): Docs_v1.Schema.OptionalColor; + // Create a new instance of PageBreak + newPageBreak(): Docs_v1.Schema.PageBreak; + // Create a new instance of Paragraph + newParagraph(): Docs_v1.Schema.Paragraph; + // Create a new instance of ParagraphBorder + newParagraphBorder(): Docs_v1.Schema.ParagraphBorder; + // Create a new instance of ParagraphElement + newParagraphElement(): Docs_v1.Schema.ParagraphElement; + // Create a new instance of ParagraphStyle + newParagraphStyle(): Docs_v1.Schema.ParagraphStyle; + // Create a new instance of Range + newRange(): Docs_v1.Schema.Range; + // Create a new instance of ReplaceAllTextRequest + newReplaceAllTextRequest(): Docs_v1.Schema.ReplaceAllTextRequest; + // Create a new instance of Request + newRequest(): Docs_v1.Schema.Request; + // Create a new instance of RgbColor + newRgbColor(): Docs_v1.Schema.RgbColor; + // Create a new instance of SectionBreak + newSectionBreak(): Docs_v1.Schema.SectionBreak; + // Create a new instance of SectionColumnProperties + newSectionColumnProperties(): Docs_v1.Schema.SectionColumnProperties; + // Create a new instance of SectionStyle + newSectionStyle(): Docs_v1.Schema.SectionStyle; + // Create a new instance of Shading + newShading(): Docs_v1.Schema.Shading; + // Create a new instance of Size + newSize(): Docs_v1.Schema.Size; + // Create a new instance of StructuralElement + newStructuralElement(): Docs_v1.Schema.StructuralElement; + // Create a new instance of SubstringMatchCriteria + newSubstringMatchCriteria(): Docs_v1.Schema.SubstringMatchCriteria; + // Create a new instance of TabStop + newTabStop(): Docs_v1.Schema.TabStop; + // Create a new instance of Table + newTable(): Docs_v1.Schema.Table; + // Create a new instance of TableCell + newTableCell(): Docs_v1.Schema.TableCell; + // Create a new instance of TableCellBorder + newTableCellBorder(): Docs_v1.Schema.TableCellBorder; + // Create a new instance of TableCellLocation + newTableCellLocation(): Docs_v1.Schema.TableCellLocation; + // Create a new instance of TableCellStyle + newTableCellStyle(): Docs_v1.Schema.TableCellStyle; + // Create a new instance of TableColumnProperties + newTableColumnProperties(): Docs_v1.Schema.TableColumnProperties; + // Create a new instance of TableOfContents + newTableOfContents(): Docs_v1.Schema.TableOfContents; + // Create a new instance of TableRow + newTableRow(): Docs_v1.Schema.TableRow; + // Create a new instance of TableRowStyle + newTableRowStyle(): Docs_v1.Schema.TableRowStyle; + // Create a new instance of TableStyle + newTableStyle(): Docs_v1.Schema.TableStyle; + // Create a new instance of TextRun + newTextRun(): Docs_v1.Schema.TextRun; + // Create a new instance of TextStyle + newTextStyle(): Docs_v1.Schema.TextStyle; + // Create a new instance of UpdateParagraphStyleRequest + newUpdateParagraphStyleRequest(): Docs_v1.Schema.UpdateParagraphStyleRequest; + // Create a new instance of UpdateTextStyleRequest + newUpdateTextStyleRequest(): Docs_v1.Schema.UpdateTextStyleRequest; + // Create a new instance of WeightedFontFamily + newWeightedFontFamily(): Docs_v1.Schema.WeightedFontFamily; + // Create a new instance of WriteControl + newWriteControl(): Docs_v1.Schema.WriteControl; + } +} + +declare var Docs_v1: GoogleAppsScript.Docs_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/drive/v2.d.ts b/types/google-apps-script/apis/drive/v2.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/drive_v2.d.ts b/types/google-apps-script/apis/drive_v2.d.ts new file mode 100644 index 0000000000..9a956bef53 --- /dev/null +++ b/types/google-apps-script/apis/drive_v2.d.ts @@ -0,0 +1,836 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Drive_v2 { + namespace Collection { + export interface AboutCollection { + // Gets the information about the current user along with Drive API settings + get(): Drive_v2.Schema.About; + // Gets the information about the current user along with Drive API settings + get(optionalArgs: object): Drive_v2.Schema.About; + } + export interface AppsCollection { + // Gets a specific app. + get(appId: string): Drive_v2.Schema.App; + // Lists a user's installed apps. + list(): Drive_v2.Schema.AppList; + // Lists a user's installed apps. + list(optionalArgs: object): Drive_v2.Schema.AppList; + } + export interface ChangesCollection { + // Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. + get(changeId: string): Drive_v2.Schema.Change; + // Deprecated - Use changes.getStartPageToken and changes.list to retrieve recent changes. + get(changeId: string, optionalArgs: object): Drive_v2.Schema.Change; + // Gets the starting pageToken for listing future changes. + getStartPageToken(): Drive_v2.Schema.StartPageToken; + // Gets the starting pageToken for listing future changes. + getStartPageToken(optionalArgs: object): Drive_v2.Schema.StartPageToken; + // Lists the changes for a user or Team Drive. + list(): Drive_v2.Schema.ChangeList; + // Lists the changes for a user or Team Drive. + list(optionalArgs: object): Drive_v2.Schema.ChangeList; + // Subscribe to changes for a user. + watch(resource: Schema.Channel): Drive_v2.Schema.Channel; + // Subscribe to changes for a user. + watch(resource: Schema.Channel, optionalArgs: object): Drive_v2.Schema.Channel; + } + export interface ChannelsCollection { + // Stop watching resources through this channel + stop(resource: Schema.Channel): void; + } + export interface ChildrenCollection { + // Gets a specific child reference. + get(folderId: string, childId: string): Drive_v2.Schema.ChildReference; + // Inserts a file into a folder. + insert(resource: Schema.ChildReference, folderId: string): Drive_v2.Schema.ChildReference; + // Inserts a file into a folder. + insert(resource: Schema.ChildReference, folderId: string, optionalArgs: object): Drive_v2.Schema.ChildReference; + // Lists a folder's children. + list(folderId: string): Drive_v2.Schema.ChildList; + // Lists a folder's children. + list(folderId: string, optionalArgs: object): Drive_v2.Schema.ChildList; + // Removes a child from a folder. + remove(folderId: string, childId: string): void; + } + export interface CommentsCollection { + // Gets a comment by ID. + get(fileId: string, commentId: string): Drive_v2.Schema.Comment; + // Gets a comment by ID. + get(fileId: string, commentId: string, optionalArgs: object): Drive_v2.Schema.Comment; + // Creates a new comment on the given file. + insert(resource: Schema.Comment, fileId: string): Drive_v2.Schema.Comment; + // Lists a file's comments. + list(fileId: string): Drive_v2.Schema.CommentList; + // Lists a file's comments. + list(fileId: string, optionalArgs: object): Drive_v2.Schema.CommentList; + // Updates an existing comment. This method supports patch semantics. + patch(resource: Schema.Comment, fileId: string, commentId: string): Drive_v2.Schema.Comment; + // Deletes a comment. + remove(fileId: string, commentId: string): void; + // Updates an existing comment. + update(resource: Schema.Comment, fileId: string, commentId: string): Drive_v2.Schema.Comment; + } + export interface FilesCollection { + // Creates a copy of the specified file. + copy(resource: Schema.File, fileId: string): Drive_v2.Schema.File; + // Creates a copy of the specified file. + copy(resource: Schema.File, fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Permanently deletes all of the user's trashed files. + emptyTrash(): void; + // Exports a Google Doc to the requested MIME type and returns the exported content. Please note that the exported content is limited to 10MB. + export(fileId: string, mimeType: string): void; + // Generates a set of file IDs which can be provided in insert requests. + generateIds(): Drive_v2.Schema.GeneratedIds; + // Generates a set of file IDs which can be provided in insert requests. + generateIds(optionalArgs: object): Drive_v2.Schema.GeneratedIds; + // Gets a file's metadata by ID. + get(fileId: string): Drive_v2.Schema.File; + // Gets a file's metadata by ID. + get(fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Insert a new file. + insert(resource: Schema.File): Drive_v2.Schema.File; + // Insert a new file. + insert(resource: Schema.File, mediaData: any): Drive_v2.Schema.File; + // Insert a new file. + insert(resource: Schema.File, mediaData: any, optionalArgs: object): Drive_v2.Schema.File; + // Lists the user's files. + list(): Drive_v2.Schema.FileList; + // Lists the user's files. + list(optionalArgs: object): Drive_v2.Schema.FileList; + // Updates file metadata and/or content. This method supports patch semantics. + patch(resource: Schema.File, fileId: string): Drive_v2.Schema.File; + // Updates file metadata and/or content. This method supports patch semantics. + patch(resource: Schema.File, fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. + remove(fileId: string): void; + // Permanently deletes a file by ID. Skips the trash. The currently authenticated user must own the file or be an organizer on the parent for Team Drive files. + remove(fileId: string, optionalArgs: object): void; + // Set the file's updated time to the current server time. + touch(fileId: string): Drive_v2.Schema.File; + // Set the file's updated time to the current server time. + touch(fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for Team Drive files. + trash(fileId: string): Drive_v2.Schema.File; + // Moves a file to the trash. The currently authenticated user must own the file or be at least a fileOrganizer on the parent for Team Drive files. + trash(fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Restores a file from the trash. + untrash(fileId: string): Drive_v2.Schema.File; + // Restores a file from the trash. + untrash(fileId: string, optionalArgs: object): Drive_v2.Schema.File; + // Updates file metadata and/or content. + update(resource: Schema.File, fileId: string): Drive_v2.Schema.File; + // Updates file metadata and/or content. + update(resource: Schema.File, fileId: string, mediaData: any): Drive_v2.Schema.File; + // Updates file metadata and/or content. + update(resource: Schema.File, fileId: string, mediaData: any, optionalArgs: object): Drive_v2.Schema.File; + // Subscribe to changes on a file + watch(resource: Schema.Channel, fileId: string): Drive_v2.Schema.Channel; + // Subscribe to changes on a file + watch(resource: Schema.Channel, fileId: string, optionalArgs: object): Drive_v2.Schema.Channel; + } + export interface ParentsCollection { + // Gets a specific parent reference. + get(fileId: string, parentId: string): Drive_v2.Schema.ParentReference; + // Adds a parent folder for a file. + insert(resource: Schema.ParentReference, fileId: string): Drive_v2.Schema.ParentReference; + // Adds a parent folder for a file. + insert(resource: Schema.ParentReference, fileId: string, optionalArgs: object): Drive_v2.Schema.ParentReference; + // Lists a file's parents. + list(fileId: string): Drive_v2.Schema.ParentList; + // Removes a parent from a file. + remove(fileId: string, parentId: string): void; + } + export interface PermissionsCollection { + // Gets a permission by ID. + get(fileId: string, permissionId: string): Drive_v2.Schema.Permission; + // Gets a permission by ID. + get(fileId: string, permissionId: string, optionalArgs: object): Drive_v2.Schema.Permission; + // Returns the permission ID for an email address. + getIdForEmail(email: string): Drive_v2.Schema.PermissionId; + // Inserts a permission for a file or Team Drive. + insert(resource: Schema.Permission, fileId: string): Drive_v2.Schema.Permission; + // Inserts a permission for a file or Team Drive. + insert(resource: Schema.Permission, fileId: string, optionalArgs: object): Drive_v2.Schema.Permission; + // Lists a file's or Team Drive's permissions. + list(fileId: string): Drive_v2.Schema.PermissionList; + // Lists a file's or Team Drive's permissions. + list(fileId: string, optionalArgs: object): Drive_v2.Schema.PermissionList; + // Updates a permission using patch semantics. + patch(resource: Schema.Permission, fileId: string, permissionId: string): Drive_v2.Schema.Permission; + // Updates a permission using patch semantics. + patch(resource: Schema.Permission, fileId: string, permissionId: string, optionalArgs: object): Drive_v2.Schema.Permission; + // Deletes a permission from a file or Team Drive. + remove(fileId: string, permissionId: string): void; + // Deletes a permission from a file or Team Drive. + remove(fileId: string, permissionId: string, optionalArgs: object): void; + // Updates a permission. + update(resource: Schema.Permission, fileId: string, permissionId: string): Drive_v2.Schema.Permission; + // Updates a permission. + update(resource: Schema.Permission, fileId: string, permissionId: string, optionalArgs: object): Drive_v2.Schema.Permission; + } + export interface PropertiesCollection { + // Gets a property by its key. + get(fileId: string, propertyKey: string): Drive_v2.Schema.Property; + // Gets a property by its key. + get(fileId: string, propertyKey: string, optionalArgs: object): Drive_v2.Schema.Property; + // Adds a property to a file, or updates it if it already exists. + insert(resource: Schema.Property, fileId: string): Drive_v2.Schema.Property; + // Lists a file's properties. + list(fileId: string): Drive_v2.Schema.PropertyList; + // Updates a property. + patch(resource: Schema.Property, fileId: string, propertyKey: string): Drive_v2.Schema.Property; + // Updates a property. + patch(resource: Schema.Property, fileId: string, propertyKey: string, optionalArgs: object): Drive_v2.Schema.Property; + // Deletes a property. + remove(fileId: string, propertyKey: string): void; + // Deletes a property. + remove(fileId: string, propertyKey: string, optionalArgs: object): void; + // Updates a property. + update(resource: Schema.Property, fileId: string, propertyKey: string): Drive_v2.Schema.Property; + // Updates a property. + update(resource: Schema.Property, fileId: string, propertyKey: string, optionalArgs: object): Drive_v2.Schema.Property; + } + export interface RealtimeCollection { + // Exports the contents of the Realtime API data model associated with this file as JSON. + get(fileId: string): void; + // Exports the contents of the Realtime API data model associated with this file as JSON. + get(fileId: string, optionalArgs: object): void; + // Overwrites the Realtime API data model associated with this file with the provided JSON data model. + update(fileId: string): void; + // Overwrites the Realtime API data model associated with this file with the provided JSON data model. + update(fileId: string, mediaData: any): void; + // Overwrites the Realtime API data model associated with this file with the provided JSON data model. + update(fileId: string, mediaData: any, optionalArgs: object): void; + } + export interface RepliesCollection { + // Gets a reply. + get(fileId: string, commentId: string, replyId: string): Drive_v2.Schema.CommentReply; + // Gets a reply. + get(fileId: string, commentId: string, replyId: string, optionalArgs: object): Drive_v2.Schema.CommentReply; + // Creates a new reply to the given comment. + insert(resource: Schema.CommentReply, fileId: string, commentId: string): Drive_v2.Schema.CommentReply; + // Lists all of the replies to a comment. + list(fileId: string, commentId: string): Drive_v2.Schema.CommentReplyList; + // Lists all of the replies to a comment. + list(fileId: string, commentId: string, optionalArgs: object): Drive_v2.Schema.CommentReplyList; + // Updates an existing reply. This method supports patch semantics. + patch(resource: Schema.CommentReply, fileId: string, commentId: string, replyId: string): Drive_v2.Schema.CommentReply; + // Deletes a reply. + remove(fileId: string, commentId: string, replyId: string): void; + // Updates an existing reply. + update(resource: Schema.CommentReply, fileId: string, commentId: string, replyId: string): Drive_v2.Schema.CommentReply; + } + export interface RevisionsCollection { + // Gets a specific revision. + get(fileId: string, revisionId: string): Drive_v2.Schema.Revision; + // Lists a file's revisions. + list(fileId: string): Drive_v2.Schema.RevisionList; + // Lists a file's revisions. + list(fileId: string, optionalArgs: object): Drive_v2.Schema.RevisionList; + // Updates a revision. This method supports patch semantics. + patch(resource: Schema.Revision, fileId: string, revisionId: string): Drive_v2.Schema.Revision; + // Permanently deletes a file version. You can only delete revisions for files with binary content, like images or videos. Revisions for other files, like Google Docs or Sheets, and the last remaining file version can't be deleted. + remove(fileId: string, revisionId: string): void; + // Updates a revision. + update(resource: Schema.Revision, fileId: string, revisionId: string): Drive_v2.Schema.Revision; + } + export interface TeamdrivesCollection { + // Gets a Team Drive's metadata by ID. + get(teamDriveId: string): Drive_v2.Schema.TeamDrive; + // Gets a Team Drive's metadata by ID. + get(teamDriveId: string, optionalArgs: object): Drive_v2.Schema.TeamDrive; + // Creates a new Team Drive. + insert(resource: Schema.TeamDrive, requestId: string): Drive_v2.Schema.TeamDrive; + // Lists the user's Team Drives. + list(): Drive_v2.Schema.TeamDriveList; + // Lists the user's Team Drives. + list(optionalArgs: object): Drive_v2.Schema.TeamDriveList; + // Permanently deletes a Team Drive for which the user is an organizer. The Team Drive cannot contain any untrashed items. + remove(teamDriveId: string): void; + // Updates a Team Drive's metadata + update(resource: Schema.TeamDrive, teamDriveId: string): Drive_v2.Schema.TeamDrive; + // Updates a Team Drive's metadata + update(resource: Schema.TeamDrive, teamDriveId: string, optionalArgs: object): Drive_v2.Schema.TeamDrive; + } + } + namespace Schema { + export interface About { + additionalRoleInfo?: Drive_v2.Schema.AboutAdditionalRoleInfo[]; + canCreateTeamDrives?: boolean; + domainSharingPolicy?: string; + etag?: string; + exportFormats?: Drive_v2.Schema.AboutExportFormats[]; + features?: Drive_v2.Schema.AboutFeatures[]; + folderColorPalette?: string[]; + importFormats?: Drive_v2.Schema.AboutImportFormats[]; + isCurrentAppInstalled?: boolean; + kind?: string; + languageCode?: string; + largestChangeId?: string; + maxUploadSizes?: Drive_v2.Schema.AboutMaxUploadSizes[]; + name?: string; + permissionId?: string; + quotaBytesByService?: Drive_v2.Schema.AboutQuotaBytesByService[]; + quotaBytesTotal?: string; + quotaBytesUsed?: string; + quotaBytesUsedAggregate?: string; + quotaBytesUsedInTrash?: string; + quotaType?: string; + remainingChangeIds?: string; + rootFolderId?: string; + selfLink?: string; + teamDriveThemes?: Drive_v2.Schema.AboutTeamDriveThemes[]; + user?: Drive_v2.Schema.User; + } + export interface AboutAdditionalRoleInfo { + roleSets?: Drive_v2.Schema.AboutAdditionalRoleInfoRoleSets[]; + type?: string; + } + export interface AboutAdditionalRoleInfoRoleSets { + additionalRoles?: string[]; + primaryRole?: string; + } + export interface AboutExportFormats { + source?: string; + targets?: string[]; + } + export interface AboutFeatures { + featureName?: string; + featureRate?: Number; + } + export interface AboutImportFormats { + source?: string; + targets?: string[]; + } + export interface AboutMaxUploadSizes { + size?: string; + type?: string; + } + export interface AboutQuotaBytesByService { + bytesUsed?: string; + serviceName?: string; + } + export interface AboutTeamDriveThemes { + backgroundImageLink?: string; + colorRgb?: string; + id?: string; + } + export interface App { + authorized?: boolean; + createInFolderTemplate?: string; + createUrl?: string; + hasDriveWideScope?: boolean; + icons?: Drive_v2.Schema.AppIcons[]; + id?: string; + installed?: boolean; + kind?: string; + longDescription?: string; + name?: string; + objectType?: string; + openUrlTemplate?: string; + primaryFileExtensions?: string[]; + primaryMimeTypes?: string[]; + productId?: string; + productUrl?: string; + secondaryFileExtensions?: string[]; + secondaryMimeTypes?: string[]; + shortDescription?: string; + supportsCreate?: boolean; + supportsImport?: boolean; + supportsMultiOpen?: boolean; + supportsOfflineCreate?: boolean; + useByDefault?: boolean; + } + export interface AppIcons { + category?: string; + iconUrl?: string; + size?: number; + } + export interface AppList { + defaultAppIds?: string[]; + etag?: string; + items?: Drive_v2.Schema.App[]; + kind?: string; + selfLink?: string; + } + export interface Change { + deleted?: boolean; + file?: Drive_v2.Schema.File; + fileId?: string; + id?: string; + kind?: string; + modificationDate?: string; + selfLink?: string; + teamDrive?: Drive_v2.Schema.TeamDrive; + teamDriveId?: string; + type?: string; + } + export interface ChangeList { + etag?: string; + items?: Drive_v2.Schema.Change[]; + kind?: string; + largestChangeId?: string; + newStartPageToken?: string; + nextLink?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface Channel { + address?: string; + expiration?: string; + id?: string; + kind?: string; + params?: object; + payload?: boolean; + resourceId?: string; + resourceUri?: string; + token?: string; + type?: string; + } + export interface ChildList { + etag?: string; + items?: Drive_v2.Schema.ChildReference[]; + kind?: string; + nextLink?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface ChildReference { + childLink?: string; + id?: string; + kind?: string; + selfLink?: string; + } + export interface Comment { + anchor?: string; + author?: Drive_v2.Schema.User; + commentId?: string; + content?: string; + context?: Drive_v2.Schema.CommentContext; + createdDate?: string; + deleted?: boolean; + fileId?: string; + fileTitle?: string; + htmlContent?: string; + kind?: string; + modifiedDate?: string; + replies?: Drive_v2.Schema.CommentReply[]; + selfLink?: string; + status?: string; + } + export interface CommentContext { + type?: string; + value?: string; + } + export interface CommentList { + items?: Drive_v2.Schema.Comment[]; + kind?: string; + nextLink?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface CommentReply { + author?: Drive_v2.Schema.User; + content?: string; + createdDate?: string; + deleted?: boolean; + htmlContent?: string; + kind?: string; + modifiedDate?: string; + replyId?: string; + verb?: string; + } + export interface CommentReplyList { + items?: Drive_v2.Schema.CommentReply[]; + kind?: string; + nextLink?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface File { + alternateLink?: string; + appDataContents?: boolean; + canComment?: boolean; + canReadRevisions?: boolean; + capabilities?: Drive_v2.Schema.FileCapabilities; + copyRequiresWriterPermission?: boolean; + copyable?: boolean; + createdDate?: string; + defaultOpenWithLink?: string; + description?: string; + downloadUrl?: string; + editable?: boolean; + embedLink?: string; + etag?: string; + explicitlyTrashed?: boolean; + exportLinks?: object; + fileExtension?: string; + fileSize?: string; + folderColorRgb?: string; + fullFileExtension?: string; + hasAugmentedPermissions?: boolean; + hasThumbnail?: boolean; + headRevisionId?: string; + iconLink?: string; + id?: string; + imageMediaMetadata?: Drive_v2.Schema.FileImageMediaMetadata; + indexableText?: Drive_v2.Schema.FileIndexableText; + isAppAuthorized?: boolean; + kind?: string; + labels?: Drive_v2.Schema.FileLabels; + lastModifyingUser?: Drive_v2.Schema.User; + lastModifyingUserName?: string; + lastViewedByMeDate?: string; + markedViewedByMeDate?: string; + md5Checksum?: string; + mimeType?: string; + modifiedByMeDate?: string; + modifiedDate?: string; + openWithLinks?: object; + originalFilename?: string; + ownedByMe?: boolean; + ownerNames?: string[]; + owners?: Drive_v2.Schema.User[]; + parents?: Drive_v2.Schema.ParentReference[]; + permissionIds?: string[]; + permissions?: Drive_v2.Schema.Permission[]; + properties?: Drive_v2.Schema.Property[]; + quotaBytesUsed?: string; + selfLink?: string; + shareable?: boolean; + shared?: boolean; + sharedWithMeDate?: string; + sharingUser?: Drive_v2.Schema.User; + spaces?: string[]; + teamDriveId?: string; + thumbnail?: Drive_v2.Schema.FileThumbnail; + thumbnailLink?: string; + thumbnailVersion?: string; + title?: string; + trashedDate?: string; + trashingUser?: Drive_v2.Schema.User; + userPermission?: Drive_v2.Schema.Permission; + version?: string; + videoMediaMetadata?: Drive_v2.Schema.FileVideoMediaMetadata; + webContentLink?: string; + webViewLink?: string; + writersCanShare?: boolean; + } + export interface FileCapabilities { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermission?: boolean; + canChangeRestrictedDownload?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDelete?: boolean; + canDeleteChildren?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canMoveChildrenOutOfTeamDrive?: boolean; + canMoveChildrenWithinTeamDrive?: boolean; + canMoveItemIntoTeamDrive?: boolean; + canMoveItemOutOfTeamDrive?: boolean; + canMoveItemWithinTeamDrive?: boolean; + canMoveTeamDriveItem?: boolean; + canReadRevisions?: boolean; + canReadTeamDrive?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canShare?: boolean; + canTrash?: boolean; + canTrashChildren?: boolean; + canUntrash?: boolean; + } + export interface FileImageMediaMetadata { + aperture?: Number; + cameraMake?: string; + cameraModel?: string; + colorSpace?: string; + date?: string; + exposureBias?: Number; + exposureMode?: string; + exposureTime?: Number; + flashUsed?: boolean; + focalLength?: Number; + height?: number; + isoSpeed?: number; + lens?: string; + location?: Drive_v2.Schema.FileImageMediaMetadataLocation; + maxApertureValue?: Number; + meteringMode?: string; + rotation?: number; + sensor?: string; + subjectDistance?: number; + whiteBalance?: string; + width?: number; + } + export interface FileImageMediaMetadataLocation { + altitude?: Number; + latitude?: Number; + longitude?: Number; + } + export interface FileIndexableText { + text?: string; + } + export interface FileLabels { + hidden?: boolean; + modified?: boolean; + restricted?: boolean; + starred?: boolean; + trashed?: boolean; + viewed?: boolean; + } + export interface FileList { + etag?: string; + incompleteSearch?: boolean; + items?: Drive_v2.Schema.File[]; + kind?: string; + nextLink?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface FileThumbnail { + image?: string; + mimeType?: string; + } + export interface FileVideoMediaMetadata { + durationMillis?: string; + height?: number; + width?: number; + } + export interface GeneratedIds { + ids?: string[]; + kind?: string; + space?: string; + } + export interface ParentList { + etag?: string; + items?: Drive_v2.Schema.ParentReference[]; + kind?: string; + selfLink?: string; + } + export interface ParentReference { + id?: string; + isRoot?: boolean; + kind?: string; + parentLink?: string; + selfLink?: string; + } + export interface Permission { + additionalRoles?: string[]; + authKey?: string; + deleted?: boolean; + domain?: string; + emailAddress?: string; + etag?: string; + expirationDate?: string; + id?: string; + kind?: string; + name?: string; + photoLink?: string; + role?: string; + selfLink?: string; + teamDrivePermissionDetails?: Drive_v2.Schema.PermissionTeamDrivePermissionDetails[]; + type?: string; + value?: string; + withLink?: boolean; + } + export interface PermissionId { + id?: string; + kind?: string; + } + export interface PermissionList { + etag?: string; + items?: Drive_v2.Schema.Permission[]; + kind?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface PermissionTeamDrivePermissionDetails { + additionalRoles?: string[]; + inherited?: boolean; + inheritedFrom?: string; + role?: string; + teamDrivePermissionType?: string; + } + export interface Property { + etag?: string; + key?: string; + kind?: string; + selfLink?: string; + value?: string; + visibility?: string; + } + export interface PropertyList { + etag?: string; + items?: Drive_v2.Schema.Property[]; + kind?: string; + selfLink?: string; + } + export interface Revision { + downloadUrl?: string; + etag?: string; + exportLinks?: object; + fileSize?: string; + id?: string; + kind?: string; + lastModifyingUser?: Drive_v2.Schema.User; + lastModifyingUserName?: string; + md5Checksum?: string; + mimeType?: string; + modifiedDate?: string; + originalFilename?: string; + pinned?: boolean; + publishAuto?: boolean; + published?: boolean; + publishedLink?: string; + publishedOutsideDomain?: boolean; + selfLink?: string; + } + export interface RevisionList { + etag?: string; + items?: Drive_v2.Schema.Revision[]; + kind?: string; + nextPageToken?: string; + selfLink?: string; + } + export interface StartPageToken { + kind?: string; + startPageToken?: string; + } + export interface TeamDrive { + backgroundImageFile?: Drive_v2.Schema.TeamDriveBackgroundImageFile; + backgroundImageLink?: string; + capabilities?: Drive_v2.Schema.TeamDriveCapabilities; + colorRgb?: string; + createdDate?: string; + id?: string; + kind?: string; + name?: string; + restrictions?: Drive_v2.Schema.TeamDriveRestrictions; + themeId?: string; + } + export interface TeamDriveBackgroundImageFile { + id?: string; + width?: Number; + xCoordinate?: Number; + yCoordinate?: Number; + } + export interface TeamDriveCapabilities { + canAddChildren?: boolean; + canChangeCopyRequiresWriterPermissionRestriction?: boolean; + canChangeDomainUsersOnlyRestriction?: boolean; + canChangeTeamDriveBackground?: boolean; + canChangeTeamMembersOnlyRestriction?: boolean; + canComment?: boolean; + canCopy?: boolean; + canDeleteChildren?: boolean; + canDeleteTeamDrive?: boolean; + canDownload?: boolean; + canEdit?: boolean; + canListChildren?: boolean; + canManageMembers?: boolean; + canReadRevisions?: boolean; + canRemoveChildren?: boolean; + canRename?: boolean; + canRenameTeamDrive?: boolean; + canShare?: boolean; + canTrashChildren?: boolean; + } + export interface TeamDriveList { + items?: Drive_v2.Schema.TeamDrive[]; + kind?: string; + nextPageToken?: string; + } + export interface TeamDriveRestrictions { + adminManagedRestrictions?: boolean; + copyRequiresWriterPermission?: boolean; + domainUsersOnly?: boolean; + teamMembersOnly?: boolean; + } + export interface User { + displayName?: string; + emailAddress?: string; + isAuthenticatedUser?: boolean; + kind?: string; + permissionId?: string; + picture?: Drive_v2.Schema.UserPicture; + } + export interface UserPicture { + url?: string; + } + } + } + export interface Drive_v2 { + About?: Drive_v2.Collection.AboutCollection; + Apps?: Drive_v2.Collection.AppsCollection; + Changes?: Drive_v2.Collection.ChangesCollection; + Channels?: Drive_v2.Collection.ChannelsCollection; + Children?: Drive_v2.Collection.ChildrenCollection; + Comments?: Drive_v2.Collection.CommentsCollection; + Files?: Drive_v2.Collection.FilesCollection; + Parents?: Drive_v2.Collection.ParentsCollection; + Permissions?: Drive_v2.Collection.PermissionsCollection; + Properties?: Drive_v2.Collection.PropertiesCollection; + Realtime?: Drive_v2.Collection.RealtimeCollection; + Replies?: Drive_v2.Collection.RepliesCollection; + Revisions?: Drive_v2.Collection.RevisionsCollection; + Teamdrives?: Drive_v2.Collection.TeamdrivesCollection; + // Create a new instance of Channel + newChannel(): Drive_v2.Schema.Channel; + // Create a new instance of ChildReference + newChildReference(): Drive_v2.Schema.ChildReference; + // Create a new instance of Comment + newComment(): Drive_v2.Schema.Comment; + // Create a new instance of CommentContext + newCommentContext(): Drive_v2.Schema.CommentContext; + // Create a new instance of CommentReply + newCommentReply(): Drive_v2.Schema.CommentReply; + // Create a new instance of File + newFile(): Drive_v2.Schema.File; + // Create a new instance of FileCapabilities + newFileCapabilities(): Drive_v2.Schema.FileCapabilities; + // Create a new instance of FileImageMediaMetadata + newFileImageMediaMetadata(): Drive_v2.Schema.FileImageMediaMetadata; + // Create a new instance of FileImageMediaMetadataLocation + newFileImageMediaMetadataLocation(): Drive_v2.Schema.FileImageMediaMetadataLocation; + // Create a new instance of FileIndexableText + newFileIndexableText(): Drive_v2.Schema.FileIndexableText; + // Create a new instance of FileLabels + newFileLabels(): Drive_v2.Schema.FileLabels; + // Create a new instance of FileThumbnail + newFileThumbnail(): Drive_v2.Schema.FileThumbnail; + // Create a new instance of FileVideoMediaMetadata + newFileVideoMediaMetadata(): Drive_v2.Schema.FileVideoMediaMetadata; + // Create a new instance of ParentReference + newParentReference(): Drive_v2.Schema.ParentReference; + // Create a new instance of Permission + newPermission(): Drive_v2.Schema.Permission; + // Create a new instance of PermissionTeamDrivePermissionDetails + newPermissionTeamDrivePermissionDetails(): Drive_v2.Schema.PermissionTeamDrivePermissionDetails; + // Create a new instance of Property + newProperty(): Drive_v2.Schema.Property; + // Create a new instance of Revision + newRevision(): Drive_v2.Schema.Revision; + // Create a new instance of TeamDrive + newTeamDrive(): Drive_v2.Schema.TeamDrive; + // Create a new instance of TeamDriveBackgroundImageFile + newTeamDriveBackgroundImageFile(): Drive_v2.Schema.TeamDriveBackgroundImageFile; + // Create a new instance of TeamDriveCapabilities + newTeamDriveCapabilities(): Drive_v2.Schema.TeamDriveCapabilities; + // Create a new instance of TeamDriveRestrictions + newTeamDriveRestrictions(): Drive_v2.Schema.TeamDriveRestrictions; + // Create a new instance of User + newUser(): Drive_v2.Schema.User; + // Create a new instance of UserPicture + newUserPicture(): Drive_v2.Schema.UserPicture; + } +} + +declare var Drive_v2: GoogleAppsScript.Drive_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/driveactivity_v2.d.ts b/types/google-apps-script/apis/driveactivity_v2.d.ts new file mode 100644 index 0000000000..70eeea3e5b --- /dev/null +++ b/types/google-apps-script/apis/driveactivity_v2.d.ts @@ -0,0 +1,217 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Driveactivity_v2 { + namespace Collection { + export interface ActivityCollection { + // Query past activity in Google Drive. + query(resource: Schema.QueryDriveActivityRequest): Driveactivity_v2.Schema.QueryDriveActivityResponse; + } + } + namespace Schema { + export interface Action { + actor?: Driveactivity_v2.Schema.Actor; + detail?: Driveactivity_v2.Schema.ActionDetail; + target?: Driveactivity_v2.Schema.Target; + timeRange?: Driveactivity_v2.Schema.TimeRange; + timestamp?: string; + } + export interface ActionDetail { + comment?: Driveactivity_v2.Schema.Comment; + create?: Driveactivity_v2.Schema.Create; + delete?: Driveactivity_v2.Schema.Delete; + dlpChange?: Driveactivity_v2.Schema.DataLeakPreventionChange; + edit?: any; + move?: Driveactivity_v2.Schema.Move; + permissionChange?: Driveactivity_v2.Schema.PermissionChange; + reference?: Driveactivity_v2.Schema.ApplicationReference; + rename?: Driveactivity_v2.Schema.Rename; + restore?: Driveactivity_v2.Schema.Restore; + settingsChange?: Driveactivity_v2.Schema.SettingsChange; + } + export interface Actor { + administrator?: string; + anonymous?: string; + impersonation?: Driveactivity_v2.Schema.Impersonation; + system?: Driveactivity_v2.Schema.SystemEvent; + user?: Driveactivity_v2.Schema.User; + } + export interface ApplicationReference { + type?: string; + } + export interface Assignment { + subtype?: string; + } + export interface Comment { + assignment?: Driveactivity_v2.Schema.Assignment; + mentionedUsers?: Driveactivity_v2.Schema.User[]; + post?: Driveactivity_v2.Schema.Post; + suggestion?: Driveactivity_v2.Schema.Suggestion; + } + export interface ConsolidationStrategy { + legacy?: any; + none?: any; + } + export interface Copy { + originalObject?: Driveactivity_v2.Schema.TargetReference; + } + export interface Create { + copy?: Driveactivity_v2.Schema.Copy; + new?: any; + upload?: any; + } + export interface DataLeakPreventionChange { + type?: string; + } + export interface Delete { + type?: string; + } + export interface Domain { + legacyId?: string; + name?: string; + } + export interface DriveActivity { + actions?: Driveactivity_v2.Schema.Action[]; + actors?: Driveactivity_v2.Schema.Actor[]; + primaryActionDetail?: Driveactivity_v2.Schema.ActionDetail; + targets?: Driveactivity_v2.Schema.Target[]; + timeRange?: Driveactivity_v2.Schema.TimeRange; + timestamp?: string; + } + export interface DriveItem { + file?: any; + folder?: Driveactivity_v2.Schema.Folder; + mimeType?: string; + name?: string; + owner?: Driveactivity_v2.Schema.Owner; + title?: string; + } + export interface DriveItemReference { + file?: any; + folder?: Driveactivity_v2.Schema.Folder; + name?: string; + title?: string; + } + export interface FileComment { + legacyCommentId?: string; + legacyDiscussionId?: string; + linkToDiscussion?: string; + parent?: Driveactivity_v2.Schema.DriveItem; + } + export interface Folder { + type?: string; + } + export interface Group { + email?: string; + title?: string; + } + export interface Impersonation { + impersonatedUser?: Driveactivity_v2.Schema.User; + } + export interface KnownUser { + isCurrentUser?: boolean; + personName?: string; + } + export interface Move { + addedParents?: Driveactivity_v2.Schema.TargetReference[]; + removedParents?: Driveactivity_v2.Schema.TargetReference[]; + } + export interface Owner { + domain?: Driveactivity_v2.Schema.Domain; + teamDrive?: Driveactivity_v2.Schema.TeamDriveReference; + user?: Driveactivity_v2.Schema.User; + } + export interface Permission { + allowDiscovery?: boolean; + anyone?: any; + domain?: Driveactivity_v2.Schema.Domain; + group?: Driveactivity_v2.Schema.Group; + role?: string; + user?: Driveactivity_v2.Schema.User; + } + export interface PermissionChange { + addedPermissions?: Driveactivity_v2.Schema.Permission[]; + removedPermissions?: Driveactivity_v2.Schema.Permission[]; + } + export interface Post { + subtype?: string; + } + export interface QueryDriveActivityRequest { + ancestorName?: string; + consolidationStrategy?: Driveactivity_v2.Schema.ConsolidationStrategy; + filter?: string; + itemName?: string; + pageSize?: number; + pageToken?: string; + } + export interface QueryDriveActivityResponse { + activities?: Driveactivity_v2.Schema.DriveActivity[]; + nextPageToken?: string; + } + export interface Rename { + newTitle?: string; + oldTitle?: string; + } + export interface Restore { + type?: string; + } + export interface RestrictionChange { + feature?: string; + newRestriction?: string; + } + export interface SettingsChange { + restrictionChanges?: Driveactivity_v2.Schema.RestrictionChange[]; + } + export interface Suggestion { + subtype?: string; + } + export interface SystemEvent { + type?: string; + } + export interface Target { + driveItem?: Driveactivity_v2.Schema.DriveItem; + fileComment?: any; + teamDrive?: Driveactivity_v2.Schema.TeamDrive; + } + export interface TargetReference { + driveItem?: Driveactivity_v2.Schema.DriveItemReference; + teamDrive?: Driveactivity_v2.Schema.TeamDriveReference; + } + export interface TeamDrive { + name?: string; + root?: Driveactivity_v2.Schema.DriveItem; + title?: string; + } + export interface TeamDriveReference { + name?: string; + title?: string; + } + export interface TimeRange { + endTime?: string; + startTime?: string; + } + export interface User { + deletedUser?: any; + knownUser?: Driveactivity_v2.Schema.KnownUser; + unknownUser?: any; + } + } + } + export interface Driveactivity_v2 { + Activity?: Driveactivity_v2.Collection.ActivityCollection; + // Create a new instance of ConsolidationStrategy + newConsolidationStrategy(): Driveactivity_v2.Schema.ConsolidationStrategy; + // Create a new instance of Legacy + newLegacy(): any; + // Create a new instance of NoConsolidation + newNoConsolidation(): any; + // Create a new instance of QueryDriveActivityRequest + newQueryDriveActivityRequest(): Driveactivity_v2.Schema.QueryDriveActivityRequest; + } +} + +declare var Driveactivity_v2: GoogleAppsScript.Driveactivity_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/fusiontables/v1.d.ts b/types/google-apps-script/apis/fusiontables/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/fusiontables/v2.d.ts b/types/google-apps-script/apis/fusiontables/v2.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/fusiontables_v2.d.ts b/types/google-apps-script/apis/fusiontables_v2.d.ts new file mode 100644 index 0000000000..46ad172f1a --- /dev/null +++ b/types/google-apps-script/apis/fusiontables_v2.d.ts @@ -0,0 +1,336 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Fusiontables_v2 { + namespace Collection { + export interface ColumnCollection { + // Retrieves a specific column by its ID. + get(tableId: string, columnId: string): Fusiontables_v2.Schema.Column; + // Adds a new column to the table. + insert(resource: Schema.Column, tableId: string): Fusiontables_v2.Schema.Column; + // Retrieves a list of columns. + list(tableId: string): Fusiontables_v2.Schema.ColumnList; + // Retrieves a list of columns. + list(tableId: string, optionalArgs: object): Fusiontables_v2.Schema.ColumnList; + // Updates the name or type of an existing column. This method supports patch semantics. + patch(resource: Schema.Column, tableId: string, columnId: string): Fusiontables_v2.Schema.Column; + // Deletes the specified column. + remove(tableId: string, columnId: string): void; + // Updates the name or type of an existing column. + update(resource: Schema.Column, tableId: string, columnId: string): Fusiontables_v2.Schema.Column; + } + export interface QueryCollection { + // Executes a Fusion Tables SQL statement, which can be any of + // - SELECT + // - INSERT + // - UPDATE + // - DELETE + // - SHOW + // - DESCRIBE + // - CREATE statement. + sql(sql: string): Fusiontables_v2.Schema.Sqlresponse; + // Executes a Fusion Tables SQL statement, which can be any of + // - SELECT + // - INSERT + // - UPDATE + // - DELETE + // - SHOW + // - DESCRIBE + // - CREATE statement. + sql(sql: string, optionalArgs: object): Fusiontables_v2.Schema.Sqlresponse; + // Executes a SQL statement which can be any of + // - SELECT + // - SHOW + // - DESCRIBE + sqlGet(sql: string): Fusiontables_v2.Schema.Sqlresponse; + // Executes a SQL statement which can be any of + // - SELECT + // - SHOW + // - DESCRIBE + sqlGet(sql: string, optionalArgs: object): Fusiontables_v2.Schema.Sqlresponse; + } + export interface StyleCollection { + // Gets a specific style. + get(tableId: string, styleId: number): Fusiontables_v2.Schema.StyleSetting; + // Adds a new style for the table. + insert(resource: Schema.StyleSetting, tableId: string): Fusiontables_v2.Schema.StyleSetting; + // Retrieves a list of styles. + list(tableId: string): Fusiontables_v2.Schema.StyleSettingList; + // Retrieves a list of styles. + list(tableId: string, optionalArgs: object): Fusiontables_v2.Schema.StyleSettingList; + // Updates an existing style. This method supports patch semantics. + patch(resource: Schema.StyleSetting, tableId: string, styleId: number): Fusiontables_v2.Schema.StyleSetting; + // Deletes a style. + remove(tableId: string, styleId: number): void; + // Updates an existing style. + update(resource: Schema.StyleSetting, tableId: string, styleId: number): Fusiontables_v2.Schema.StyleSetting; + } + export interface TableCollection { + // Copies a table. + copy(tableId: string): Fusiontables_v2.Schema.Table; + // Copies a table. + copy(tableId: string, optionalArgs: object): Fusiontables_v2.Schema.Table; + // Retrieves a specific table by its ID. + get(tableId: string): Fusiontables_v2.Schema.Table; + // Imports more rows into a table. + importRows(tableId: string): Fusiontables_v2.Schema.Import; + // Imports more rows into a table. + importRows(tableId: string, mediaData: any): Fusiontables_v2.Schema.Import; + // Imports more rows into a table. + importRows(tableId: string, mediaData: any, optionalArgs: object): Fusiontables_v2.Schema.Import; + // Imports a new table. + importTable(name: string): Fusiontables_v2.Schema.Table; + // Imports a new table. + importTable(name: string, mediaData: any): Fusiontables_v2.Schema.Table; + // Imports a new table. + importTable(name: string, mediaData: any, optionalArgs: object): Fusiontables_v2.Schema.Table; + // Creates a new table. + insert(resource: Schema.Table): Fusiontables_v2.Schema.Table; + // Retrieves a list of tables a user owns. + list(): Fusiontables_v2.Schema.TableList; + // Retrieves a list of tables a user owns. + list(optionalArgs: object): Fusiontables_v2.Schema.TableList; + // Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. + patch(resource: Schema.Table, tableId: string): Fusiontables_v2.Schema.Table; + // Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. This method supports patch semantics. + patch(resource: Schema.Table, tableId: string, optionalArgs: object): Fusiontables_v2.Schema.Table; + // Replaces rows of the table with the rows of the spreadsheet that is first imported from. Current rows remain visible until all replacement rows are ready. + refetchSheet(tableId: string): Fusiontables_v2.Schema.Task; + // Deletes a table. + remove(tableId: string): void; + // Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready. + replaceRows(tableId: string): Fusiontables_v2.Schema.Task; + // Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready. + replaceRows(tableId: string, mediaData: any): Fusiontables_v2.Schema.Task; + // Replaces rows of an existing table. Current rows remain visible until all replacement rows are ready. + replaceRows(tableId: string, mediaData: any, optionalArgs: object): Fusiontables_v2.Schema.Task; + // Updates an existing table. Unless explicitly requested, only the name, description, and attribution will be updated. + update(resource: Schema.Table, tableId: string): Fusiontables_v2.Schema.Table; + // 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_v2.Schema.Table; + } + export interface TaskCollection { + // Retrieves a specific task by its ID. + get(tableId: string, taskId: string): Fusiontables_v2.Schema.Task; + // Retrieves a list of tasks. + list(tableId: string): Fusiontables_v2.Schema.TaskList; + // Retrieves a list of tasks. + list(tableId: string, optionalArgs: object): Fusiontables_v2.Schema.TaskList; + // Deletes a specific task by its ID, unless that task has already started running. + remove(tableId: string, taskId: string): void; + } + export interface TemplateCollection { + // Retrieves a specific template by its id + get(tableId: string, templateId: number): Fusiontables_v2.Schema.Template; + // Creates a new template for the table. + insert(resource: Schema.Template, tableId: string): Fusiontables_v2.Schema.Template; + // Retrieves a list of templates. + list(tableId: string): Fusiontables_v2.Schema.TemplateList; + // Retrieves a list of templates. + list(tableId: string, optionalArgs: object): Fusiontables_v2.Schema.TemplateList; + // Updates an existing template. This method supports patch semantics. + patch(resource: Schema.Template, tableId: string, templateId: number): Fusiontables_v2.Schema.Template; + // Deletes a template + remove(tableId: string, templateId: number): void; + // Updates an existing template + update(resource: Schema.Template, tableId: string, templateId: number): Fusiontables_v2.Schema.Template; + } + } + namespace Schema { + export interface Bucket { + color?: string; + icon?: string; + max?: Number; + min?: Number; + opacity?: Number; + weight?: number; + } + export interface Column { + baseColumn?: Fusiontables_v2.Schema.ColumnBaseColumn; + columnId?: number; + columnJsonSchema?: string; + columnPropertiesJson?: string; + description?: string; + formatPattern?: string; + graphPredicate?: string; + kind?: string; + name?: string; + type?: string; + validValues?: string[]; + validateData?: boolean; + } + export interface ColumnBaseColumn { + columnId?: number; + tableIndex?: number; + } + export interface ColumnList { + items?: Fusiontables_v2.Schema.Column[]; + kind?: string; + nextPageToken?: string; + totalItems?: number; + } + export interface Geometry { + geometries?: Object[]; + geometry?: object; + type?: string; + } + export interface Import { + kind?: string; + numRowsReceived?: string; + } + export interface Line { + coordinates?: Number[][]; + type?: string; + } + export interface LineStyle { + strokeColor?: string; + strokeColorStyler?: Fusiontables_v2.Schema.StyleFunction; + strokeOpacity?: Number; + strokeWeight?: number; + strokeWeightStyler?: Fusiontables_v2.Schema.StyleFunction; + } + export interface Point { + coordinates?: Number[]; + type?: string; + } + export interface PointStyle { + iconName?: string; + iconStyler?: Fusiontables_v2.Schema.StyleFunction; + } + export interface Polygon { + coordinates?: Number[][][]; + type?: string; + } + export interface PolygonStyle { + fillColor?: string; + fillColorStyler?: Fusiontables_v2.Schema.StyleFunction; + fillOpacity?: Number; + strokeColor?: string; + strokeColorStyler?: Fusiontables_v2.Schema.StyleFunction; + strokeOpacity?: Number; + strokeWeight?: number; + strokeWeightStyler?: Fusiontables_v2.Schema.StyleFunction; + } + export interface Sqlresponse { + columns?: string[]; + kind?: string; + rows?: Object[][]; + } + export interface StyleFunction { + buckets?: Fusiontables_v2.Schema.Bucket[]; + columnName?: string; + gradient?: Fusiontables_v2.Schema.StyleFunctionGradient; + kind?: string; + } + export interface StyleFunctionGradient { + colors?: Fusiontables_v2.Schema.StyleFunctionGradientColors[]; + max?: Number; + min?: Number; + } + export interface StyleFunctionGradientColors { + color?: string; + opacity?: Number; + } + export interface StyleSetting { + kind?: string; + markerOptions?: Fusiontables_v2.Schema.PointStyle; + name?: string; + polygonOptions?: Fusiontables_v2.Schema.PolygonStyle; + polylineOptions?: Fusiontables_v2.Schema.LineStyle; + styleId?: number; + tableId?: string; + } + export interface StyleSettingList { + items?: Fusiontables_v2.Schema.StyleSetting[]; + kind?: string; + nextPageToken?: string; + totalItems?: number; + } + export interface Table { + attribution?: string; + attributionLink?: string; + baseTableIds?: string[]; + columnPropertiesJsonSchema?: string; + columns?: Fusiontables_v2.Schema.Column[]; + description?: string; + isExportable?: boolean; + kind?: string; + name?: string; + sql?: string; + tableId?: string; + tablePropertiesJson?: string; + tablePropertiesJsonSchema?: string; + } + export interface TableList { + items?: Fusiontables_v2.Schema.Table[]; + kind?: string; + nextPageToken?: string; + } + export interface Task { + kind?: string; + progress?: string; + started?: boolean; + taskId?: string; + type?: string; + } + export interface TaskList { + items?: Fusiontables_v2.Schema.Task[]; + kind?: string; + nextPageToken?: string; + totalItems?: number; + } + export interface Template { + automaticColumnNames?: string[]; + body?: string; + kind?: string; + name?: string; + tableId?: string; + templateId?: number; + } + export interface TemplateList { + items?: Fusiontables_v2.Schema.Template[]; + kind?: string; + nextPageToken?: string; + totalItems?: number; + } + } + } + export interface Fusiontables_v2 { + Column?: Fusiontables_v2.Collection.ColumnCollection; + Query?: Fusiontables_v2.Collection.QueryCollection; + Style?: Fusiontables_v2.Collection.StyleCollection; + Table?: Fusiontables_v2.Collection.TableCollection; + Task?: Fusiontables_v2.Collection.TaskCollection; + Template?: Fusiontables_v2.Collection.TemplateCollection; + // Create a new instance of Bucket + newBucket(): Fusiontables_v2.Schema.Bucket; + // Create a new instance of Column + newColumn(): Fusiontables_v2.Schema.Column; + // Create a new instance of ColumnBaseColumn + newColumnBaseColumn(): Fusiontables_v2.Schema.ColumnBaseColumn; + // Create a new instance of LineStyle + newLineStyle(): Fusiontables_v2.Schema.LineStyle; + // Create a new instance of PointStyle + newPointStyle(): Fusiontables_v2.Schema.PointStyle; + // Create a new instance of PolygonStyle + newPolygonStyle(): Fusiontables_v2.Schema.PolygonStyle; + // Create a new instance of StyleFunction + newStyleFunction(): Fusiontables_v2.Schema.StyleFunction; + // Create a new instance of StyleFunctionGradient + newStyleFunctionGradient(): Fusiontables_v2.Schema.StyleFunctionGradient; + // Create a new instance of StyleFunctionGradientColors + newStyleFunctionGradientColors(): Fusiontables_v2.Schema.StyleFunctionGradientColors; + // Create a new instance of StyleSetting + newStyleSetting(): Fusiontables_v2.Schema.StyleSetting; + // Create a new instance of Table + newTable(): Fusiontables_v2.Schema.Table; + // Create a new instance of Template + newTemplate(): Fusiontables_v2.Schema.Template; + } +} + +declare var Fusiontables_v2: GoogleAppsScript.Fusiontables_v2; diff --git a/types/google-apps-script/apis/gmail/v1.d.ts b/types/google-apps-script/apis/gmail/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/gmail_v1.d.ts b/types/google-apps-script/apis/gmail_v1.d.ts new file mode 100644 index 0000000000..bc848817e9 --- /dev/null +++ b/types/google-apps-script/apis/gmail_v1.d.ts @@ -0,0 +1,518 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Gmail_v1 { + namespace Collection { + namespace Users { + namespace Messages { + export interface AttachmentsCollection { + // Gets the specified message attachment. + get(userId: string, messageId: string, id: string): Gmail_v1.Schema.MessagePartBody; + } + } + namespace Settings { + namespace SendAs { + export interface SmimeInfoCollection { + // Gets the specified S/MIME config for the specified send-as alias. + get(userId: string, sendAsEmail: string, id: string): Gmail_v1.Schema.SmimeInfo; + // Insert (upload) the given S/MIME config for the specified send-as alias. Note that pkcs12 format is required for the key. + insert(resource: Schema.SmimeInfo, userId: string, sendAsEmail: string): Gmail_v1.Schema.SmimeInfo; + // Lists S/MIME configs for the specified send-as alias. + list(userId: string, sendAsEmail: string): Gmail_v1.Schema.ListSmimeInfoResponse; + // Deletes the specified S/MIME config for the specified send-as alias. + remove(userId: string, sendAsEmail: string, id: string): void; + // Sets the default S/MIME config for the specified send-as alias. + setDefault(userId: string, sendAsEmail: string, id: string): void; + } + } + export interface DelegatesCollection { + // Adds a delegate with its verification status set directly to accepted, without sending any verification email. The delegate user must be a member of the same G Suite organization as the delegator user. + // Gmail imposes limtations on the number of delegates and delegators each user in a G Suite organization can have. These limits depend on your organization, but in general each user can have up to 25 delegates and up to 10 delegators. + // Note that a delegate user must be referred to by their primary email address, and not an email alias. + // Also note that when a new delegate is created, there may be up to a one minute delay before the new delegate is available for use. + // This method is only available to service account clients that have been delegated domain-wide authority. + create(resource: Schema.Delegate, userId: string): Gmail_v1.Schema.Delegate; + // Gets the specified delegate. + // Note that a delegate user must be referred to by their primary email address, and not an email alias. + // This method is only available to service account clients that have been delegated domain-wide authority. + get(userId: string, delegateEmail: string): Gmail_v1.Schema.Delegate; + // Lists the delegates for the specified account. + // This method is only available to service account clients that have been delegated domain-wide authority. + list(userId: string): Gmail_v1.Schema.ListDelegatesResponse; + // Removes the specified delegate (which can be of any verification status), and revokes any verification that may have been required for using it. + // Note that a delegate user must be referred to by their primary email address, and not an email alias. + // This method is only available to service account clients that have been delegated domain-wide authority. + remove(userId: string, delegateEmail: string): void; + } + export interface FiltersCollection { + // Creates a filter. + create(resource: Schema.Filter, userId: string): Gmail_v1.Schema.Filter; + // Gets a filter. + get(userId: string, id: string): Gmail_v1.Schema.Filter; + // Lists the message filters of a Gmail user. + list(userId: string): Gmail_v1.Schema.ListFiltersResponse; + // Deletes a filter. + remove(userId: string, id: string): void; + } + export 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_v1.Schema.ForwardingAddress; + // Gets the specified forwarding address. + get(userId: string, forwardingEmail: string): Gmail_v1.Schema.ForwardingAddress; + // Lists the forwarding addresses for the specified account. + list(userId: string): Gmail_v1.Schema.ListForwardingAddressesResponse; + // Deletes the specified forwarding address and revokes any verification that may have been required. + // This method is only available to service account clients that have been delegated domain-wide authority. + remove(userId: string, forwardingEmail: string): void; + } + export interface SendAsCollection { + SmimeInfo?: Gmail_v1.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. + create(resource: Schema.SendAs, userId: string): Gmail_v1.Schema.SendAs; + // Gets the specified send-as alias. Fails with an HTTP 404 error if the specified address is not a member of the collection. + get(userId: string, sendAsEmail: string): Gmail_v1.Schema.SendAs; + // Lists the send-as aliases for the specified account. The result includes the primary send-as address associated with the account as well as any custom "from" aliases. + list(userId: string): Gmail_v1.Schema.ListSendAsResponse; + // Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. + // Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. This method supports patch semantics. + patch(resource: Schema.SendAs, userId: string, sendAsEmail: string): Gmail_v1.Schema.SendAs; + // Deletes the specified send-as alias. Revokes any verification that may have been required for using it. + // This method is only available to service account clients that have been delegated domain-wide authority. + remove(userId: string, sendAsEmail: string): void; + // Updates a send-as alias. If a signature is provided, Gmail will sanitize the HTML before saving it with the alias. + // Addresses other than the primary address for the account can only be updated by service account clients that have been delegated domain-wide authority. + update(resource: Schema.SendAs, userId: string, sendAsEmail: string): Gmail_v1.Schema.SendAs; + // Sends a verification email to the specified send-as alias address. The verification status must be pending. + // This method is only available to service account clients that have been delegated domain-wide authority. + verify(userId: string, sendAsEmail: string): void; + } + } + export interface DraftsCollection { + // Creates a new draft with the DRAFT label. + create(resource: Schema.Draft, userId: string): Gmail_v1.Schema.Draft; + // Creates a new draft with the DRAFT label. + create(resource: Schema.Draft, userId: string, mediaData: any): Gmail_v1.Schema.Draft; + // Gets the specified draft. + get(userId: string, id: string): Gmail_v1.Schema.Draft; + // Gets the specified draft. + get(userId: string, id: string, optionalArgs: object): Gmail_v1.Schema.Draft; + // Lists the drafts in the user's mailbox. + list(userId: string): Gmail_v1.Schema.ListDraftsResponse; + // Lists the drafts in the user's mailbox. + list(userId: string, optionalArgs: object): Gmail_v1.Schema.ListDraftsResponse; + // Immediately and permanently deletes the specified draft. Does not simply trash it. + remove(userId: string, id: string): void; + // Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. + send(resource: Schema.Draft, userId: string): Gmail_v1.Schema.Message; + // Sends the specified, existing draft to the recipients in the To, Cc, and Bcc headers. + send(resource: Schema.Draft, userId: string, mediaData: any): Gmail_v1.Schema.Message; + // Replaces a draft's content. + update(resource: Schema.Draft, userId: string, id: string): Gmail_v1.Schema.Draft; + // Replaces a draft's content. + update(resource: Schema.Draft, userId: string, id: string, mediaData: any): Gmail_v1.Schema.Draft; + } + export 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_v1.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_v1.Schema.ListHistoryResponse; + } + export interface LabelsCollection { + // Creates a new label. + create(resource: Schema.Label, userId: string): Gmail_v1.Schema.Label; + // Gets the specified label. + get(userId: string, id: string): Gmail_v1.Schema.Label; + // Lists all labels in the user's mailbox. + list(userId: string): Gmail_v1.Schema.ListLabelsResponse; + // Updates the specified label. This method supports patch semantics. + patch(resource: Schema.Label, userId: string, id: string): Gmail_v1.Schema.Label; + // Immediately and permanently deletes the specified label and removes it from any messages and threads that it is applied to. + remove(userId: string, id: string): void; + // Updates the specified label. + update(resource: Schema.Label, userId: string, id: string): Gmail_v1.Schema.Label; + } + export interface MessagesCollection { + Attachments?: Gmail_v1.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; + // Modifies the labels on the specified messages. + batchModify(resource: Schema.BatchModifyMessagesRequest, userId: string): void; + // Gets the specified message. + get(userId: string, id: string): Gmail_v1.Schema.Message; + // Gets the specified message. + get(userId: string, id: string, optionalArgs: object): Gmail_v1.Schema.Message; + // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. + import(resource: Schema.Message, userId: string): Gmail_v1.Schema.Message; + // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. + import(resource: Schema.Message, userId: string, mediaData: any): Gmail_v1.Schema.Message; + // Imports a message into only this user's mailbox, with standard email delivery scanning and classification similar to receiving via SMTP. Does not send a message. + import(resource: Schema.Message, userId: string, mediaData: any, optionalArgs: object): Gmail_v1.Schema.Message; + // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. + insert(resource: Schema.Message, userId: string): Gmail_v1.Schema.Message; + // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. + insert(resource: Schema.Message, userId: string, mediaData: any): Gmail_v1.Schema.Message; + // Directly inserts a message into only this user's mailbox similar to IMAP APPEND, bypassing most scanning and classification. Does not send a message. + insert(resource: Schema.Message, userId: string, mediaData: any, optionalArgs: object): Gmail_v1.Schema.Message; + // Lists the messages in the user's mailbox. + list(userId: string): Gmail_v1.Schema.ListMessagesResponse; + // Lists the messages in the user's mailbox. + list(userId: string, optionalArgs: object): Gmail_v1.Schema.ListMessagesResponse; + // Modifies the labels on the specified message. + modify(resource: Schema.ModifyMessageRequest, userId: string, id: string): Gmail_v1.Schema.Message; + // Immediately and permanently deletes the specified message. This operation cannot be undone. Prefer messages.trash instead. + remove(userId: string, id: string): void; + // Sends the specified message to the recipients in the To, Cc, and Bcc headers. + send(resource: Schema.Message, userId: string): Gmail_v1.Schema.Message; + // Sends the specified message to the recipients in the To, Cc, and Bcc headers. + send(resource: Schema.Message, userId: string, mediaData: any): Gmail_v1.Schema.Message; + // Moves the specified message to the trash. + trash(userId: string, id: string): Gmail_v1.Schema.Message; + // Removes the specified message from the trash. + untrash(userId: string, id: string): Gmail_v1.Schema.Message; + } + export interface SettingsCollection { + Delegates?: Gmail_v1.Collection.Users.Settings.DelegatesCollection; + Filters?: Gmail_v1.Collection.Users.Settings.FiltersCollection; + ForwardingAddresses?: Gmail_v1.Collection.Users.Settings.ForwardingAddressesCollection; + SendAs?: Gmail_v1.Collection.Users.Settings.SendAsCollection; + // Gets the auto-forwarding setting for the specified account. + getAutoForwarding(userId: string): Gmail_v1.Schema.AutoForwarding; + // Gets IMAP settings. + getImap(userId: string): Gmail_v1.Schema.ImapSettings; + // Gets POP settings. + getPop(userId: string): Gmail_v1.Schema.PopSettings; + // Gets vacation responder settings. + getVacation(userId: string): Gmail_v1.Schema.VacationSettings; + // Updates the auto-forwarding setting for the specified account. A verified forwarding address must be specified when auto-forwarding is enabled. + // This method is only available to service account clients that have been delegated domain-wide authority. + updateAutoForwarding(resource: Schema.AutoForwarding, userId: string): Gmail_v1.Schema.AutoForwarding; + // Updates IMAP settings. + updateImap(resource: Schema.ImapSettings, userId: string): Gmail_v1.Schema.ImapSettings; + // Updates POP settings. + updatePop(resource: Schema.PopSettings, userId: string): Gmail_v1.Schema.PopSettings; + // Updates vacation responder settings. + updateVacation(resource: Schema.VacationSettings, userId: string): Gmail_v1.Schema.VacationSettings; + } + export interface ThreadsCollection { + // Gets the specified thread. + get(userId: string, id: string): Gmail_v1.Schema.Thread; + // Gets the specified thread. + get(userId: string, id: string, optionalArgs: object): Gmail_v1.Schema.Thread; + // Lists the threads in the user's mailbox. + list(userId: string): Gmail_v1.Schema.ListThreadsResponse; + // Lists the threads in the user's mailbox. + list(userId: string, optionalArgs: object): Gmail_v1.Schema.ListThreadsResponse; + // Modifies the labels applied to the thread. This applies to all messages in the thread. + modify(resource: Schema.ModifyThreadRequest, userId: string, id: string): Gmail_v1.Schema.Thread; + // Immediately and permanently deletes the specified thread. This operation cannot be undone. Prefer threads.trash instead. + remove(userId: string, id: string): void; + // Moves the specified thread to the trash. + trash(userId: string, id: string): Gmail_v1.Schema.Thread; + // Removes the specified thread from the trash. + untrash(userId: string, id: string): Gmail_v1.Schema.Thread; + } + } + export interface UsersCollection { + Drafts?: Gmail_v1.Collection.Users.DraftsCollection; + History?: Gmail_v1.Collection.Users.HistoryCollection; + Labels?: Gmail_v1.Collection.Users.LabelsCollection; + Messages?: Gmail_v1.Collection.Users.MessagesCollection; + Settings?: Gmail_v1.Collection.Users.SettingsCollection; + Threads?: Gmail_v1.Collection.Users.ThreadsCollection; + // Gets the current user's Gmail profile. + getProfile(userId: string): Gmail_v1.Schema.Profile; + // Stop receiving push notifications for the given user mailbox. + stop(userId: string): void; + // Set up or update a push notification watch on the given user mailbox. + watch(resource: Schema.WatchRequest, userId: string): Gmail_v1.Schema.WatchResponse; + } + } + namespace Schema { + export interface AutoForwarding { + disposition?: string; + emailAddress?: string; + enabled?: boolean; + } + export interface BatchDeleteMessagesRequest { + ids?: string[]; + } + export interface BatchModifyMessagesRequest { + addLabelIds?: string[]; + ids?: string[]; + removeLabelIds?: string[]; + } + export interface Delegate { + delegateEmail?: string; + verificationStatus?: string; + } + export interface Draft { + id?: string; + message?: Gmail_v1.Schema.Message; + } + export interface Filter { + action?: Gmail_v1.Schema.FilterAction; + criteria?: Gmail_v1.Schema.FilterCriteria; + id?: string; + } + export interface FilterAction { + addLabelIds?: string[]; + forward?: string; + removeLabelIds?: string[]; + } + export interface FilterCriteria { + excludeChats?: boolean; + from?: string; + hasAttachment?: boolean; + negatedQuery?: string; + query?: string; + size?: number; + sizeComparison?: string; + subject?: string; + to?: string; + } + export interface ForwardingAddress { + forwardingEmail?: string; + verificationStatus?: string; + } + export interface History { + id?: string; + labelsAdded?: Gmail_v1.Schema.HistoryLabelAdded[]; + labelsRemoved?: Gmail_v1.Schema.HistoryLabelRemoved[]; + messages?: Gmail_v1.Schema.Message[]; + messagesAdded?: Gmail_v1.Schema.HistoryMessageAdded[]; + messagesDeleted?: Gmail_v1.Schema.HistoryMessageDeleted[]; + } + export interface HistoryLabelAdded { + labelIds?: string[]; + message?: Gmail_v1.Schema.Message; + } + export interface HistoryLabelRemoved { + labelIds?: string[]; + message?: Gmail_v1.Schema.Message; + } + export interface HistoryMessageAdded { + message?: Gmail_v1.Schema.Message; + } + export interface HistoryMessageDeleted { + message?: Gmail_v1.Schema.Message; + } + export interface ImapSettings { + autoExpunge?: boolean; + enabled?: boolean; + expungeBehavior?: string; + maxFolderSize?: number; + } + export interface Label { + color?: Gmail_v1.Schema.LabelColor; + id?: string; + labelListVisibility?: string; + messageListVisibility?: string; + messagesTotal?: number; + messagesUnread?: number; + name?: string; + threadsTotal?: number; + threadsUnread?: number; + type?: string; + } + export interface LabelColor { + backgroundColor?: string; + textColor?: string; + } + export interface ListDelegatesResponse { + delegates?: Gmail_v1.Schema.Delegate[]; + } + export interface ListDraftsResponse { + drafts?: Gmail_v1.Schema.Draft[]; + nextPageToken?: string; + resultSizeEstimate?: number; + } + export interface ListFiltersResponse { + filter?: Gmail_v1.Schema.Filter[]; + } + export interface ListForwardingAddressesResponse { + forwardingAddresses?: Gmail_v1.Schema.ForwardingAddress[]; + } + export interface ListHistoryResponse { + history?: Gmail_v1.Schema.History[]; + historyId?: string; + nextPageToken?: string; + } + export interface ListLabelsResponse { + labels?: Gmail_v1.Schema.Label[]; + } + export interface ListMessagesResponse { + messages?: Gmail_v1.Schema.Message[]; + nextPageToken?: string; + resultSizeEstimate?: number; + } + export interface ListSendAsResponse { + sendAs?: Gmail_v1.Schema.SendAs[]; + } + export interface ListSmimeInfoResponse { + smimeInfo?: Gmail_v1.Schema.SmimeInfo[]; + } + export interface ListThreadsResponse { + nextPageToken?: string; + resultSizeEstimate?: number; + threads?: Gmail_v1.Schema.Thread[]; + } + export interface Message { + historyId?: string; + id?: string; + internalDate?: string; + labelIds?: string[]; + payload?: Gmail_v1.Schema.MessagePart; + raw?: string; + sizeEstimate?: number; + snippet?: string; + threadId?: string; + } + export interface MessagePart { + body?: Gmail_v1.Schema.MessagePartBody; + filename?: string; + headers?: Gmail_v1.Schema.MessagePartHeader[]; + mimeType?: string; + partId?: string; + parts?: Gmail_v1.Schema.MessagePart[]; + } + export interface MessagePartBody { + attachmentId?: string; + data?: string; + size?: number; + } + export interface MessagePartHeader { + name?: string; + value?: string; + } + export interface ModifyMessageRequest { + addLabelIds?: string[]; + removeLabelIds?: string[]; + } + export interface ModifyThreadRequest { + addLabelIds?: string[]; + removeLabelIds?: string[]; + } + export interface PopSettings { + accessWindow?: string; + disposition?: string; + } + export interface Profile { + emailAddress?: string; + historyId?: string; + messagesTotal?: number; + threadsTotal?: number; + } + export interface SendAs { + displayName?: string; + isDefault?: boolean; + isPrimary?: boolean; + replyToAddress?: string; + sendAsEmail?: string; + signature?: string; + smtpMsa?: Gmail_v1.Schema.SmtpMsa; + treatAsAlias?: boolean; + verificationStatus?: string; + } + export interface SmimeInfo { + encryptedKeyPassword?: string; + expiration?: string; + id?: string; + isDefault?: boolean; + issuerCn?: string; + pem?: string; + pkcs12?: string; + } + export interface SmtpMsa { + host?: string; + password?: string; + port?: number; + securityMode?: string; + username?: string; + } + export interface Thread { + historyId?: string; + id?: string; + messages?: Gmail_v1.Schema.Message[]; + snippet?: string; + } + export interface VacationSettings { + enableAutoReply?: boolean; + endTime?: string; + responseBodyHtml?: string; + responseBodyPlainText?: string; + responseSubject?: string; + restrictToContacts?: boolean; + restrictToDomain?: boolean; + startTime?: string; + } + export interface WatchRequest { + labelFilterAction?: string; + labelIds?: string[]; + topicName?: string; + } + export interface WatchResponse { + expiration?: string; + historyId?: string; + } + } + } + export interface Gmail_v1 { + Users?: Gmail_v1.Collection.UsersCollection; + // Create a new instance of AutoForwarding + newAutoForwarding(): Gmail_v1.Schema.AutoForwarding; + // Create a new instance of BatchDeleteMessagesRequest + newBatchDeleteMessagesRequest(): Gmail_v1.Schema.BatchDeleteMessagesRequest; + // Create a new instance of BatchModifyMessagesRequest + newBatchModifyMessagesRequest(): Gmail_v1.Schema.BatchModifyMessagesRequest; + // Create a new instance of Delegate + newDelegate(): Gmail_v1.Schema.Delegate; + // Create a new instance of Draft + newDraft(): Gmail_v1.Schema.Draft; + // Create a new instance of Filter + newFilter(): Gmail_v1.Schema.Filter; + // Create a new instance of FilterAction + newFilterAction(): Gmail_v1.Schema.FilterAction; + // Create a new instance of FilterCriteria + newFilterCriteria(): Gmail_v1.Schema.FilterCriteria; + // Create a new instance of ForwardingAddress + newForwardingAddress(): Gmail_v1.Schema.ForwardingAddress; + // Create a new instance of ImapSettings + newImapSettings(): Gmail_v1.Schema.ImapSettings; + // Create a new instance of Label + newLabel(): Gmail_v1.Schema.Label; + // Create a new instance of LabelColor + newLabelColor(): Gmail_v1.Schema.LabelColor; + // Create a new instance of Message + newMessage(): Gmail_v1.Schema.Message; + // Create a new instance of MessagePart + newMessagePart(): Gmail_v1.Schema.MessagePart; + // Create a new instance of MessagePartBody + newMessagePartBody(): Gmail_v1.Schema.MessagePartBody; + // Create a new instance of MessagePartHeader + newMessagePartHeader(): Gmail_v1.Schema.MessagePartHeader; + // Create a new instance of ModifyMessageRequest + newModifyMessageRequest(): Gmail_v1.Schema.ModifyMessageRequest; + // Create a new instance of ModifyThreadRequest + newModifyThreadRequest(): Gmail_v1.Schema.ModifyThreadRequest; + // Create a new instance of PopSettings + newPopSettings(): Gmail_v1.Schema.PopSettings; + // Create a new instance of SendAs + newSendAs(): Gmail_v1.Schema.SendAs; + // Create a new instance of SmimeInfo + newSmimeInfo(): Gmail_v1.Schema.SmimeInfo; + // Create a new instance of SmtpMsa + newSmtpMsa(): Gmail_v1.Schema.SmtpMsa; + // Create a new instance of VacationSettings + newVacationSettings(): Gmail_v1.Schema.VacationSettings; + // Create a new instance of WatchRequest + newWatchRequest(): Gmail_v1.Schema.WatchRequest; + } +} + +declare var Gmail_v1: GoogleAppsScript.Gmail_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/groupsmigration/v1.d.ts b/types/google-apps-script/apis/groupsmigration/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/groupsmigration_v1.d.ts b/types/google-apps-script/apis/groupsmigration_v1.d.ts new file mode 100644 index 0000000000..189a1fba06 --- /dev/null +++ b/types/google-apps-script/apis/groupsmigration_v1.d.ts @@ -0,0 +1,29 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Groupsmigration_v1 { + namespace Collection { + export interface ArchiveCollection { + // Inserts a new mail into the archive of the Google group. + insert(groupId: string): Groupsmigration_v1.Schema.Groups; + // Inserts a new mail into the archive of the Google group. + insert(groupId: string, mediaData: any): Groupsmigration_v1.Schema.Groups; + } + } + namespace Schema { + export interface Groups { + kind?: string; + responseCode?: string; + } + } + } + export interface Groupsmigration_v1 { + Archive?: Groupsmigration_v1.Collection.ArchiveCollection; + } +} + +declare var Groupsmigration_v1: GoogleAppsScript.Groupsmigration_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/groupssettings/v1.d.ts b/types/google-apps-script/apis/groupssettings/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/groupssettings_v1.d.ts b/types/google-apps-script/apis/groupssettings_v1.d.ts new file mode 100644 index 0000000000..71f60b438f --- /dev/null +++ b/types/google-apps-script/apis/groupssettings_v1.d.ts @@ -0,0 +1,92 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Groupssettings_v1 { + namespace Collection { + export interface GroupsCollection { + // Gets one resource by id. + get(groupUniqueId: string): Groupssettings_v1.Schema.Groups; + // Updates an existing resource. This method supports patch semantics. + patch(resource: Schema.Groups, groupUniqueId: string): Groupssettings_v1.Schema.Groups; + // Updates an existing resource. + update(resource: Schema.Groups, groupUniqueId: string): Groupssettings_v1.Schema.Groups; + } + } + namespace Schema { + export interface Groups { + allowExternalMembers?: string; + allowGoogleCommunication?: string; + allowWebPosting?: string; + archiveOnly?: string; + customFooterText?: string; + customReplyTo?: string; + customRolesEnabledForSettingsToBeMerged?: string; + defaultMessageDenyNotificationText?: string; + description?: string; + email?: string; + enableCollaborativeInbox?: string; + favoriteRepliesOnTop?: string; + includeCustomFooter?: string; + includeInGlobalAddressList?: string; + isArchived?: string; + kind?: string; + maxMessageBytes?: number; + membersCanPostAsTheGroup?: string; + messageDisplayFont?: string; + messageModerationLevel?: string; + name?: string; + primaryLanguage?: string; + replyTo?: string; + sendMessageDenyNotification?: string; + showInGroupDirectory?: string; + spamModerationLevel?: string; + whoCanAdd?: string; + whoCanAddReferences?: string; + whoCanApproveMembers?: string; + whoCanApproveMessages?: string; + whoCanAssignTopics?: string; + whoCanAssistContent?: string; + whoCanBanUsers?: string; + whoCanContactOwner?: string; + whoCanDeleteAnyPost?: string; + whoCanDeleteTopics?: string; + whoCanDiscoverGroup?: string; + whoCanEnterFreeFormTags?: string; + whoCanHideAbuse?: string; + whoCanInvite?: string; + whoCanJoin?: string; + whoCanLeaveGroup?: string; + whoCanLockTopics?: string; + whoCanMakeTopicsSticky?: string; + whoCanMarkDuplicate?: string; + whoCanMarkFavoriteReplyOnAnyTopic?: string; + whoCanMarkFavoriteReplyOnOwnTopic?: string; + whoCanMarkNoResponseNeeded?: string; + whoCanModerateContent?: string; + whoCanModerateMembers?: string; + whoCanModifyMembers?: string; + whoCanModifyTagsAndCategories?: string; + whoCanMoveTopicsIn?: string; + whoCanMoveTopicsOut?: string; + whoCanPostAnnouncements?: string; + whoCanPostMessage?: string; + whoCanTakeTopics?: string; + whoCanUnassignTopic?: string; + whoCanUnmarkFavoriteReplyOnAnyTopic?: string; + whoCanViewGroup?: string; + whoCanViewMembership?: string; + } + } + } + export interface Groupssettings_v1 { + Groups?: Groupssettings_v1.Collection.GroupsCollection; + // Create a new instance of Groups + newGroups(): Groupssettings_v1.Schema.Groups; + } +} + +declare var Groupssettings_v1: GoogleAppsScript.Groupssettings_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/licensing/v1.d.ts b/types/google-apps-script/apis/licensing/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/licensing_v1.d.ts b/types/google-apps-script/apis/licensing_v1.d.ts new file mode 100644 index 0000000000..7621eeeef5 --- /dev/null +++ b/types/google-apps-script/apis/licensing_v1.d.ts @@ -0,0 +1,62 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Licensing_v1 { + namespace Collection { + export interface LicenseAssignmentsCollection { + // Get license assignment of a particular product and sku for a user + get(productId: string, skuId: string, userId: string): Licensing_v1.Schema.LicenseAssignment; + // Assign License. + insert(resource: Schema.LicenseAssignmentInsert, productId: string, skuId: string): Licensing_v1.Schema.LicenseAssignment; + // List license assignments for given product of the customer. + listForProduct(productId: string, customerId: string): Licensing_v1.Schema.LicenseAssignmentList; + // List license assignments for given product of the customer. + listForProduct(productId: string, customerId: string, optionalArgs: object): Licensing_v1.Schema.LicenseAssignmentList; + // List license assignments for given product and sku of the customer. + listForProductAndSku(productId: string, skuId: string, customerId: string): Licensing_v1.Schema.LicenseAssignmentList; + // List license assignments for given product and sku of the customer. + listForProductAndSku(productId: string, skuId: string, customerId: string, optionalArgs: object): Licensing_v1.Schema.LicenseAssignmentList; + // Assign License. This method supports patch semantics. + patch(resource: Schema.LicenseAssignment, productId: string, skuId: string, userId: string): Licensing_v1.Schema.LicenseAssignment; + // Revoke License. + remove(productId: string, skuId: string, userId: string): void; + // Assign License. + update(resource: Schema.LicenseAssignment, productId: string, skuId: string, userId: string): Licensing_v1.Schema.LicenseAssignment; + } + } + namespace Schema { + export interface LicenseAssignment { + etags?: string; + kind?: string; + productId?: string; + productName?: string; + selfLink?: string; + skuId?: string; + skuName?: string; + userId?: string; + } + export interface LicenseAssignmentInsert { + userId?: string; + } + export interface LicenseAssignmentList { + etag?: string; + items?: Licensing_v1.Schema.LicenseAssignment[]; + kind?: string; + nextPageToken?: string; + } + } + } + export interface Licensing_v1 { + LicenseAssignments?: Licensing_v1.Collection.LicenseAssignmentsCollection; + // Create a new instance of LicenseAssignment + newLicenseAssignment(): Licensing_v1.Schema.LicenseAssignment; + // Create a new instance of LicenseAssignmentInsert + newLicenseAssignmentInsert(): Licensing_v1.Schema.LicenseAssignmentInsert; + } +} + +declare var Licensing_v1: GoogleAppsScript.Licensing_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/mirror/v1.d.ts b/types/google-apps-script/apis/mirror/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/mirror_v1.d.ts b/types/google-apps-script/apis/mirror_v1.d.ts new file mode 100644 index 0000000000..6993fb6033 --- /dev/null +++ b/types/google-apps-script/apis/mirror_v1.d.ts @@ -0,0 +1,266 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Mirror_v1 { + namespace Collection { + namespace Timeline { + export interface AttachmentsCollection { + // Retrieves an attachment on a timeline item by item ID and attachment ID. + get(itemId: string, attachmentId: string): Mirror_v1.Schema.Attachment; + // Adds a new attachment to a timeline item. + insert(itemId: string): Mirror_v1.Schema.Attachment; + // Adds a new attachment to a timeline item. + insert(itemId: string, mediaData: any): Mirror_v1.Schema.Attachment; + // Returns a list of attachments for a timeline item. + list(itemId: string): Mirror_v1.Schema.AttachmentsListResponse; + // Deletes an attachment from a timeline item. + remove(itemId: string, attachmentId: string): void; + } + } + export interface AccountsCollection { + // Inserts a new account for a user + insert(resource: Schema.Account, userToken: string, accountType: string, accountName: string): Mirror_v1.Schema.Account; + } + export interface ContactsCollection { + // Gets a single contact by ID. + get(id: string): Mirror_v1.Schema.Contact; + // Inserts a new contact. + insert(resource: Schema.Contact): Mirror_v1.Schema.Contact; + // Retrieves a list of contacts for the authenticated user. + list(): Mirror_v1.Schema.ContactsListResponse; + // Updates a contact in place. This method supports patch semantics. + patch(resource: Schema.Contact, id: string): Mirror_v1.Schema.Contact; + // Deletes a contact. + remove(id: string): void; + // Updates a contact in place. + update(resource: Schema.Contact, id: string): Mirror_v1.Schema.Contact; + } + export interface LocationsCollection { + // Gets a single location by ID. + get(id: string): Mirror_v1.Schema.Location; + // Retrieves a list of locations for the user. + list(): Mirror_v1.Schema.LocationsListResponse; + } + export interface SettingsCollection { + // Gets a single setting by ID. + get(id: string): Mirror_v1.Schema.Setting; + } + export interface SubscriptionsCollection { + // Creates a new subscription. + insert(resource: Schema.Subscription): Mirror_v1.Schema.Subscription; + // Retrieves a list of subscriptions for the authenticated user and service. + list(): Mirror_v1.Schema.SubscriptionsListResponse; + // Deletes a subscription. + remove(id: string): void; + // Updates an existing subscription in place. + update(resource: Schema.Subscription, id: string): Mirror_v1.Schema.Subscription; + } + export interface TimelineCollection { + Attachments?: Mirror_v1.Collection.Timeline.AttachmentsCollection; + // Gets a single timeline item by ID. + get(id: string): Mirror_v1.Schema.TimelineItem; + // Inserts a new item into the timeline. + insert(resource: Schema.TimelineItem): Mirror_v1.Schema.TimelineItem; + // Inserts a new item into the timeline. + insert(resource: Schema.TimelineItem, mediaData: any): Mirror_v1.Schema.TimelineItem; + // Retrieves a list of timeline items for the authenticated user. + list(): Mirror_v1.Schema.TimelineListResponse; + // Retrieves a list of timeline items for the authenticated user. + list(optionalArgs: object): Mirror_v1.Schema.TimelineListResponse; + // Updates a timeline item in place. This method supports patch semantics. + patch(resource: Schema.TimelineItem, id: string): Mirror_v1.Schema.TimelineItem; + // Deletes a timeline item. + remove(id: string): void; + // Updates a timeline item in place. + update(resource: Schema.TimelineItem, id: string): Mirror_v1.Schema.TimelineItem; + // Updates a timeline item in place. + update(resource: Schema.TimelineItem, id: string, mediaData: any): Mirror_v1.Schema.TimelineItem; + } + } + namespace Schema { + export interface Account { + authTokens?: Mirror_v1.Schema.AuthToken[]; + features?: string[]; + password?: string; + userData?: Mirror_v1.Schema.UserData[]; + } + export interface Attachment { + contentType?: string; + contentUrl?: string; + id?: string; + isProcessingContent?: boolean; + } + export interface AttachmentsListResponse { + items?: Mirror_v1.Schema.Attachment[]; + kind?: string; + } + export interface AuthToken { + authToken?: string; + type?: string; + } + export interface Command { + type?: string; + } + export interface Contact { + acceptCommands?: Mirror_v1.Schema.Command[]; + acceptTypes?: string[]; + displayName?: string; + id?: string; + imageUrls?: string[]; + kind?: string; + phoneNumber?: string; + priority?: number; + sharingFeatures?: string[]; + source?: string; + speakableName?: string; + type?: string; + } + export interface ContactsListResponse { + items?: Mirror_v1.Schema.Contact[]; + kind?: string; + } + export interface Location { + accuracy?: Number; + address?: string; + displayName?: string; + id?: string; + kind?: string; + latitude?: Number; + longitude?: Number; + timestamp?: string; + } + export interface LocationsListResponse { + items?: Mirror_v1.Schema.Location[]; + kind?: string; + } + export interface MenuItem { + action?: string; + contextual_command?: string; + id?: string; + payload?: string; + removeWhenSelected?: boolean; + values?: Mirror_v1.Schema.MenuValue[]; + } + export interface MenuValue { + displayName?: string; + iconUrl?: string; + state?: string; + } + export interface Notification { + collection?: string; + itemId?: string; + operation?: string; + userActions?: Mirror_v1.Schema.UserAction[]; + userToken?: string; + verifyToken?: string; + } + export interface NotificationConfig { + deliveryTime?: string; + level?: string; + } + export interface Setting { + id?: string; + kind?: string; + value?: string; + } + export interface Subscription { + callbackUrl?: string; + collection?: string; + id?: string; + kind?: string; + notification?: Mirror_v1.Schema.Notification; + operation?: string[]; + updated?: string; + userToken?: string; + verifyToken?: string; + } + export interface SubscriptionsListResponse { + items?: Mirror_v1.Schema.Subscription[]; + kind?: string; + } + export interface TimelineItem { + attachments?: Mirror_v1.Schema.Attachment[]; + bundleId?: string; + canonicalUrl?: string; + created?: string; + creator?: Mirror_v1.Schema.Contact; + displayTime?: string; + etag?: string; + html?: string; + id?: string; + inReplyTo?: string; + isBundleCover?: boolean; + isDeleted?: boolean; + isPinned?: boolean; + kind?: string; + location?: Mirror_v1.Schema.Location; + menuItems?: Mirror_v1.Schema.MenuItem[]; + notification?: Mirror_v1.Schema.NotificationConfig; + pinScore?: number; + recipients?: Mirror_v1.Schema.Contact[]; + selfLink?: string; + sourceItemId?: string; + speakableText?: string; + speakableType?: string; + text?: string; + title?: string; + updated?: string; + } + export interface TimelineListResponse { + items?: Mirror_v1.Schema.TimelineItem[]; + kind?: string; + nextPageToken?: string; + } + export interface UserAction { + payload?: string; + type?: string; + } + export interface UserData { + key?: string; + value?: string; + } + } + } + export interface Mirror_v1 { + Accounts?: Mirror_v1.Collection.AccountsCollection; + Contacts?: Mirror_v1.Collection.ContactsCollection; + Locations?: Mirror_v1.Collection.LocationsCollection; + Settings?: Mirror_v1.Collection.SettingsCollection; + Subscriptions?: Mirror_v1.Collection.SubscriptionsCollection; + Timeline?: Mirror_v1.Collection.TimelineCollection; + // Create a new instance of Account + newAccount(): Mirror_v1.Schema.Account; + // Create a new instance of Attachment + newAttachment(): Mirror_v1.Schema.Attachment; + // Create a new instance of AuthToken + newAuthToken(): Mirror_v1.Schema.AuthToken; + // Create a new instance of Command + newCommand(): Mirror_v1.Schema.Command; + // Create a new instance of Contact + newContact(): Mirror_v1.Schema.Contact; + // Create a new instance of Location + newLocation(): Mirror_v1.Schema.Location; + // Create a new instance of MenuItem + newMenuItem(): Mirror_v1.Schema.MenuItem; + // Create a new instance of MenuValue + newMenuValue(): Mirror_v1.Schema.MenuValue; + // Create a new instance of Notification + newNotification(): Mirror_v1.Schema.Notification; + // Create a new instance of NotificationConfig + newNotificationConfig(): Mirror_v1.Schema.NotificationConfig; + // Create a new instance of Subscription + newSubscription(): Mirror_v1.Schema.Subscription; + // Create a new instance of TimelineItem + newTimelineItem(): Mirror_v1.Schema.TimelineItem; + // Create a new instance of UserAction + newUserAction(): Mirror_v1.Schema.UserAction; + // Create a new instance of UserData + newUserData(): Mirror_v1.Schema.UserData; + } +} + +declare var Mirror_v1: GoogleAppsScript.Mirror_v1; diff --git a/types/google-apps-script/apis/peopleapi_v1.d.ts b/types/google-apps-script/apis/peopleapi_v1.d.ts new file mode 100644 index 0000000000..4fecaf9bfa --- /dev/null +++ b/types/google-apps-script/apis/peopleapi_v1.d.ts @@ -0,0 +1,518 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Peopleapi_v1 { + namespace Collection { + namespace ContactGroups { + export interface MembersCollection { + // Modify the members of a contact group owned by the authenticated user. + //
+ // The only system contact groups that can have members added are + // `contactGroups/myContacts` and `contactGroups/starred`. Other system + // contact groups are deprecated and can only have contacts removed. + modify(resource: Schema.ModifyContactGroupMembersRequest, resourceName: string): Peopleapi_v1.Schema.ModifyContactGroupMembersResponse; + } + } + namespace People { + export interface ConnectionsCollection { + // Provides a list of the authenticated user's contacts merged with any + // connected profiles. + //
+ // The request throws a 400 error if 'personFields' is not specified. + list(resourceName: string): Peopleapi_v1.Schema.ListConnectionsResponse; + // Provides a list of the authenticated user's contacts merged with any + // connected profiles. + //
+ // The request throws a 400 error if 'personFields' is not specified. + list(resourceName: string, optionalArgs: object): Peopleapi_v1.Schema.ListConnectionsResponse; + } + } + export interface ContactGroupsCollection { + Members?: Peopleapi_v1.Collection.ContactGroups.MembersCollection; + // Get a list of contact groups owned by the authenticated user by specifying + // a list of contact group resource names. + batchGet(): Peopleapi_v1.Schema.BatchGetContactGroupsResponse; + // Get a list of contact groups owned by the authenticated user by specifying + // a list of contact group resource names. + batchGet(optionalArgs: object): Peopleapi_v1.Schema.BatchGetContactGroupsResponse; + // Create a new contact group owned by the authenticated user. + create(resource: Schema.CreateContactGroupRequest): Peopleapi_v1.Schema.ContactGroup; + // Get a specific contact group owned by the authenticated user by specifying + // a contact group resource name. + get(resourceName: string): Peopleapi_v1.Schema.ContactGroup; + // Get a specific contact group owned by the authenticated user by specifying + // a contact group resource name. + get(resourceName: string, optionalArgs: object): Peopleapi_v1.Schema.ContactGroup; + // List all contact groups owned by the authenticated user. Members of the + // contact groups are not populated. + list(): Peopleapi_v1.Schema.ListContactGroupsResponse; + // List all contact groups owned by the authenticated user. Members of the + // contact groups are not populated. + list(optionalArgs: object): Peopleapi_v1.Schema.ListContactGroupsResponse; + // Delete an existing contact group owned by the authenticated user by + // specifying a contact group resource name. + remove(resourceName: string): void; + // Delete an existing contact group owned by the authenticated user by + // specifying a contact group resource name. + remove(resourceName: string, optionalArgs: object): void; + // Update the name of an existing contact group owned by the authenticated + // user. + update(resource: Schema.UpdateContactGroupRequest, resourceName: string): Peopleapi_v1.Schema.ContactGroup; + } + export interface PeopleCollection { + Connections?: Peopleapi_v1.Collection.People.ConnectionsCollection; + // Create a new contact and return the person resource for that contact. + createContact(resource: Schema.Person): Peopleapi_v1.Schema.Person; + // Create a new contact and return the person resource for that contact. + createContact(resource: Schema.Person, optionalArgs: object): Peopleapi_v1.Schema.Person; + // Delete a contact person. Any non-contact data will not be deleted. + deleteContact(resourceName: string): void; + // Provides information about a person by specifying a resource name. Use + // `people/me` to indicate the authenticated user. + //
+ // The request throws a 400 error if 'personFields' is not specified. + get(resourceName: string): Peopleapi_v1.Schema.Person; + // Provides information about a person by specifying a resource name. Use + // `people/me` to indicate the authenticated user. + //
+ // The request throws a 400 error if 'personFields' is not specified. + get(resourceName: string, optionalArgs: object): Peopleapi_v1.Schema.Person; + // Provides information about a list of specific people by specifying a list + // of requested resource names. Use `people/me` to indicate the authenticated + // user. + //
+ // The request throws a 400 error if 'personFields' is not specified. + getBatchGet(): Peopleapi_v1.Schema.GetPeopleResponse; + // Provides information about a list of specific people by specifying a list + // of requested resource names. Use `people/me` to indicate the authenticated + // user. + //
+ // The request throws a 400 error if 'personFields' is not specified. + getBatchGet(optionalArgs: object): Peopleapi_v1.Schema.GetPeopleResponse; + // Update contact data for an existing contact person. Any non-contact data + // will not be modified. + // The request throws a 400 error if `updatePersonFields` is not specified. + //
+ // The request throws a 400 error if `person.metadata.sources` is not + // specified for the contact to be updated. + //
+ // The request throws a 412 error if `person.metadata.sources.etag` is + // different than the contact's etag, which indicates the contact has changed + // since its data was read. Clients should get the latest person and re-apply + // their updates to the latest person. + updateContact(resource: Schema.Person, resourceName: string): Peopleapi_v1.Schema.Person; + // Update contact data for an existing contact person. Any non-contact data + // will not be modified. + // The request throws a 400 error if `updatePersonFields` is not specified. + //
+ // The request throws a 400 error if `person.metadata.sources` is not + // specified for the contact to be updated. + //
+ // The request throws a 412 error if `person.metadata.sources.etag` is + // different than the contact's etag, which indicates the contact has changed + // since its data was read. Clients should get the latest person and re-apply + // their updates to the latest person. + updateContact(resource: Schema.Person, resourceName: string, optionalArgs: object): Peopleapi_v1.Schema.Person; + } + } + namespace Schema { + export interface Address { + city?: string; + country?: string; + countryCode?: string; + extendedAddress?: string; + formattedType?: string; + formattedValue?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + poBox?: string; + postalCode?: string; + region?: string; + streetAddress?: string; + type?: string; + } + export interface AgeRangeType { + ageRange?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + } + export interface BatchGetContactGroupsResponse { + responses?: Peopleapi_v1.Schema.ContactGroupResponse[]; + } + export interface Biography { + contentType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface Birthday { + date?: Peopleapi_v1.Schema.Date; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + text?: string; + } + export interface BraggingRights { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface ContactGroup { + etag?: string; + formattedName?: string; + groupType?: string; + memberCount?: number; + memberResourceNames?: string[]; + metadata?: Peopleapi_v1.Schema.ContactGroupMetadata; + name?: string; + resourceName?: string; + } + export interface ContactGroupMembership { + contactGroupId?: string; + } + export interface ContactGroupMetadata { + deleted?: boolean; + updateTime?: string; + } + export interface ContactGroupResponse { + contactGroup?: Peopleapi_v1.Schema.ContactGroup; + requestedResourceName?: string; + status?: Peopleapi_v1.Schema.Status; + } + export interface CoverPhoto { + default?: boolean; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + url?: string; + } + export interface CreateContactGroupRequest { + contactGroup?: Peopleapi_v1.Schema.ContactGroup; + } + export interface Date { + day?: number; + month?: number; + year?: number; + } + export interface DomainMembership { + inViewerDomain?: boolean; + } + export interface EmailAddress { + displayName?: string; + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + value?: string; + } + export interface Event { + date?: Peopleapi_v1.Schema.Date; + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + } + export interface FieldMetadata { + primary?: boolean; + source?: Peopleapi_v1.Schema.Source; + verified?: boolean; + } + export interface Gender { + formattedValue?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface GetPeopleResponse { + responses?: Peopleapi_v1.Schema.PersonResponse[]; + } + export interface ImClient { + formattedProtocol?: string; + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + protocol?: string; + type?: string; + username?: string; + } + export interface Interest { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface ListConnectionsResponse { + connections?: Peopleapi_v1.Schema.Person[]; + nextPageToken?: string; + nextSyncToken?: string; + totalItems?: number; + totalPeople?: number; + } + export interface ListContactGroupsResponse { + contactGroups?: Peopleapi_v1.Schema.ContactGroup[]; + nextPageToken?: string; + nextSyncToken?: string; + totalItems?: number; + } + export interface Locale { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface Membership { + contactGroupMembership?: Peopleapi_v1.Schema.ContactGroupMembership; + domainMembership?: Peopleapi_v1.Schema.DomainMembership; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + } + export interface ModifyContactGroupMembersRequest { + resourceNamesToAdd?: string[]; + resourceNamesToRemove?: string[]; + } + export interface ModifyContactGroupMembersResponse { + notFoundResourceNames?: string[]; + } + export interface Name { + displayName?: string; + displayNameLastFirst?: string; + familyName?: string; + givenName?: string; + honorificPrefix?: string; + honorificSuffix?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + middleName?: string; + phoneticFamilyName?: string; + phoneticFullName?: string; + phoneticGivenName?: string; + phoneticHonorificPrefix?: string; + phoneticHonorificSuffix?: string; + phoneticMiddleName?: string; + } + export interface Nickname { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + value?: string; + } + export interface Occupation { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface Organization { + current?: boolean; + department?: string; + domain?: string; + endDate?: Peopleapi_v1.Schema.Date; + formattedType?: string; + jobDescription?: string; + location?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + name?: string; + phoneticName?: string; + startDate?: Peopleapi_v1.Schema.Date; + symbol?: string; + title?: string; + type?: string; + } + export interface Person { + addresses?: Peopleapi_v1.Schema.Address[]; + ageRange?: string; + ageRanges?: Peopleapi_v1.Schema.AgeRangeType[]; + biographies?: Peopleapi_v1.Schema.Biography[]; + birthdays?: Peopleapi_v1.Schema.Birthday[]; + braggingRights?: Peopleapi_v1.Schema.BraggingRights[]; + coverPhotos?: Peopleapi_v1.Schema.CoverPhoto[]; + emailAddresses?: Peopleapi_v1.Schema.EmailAddress[]; + etag?: string; + events?: Peopleapi_v1.Schema.Event[]; + genders?: Peopleapi_v1.Schema.Gender[]; + imClients?: Peopleapi_v1.Schema.ImClient[]; + interests?: Peopleapi_v1.Schema.Interest[]; + locales?: Peopleapi_v1.Schema.Locale[]; + memberships?: Peopleapi_v1.Schema.Membership[]; + metadata?: Peopleapi_v1.Schema.PersonMetadata; + names?: Peopleapi_v1.Schema.Name[]; + nicknames?: Peopleapi_v1.Schema.Nickname[]; + occupations?: Peopleapi_v1.Schema.Occupation[]; + organizations?: Peopleapi_v1.Schema.Organization[]; + phoneNumbers?: Peopleapi_v1.Schema.PhoneNumber[]; + photos?: Peopleapi_v1.Schema.Photo[]; + relations?: Peopleapi_v1.Schema.Relation[]; + relationshipInterests?: Peopleapi_v1.Schema.RelationshipInterest[]; + relationshipStatuses?: Peopleapi_v1.Schema.RelationshipStatus[]; + residences?: Peopleapi_v1.Schema.Residence[]; + resourceName?: string; + sipAddresses?: Peopleapi_v1.Schema.SipAddress[]; + skills?: Peopleapi_v1.Schema.Skill[]; + taglines?: Peopleapi_v1.Schema.Tagline[]; + urls?: Peopleapi_v1.Schema.Url[]; + userDefined?: Peopleapi_v1.Schema.UserDefined[]; + } + export interface PersonMetadata { + deleted?: boolean; + linkedPeopleResourceNames?: string[]; + objectType?: string; + previousResourceNames?: string[]; + sources?: Peopleapi_v1.Schema.Source[]; + } + export interface PersonResponse { + httpStatusCode?: number; + person?: Peopleapi_v1.Schema.Person; + requestedResourceName?: string; + status?: Peopleapi_v1.Schema.Status; + } + export interface PhoneNumber { + canonicalForm?: string; + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + value?: string; + } + export interface Photo { + default?: boolean; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + url?: string; + } + export interface ProfileMetadata { + objectType?: string; + userTypes?: string[]; + } + export interface Relation { + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + person?: string; + type?: string; + } + export interface RelationshipInterest { + formattedValue?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface RelationshipStatus { + formattedValue?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface Residence { + current?: boolean; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface SipAddress { + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + value?: string; + } + export interface Skill { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface Source { + etag?: string; + id?: string; + profileMetadata?: Peopleapi_v1.Schema.ProfileMetadata; + type?: string; + updateTime?: string; + } + export interface Status { + code?: number; + details?: Object[]; + message?: string; + } + export interface Tagline { + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + export interface UpdateContactGroupRequest { + contactGroup?: Peopleapi_v1.Schema.ContactGroup; + } + export interface Url { + formattedType?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + type?: string; + value?: string; + } + export interface UserDefined { + key?: string; + metadata?: Peopleapi_v1.Schema.FieldMetadata; + value?: string; + } + } + } + export interface Peopleapi_v1 { + ContactGroups?: Peopleapi_v1.Collection.ContactGroupsCollection; + People?: Peopleapi_v1.Collection.PeopleCollection; + // Create a new instance of Address + newAddress(): Peopleapi_v1.Schema.Address; + // Create a new instance of AgeRangeType + newAgeRangeType(): Peopleapi_v1.Schema.AgeRangeType; + // Create a new instance of Biography + newBiography(): Peopleapi_v1.Schema.Biography; + // Create a new instance of Birthday + newBirthday(): Peopleapi_v1.Schema.Birthday; + // Create a new instance of BraggingRights + newBraggingRights(): Peopleapi_v1.Schema.BraggingRights; + // Create a new instance of ContactGroup + newContactGroup(): Peopleapi_v1.Schema.ContactGroup; + // Create a new instance of ContactGroupMembership + newContactGroupMembership(): Peopleapi_v1.Schema.ContactGroupMembership; + // Create a new instance of ContactGroupMetadata + newContactGroupMetadata(): Peopleapi_v1.Schema.ContactGroupMetadata; + // Create a new instance of CoverPhoto + newCoverPhoto(): Peopleapi_v1.Schema.CoverPhoto; + // Create a new instance of CreateContactGroupRequest + newCreateContactGroupRequest(): Peopleapi_v1.Schema.CreateContactGroupRequest; + // Create a new instance of Date + newDate(): Peopleapi_v1.Schema.Date; + // Create a new instance of DomainMembership + newDomainMembership(): Peopleapi_v1.Schema.DomainMembership; + // Create a new instance of EmailAddress + newEmailAddress(): Peopleapi_v1.Schema.EmailAddress; + // Create a new instance of Event + newEvent(): Peopleapi_v1.Schema.Event; + // Create a new instance of FieldMetadata + newFieldMetadata(): Peopleapi_v1.Schema.FieldMetadata; + // Create a new instance of Gender + newGender(): Peopleapi_v1.Schema.Gender; + // Create a new instance of ImClient + newImClient(): Peopleapi_v1.Schema.ImClient; + // Create a new instance of Interest + newInterest(): Peopleapi_v1.Schema.Interest; + // Create a new instance of Locale + newLocale(): Peopleapi_v1.Schema.Locale; + // Create a new instance of Membership + newMembership(): Peopleapi_v1.Schema.Membership; + // Create a new instance of ModifyContactGroupMembersRequest + newModifyContactGroupMembersRequest(): Peopleapi_v1.Schema.ModifyContactGroupMembersRequest; + // Create a new instance of Name + newName(): Peopleapi_v1.Schema.Name; + // Create a new instance of Nickname + newNickname(): Peopleapi_v1.Schema.Nickname; + // Create a new instance of Occupation + newOccupation(): Peopleapi_v1.Schema.Occupation; + // Create a new instance of Organization + newOrganization(): Peopleapi_v1.Schema.Organization; + // Create a new instance of Person + newPerson(): Peopleapi_v1.Schema.Person; + // Create a new instance of PersonMetadata + newPersonMetadata(): Peopleapi_v1.Schema.PersonMetadata; + // Create a new instance of PhoneNumber + newPhoneNumber(): Peopleapi_v1.Schema.PhoneNumber; + // Create a new instance of Photo + newPhoto(): Peopleapi_v1.Schema.Photo; + // Create a new instance of ProfileMetadata + newProfileMetadata(): Peopleapi_v1.Schema.ProfileMetadata; + // Create a new instance of Relation + newRelation(): Peopleapi_v1.Schema.Relation; + // Create a new instance of RelationshipInterest + newRelationshipInterest(): Peopleapi_v1.Schema.RelationshipInterest; + // Create a new instance of RelationshipStatus + newRelationshipStatus(): Peopleapi_v1.Schema.RelationshipStatus; + // Create a new instance of Residence + newResidence(): Peopleapi_v1.Schema.Residence; + // Create a new instance of SipAddress + newSipAddress(): Peopleapi_v1.Schema.SipAddress; + // Create a new instance of Skill + newSkill(): Peopleapi_v1.Schema.Skill; + // Create a new instance of Source + newSource(): Peopleapi_v1.Schema.Source; + // Create a new instance of Tagline + newTagline(): Peopleapi_v1.Schema.Tagline; + // Create a new instance of UpdateContactGroupRequest + newUpdateContactGroupRequest(): Peopleapi_v1.Schema.UpdateContactGroupRequest; + // Create a new instance of Url + newUrl(): Peopleapi_v1.Schema.Url; + // Create a new instance of UserDefined + newUserDefined(): Peopleapi_v1.Schema.UserDefined; + } +} + +declare var Peopleapi_v1: GoogleAppsScript.Peopleapi_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/plus/v1.d.ts b/types/google-apps-script/apis/plus/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/plusDomains/v1.d.ts b/types/google-apps-script/apis/plusDomains/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/reports_v1.d.ts b/types/google-apps-script/apis/reports_v1.d.ts new file mode 100644 index 0000000000..e6f3a83c0c --- /dev/null +++ b/types/google-apps-script/apis/reports_v1.d.ts @@ -0,0 +1,147 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Admin_reports_v1 { + namespace Collection { + export interface ActivitiesCollection { + // Retrieves a list of activities for a specific customer and application. + list(userKey: string, applicationName: string): Admin_reports_v1.Schema.Activities; + // Retrieves a list of activities for a specific customer and application. + list(userKey: string, applicationName: string, optionalArgs: object): Admin_reports_v1.Schema.Activities; + // Push changes to activities + watch(resource: Schema.Channel, userKey: string, applicationName: string): Admin_reports_v1.Schema.Channel; + // Push changes to activities + watch(resource: Schema.Channel, userKey: string, applicationName: string, optionalArgs: object): Admin_reports_v1.Schema.Channel; + } + export interface ChannelsCollection { + // Stop watching resources through this channel + stop(resource: Schema.Channel): void; + } + export interface CustomerUsageReportsCollection { + // Retrieves a report which is a collection of properties / statistics for a specific customer. + get(date: string): Admin_reports_v1.Schema.UsageReports; + // Retrieves a report which is a collection of properties / statistics for a specific customer. + get(date: string, optionalArgs: object): Admin_reports_v1.Schema.UsageReports; + } + export interface EntityUsageReportsCollection { + // Retrieves a report which is a collection of properties / statistics for a set of objects. + get(entityType: string, entityKey: string, date: string): Admin_reports_v1.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): Admin_reports_v1.Schema.UsageReports; + } + export interface UserUsageReportCollection { + // Retrieves a report which is a collection of properties / statistics for a set of users. + get(userKey: string, date: string): Admin_reports_v1.Schema.UsageReports; + // Retrieves a report which is a collection of properties / statistics for a set of users. + get(userKey: string, date: string, optionalArgs: object): Admin_reports_v1.Schema.UsageReports; + } + } + namespace Schema { + export interface Activities { + etag?: string; + items?: Admin_reports_v1.Schema.Activity[]; + kind?: string; + nextPageToken?: string; + } + export interface Activity { + actor?: Admin_reports_v1.Schema.ActivityActor; + etag?: string; + events?: Admin_reports_v1.Schema.ActivityEvents[]; + id?: Admin_reports_v1.Schema.ActivityId; + ipAddress?: string; + kind?: string; + ownerDomain?: string; + } + export interface ActivityActor { + callerType?: string; + email?: string; + key?: string; + profileId?: string; + } + export interface ActivityEvents { + name?: string; + parameters?: Admin_reports_v1.Schema.ActivityEventsParameters[]; + type?: string; + } + export interface ActivityEventsParameters { + boolValue?: boolean; + intValue?: string; + multiIntValue?: string[]; + multiValue?: string[]; + name?: string; + value?: string; + } + export interface ActivityId { + applicationName?: string; + customerId?: string; + time?: string; + uniqueQualifier?: string; + } + export interface Channel { + address?: string; + expiration?: string; + id?: string; + kind?: string; + params?: object; + payload?: boolean; + resourceId?: string; + resourceUri?: string; + token?: string; + type?: string; + } + export interface UsageReport { + date?: string; + entity?: Admin_reports_v1.Schema.UsageReportEntity; + etag?: string; + kind?: string; + parameters?: Admin_reports_v1.Schema.UsageReportParameters[]; + } + export interface UsageReportEntity { + customerId?: string; + entityId?: string; + profileId?: string; + type?: string; + userEmail?: string; + } + export interface UsageReportParameters { + boolValue?: boolean; + datetimeValue?: string; + intValue?: string; + msgValue?: Object[]; + name?: string; + stringValue?: string; + } + export interface UsageReports { + etag?: string; + kind?: string; + nextPageToken?: string; + usageReports?: Admin_reports_v1.Schema.UsageReport[]; + warnings?: Admin_reports_v1.Schema.UsageReportsWarnings[]; + } + export interface UsageReportsWarnings { + code?: string; + data?: Admin_reports_v1.Schema.UsageReportsWarningsData[]; + message?: string; + } + export interface UsageReportsWarningsData { + key?: string; + value?: string; + } + } + } + export interface Admin_reports_v1 { + Activities?: Admin_reports_v1.Collection.ActivitiesCollection; + Channels?: Admin_reports_v1.Collection.ChannelsCollection; + CustomerUsageReports?: Admin_reports_v1.Collection.CustomerUsageReportsCollection; + EntityUsageReports?: Admin_reports_v1.Collection.EntityUsageReportsCollection; + UserUsageReport?: Admin_reports_v1.Collection.UserUsageReportCollection; + // Create a new instance of Channel + newChannel(): Admin_reports_v1.Schema.Channel; + } +} + +declare var Admin_reports_v1: GoogleAppsScript.Admin_reports_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/reseller/v1.d.ts b/types/google-apps-script/apis/reseller/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/reseller_v1.d.ts b/types/google-apps-script/apis/reseller_v1.d.ts new file mode 100644 index 0000000000..a20d0a1ccc --- /dev/null +++ b/types/google-apps-script/apis/reseller_v1.d.ts @@ -0,0 +1,179 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Reseller_v1 { + namespace Collection { + export interface CustomersCollection { + // Get a customer account. + get(customerId: string): Reseller_v1.Schema.Customer; + // Order a new customer's account. + insert(resource: Schema.Customer): Reseller_v1.Schema.Customer; + // Order a new customer's account. + insert(resource: Schema.Customer, optionalArgs: object): Reseller_v1.Schema.Customer; + // Update a customer account's settings. This method supports patch semantics. + patch(resource: Schema.Customer, customerId: string): Reseller_v1.Schema.Customer; + // Update a customer account's settings. + update(resource: Schema.Customer, customerId: string): Reseller_v1.Schema.Customer; + } + export interface ResellernotifyCollection { + // Returns all the details of the watch corresponding to the reseller. + getwatchdetails(): Reseller_v1.Schema.ResellernotifyGetwatchdetailsResponse; + // Registers a Reseller for receiving notifications. + register(): Reseller_v1.Schema.ResellernotifyResource; + // Registers a Reseller for receiving notifications. + register(optionalArgs: object): Reseller_v1.Schema.ResellernotifyResource; + // Unregisters a Reseller for receiving notifications. + unregister(): Reseller_v1.Schema.ResellernotifyResource; + // Unregisters a Reseller for receiving notifications. + unregister(optionalArgs: object): Reseller_v1.Schema.ResellernotifyResource; + } + export interface SubscriptionsCollection { + // Activates a subscription previously suspended by the reseller + activate(customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Update a subscription plan. Use this method to update a plan for a 30-day trial or a flexible plan subscription to an annual commitment plan with monthly or yearly payments. + changePlan(resource: Schema.ChangePlanRequest, customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Update a user license's renewal settings. This is applicable for accounts with annual commitment plans only. + changeRenewalSettings(resource: Schema.RenewalSettings, customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Update a subscription's user license settings. + changeSeats(resource: Schema.Seats, customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Get a specific subscription. + get(customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Create or transfer a subscription. + insert(resource: Schema.Subscription, customerId: string): Reseller_v1.Schema.Subscription; + // Create or transfer a subscription. + insert(resource: Schema.Subscription, customerId: string, optionalArgs: object): Reseller_v1.Schema.Subscription; + // List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. + list(): Reseller_v1.Schema.Subscriptions; + // List of subscriptions managed by the reseller. The list can be all subscriptions, all of a customer's subscriptions, or all of a customer's transferable subscriptions. + list(optionalArgs: object): Reseller_v1.Schema.Subscriptions; + // Cancel or transfer a subscription to direct. + remove(customerId: string, subscriptionId: string, deletionType: string): void; + // Immediately move a 30-day free trial subscription to a paid service subscription. + startPaidService(customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + // Suspends an active subscription. + suspend(customerId: string, subscriptionId: string): Reseller_v1.Schema.Subscription; + } + } + namespace Schema { + export interface Address { + addressLine1?: string; + addressLine2?: string; + addressLine3?: string; + contactName?: string; + countryCode?: string; + kind?: string; + locality?: string; + organizationName?: string; + postalCode?: string; + region?: string; + } + export interface ChangePlanRequest { + dealCode?: string; + kind?: string; + planName?: string; + purchaseOrderId?: string; + seats?: Reseller_v1.Schema.Seats; + } + export interface Customer { + alternateEmail?: string; + customerDomain?: string; + customerDomainVerified?: boolean; + customerId?: string; + kind?: string; + phoneNumber?: string; + postalAddress?: Reseller_v1.Schema.Address; + resourceUiUrl?: string; + } + export interface RenewalSettings { + kind?: string; + renewalType?: string; + } + export interface ResellernotifyGetwatchdetailsResponse { + serviceAccountEmailAddresses?: string[]; + topicName?: string; + } + export interface ResellernotifyResource { + topicName?: string; + } + export interface Seats { + kind?: string; + licensedNumberOfSeats?: number; + maximumNumberOfSeats?: number; + numberOfSeats?: number; + } + export interface Subscription { + billingMethod?: string; + creationTime?: string; + customerDomain?: string; + customerId?: string; + dealCode?: string; + kind?: string; + plan?: Reseller_v1.Schema.SubscriptionPlan; + purchaseOrderId?: string; + renewalSettings?: Reseller_v1.Schema.RenewalSettings; + resourceUiUrl?: string; + seats?: Reseller_v1.Schema.Seats; + skuId?: string; + skuName?: string; + status?: string; + subscriptionId?: string; + suspensionReasons?: string[]; + transferInfo?: Reseller_v1.Schema.SubscriptionTransferInfo; + trialSettings?: Reseller_v1.Schema.SubscriptionTrialSettings; + } + export interface SubscriptionPlan { + commitmentInterval?: Reseller_v1.Schema.SubscriptionPlanCommitmentInterval; + isCommitmentPlan?: boolean; + planName?: string; + } + export interface SubscriptionPlanCommitmentInterval { + endTime?: string; + startTime?: string; + } + export interface SubscriptionTransferInfo { + minimumTransferableSeats?: number; + transferabilityExpirationTime?: string; + } + export interface SubscriptionTrialSettings { + isInTrial?: boolean; + trialEndTime?: string; + } + export interface Subscriptions { + kind?: string; + nextPageToken?: string; + subscriptions?: Reseller_v1.Schema.Subscription[]; + } + } + } + export interface Reseller_v1 { + Customers?: Reseller_v1.Collection.CustomersCollection; + Resellernotify?: Reseller_v1.Collection.ResellernotifyCollection; + Subscriptions?: Reseller_v1.Collection.SubscriptionsCollection; + // Create a new instance of Address + newAddress(): Reseller_v1.Schema.Address; + // Create a new instance of ChangePlanRequest + newChangePlanRequest(): Reseller_v1.Schema.ChangePlanRequest; + // Create a new instance of Customer + newCustomer(): Reseller_v1.Schema.Customer; + // Create a new instance of RenewalSettings + newRenewalSettings(): Reseller_v1.Schema.RenewalSettings; + // Create a new instance of Seats + newSeats(): Reseller_v1.Schema.Seats; + // Create a new instance of Subscription + newSubscription(): Reseller_v1.Schema.Subscription; + // Create a new instance of SubscriptionPlan + newSubscriptionPlan(): Reseller_v1.Schema.SubscriptionPlan; + // Create a new instance of SubscriptionPlanCommitmentInterval + newSubscriptionPlanCommitmentInterval(): Reseller_v1.Schema.SubscriptionPlanCommitmentInterval; + // Create a new instance of SubscriptionTransferInfo + newSubscriptionTransferInfo(): Reseller_v1.Schema.SubscriptionTransferInfo; + // Create a new instance of SubscriptionTrialSettings + newSubscriptionTrialSettings(): Reseller_v1.Schema.SubscriptionTrialSettings; + } +} + +declare var Reseller_v1: GoogleAppsScript.Reseller_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/sheets/v4.d.ts b/types/google-apps-script/apis/sheets/v4.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/sheets_v4.d.ts b/types/google-apps-script/apis/sheets_v4.d.ts new file mode 100644 index 0000000000..6d65b1aa90 --- /dev/null +++ b/types/google-apps-script/apis/sheets_v4.d.ts @@ -0,0 +1,1524 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Sheets_v4 { + namespace Collection { + namespace Spreadsheets { + export interface DeveloperMetadataCollection { + // Returns the developer metadata with the specified ID. + // The caller must specify the spreadsheet ID and the developer metadata's + // unique metadataId. + get(spreadsheetId: string, metadataId: number): Sheets_v4.Schema.DeveloperMetadata; + // Returns all developer metadata matching the specified DataFilter. + // If the provided DataFilter represents a DeveloperMetadataLookup object, + // this will return all DeveloperMetadata entries selected by it. If the + // DataFilter represents a location in a spreadsheet, this will return all + // developer metadata associated with locations intersecting that region. + search(resource: Schema.SearchDeveloperMetadataRequest, spreadsheetId: string): Sheets_v4.Schema.SearchDeveloperMetadataResponse; + } + export interface SheetsCollection { + // Copies a single sheet from a spreadsheet to another spreadsheet. + // Returns the properties of the newly created sheet. + copyTo(resource: Schema.CopySheetToAnotherSpreadsheetRequest, spreadsheetId: string, sheetId: number): Sheets_v4.Schema.SheetProperties; + } + export interface ValuesCollection { + // Appends values to a spreadsheet. The input range is used to search for + // existing data and find a "table" within that range. Values will be + // appended to the next row of the table, starting with the first column of + // the table. See the + // [guide](/sheets/api/guides/values#appending_values) + // and + // [sample code](/sheets/api/samples/writing#append_values) + // for specific details of how tables are detected and data is appended. + // The caller must specify the spreadsheet ID, range, and + // a valueInputOption. The `valueInputOption` only + // controls how the input data will be added to the sheet (column-wise or + // row-wise), it does not influence what cell the data starts being written + // to. + append(resource: Schema.ValueRange, spreadsheetId: string, range: string): Sheets_v4.Schema.AppendValuesResponse; + // Appends values to a spreadsheet. The input range is used to search for + // existing data and find a "table" within that range. Values will be + // appended to the next row of the table, starting with the first column of + // the table. See the + // [guide](/sheets/api/guides/values#appending_values) + // and + // [sample code](/sheets/api/samples/writing#append_values) + // for specific details of how tables are detected and data is appended. + // The caller must specify the spreadsheet ID, range, and + // a valueInputOption. The `valueInputOption` only + // controls how the input data will be added to the sheet (column-wise or + // row-wise), it does not influence what cell the data starts being written + // to. + append(resource: Schema.ValueRange, spreadsheetId: string, range: string, optionalArgs: object): Sheets_v4.Schema.AppendValuesResponse; + // Clears one or more ranges of values from a spreadsheet. + // The caller must specify the spreadsheet ID and one or more ranges. + // Only values are cleared -- all other properties of the cell (such as + // formatting, data validation, etc..) are kept. + batchClear(resource: Schema.BatchClearValuesRequest, spreadsheetId: string): Sheets_v4.Schema.BatchClearValuesResponse; + // Clears one or more ranges of values from a spreadsheet. + // The caller must specify the spreadsheet ID and one or more + // DataFilters. Ranges matching any of the specified data + // filters will be cleared. Only values are cleared -- all other properties + // of the cell (such as formatting, data validation, etc..) are kept. + batchClearByDataFilter(resource: Schema.BatchClearValuesByDataFilterRequest, spreadsheetId: string): Sheets_v4.Schema.BatchClearValuesByDataFilterResponse; + // Returns one or more ranges of values from a spreadsheet. + // The caller must specify the spreadsheet ID and one or more ranges. + batchGet(spreadsheetId: string): Sheets_v4.Schema.BatchGetValuesResponse; + // Returns one or more ranges of values from a spreadsheet. + // The caller must specify the spreadsheet ID and one or more ranges. + batchGet(spreadsheetId: string, optionalArgs: object): Sheets_v4.Schema.BatchGetValuesResponse; + // Returns one or more ranges of values that match the specified data filters. + // The caller must specify the spreadsheet ID and one or more + // DataFilters. Ranges that match any of the data filters in + // the request will be returned. + batchGetByDataFilter(resource: Schema.BatchGetValuesByDataFilterRequest, spreadsheetId: string): Sheets_v4.Schema.BatchGetValuesByDataFilterResponse; + // Sets values in one or more ranges of a spreadsheet. + // The caller must specify the spreadsheet ID, + // a valueInputOption, and one or more + // ValueRanges. + batchUpdate(resource: Schema.BatchUpdateValuesRequest, spreadsheetId: string): Sheets_v4.Schema.BatchUpdateValuesResponse; + // Sets values in one or more ranges of a spreadsheet. + // The caller must specify the spreadsheet ID, + // a valueInputOption, and one or more + // DataFilterValueRanges. + batchUpdateByDataFilter(resource: Schema.BatchUpdateValuesByDataFilterRequest, spreadsheetId: string): Sheets_v4.Schema.BatchUpdateValuesByDataFilterResponse; + // Clears values from a spreadsheet. + // The caller must specify the spreadsheet ID and range. + // Only values are cleared -- all other properties of the cell (such as + // formatting, data validation, etc..) are kept. + clear(resource: any, /* Schema.ClearValuesRequest */ spreadsheetId: string, range: string): Sheets_v4.Schema.ClearValuesResponse; + // Returns a range of values from a spreadsheet. + // The caller must specify the spreadsheet ID and a range. + get(spreadsheetId: string, range: string): Sheets_v4.Schema.ValueRange; + // Returns a range of values from a spreadsheet. + // The caller must specify the spreadsheet ID and a range. + get(spreadsheetId: string, range: string, optionalArgs: object): Sheets_v4.Schema.ValueRange; + // Sets values in a range of a spreadsheet. + // The caller must specify the spreadsheet ID, range, and + // a valueInputOption. + update(resource: Schema.ValueRange, spreadsheetId: string, range: string): Sheets_v4.Schema.UpdateValuesResponse; + // Sets values in a range of a spreadsheet. + // The caller must specify the spreadsheet ID, range, and + // a valueInputOption. + update(resource: Schema.ValueRange, spreadsheetId: string, range: string, optionalArgs: object): Sheets_v4.Schema.UpdateValuesResponse; + } + } + export interface SpreadsheetsCollection { + DeveloperMetadata?: Sheets_v4.Collection.Spreadsheets.DeveloperMetadataCollection; + Sheets?: Sheets_v4.Collection.Spreadsheets.SheetsCollection; + Values?: Sheets_v4.Collection.Spreadsheets.ValuesCollection; + // Applies one or more updates to the spreadsheet. + // Each request is validated before + // being applied. If any request is not valid then the entire request will + // fail and nothing will be applied. + // Some requests have replies to + // give you some information about how + // they are applied. The replies will mirror the requests. For example, + // if you applied 4 updates and the 3rd one had a reply, then the + // response will have 2 empty replies, the actual reply, and another empty + // reply, in that order. + // Due to the collaborative nature of spreadsheets, it is not guaranteed that + // the spreadsheet will reflect exactly your changes after this completes, + // however it is guaranteed that the updates in the request will be + // applied together atomically. Your changes may be altered with respect to + // collaborator changes. If there are no collaborators, the spreadsheet + // should reflect your changes. + batchUpdate(resource: Schema.BatchUpdateSpreadsheetRequest, spreadsheetId: string): Sheets_v4.Schema.BatchUpdateSpreadsheetResponse; + // Creates a spreadsheet, returning the newly created spreadsheet. + create(resource: Schema.Spreadsheet): Sheets_v4.Schema.Spreadsheet; + // Returns the spreadsheet at the given ID. + // The caller must specify the spreadsheet ID. + // By default, data within grids will not be returned. + // You can include grid data one of two ways: + // * Specify a field mask listing your desired fields using the `fields` URL + // parameter in HTTP + // * Set the includeGridData + // URL parameter to true. If a field mask is set, the `includeGridData` + // parameter is ignored + // For large spreadsheets, it is recommended to retrieve only the specific + // fields of the spreadsheet that you want. + // To retrieve only subsets of the spreadsheet, use the + // ranges URL parameter. + // Multiple ranges can be specified. Limiting the range will + // return only the portions of the spreadsheet that intersect the requested + // ranges. Ranges are specified using A1 notation. + get(spreadsheetId: string): Sheets_v4.Schema.Spreadsheet; + // Returns the spreadsheet at the given ID. + // The caller must specify the spreadsheet ID. + // By default, data within grids will not be returned. + // You can include grid data one of two ways: + // * Specify a field mask listing your desired fields using the `fields` URL + // parameter in HTTP + // * Set the includeGridData + // URL parameter to true. If a field mask is set, the `includeGridData` + // parameter is ignored + // For large spreadsheets, it is recommended to retrieve only the specific + // fields of the spreadsheet that you want. + // To retrieve only subsets of the spreadsheet, use the + // ranges URL parameter. + // Multiple ranges can be specified. Limiting the range will + // return only the portions of the spreadsheet that intersect the requested + // ranges. Ranges are specified using A1 notation. + get(spreadsheetId: string, optionalArgs: object): Sheets_v4.Schema.Spreadsheet; + // Returns the spreadsheet at the given ID. + // The caller must specify the spreadsheet ID. + // This method differs from GetSpreadsheet in that it allows selecting + // which subsets of spreadsheet data to return by specifying a + // dataFilters parameter. + // Multiple DataFilters can be specified. Specifying one or + // more data filters will return the portions of the spreadsheet that + // intersect ranges matched by any of the filters. + // By default, data within grids will not be returned. + // You can include grid data one of two ways: + // * Specify a field mask listing your desired fields using the `fields` URL + // parameter in HTTP + // * Set the includeGridData + // parameter to true. If a field mask is set, the `includeGridData` + // parameter is ignored + // For large spreadsheets, it is recommended to retrieve only the specific + // fields of the spreadsheet that you want. + getByDataFilter(resource: Schema.GetSpreadsheetByDataFilterRequest, spreadsheetId: string): Sheets_v4.Schema.Spreadsheet; + } + } + namespace Schema { + export interface AddBandingRequest { + bandedRange?: Sheets_v4.Schema.BandedRange; + } + export interface AddBandingResponse { + bandedRange?: Sheets_v4.Schema.BandedRange; + } + export interface AddChartRequest { + chart?: Sheets_v4.Schema.EmbeddedChart; + } + export interface AddChartResponse { + chart?: Sheets_v4.Schema.EmbeddedChart; + } + export interface AddConditionalFormatRuleRequest { + index?: number; + rule?: Sheets_v4.Schema.ConditionalFormatRule; + } + export interface AddDimensionGroupRequest { + range?: Sheets_v4.Schema.DimensionRange; + } + export interface AddDimensionGroupResponse { + dimensionGroups?: Sheets_v4.Schema.DimensionGroup[]; + } + export interface AddFilterViewRequest { + filter?: Sheets_v4.Schema.FilterView; + } + export interface AddFilterViewResponse { + filter?: Sheets_v4.Schema.FilterView; + } + export interface AddNamedRangeRequest { + namedRange?: Sheets_v4.Schema.NamedRange; + } + export interface AddNamedRangeResponse { + namedRange?: Sheets_v4.Schema.NamedRange; + } + export interface AddProtectedRangeRequest { + protectedRange?: Sheets_v4.Schema.ProtectedRange; + } + export interface AddProtectedRangeResponse { + protectedRange?: Sheets_v4.Schema.ProtectedRange; + } + export interface AddSheetRequest { + properties?: Sheets_v4.Schema.SheetProperties; + } + export interface AddSheetResponse { + properties?: Sheets_v4.Schema.SheetProperties; + } + export interface AppendCellsRequest { + fields?: string; + rows?: Sheets_v4.Schema.RowData[]; + sheetId?: number; + } + export interface AppendDimensionRequest { + dimension?: string; + length?: number; + sheetId?: number; + } + export interface AppendValuesResponse { + spreadsheetId?: string; + tableRange?: string; + updates?: Sheets_v4.Schema.UpdateValuesResponse; + } + export interface AutoFillRequest { + range?: Sheets_v4.Schema.GridRange; + sourceAndDestination?: Sheets_v4.Schema.SourceAndDestination; + useAlternateSeries?: boolean; + } + export interface AutoResizeDimensionsRequest { + dimensions?: Sheets_v4.Schema.DimensionRange; + } + export interface BandedRange { + bandedRangeId?: number; + columnProperties?: Sheets_v4.Schema.BandingProperties; + range?: Sheets_v4.Schema.GridRange; + rowProperties?: Sheets_v4.Schema.BandingProperties; + } + export interface BandingProperties { + firstBandColor?: Sheets_v4.Schema.Color; + footerColor?: Sheets_v4.Schema.Color; + headerColor?: Sheets_v4.Schema.Color; + secondBandColor?: Sheets_v4.Schema.Color; + } + export interface BasicChartAxis { + format?: Sheets_v4.Schema.TextFormat; + position?: string; + title?: string; + titleTextPosition?: Sheets_v4.Schema.TextPosition; + } + export interface BasicChartDomain { + domain?: Sheets_v4.Schema.ChartData; + reversed?: boolean; + } + export interface BasicChartSeries { + color?: Sheets_v4.Schema.Color; + lineStyle?: Sheets_v4.Schema.LineStyle; + series?: Sheets_v4.Schema.ChartData; + targetAxis?: string; + type?: string; + } + export interface BasicChartSpec { + axis?: Sheets_v4.Schema.BasicChartAxis[]; + chartType?: string; + compareMode?: string; + domains?: Sheets_v4.Schema.BasicChartDomain[]; + headerCount?: number; + interpolateNulls?: boolean; + legendPosition?: string; + lineSmoothing?: boolean; + series?: Sheets_v4.Schema.BasicChartSeries[]; + stackedType?: string; + threeDimensional?: boolean; + } + export interface BasicFilter { + criteria?: object; + range?: Sheets_v4.Schema.GridRange; + sortSpecs?: Sheets_v4.Schema.SortSpec[]; + } + export interface BatchClearValuesByDataFilterRequest { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + } + export interface BatchClearValuesByDataFilterResponse { + clearedRanges?: string[]; + spreadsheetId?: string; + } + export interface BatchClearValuesRequest { + ranges?: string[]; + } + export interface BatchClearValuesResponse { + clearedRanges?: string[]; + spreadsheetId?: string; + } + export interface BatchGetValuesByDataFilterRequest { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + dateTimeRenderOption?: string; + majorDimension?: string; + valueRenderOption?: string; + } + export interface BatchGetValuesByDataFilterResponse { + spreadsheetId?: string; + valueRanges?: Sheets_v4.Schema.MatchedValueRange[]; + } + export interface BatchGetValuesResponse { + spreadsheetId?: string; + valueRanges?: Sheets_v4.Schema.ValueRange[]; + } + export interface BatchUpdateSpreadsheetRequest { + includeSpreadsheetInResponse?: boolean; + requests?: Sheets_v4.Schema.Request[]; + responseIncludeGridData?: boolean; + responseRanges?: string[]; + } + export interface BatchUpdateSpreadsheetResponse { + replies?: Sheets_v4.Schema.Response[]; + spreadsheetId?: string; + updatedSpreadsheet?: Sheets_v4.Schema.Spreadsheet; + } + export interface BatchUpdateValuesByDataFilterRequest { + data?: Sheets_v4.Schema.DataFilterValueRange[]; + includeValuesInResponse?: boolean; + responseDateTimeRenderOption?: string; + responseValueRenderOption?: string; + valueInputOption?: string; + } + export interface BatchUpdateValuesByDataFilterResponse { + responses?: Sheets_v4.Schema.UpdateValuesByDataFilterResponse[]; + spreadsheetId?: string; + totalUpdatedCells?: number; + totalUpdatedColumns?: number; + totalUpdatedRows?: number; + totalUpdatedSheets?: number; + } + export interface BatchUpdateValuesRequest { + data?: Sheets_v4.Schema.ValueRange[]; + includeValuesInResponse?: boolean; + responseDateTimeRenderOption?: string; + responseValueRenderOption?: string; + valueInputOption?: string; + } + export interface BatchUpdateValuesResponse { + responses?: Sheets_v4.Schema.UpdateValuesResponse[]; + spreadsheetId?: string; + totalUpdatedCells?: number; + totalUpdatedColumns?: number; + totalUpdatedRows?: number; + totalUpdatedSheets?: number; + } + export interface BooleanCondition { + type?: string; + values?: Sheets_v4.Schema.ConditionValue[]; + } + export interface BooleanRule { + condition?: Sheets_v4.Schema.BooleanCondition; + format?: Sheets_v4.Schema.CellFormat; + } + export interface Border { + color?: Sheets_v4.Schema.Color; + style?: string; + width?: number; + } + export interface Borders { + bottom?: Sheets_v4.Schema.Border; + left?: Sheets_v4.Schema.Border; + right?: Sheets_v4.Schema.Border; + top?: Sheets_v4.Schema.Border; + } + export interface BubbleChartSpec { + bubbleBorderColor?: Sheets_v4.Schema.Color; + bubbleLabels?: Sheets_v4.Schema.ChartData; + bubbleMaxRadiusSize?: number; + bubbleMinRadiusSize?: number; + bubbleOpacity?: Number; + bubbleSizes?: Sheets_v4.Schema.ChartData; + bubbleTextStyle?: Sheets_v4.Schema.TextFormat; + domain?: Sheets_v4.Schema.ChartData; + groupIds?: Sheets_v4.Schema.ChartData; + legendPosition?: string; + series?: Sheets_v4.Schema.ChartData; + } + export interface CandlestickChartSpec { + data?: Sheets_v4.Schema.CandlestickData[]; + domain?: Sheets_v4.Schema.CandlestickDomain; + } + export interface CandlestickData { + closeSeries?: Sheets_v4.Schema.CandlestickSeries; + highSeries?: Sheets_v4.Schema.CandlestickSeries; + lowSeries?: Sheets_v4.Schema.CandlestickSeries; + openSeries?: Sheets_v4.Schema.CandlestickSeries; + } + export interface CandlestickDomain { + data?: Sheets_v4.Schema.ChartData; + reversed?: boolean; + } + export interface CandlestickSeries { + data?: Sheets_v4.Schema.ChartData; + } + export interface CellData { + dataValidation?: Sheets_v4.Schema.DataValidationRule; + effectiveFormat?: Sheets_v4.Schema.CellFormat; + effectiveValue?: Sheets_v4.Schema.ExtendedValue; + formattedValue?: string; + hyperlink?: string; + note?: string; + pivotTable?: Sheets_v4.Schema.PivotTable; + textFormatRuns?: Sheets_v4.Schema.TextFormatRun[]; + userEnteredFormat?: Sheets_v4.Schema.CellFormat; + userEnteredValue?: Sheets_v4.Schema.ExtendedValue; + } + export interface CellFormat { + backgroundColor?: Sheets_v4.Schema.Color; + borders?: Sheets_v4.Schema.Borders; + horizontalAlignment?: string; + hyperlinkDisplayType?: string; + numberFormat?: Sheets_v4.Schema.NumberFormat; + padding?: Sheets_v4.Schema.Padding; + textDirection?: string; + textFormat?: Sheets_v4.Schema.TextFormat; + textRotation?: Sheets_v4.Schema.TextRotation; + verticalAlignment?: string; + wrapStrategy?: string; + } + export interface ChartData { + sourceRange?: Sheets_v4.Schema.ChartSourceRange; + } + export interface ChartSourceRange { + sources?: Sheets_v4.Schema.GridRange[]; + } + export interface ChartSpec { + altText?: string; + backgroundColor?: Sheets_v4.Schema.Color; + basicChart?: Sheets_v4.Schema.BasicChartSpec; + bubbleChart?: Sheets_v4.Schema.BubbleChartSpec; + candlestickChart?: Sheets_v4.Schema.CandlestickChartSpec; + fontName?: string; + hiddenDimensionStrategy?: string; + histogramChart?: Sheets_v4.Schema.HistogramChartSpec; + maximized?: boolean; + orgChart?: Sheets_v4.Schema.OrgChartSpec; + pieChart?: Sheets_v4.Schema.PieChartSpec; + subtitle?: string; + subtitleTextFormat?: Sheets_v4.Schema.TextFormat; + subtitleTextPosition?: Sheets_v4.Schema.TextPosition; + title?: string; + titleTextFormat?: Sheets_v4.Schema.TextFormat; + titleTextPosition?: Sheets_v4.Schema.TextPosition; + treemapChart?: Sheets_v4.Schema.TreemapChartSpec; + waterfallChart?: Sheets_v4.Schema.WaterfallChartSpec; + } + export interface ClearBasicFilterRequest { + sheetId?: number; + } + export interface ClearValuesResponse { + clearedRange?: string; + spreadsheetId?: string; + } + export interface Color { + alpha?: Number; + blue?: Number; + green?: Number; + red?: Number; + } + export interface ConditionValue { + relativeDate?: string; + userEnteredValue?: string; + } + export interface ConditionalFormatRule { + booleanRule?: Sheets_v4.Schema.BooleanRule; + gradientRule?: Sheets_v4.Schema.GradientRule; + ranges?: Sheets_v4.Schema.GridRange[]; + } + export interface CopyPasteRequest { + destination?: Sheets_v4.Schema.GridRange; + pasteOrientation?: string; + pasteType?: string; + source?: Sheets_v4.Schema.GridRange; + } + export interface CopySheetToAnotherSpreadsheetRequest { + destinationSpreadsheetId?: string; + } + export interface CreateDeveloperMetadataRequest { + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata; + } + export interface CreateDeveloperMetadataResponse { + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata; + } + export interface CutPasteRequest { + destination?: Sheets_v4.Schema.GridCoordinate; + pasteType?: string; + source?: Sheets_v4.Schema.GridRange; + } + export interface DataFilter { + a1Range?: string; + developerMetadataLookup?: Sheets_v4.Schema.DeveloperMetadataLookup; + gridRange?: Sheets_v4.Schema.GridRange; + } + export interface DataFilterValueRange { + dataFilter?: Sheets_v4.Schema.DataFilter; + majorDimension?: string; + values?: Object[][]; + } + export interface DataValidationRule { + condition?: Sheets_v4.Schema.BooleanCondition; + inputMessage?: string; + showCustomUi?: boolean; + strict?: boolean; + } + export interface DateTimeRule { + type?: string; + } + export interface DeleteBandingRequest { + bandedRangeId?: number; + } + export interface DeleteConditionalFormatRuleRequest { + index?: number; + sheetId?: number; + } + export interface DeleteConditionalFormatRuleResponse { + rule?: Sheets_v4.Schema.ConditionalFormatRule; + } + export interface DeleteDeveloperMetadataRequest { + dataFilter?: Sheets_v4.Schema.DataFilter; + } + export interface DeleteDeveloperMetadataResponse { + deletedDeveloperMetadata?: Sheets_v4.Schema.DeveloperMetadata[]; + } + export interface DeleteDimensionGroupRequest { + range?: Sheets_v4.Schema.DimensionRange; + } + export interface DeleteDimensionGroupResponse { + dimensionGroups?: Sheets_v4.Schema.DimensionGroup[]; + } + export interface DeleteDimensionRequest { + range?: Sheets_v4.Schema.DimensionRange; + } + export interface DeleteEmbeddedObjectRequest { + objectId?: number; + } + export interface DeleteFilterViewRequest { + filterId?: number; + } + export interface DeleteNamedRangeRequest { + namedRangeId?: string; + } + export interface DeleteProtectedRangeRequest { + protectedRangeId?: number; + } + export interface DeleteRangeRequest { + range?: Sheets_v4.Schema.GridRange; + shiftDimension?: string; + } + export interface DeleteSheetRequest { + sheetId?: number; + } + export interface DeveloperMetadata { + location?: Sheets_v4.Schema.DeveloperMetadataLocation; + metadataId?: number; + metadataKey?: string; + metadataValue?: string; + visibility?: string; + } + export interface DeveloperMetadataLocation { + dimensionRange?: Sheets_v4.Schema.DimensionRange; + locationType?: string; + sheetId?: number; + spreadsheet?: boolean; + } + export interface DeveloperMetadataLookup { + locationMatchingStrategy?: string; + locationType?: string; + metadataId?: number; + metadataKey?: string; + metadataLocation?: Sheets_v4.Schema.DeveloperMetadataLocation; + metadataValue?: string; + visibility?: string; + } + export interface DimensionGroup { + collapsed?: boolean; + depth?: number; + range?: Sheets_v4.Schema.DimensionRange; + } + export interface DimensionProperties { + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata[]; + hiddenByFilter?: boolean; + hiddenByUser?: boolean; + pixelSize?: number; + } + export interface DimensionRange { + dimension?: string; + endIndex?: number; + sheetId?: number; + startIndex?: number; + } + export interface DuplicateFilterViewRequest { + filterId?: number; + } + export interface DuplicateFilterViewResponse { + filter?: Sheets_v4.Schema.FilterView; + } + export interface DuplicateSheetRequest { + insertSheetIndex?: number; + newSheetId?: number; + newSheetName?: string; + sourceSheetId?: number; + } + export interface DuplicateSheetResponse { + properties?: Sheets_v4.Schema.SheetProperties; + } + export interface Editors { + domainUsersCanEdit?: boolean; + groups?: string[]; + users?: string[]; + } + export interface EmbeddedChart { + chartId?: number; + position?: Sheets_v4.Schema.EmbeddedObjectPosition; + spec?: Sheets_v4.Schema.ChartSpec; + } + export interface EmbeddedObjectPosition { + newSheet?: boolean; + overlayPosition?: Sheets_v4.Schema.OverlayPosition; + sheetId?: number; + } + export interface ErrorValue { + message?: string; + type?: string; + } + export interface ExtendedValue { + boolValue?: boolean; + errorValue?: Sheets_v4.Schema.ErrorValue; + formulaValue?: string; + numberValue?: Number; + stringValue?: string; + } + export interface FilterCriteria { + condition?: Sheets_v4.Schema.BooleanCondition; + hiddenValues?: string[]; + } + export interface FilterView { + criteria?: object; + filterViewId?: number; + namedRangeId?: string; + range?: Sheets_v4.Schema.GridRange; + sortSpecs?: Sheets_v4.Schema.SortSpec[]; + title?: string; + } + export interface FindReplaceRequest { + allSheets?: boolean; + find?: string; + includeFormulas?: boolean; + matchCase?: boolean; + matchEntireCell?: boolean; + range?: Sheets_v4.Schema.GridRange; + replacement?: string; + searchByRegex?: boolean; + sheetId?: number; + } + export interface FindReplaceResponse { + formulasChanged?: number; + occurrencesChanged?: number; + rowsChanged?: number; + sheetsChanged?: number; + valuesChanged?: number; + } + export interface GetSpreadsheetByDataFilterRequest { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + includeGridData?: boolean; + } + export interface GradientRule { + maxpoint?: Sheets_v4.Schema.InterpolationPoint; + midpoint?: Sheets_v4.Schema.InterpolationPoint; + minpoint?: Sheets_v4.Schema.InterpolationPoint; + } + export interface GridCoordinate { + columnIndex?: number; + rowIndex?: number; + sheetId?: number; + } + export interface GridData { + columnMetadata?: Sheets_v4.Schema.DimensionProperties[]; + rowData?: Sheets_v4.Schema.RowData[]; + rowMetadata?: Sheets_v4.Schema.DimensionProperties[]; + startColumn?: number; + startRow?: number; + } + export interface GridProperties { + columnCount?: number; + columnGroupControlAfter?: boolean; + frozenColumnCount?: number; + frozenRowCount?: number; + hideGridlines?: boolean; + rowCount?: number; + rowGroupControlAfter?: boolean; + } + export interface GridRange { + endColumnIndex?: number; + endRowIndex?: number; + sheetId?: number; + startColumnIndex?: number; + startRowIndex?: number; + } + export interface HistogramChartSpec { + bucketSize?: Number; + legendPosition?: string; + outlierPercentile?: Number; + series?: Sheets_v4.Schema.HistogramSeries[]; + showItemDividers?: boolean; + } + export interface HistogramRule { + end?: Number; + interval?: Number; + start?: Number; + } + export interface HistogramSeries { + barColor?: Sheets_v4.Schema.Color; + data?: Sheets_v4.Schema.ChartData; + } + export interface InsertDimensionRequest { + inheritFromBefore?: boolean; + range?: Sheets_v4.Schema.DimensionRange; + } + export interface InsertRangeRequest { + range?: Sheets_v4.Schema.GridRange; + shiftDimension?: string; + } + export interface InterpolationPoint { + color?: Sheets_v4.Schema.Color; + type?: string; + value?: string; + } + export interface IterativeCalculationSettings { + convergenceThreshold?: Number; + maxIterations?: number; + } + export interface LineStyle { + type?: string; + width?: number; + } + export interface ManualRule { + groups?: Sheets_v4.Schema.ManualRuleGroup[]; + } + export interface ManualRuleGroup { + groupName?: Sheets_v4.Schema.ExtendedValue; + items?: Sheets_v4.Schema.ExtendedValue[]; + } + export interface MatchedDeveloperMetadata { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata; + } + export interface MatchedValueRange { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + valueRange?: Sheets_v4.Schema.ValueRange; + } + export interface MergeCellsRequest { + mergeType?: string; + range?: Sheets_v4.Schema.GridRange; + } + export interface MoveDimensionRequest { + destinationIndex?: number; + source?: Sheets_v4.Schema.DimensionRange; + } + export interface NamedRange { + name?: string; + namedRangeId?: string; + range?: Sheets_v4.Schema.GridRange; + } + export interface NumberFormat { + pattern?: string; + type?: string; + } + export interface OrgChartSpec { + labels?: Sheets_v4.Schema.ChartData; + nodeColor?: Sheets_v4.Schema.Color; + nodeSize?: string; + parentLabels?: Sheets_v4.Schema.ChartData; + selectedNodeColor?: Sheets_v4.Schema.Color; + tooltips?: Sheets_v4.Schema.ChartData; + } + export interface OverlayPosition { + anchorCell?: Sheets_v4.Schema.GridCoordinate; + heightPixels?: number; + offsetXPixels?: number; + offsetYPixels?: number; + widthPixels?: number; + } + export interface Padding { + bottom?: number; + left?: number; + right?: number; + top?: number; + } + export interface PasteDataRequest { + coordinate?: Sheets_v4.Schema.GridCoordinate; + data?: string; + delimiter?: string; + html?: boolean; + type?: string; + } + export interface PieChartSpec { + domain?: Sheets_v4.Schema.ChartData; + legendPosition?: string; + pieHole?: Number; + series?: Sheets_v4.Schema.ChartData; + threeDimensional?: boolean; + } + export interface PivotFilterCriteria { + visibleValues?: string[]; + } + export interface PivotGroup { + groupRule?: Sheets_v4.Schema.PivotGroupRule; + label?: string; + repeatHeadings?: boolean; + showTotals?: boolean; + sortOrder?: string; + sourceColumnOffset?: number; + valueBucket?: Sheets_v4.Schema.PivotGroupSortValueBucket; + valueMetadata?: Sheets_v4.Schema.PivotGroupValueMetadata[]; + } + export interface PivotGroupRule { + dateTimeRule?: Sheets_v4.Schema.DateTimeRule; + histogramRule?: Sheets_v4.Schema.HistogramRule; + manualRule?: Sheets_v4.Schema.ManualRule; + } + export interface PivotGroupSortValueBucket { + buckets?: Sheets_v4.Schema.ExtendedValue[]; + valuesIndex?: number; + } + export interface PivotGroupValueMetadata { + collapsed?: boolean; + value?: Sheets_v4.Schema.ExtendedValue; + } + export interface PivotTable { + columns?: Sheets_v4.Schema.PivotGroup[]; + criteria?: object; + rows?: Sheets_v4.Schema.PivotGroup[]; + source?: Sheets_v4.Schema.GridRange; + valueLayout?: string; + values?: Sheets_v4.Schema.PivotValue[]; + } + export interface PivotValue { + calculatedDisplayType?: string; + formula?: string; + name?: string; + sourceColumnOffset?: number; + summarizeFunction?: string; + } + export interface ProtectedRange { + description?: string; + editors?: Sheets_v4.Schema.Editors; + namedRangeId?: string; + protectedRangeId?: number; + range?: Sheets_v4.Schema.GridRange; + requestingUserCanEdit?: boolean; + unprotectedRanges?: Sheets_v4.Schema.GridRange[]; + warningOnly?: boolean; + } + export interface RandomizeRangeRequest { + range?: Sheets_v4.Schema.GridRange; + } + export interface RepeatCellRequest { + cell?: Sheets_v4.Schema.CellData; + fields?: string; + range?: Sheets_v4.Schema.GridRange; + } + export interface Request { + addBanding?: Sheets_v4.Schema.AddBandingRequest; + addChart?: Sheets_v4.Schema.AddChartRequest; + addConditionalFormatRule?: Sheets_v4.Schema.AddConditionalFormatRuleRequest; + addDimensionGroup?: Sheets_v4.Schema.AddDimensionGroupRequest; + addFilterView?: Sheets_v4.Schema.AddFilterViewRequest; + addNamedRange?: Sheets_v4.Schema.AddNamedRangeRequest; + addProtectedRange?: Sheets_v4.Schema.AddProtectedRangeRequest; + addSheet?: Sheets_v4.Schema.AddSheetRequest; + appendCells?: Sheets_v4.Schema.AppendCellsRequest; + appendDimension?: Sheets_v4.Schema.AppendDimensionRequest; + autoFill?: Sheets_v4.Schema.AutoFillRequest; + autoResizeDimensions?: Sheets_v4.Schema.AutoResizeDimensionsRequest; + clearBasicFilter?: Sheets_v4.Schema.ClearBasicFilterRequest; + copyPaste?: Sheets_v4.Schema.CopyPasteRequest; + createDeveloperMetadata?: Sheets_v4.Schema.CreateDeveloperMetadataRequest; + cutPaste?: Sheets_v4.Schema.CutPasteRequest; + deleteBanding?: Sheets_v4.Schema.DeleteBandingRequest; + deleteConditionalFormatRule?: Sheets_v4.Schema.DeleteConditionalFormatRuleRequest; + deleteDeveloperMetadata?: Sheets_v4.Schema.DeleteDeveloperMetadataRequest; + deleteDimension?: Sheets_v4.Schema.DeleteDimensionRequest; + deleteDimensionGroup?: Sheets_v4.Schema.DeleteDimensionGroupRequest; + deleteEmbeddedObject?: Sheets_v4.Schema.DeleteEmbeddedObjectRequest; + deleteFilterView?: Sheets_v4.Schema.DeleteFilterViewRequest; + deleteNamedRange?: Sheets_v4.Schema.DeleteNamedRangeRequest; + deleteProtectedRange?: Sheets_v4.Schema.DeleteProtectedRangeRequest; + deleteRange?: Sheets_v4.Schema.DeleteRangeRequest; + deleteSheet?: Sheets_v4.Schema.DeleteSheetRequest; + duplicateFilterView?: Sheets_v4.Schema.DuplicateFilterViewRequest; + duplicateSheet?: Sheets_v4.Schema.DuplicateSheetRequest; + findReplace?: Sheets_v4.Schema.FindReplaceRequest; + insertDimension?: Sheets_v4.Schema.InsertDimensionRequest; + insertRange?: Sheets_v4.Schema.InsertRangeRequest; + mergeCells?: Sheets_v4.Schema.MergeCellsRequest; + moveDimension?: Sheets_v4.Schema.MoveDimensionRequest; + pasteData?: Sheets_v4.Schema.PasteDataRequest; + randomizeRange?: Sheets_v4.Schema.RandomizeRangeRequest; + repeatCell?: Sheets_v4.Schema.RepeatCellRequest; + setBasicFilter?: Sheets_v4.Schema.SetBasicFilterRequest; + setDataValidation?: Sheets_v4.Schema.SetDataValidationRequest; + sortRange?: Sheets_v4.Schema.SortRangeRequest; + textToColumns?: Sheets_v4.Schema.TextToColumnsRequest; + unmergeCells?: Sheets_v4.Schema.UnmergeCellsRequest; + updateBanding?: Sheets_v4.Schema.UpdateBandingRequest; + updateBorders?: Sheets_v4.Schema.UpdateBordersRequest; + updateCells?: Sheets_v4.Schema.UpdateCellsRequest; + updateChartSpec?: Sheets_v4.Schema.UpdateChartSpecRequest; + updateConditionalFormatRule?: Sheets_v4.Schema.UpdateConditionalFormatRuleRequest; + updateDeveloperMetadata?: Sheets_v4.Schema.UpdateDeveloperMetadataRequest; + updateDimensionGroup?: Sheets_v4.Schema.UpdateDimensionGroupRequest; + updateDimensionProperties?: Sheets_v4.Schema.UpdateDimensionPropertiesRequest; + updateEmbeddedObjectPosition?: Sheets_v4.Schema.UpdateEmbeddedObjectPositionRequest; + updateFilterView?: Sheets_v4.Schema.UpdateFilterViewRequest; + updateNamedRange?: Sheets_v4.Schema.UpdateNamedRangeRequest; + updateProtectedRange?: Sheets_v4.Schema.UpdateProtectedRangeRequest; + updateSheetProperties?: Sheets_v4.Schema.UpdateSheetPropertiesRequest; + updateSpreadsheetProperties?: Sheets_v4.Schema.UpdateSpreadsheetPropertiesRequest; + } + export interface Response { + addBanding?: Sheets_v4.Schema.AddBandingResponse; + addChart?: Sheets_v4.Schema.AddChartResponse; + addDimensionGroup?: Sheets_v4.Schema.AddDimensionGroupResponse; + addFilterView?: Sheets_v4.Schema.AddFilterViewResponse; + addNamedRange?: Sheets_v4.Schema.AddNamedRangeResponse; + addProtectedRange?: Sheets_v4.Schema.AddProtectedRangeResponse; + addSheet?: Sheets_v4.Schema.AddSheetResponse; + createDeveloperMetadata?: Sheets_v4.Schema.CreateDeveloperMetadataResponse; + deleteConditionalFormatRule?: Sheets_v4.Schema.DeleteConditionalFormatRuleResponse; + deleteDeveloperMetadata?: Sheets_v4.Schema.DeleteDeveloperMetadataResponse; + deleteDimensionGroup?: Sheets_v4.Schema.DeleteDimensionGroupResponse; + duplicateFilterView?: Sheets_v4.Schema.DuplicateFilterViewResponse; + duplicateSheet?: Sheets_v4.Schema.DuplicateSheetResponse; + findReplace?: Sheets_v4.Schema.FindReplaceResponse; + updateConditionalFormatRule?: Sheets_v4.Schema.UpdateConditionalFormatRuleResponse; + updateDeveloperMetadata?: Sheets_v4.Schema.UpdateDeveloperMetadataResponse; + updateEmbeddedObjectPosition?: Sheets_v4.Schema.UpdateEmbeddedObjectPositionResponse; + } + export interface RowData { + values?: Sheets_v4.Schema.CellData[]; + } + export interface SearchDeveloperMetadataRequest { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + } + export interface SearchDeveloperMetadataResponse { + matchedDeveloperMetadata?: Sheets_v4.Schema.MatchedDeveloperMetadata[]; + } + export interface SetBasicFilterRequest { + filter?: Sheets_v4.Schema.BasicFilter; + } + export interface SetDataValidationRequest { + range?: Sheets_v4.Schema.GridRange; + rule?: Sheets_v4.Schema.DataValidationRule; + } + export interface Sheet { + bandedRanges?: Sheets_v4.Schema.BandedRange[]; + basicFilter?: Sheets_v4.Schema.BasicFilter; + charts?: Sheets_v4.Schema.EmbeddedChart[]; + columnGroups?: Sheets_v4.Schema.DimensionGroup[]; + conditionalFormats?: Sheets_v4.Schema.ConditionalFormatRule[]; + data?: Sheets_v4.Schema.GridData[]; + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata[]; + filterViews?: Sheets_v4.Schema.FilterView[]; + merges?: Sheets_v4.Schema.GridRange[]; + properties?: Sheets_v4.Schema.SheetProperties; + protectedRanges?: Sheets_v4.Schema.ProtectedRange[]; + rowGroups?: Sheets_v4.Schema.DimensionGroup[]; + } + export interface SheetProperties { + gridProperties?: Sheets_v4.Schema.GridProperties; + hidden?: boolean; + index?: number; + rightToLeft?: boolean; + sheetId?: number; + sheetType?: string; + tabColor?: Sheets_v4.Schema.Color; + title?: string; + } + export interface SortRangeRequest { + range?: Sheets_v4.Schema.GridRange; + sortSpecs?: Sheets_v4.Schema.SortSpec[]; + } + export interface SortSpec { + dimensionIndex?: number; + sortOrder?: string; + } + export interface SourceAndDestination { + dimension?: string; + fillLength?: number; + source?: Sheets_v4.Schema.GridRange; + } + export interface Spreadsheet { + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata[]; + namedRanges?: Sheets_v4.Schema.NamedRange[]; + properties?: Sheets_v4.Schema.SpreadsheetProperties; + sheets?: Sheets_v4.Schema.Sheet[]; + spreadsheetId?: string; + spreadsheetUrl?: string; + } + export interface SpreadsheetProperties { + autoRecalc?: string; + defaultFormat?: Sheets_v4.Schema.CellFormat; + iterativeCalculationSettings?: Sheets_v4.Schema.IterativeCalculationSettings; + locale?: string; + timeZone?: string; + title?: string; + } + export interface TextFormat { + bold?: boolean; + fontFamily?: string; + fontSize?: number; + foregroundColor?: Sheets_v4.Schema.Color; + italic?: boolean; + strikethrough?: boolean; + underline?: boolean; + } + export interface TextFormatRun { + format?: Sheets_v4.Schema.TextFormat; + startIndex?: number; + } + export interface TextPosition { + horizontalAlignment?: string; + } + export interface TextRotation { + angle?: number; + vertical?: boolean; + } + export interface TextToColumnsRequest { + delimiter?: string; + delimiterType?: string; + source?: Sheets_v4.Schema.GridRange; + } + export interface TreemapChartColorScale { + maxValueColor?: Sheets_v4.Schema.Color; + midValueColor?: Sheets_v4.Schema.Color; + minValueColor?: Sheets_v4.Schema.Color; + noDataColor?: Sheets_v4.Schema.Color; + } + export interface TreemapChartSpec { + colorData?: Sheets_v4.Schema.ChartData; + colorScale?: Sheets_v4.Schema.TreemapChartColorScale; + headerColor?: Sheets_v4.Schema.Color; + hideTooltips?: boolean; + hintedLevels?: number; + labels?: Sheets_v4.Schema.ChartData; + levels?: number; + maxValue?: Number; + minValue?: Number; + parentLabels?: Sheets_v4.Schema.ChartData; + sizeData?: Sheets_v4.Schema.ChartData; + textFormat?: Sheets_v4.Schema.TextFormat; + } + export interface UnmergeCellsRequest { + range?: Sheets_v4.Schema.GridRange; + } + export interface UpdateBandingRequest { + bandedRange?: Sheets_v4.Schema.BandedRange; + fields?: string; + } + export interface UpdateBordersRequest { + bottom?: Sheets_v4.Schema.Border; + innerHorizontal?: Sheets_v4.Schema.Border; + innerVertical?: Sheets_v4.Schema.Border; + left?: Sheets_v4.Schema.Border; + range?: Sheets_v4.Schema.GridRange; + right?: Sheets_v4.Schema.Border; + top?: Sheets_v4.Schema.Border; + } + export interface UpdateCellsRequest { + fields?: string; + range?: Sheets_v4.Schema.GridRange; + rows?: Sheets_v4.Schema.RowData[]; + start?: Sheets_v4.Schema.GridCoordinate; + } + export interface UpdateChartSpecRequest { + chartId?: number; + spec?: Sheets_v4.Schema.ChartSpec; + } + export interface UpdateConditionalFormatRuleRequest { + index?: number; + newIndex?: number; + rule?: Sheets_v4.Schema.ConditionalFormatRule; + sheetId?: number; + } + export interface UpdateConditionalFormatRuleResponse { + newIndex?: number; + newRule?: Sheets_v4.Schema.ConditionalFormatRule; + oldIndex?: number; + oldRule?: Sheets_v4.Schema.ConditionalFormatRule; + } + export interface UpdateDeveloperMetadataRequest { + dataFilters?: Sheets_v4.Schema.DataFilter[]; + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata; + fields?: string; + } + export interface UpdateDeveloperMetadataResponse { + developerMetadata?: Sheets_v4.Schema.DeveloperMetadata[]; + } + export interface UpdateDimensionGroupRequest { + dimensionGroup?: Sheets_v4.Schema.DimensionGroup; + fields?: string; + } + export interface UpdateDimensionPropertiesRequest { + fields?: string; + properties?: Sheets_v4.Schema.DimensionProperties; + range?: Sheets_v4.Schema.DimensionRange; + } + export interface UpdateEmbeddedObjectPositionRequest { + fields?: string; + newPosition?: Sheets_v4.Schema.EmbeddedObjectPosition; + objectId?: number; + } + export interface UpdateEmbeddedObjectPositionResponse { + position?: Sheets_v4.Schema.EmbeddedObjectPosition; + } + export interface UpdateFilterViewRequest { + fields?: string; + filter?: Sheets_v4.Schema.FilterView; + } + export interface UpdateNamedRangeRequest { + fields?: string; + namedRange?: Sheets_v4.Schema.NamedRange; + } + export interface UpdateProtectedRangeRequest { + fields?: string; + protectedRange?: Sheets_v4.Schema.ProtectedRange; + } + export interface UpdateSheetPropertiesRequest { + fields?: string; + properties?: Sheets_v4.Schema.SheetProperties; + } + export interface UpdateSpreadsheetPropertiesRequest { + fields?: string; + properties?: Sheets_v4.Schema.SpreadsheetProperties; + } + export interface UpdateValuesByDataFilterResponse { + dataFilter?: Sheets_v4.Schema.DataFilter; + updatedCells?: number; + updatedColumns?: number; + updatedData?: Sheets_v4.Schema.ValueRange; + updatedRange?: string; + updatedRows?: number; + } + export interface UpdateValuesResponse { + spreadsheetId?: string; + updatedCells?: number; + updatedColumns?: number; + updatedData?: Sheets_v4.Schema.ValueRange; + updatedRange?: string; + updatedRows?: number; + } + export interface ValueRange { + majorDimension?: string; + range?: string; + values?: Object[][]; + } + export interface WaterfallChartColumnStyle { + color?: Sheets_v4.Schema.Color; + label?: string; + } + export interface WaterfallChartCustomSubtotal { + dataIsSubtotal?: boolean; + label?: string; + subtotalIndex?: number; + } + export interface WaterfallChartDomain { + data?: Sheets_v4.Schema.ChartData; + reversed?: boolean; + } + export interface WaterfallChartSeries { + customSubtotals?: Sheets_v4.Schema.WaterfallChartCustomSubtotal[]; + data?: Sheets_v4.Schema.ChartData; + hideTrailingSubtotal?: boolean; + negativeColumnsStyle?: Sheets_v4.Schema.WaterfallChartColumnStyle; + positiveColumnsStyle?: Sheets_v4.Schema.WaterfallChartColumnStyle; + subtotalColumnsStyle?: Sheets_v4.Schema.WaterfallChartColumnStyle; + } + export interface WaterfallChartSpec { + connectorLineStyle?: Sheets_v4.Schema.LineStyle; + domain?: Sheets_v4.Schema.WaterfallChartDomain; + firstValueIsTotal?: boolean; + hideConnectorLines?: boolean; + series?: Sheets_v4.Schema.WaterfallChartSeries[]; + stackedType?: string; + } + } + } + export interface Sheets_v4 { + Spreadsheets?: Sheets_v4.Collection.SpreadsheetsCollection; + // Create a new instance of AddBandingRequest + newAddBandingRequest(): Sheets_v4.Schema.AddBandingRequest; + // Create a new instance of AddChartRequest + newAddChartRequest(): Sheets_v4.Schema.AddChartRequest; + // Create a new instance of AddConditionalFormatRuleRequest + newAddConditionalFormatRuleRequest(): Sheets_v4.Schema.AddConditionalFormatRuleRequest; + // Create a new instance of AddDimensionGroupRequest + newAddDimensionGroupRequest(): Sheets_v4.Schema.AddDimensionGroupRequest; + // Create a new instance of AddFilterViewRequest + newAddFilterViewRequest(): Sheets_v4.Schema.AddFilterViewRequest; + // Create a new instance of AddNamedRangeRequest + newAddNamedRangeRequest(): Sheets_v4.Schema.AddNamedRangeRequest; + // Create a new instance of AddProtectedRangeRequest + newAddProtectedRangeRequest(): Sheets_v4.Schema.AddProtectedRangeRequest; + // Create a new instance of AddSheetRequest + newAddSheetRequest(): Sheets_v4.Schema.AddSheetRequest; + // Create a new instance of AppendCellsRequest + newAppendCellsRequest(): Sheets_v4.Schema.AppendCellsRequest; + // Create a new instance of AppendDimensionRequest + newAppendDimensionRequest(): Sheets_v4.Schema.AppendDimensionRequest; + // Create a new instance of AutoFillRequest + newAutoFillRequest(): Sheets_v4.Schema.AutoFillRequest; + // Create a new instance of AutoResizeDimensionsRequest + newAutoResizeDimensionsRequest(): Sheets_v4.Schema.AutoResizeDimensionsRequest; + // Create a new instance of BandedRange + newBandedRange(): Sheets_v4.Schema.BandedRange; + // Create a new instance of BandingProperties + newBandingProperties(): Sheets_v4.Schema.BandingProperties; + // Create a new instance of BasicChartAxis + newBasicChartAxis(): Sheets_v4.Schema.BasicChartAxis; + // Create a new instance of BasicChartDomain + newBasicChartDomain(): Sheets_v4.Schema.BasicChartDomain; + // Create a new instance of BasicChartSeries + newBasicChartSeries(): Sheets_v4.Schema.BasicChartSeries; + // Create a new instance of BasicChartSpec + newBasicChartSpec(): Sheets_v4.Schema.BasicChartSpec; + // Create a new instance of BasicFilter + newBasicFilter(): Sheets_v4.Schema.BasicFilter; + // Create a new instance of BatchClearValuesByDataFilterRequest + newBatchClearValuesByDataFilterRequest(): Sheets_v4.Schema.BatchClearValuesByDataFilterRequest; + // Create a new instance of BatchClearValuesRequest + newBatchClearValuesRequest(): Sheets_v4.Schema.BatchClearValuesRequest; + // Create a new instance of BatchGetValuesByDataFilterRequest + newBatchGetValuesByDataFilterRequest(): Sheets_v4.Schema.BatchGetValuesByDataFilterRequest; + // Create a new instance of BatchUpdateSpreadsheetRequest + newBatchUpdateSpreadsheetRequest(): Sheets_v4.Schema.BatchUpdateSpreadsheetRequest; + // Create a new instance of BatchUpdateValuesByDataFilterRequest + newBatchUpdateValuesByDataFilterRequest(): Sheets_v4.Schema.BatchUpdateValuesByDataFilterRequest; + // Create a new instance of BatchUpdateValuesRequest + newBatchUpdateValuesRequest(): Sheets_v4.Schema.BatchUpdateValuesRequest; + // Create a new instance of BooleanCondition + newBooleanCondition(): Sheets_v4.Schema.BooleanCondition; + // Create a new instance of BooleanRule + newBooleanRule(): Sheets_v4.Schema.BooleanRule; + // Create a new instance of Border + newBorder(): Sheets_v4.Schema.Border; + // Create a new instance of Borders + newBorders(): Sheets_v4.Schema.Borders; + // Create a new instance of BubbleChartSpec + newBubbleChartSpec(): Sheets_v4.Schema.BubbleChartSpec; + // Create a new instance of CandlestickChartSpec + newCandlestickChartSpec(): Sheets_v4.Schema.CandlestickChartSpec; + // Create a new instance of CandlestickData + newCandlestickData(): Sheets_v4.Schema.CandlestickData; + // Create a new instance of CandlestickDomain + newCandlestickDomain(): Sheets_v4.Schema.CandlestickDomain; + // Create a new instance of CandlestickSeries + newCandlestickSeries(): Sheets_v4.Schema.CandlestickSeries; + // Create a new instance of CellData + newCellData(): Sheets_v4.Schema.CellData; + // Create a new instance of CellFormat + newCellFormat(): Sheets_v4.Schema.CellFormat; + // Create a new instance of ChartData + newChartData(): Sheets_v4.Schema.ChartData; + // Create a new instance of ChartSourceRange + newChartSourceRange(): Sheets_v4.Schema.ChartSourceRange; + // Create a new instance of ChartSpec + newChartSpec(): Sheets_v4.Schema.ChartSpec; + // Create a new instance of ClearBasicFilterRequest + newClearBasicFilterRequest(): Sheets_v4.Schema.ClearBasicFilterRequest; + // Create a new instance of ClearValuesRequest + newClearValuesRequest(): any; // Schema.ClearValuesRequest; + // Create a new instance of Color + newColor(): Sheets_v4.Schema.Color; + // Create a new instance of ConditionValue + newConditionValue(): Sheets_v4.Schema.ConditionValue; + // Create a new instance of ConditionalFormatRule + newConditionalFormatRule(): Sheets_v4.Schema.ConditionalFormatRule; + // Create a new instance of CopyPasteRequest + newCopyPasteRequest(): Sheets_v4.Schema.CopyPasteRequest; + // Create a new instance of CopySheetToAnotherSpreadsheetRequest + newCopySheetToAnotherSpreadsheetRequest(): Sheets_v4.Schema.CopySheetToAnotherSpreadsheetRequest; + // Create a new instance of CreateDeveloperMetadataRequest + newCreateDeveloperMetadataRequest(): Sheets_v4.Schema.CreateDeveloperMetadataRequest; + // Create a new instance of CutPasteRequest + newCutPasteRequest(): Sheets_v4.Schema.CutPasteRequest; + // Create a new instance of DataFilter + newDataFilter(): Sheets_v4.Schema.DataFilter; + // Create a new instance of DataFilterValueRange + newDataFilterValueRange(): Sheets_v4.Schema.DataFilterValueRange; + // Create a new instance of DataValidationRule + newDataValidationRule(): Sheets_v4.Schema.DataValidationRule; + // Create a new instance of DateTimeRule + newDateTimeRule(): Sheets_v4.Schema.DateTimeRule; + // Create a new instance of DeleteBandingRequest + newDeleteBandingRequest(): Sheets_v4.Schema.DeleteBandingRequest; + // Create a new instance of DeleteConditionalFormatRuleRequest + newDeleteConditionalFormatRuleRequest(): Sheets_v4.Schema.DeleteConditionalFormatRuleRequest; + // Create a new instance of DeleteDeveloperMetadataRequest + newDeleteDeveloperMetadataRequest(): Sheets_v4.Schema.DeleteDeveloperMetadataRequest; + // Create a new instance of DeleteDimensionGroupRequest + newDeleteDimensionGroupRequest(): Sheets_v4.Schema.DeleteDimensionGroupRequest; + // Create a new instance of DeleteDimensionRequest + newDeleteDimensionRequest(): Sheets_v4.Schema.DeleteDimensionRequest; + // Create a new instance of DeleteEmbeddedObjectRequest + newDeleteEmbeddedObjectRequest(): Sheets_v4.Schema.DeleteEmbeddedObjectRequest; + // Create a new instance of DeleteFilterViewRequest + newDeleteFilterViewRequest(): Sheets_v4.Schema.DeleteFilterViewRequest; + // Create a new instance of DeleteNamedRangeRequest + newDeleteNamedRangeRequest(): Sheets_v4.Schema.DeleteNamedRangeRequest; + // Create a new instance of DeleteProtectedRangeRequest + newDeleteProtectedRangeRequest(): Sheets_v4.Schema.DeleteProtectedRangeRequest; + // Create a new instance of DeleteRangeRequest + newDeleteRangeRequest(): Sheets_v4.Schema.DeleteRangeRequest; + // Create a new instance of DeleteSheetRequest + newDeleteSheetRequest(): Sheets_v4.Schema.DeleteSheetRequest; + // Create a new instance of DeveloperMetadata + newDeveloperMetadata(): Sheets_v4.Schema.DeveloperMetadata; + // Create a new instance of DeveloperMetadataLocation + newDeveloperMetadataLocation(): Sheets_v4.Schema.DeveloperMetadataLocation; + // Create a new instance of DeveloperMetadataLookup + newDeveloperMetadataLookup(): Sheets_v4.Schema.DeveloperMetadataLookup; + // Create a new instance of DimensionGroup + newDimensionGroup(): Sheets_v4.Schema.DimensionGroup; + // Create a new instance of DimensionProperties + newDimensionProperties(): Sheets_v4.Schema.DimensionProperties; + // Create a new instance of DimensionRange + newDimensionRange(): Sheets_v4.Schema.DimensionRange; + // Create a new instance of DuplicateFilterViewRequest + newDuplicateFilterViewRequest(): Sheets_v4.Schema.DuplicateFilterViewRequest; + // Create a new instance of DuplicateSheetRequest + newDuplicateSheetRequest(): Sheets_v4.Schema.DuplicateSheetRequest; + // Create a new instance of Editors + newEditors(): Sheets_v4.Schema.Editors; + // Create a new instance of EmbeddedChart + newEmbeddedChart(): Sheets_v4.Schema.EmbeddedChart; + // Create a new instance of EmbeddedObjectPosition + newEmbeddedObjectPosition(): Sheets_v4.Schema.EmbeddedObjectPosition; + // Create a new instance of ErrorValue + newErrorValue(): Sheets_v4.Schema.ErrorValue; + // Create a new instance of ExtendedValue + newExtendedValue(): Sheets_v4.Schema.ExtendedValue; + // Create a new instance of FilterView + newFilterView(): Sheets_v4.Schema.FilterView; + // Create a new instance of FindReplaceRequest + newFindReplaceRequest(): Sheets_v4.Schema.FindReplaceRequest; + // Create a new instance of GetSpreadsheetByDataFilterRequest + newGetSpreadsheetByDataFilterRequest(): Sheets_v4.Schema.GetSpreadsheetByDataFilterRequest; + // Create a new instance of GradientRule + newGradientRule(): Sheets_v4.Schema.GradientRule; + // Create a new instance of GridCoordinate + newGridCoordinate(): Sheets_v4.Schema.GridCoordinate; + // Create a new instance of GridData + newGridData(): Sheets_v4.Schema.GridData; + // Create a new instance of GridProperties + newGridProperties(): Sheets_v4.Schema.GridProperties; + // Create a new instance of GridRange + newGridRange(): Sheets_v4.Schema.GridRange; + // Create a new instance of HistogramChartSpec + newHistogramChartSpec(): Sheets_v4.Schema.HistogramChartSpec; + // Create a new instance of HistogramRule + newHistogramRule(): Sheets_v4.Schema.HistogramRule; + // Create a new instance of HistogramSeries + newHistogramSeries(): Sheets_v4.Schema.HistogramSeries; + // Create a new instance of InsertDimensionRequest + newInsertDimensionRequest(): Sheets_v4.Schema.InsertDimensionRequest; + // Create a new instance of InsertRangeRequest + newInsertRangeRequest(): Sheets_v4.Schema.InsertRangeRequest; + // Create a new instance of InterpolationPoint + newInterpolationPoint(): Sheets_v4.Schema.InterpolationPoint; + // Create a new instance of IterativeCalculationSettings + newIterativeCalculationSettings(): Sheets_v4.Schema.IterativeCalculationSettings; + // Create a new instance of LineStyle + newLineStyle(): Sheets_v4.Schema.LineStyle; + // Create a new instance of ManualRule + newManualRule(): Sheets_v4.Schema.ManualRule; + // Create a new instance of ManualRuleGroup + newManualRuleGroup(): Sheets_v4.Schema.ManualRuleGroup; + // Create a new instance of MergeCellsRequest + newMergeCellsRequest(): Sheets_v4.Schema.MergeCellsRequest; + // Create a new instance of MoveDimensionRequest + newMoveDimensionRequest(): Sheets_v4.Schema.MoveDimensionRequest; + // Create a new instance of NamedRange + newNamedRange(): Sheets_v4.Schema.NamedRange; + // Create a new instance of NumberFormat + newNumberFormat(): Sheets_v4.Schema.NumberFormat; + // Create a new instance of OrgChartSpec + newOrgChartSpec(): Sheets_v4.Schema.OrgChartSpec; + // Create a new instance of OverlayPosition + newOverlayPosition(): Sheets_v4.Schema.OverlayPosition; + // Create a new instance of Padding + newPadding(): Sheets_v4.Schema.Padding; + // Create a new instance of PasteDataRequest + newPasteDataRequest(): Sheets_v4.Schema.PasteDataRequest; + // Create a new instance of PieChartSpec + newPieChartSpec(): Sheets_v4.Schema.PieChartSpec; + // Create a new instance of PivotGroup + newPivotGroup(): Sheets_v4.Schema.PivotGroup; + // Create a new instance of PivotGroupRule + newPivotGroupRule(): Sheets_v4.Schema.PivotGroupRule; + // Create a new instance of PivotGroupSortValueBucket + newPivotGroupSortValueBucket(): Sheets_v4.Schema.PivotGroupSortValueBucket; + // Create a new instance of PivotGroupValueMetadata + newPivotGroupValueMetadata(): Sheets_v4.Schema.PivotGroupValueMetadata; + // Create a new instance of PivotTable + newPivotTable(): Sheets_v4.Schema.PivotTable; + // Create a new instance of PivotValue + newPivotValue(): Sheets_v4.Schema.PivotValue; + // Create a new instance of ProtectedRange + newProtectedRange(): Sheets_v4.Schema.ProtectedRange; + // Create a new instance of RandomizeRangeRequest + newRandomizeRangeRequest(): Sheets_v4.Schema.RandomizeRangeRequest; + // Create a new instance of RepeatCellRequest + newRepeatCellRequest(): Sheets_v4.Schema.RepeatCellRequest; + // Create a new instance of Request + newRequest(): Sheets_v4.Schema.Request; + // Create a new instance of RowData + newRowData(): Sheets_v4.Schema.RowData; + // Create a new instance of SearchDeveloperMetadataRequest + newSearchDeveloperMetadataRequest(): Sheets_v4.Schema.SearchDeveloperMetadataRequest; + // Create a new instance of SetBasicFilterRequest + newSetBasicFilterRequest(): Sheets_v4.Schema.SetBasicFilterRequest; + // Create a new instance of SetDataValidationRequest + newSetDataValidationRequest(): Sheets_v4.Schema.SetDataValidationRequest; + // Create a new instance of Sheet + newSheet(): Sheets_v4.Schema.Sheet; + // Create a new instance of SheetProperties + newSheetProperties(): Sheets_v4.Schema.SheetProperties; + // Create a new instance of SortRangeRequest + newSortRangeRequest(): Sheets_v4.Schema.SortRangeRequest; + // Create a new instance of SortSpec + newSortSpec(): Sheets_v4.Schema.SortSpec; + // Create a new instance of SourceAndDestination + newSourceAndDestination(): Sheets_v4.Schema.SourceAndDestination; + // Create a new instance of Spreadsheet + newSpreadsheet(): Sheets_v4.Schema.Spreadsheet; + // Create a new instance of SpreadsheetProperties + newSpreadsheetProperties(): Sheets_v4.Schema.SpreadsheetProperties; + // Create a new instance of TextFormat + newTextFormat(): Sheets_v4.Schema.TextFormat; + // Create a new instance of TextFormatRun + newTextFormatRun(): Sheets_v4.Schema.TextFormatRun; + // Create a new instance of TextPosition + newTextPosition(): Sheets_v4.Schema.TextPosition; + // Create a new instance of TextRotation + newTextRotation(): Sheets_v4.Schema.TextRotation; + // Create a new instance of TextToColumnsRequest + newTextToColumnsRequest(): Sheets_v4.Schema.TextToColumnsRequest; + // Create a new instance of TreemapChartColorScale + newTreemapChartColorScale(): Sheets_v4.Schema.TreemapChartColorScale; + // Create a new instance of TreemapChartSpec + newTreemapChartSpec(): Sheets_v4.Schema.TreemapChartSpec; + // Create a new instance of UnmergeCellsRequest + newUnmergeCellsRequest(): Sheets_v4.Schema.UnmergeCellsRequest; + // Create a new instance of UpdateBandingRequest + newUpdateBandingRequest(): Sheets_v4.Schema.UpdateBandingRequest; + // Create a new instance of UpdateBordersRequest + newUpdateBordersRequest(): Sheets_v4.Schema.UpdateBordersRequest; + // Create a new instance of UpdateCellsRequest + newUpdateCellsRequest(): Sheets_v4.Schema.UpdateCellsRequest; + // Create a new instance of UpdateChartSpecRequest + newUpdateChartSpecRequest(): Sheets_v4.Schema.UpdateChartSpecRequest; + // Create a new instance of UpdateConditionalFormatRuleRequest + newUpdateConditionalFormatRuleRequest(): Sheets_v4.Schema.UpdateConditionalFormatRuleRequest; + // Create a new instance of UpdateDeveloperMetadataRequest + newUpdateDeveloperMetadataRequest(): Sheets_v4.Schema.UpdateDeveloperMetadataRequest; + // Create a new instance of UpdateDimensionGroupRequest + newUpdateDimensionGroupRequest(): Sheets_v4.Schema.UpdateDimensionGroupRequest; + // Create a new instance of UpdateDimensionPropertiesRequest + newUpdateDimensionPropertiesRequest(): Sheets_v4.Schema.UpdateDimensionPropertiesRequest; + // Create a new instance of UpdateEmbeddedObjectPositionRequest + newUpdateEmbeddedObjectPositionRequest(): Sheets_v4.Schema.UpdateEmbeddedObjectPositionRequest; + // Create a new instance of UpdateFilterViewRequest + newUpdateFilterViewRequest(): Sheets_v4.Schema.UpdateFilterViewRequest; + // Create a new instance of UpdateNamedRangeRequest + newUpdateNamedRangeRequest(): Sheets_v4.Schema.UpdateNamedRangeRequest; + // Create a new instance of UpdateProtectedRangeRequest + newUpdateProtectedRangeRequest(): Sheets_v4.Schema.UpdateProtectedRangeRequest; + // Create a new instance of UpdateSheetPropertiesRequest + newUpdateSheetPropertiesRequest(): Sheets_v4.Schema.UpdateSheetPropertiesRequest; + // Create a new instance of UpdateSpreadsheetPropertiesRequest + newUpdateSpreadsheetPropertiesRequest(): Sheets_v4.Schema.UpdateSpreadsheetPropertiesRequest; + // Create a new instance of ValueRange + newValueRange(): Sheets_v4.Schema.ValueRange; + // Create a new instance of WaterfallChartColumnStyle + newWaterfallChartColumnStyle(): Sheets_v4.Schema.WaterfallChartColumnStyle; + // Create a new instance of WaterfallChartCustomSubtotal + newWaterfallChartCustomSubtotal(): Sheets_v4.Schema.WaterfallChartCustomSubtotal; + // Create a new instance of WaterfallChartDomain + newWaterfallChartDomain(): Sheets_v4.Schema.WaterfallChartDomain; + // Create a new instance of WaterfallChartSeries + newWaterfallChartSeries(): Sheets_v4.Schema.WaterfallChartSeries; + // Create a new instance of WaterfallChartSpec + newWaterfallChartSpec(): Sheets_v4.Schema.WaterfallChartSpec; + } +} + +declare var Sheets_v4: GoogleAppsScript.Sheets_v4; \ No newline at end of file diff --git a/types/google-apps-script/apis/slides/v1.d.ts b/types/google-apps-script/apis/slides/v1.d.ts deleted file mode 100644 index 101fb56029..0000000000 --- a/types/google-apps-script/apis/slides/v1.d.ts +++ /dev/null @@ -1,2072 +0,0 @@ -// Type definitions for Google Apps Script 2018-10-02 -// Project: https://developers.google.com/apps-script/ -// Definitions by: grant -// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped - -declare namespace GoogleAppsScript { - export module Slides_v1 { - //// FILE: color.proto //// - // An RGB color. - export interface RgbColor { - // The red component of the color, from 0.0 to 1.0. - red: number - // The green component of the color, from 0.0 to 1.0. - green: number - // The blue component of the color, from 0.0 to 1.0. - blue: number - } - - // A themeable solid color value. - export interface OpaqueColor { - // The kind of color value. - kind: { - // An opaque RGB color. - rgb_color: RgbColor - // An opaque theme color. - theme_color: ThemeColorType - } - } - - // A color that can either be fully opaque or fully transparent. - export interface OptionalColor { - // If set, this will be used as an opaque color. If unset, this represents - // a transparent color. - opaque_color: OpaqueColor - } - - // The palette of predefined colors for a page. - export interface ColorScheme { - // The ThemeColorType and corresponding concrete color pairs. - colors: ThemeColorPair[] - } - - // Theme color types. - // - // Contain a ColorScheme that defines a mapping of - // these theme color types to concrete colors. - export enum ThemeColorType { - // Unspecified theme color. This value should not be used. - THEME_COLOR_TYPE_UNSPECIFIED, - // Represents the first dark color. - DARK1, - // Represents the first light color. - LIGHT1, - // Represents the second dark color. - DARK2, - // Represents the second light color. - LIGHT2, - // Represents the first accent color. - ACCENT1, - // Represents the second accent color. - ACCENT2, - // Represents the third accent color. - ACCENT3, - // Represents the fourth accent color. - ACCENT4, - // Represents the fifth accent color. - ACCENT5, - // Represents the sixth accent color. - ACCENT6, - // Represents the color to use for hyperlinks. - HYPERLINK, - // Represents the color to use for visited hyperlinks. - FOLLOWED_HYPERLINK, - // Represents the first text color. - TEXT1, - // Represents the first background color. - BACKGROUND1, - // Represents the second text color. - TEXT2, - // Represents the second background color. - BACKGROUND2, - } - - // A pair mapping a theme color type to the concrete color it represents. - export interface ThemeColorPair { - // The type of the theme color. - type: ThemeColorType - // The concrete color corresponding to the theme color type above. - color: RgbColor - } - - // A color and position in a gradient band. - export interface ColorStop { - // The color of the gradient stop. - color: OpaqueColor - // The alpha value of this color in the gradient band. Defaults to 1.0, - // fully opaque. - alpha: number - // The relative position of the color stop in the gradient band measured - // in percentage. The value should be in the interval [0.0, 1.0]. - position: number - } - - //// FILE: dimension.proto //// - // Units of measurement. - export enum Unit { - // The units are unknown. - UNIT_UNSPECIFIED, - // An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter - // and thus there are 914,400 EMUs per inch, and 12,700 EMUs per point. - EMU, - // A point, 1/72 of an inch. - PT, - } - - // A magnitude in a single direction in the specified units. - export interface Dimension { - // The magnitude. - magnitude: number - // The units for magnitude. - unit: Unit - } - - // A width and height. - export interface Size { - // The width of the object. - width: Dimension - // The height of the object. - height: Dimension - } - - //// FILE: model.proto //// - // A location of a single table cell within a table. - export interface TableCellLocation { - // The 0-based row index. - row_index: number - - // The 0-based column index. - column_index: number - } - - // Common properties for a page element. - // - // Note: When you initially create a PageElement, the API may modify - // the values of both `size` and `transform`, but the - // visual size will be unchanged. - export interface PageElementProperties { - // The object ID of the page where the element is located. - page_object_id: string - - // The size of the element. - size: Size - - // The transform for the element. - transform: AffineTransform - } - - // The general text content. The text must reside in a compatible shape (e.g. - // text box or rectangle) or a table cell in a page. - export interface TextContent { - // The text contents broken down into its component parts, including styling - // information. This property is read-only. - text_elements: TextElement[] - // The bulleted lists contained in this text, keyed by list ID. - lists: string[] - } - - - // Predefined layout types. - // These are commonly found layouts in presentations. However, there is no - // guarantee that these layouts are present in the current master as they - // could have been deleted or not part of the used theme. Additionally, - // the placeholders on each layout may have been changed. - export enum PredefinedLayout { - // Unspecified layout. - PREDEFINED_LAYOUT_UNSPECIFIED, - // Blank layout, with no placeholders. - BLANK, - // Layout with a caption at the bottom. - CAPTION_ONLY, - // Layout with a title and a subtitle. - TITLE, - // Layout with a title and body. - TITLE_AND_BODY, - // Layout with a title and two columns. - TITLE_AND_TWO_COLUMNS, - // Layout with only a title. - TITLE_ONLY, - // Layout with a section title. - SECTION_HEADER, - // Layout with a title and subtitle on one side and description on the other. - SECTION_TITLE_AND_DESCRIPTION, - // Layout with one title and one body, arranged in a single column. - ONE_COLUMN_TEXT, - // Layout with a main point. - MAIN_POINT, - // Layout with a big number heading. - BIG_NUMBER, - } - - // A Google Slides presentation. - export interface Presentation { - // The ID of the presentation. - presentation_id: string - // The size of pages in the presentation. - page_size: Size - // The slides in the presentation. - // A slide inherits properties from a slide layout. - slides: Page[] - // The title of the presentation. - title: string - // The slide masters in the presentation. A slide master contains all common - // page elements and the common properties for a set of layouts. They serve - // three purposes: - // - // - Placeholder shapes on a master contain the default text styles and shape - // properties of all placeholder shapes on pages that use that master. - // - The master page properties define the common page properties inherited by - // its layouts. - // - Any other shapes on the master slide will appear on all slides using that - // master, regardless of their layout. - masters: Page[] - // The layouts in the presentation. A layout is a template that determines - // how content is arranged and styled on the slides that inherit from that - // layout. - layouts: Page[] - // The locale of the presentation, as an IETF BCP 47 language tag. - locale: string - // The revision ID of the presentation. Can be used in update requests - // to assert that the presentation revision hasn't changed since the last - // read operation. Only populated if the user has edit access to the - // presentation. - // - // The format of the revision ID may change over time, so it should be treated - // opaquely. A returned revision ID is only guaranteed to be valid for 24 - // hours after it has been returned and cannot be shared across users. If the - // revision ID is unchanged between calls, then the presentation has not - // changed. Conversely, a changed ID (for the same presentation and user) - // usually means the presentation has been updated; however, a changed ID can - // also be due to internal factors such as ID format changes. - revision_id: string - // The notes master in the presentation. It serves three purposes: - // - // - Placeholder shapes on a notes master contain the default text styles and - // shape properties of all placeholder shapes on notes pages. Specifically, - // a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a - // `BODY` placeholder shape contains the speaker notes. - // - The notes master page properties define the common page properties - // inherited by all notes pages. - // - Any other shapes on the notes master will appear on all notes pages. - // - // The notes master is read-only. - notes_master: Page - } - - // The type of a page. - enum PagePageType { - // A slide page. - SLIDE, - // A master slide page. - MASTER, - // A layout page. - LAYOUT, - // A notes page. - NOTES, - // A notes master page. - NOTES_MASTER, - } - - // A page in a presentation. - export interface Page { - // The object ID for this page. Object IDs used by - // Page and PageElement share the same namespace. - object_id: string - // The type of the page. - page_type: PagePageType - // The page elements rendered on the page. - page_elements: PageElement[] - // Properties that are specific for each page type. Masters do not require - // any additional properties. - properties: { - // Slide specific properties. Only set if page_type = SLIDE. - slide_properties: SlideProperties - // Layout specific properties. Only set if page_type = LAYOUT. - layout_properties: LayoutProperties - // Notes specific properties. Only set if page_type = NOTES. - notes_properties: NotesProperties - // Master specific properties. Only set if page_type = MASTER. - master_properties: MasterProperties - } - - // The revision ID of the presentation containing this page. Can be used in - // update requests to assert that the presentation revision hasn't changed - // since the last read operation. Only populated if the user has edit access - // to the presentation. - // - // The format of the revision ID may change over time, so it should be treated - // opaquely. A returned revision ID is only guaranteed to be valid for 24 - // hours after it has been returned and cannot be shared across users. If the - // revision ID is unchanged between calls, then the presentation has not - // changed. Conversely, a changed ID (for the same presentation and user) - // usually means the presentation has been updated; however, a changed ID can - // also be due to internal factors such as ID format changes. - revision_id: string - // The properties of the page. - page_properties: PageProperties - } - - // The page background fill. - interface PagePropertiesPageBackgroundFill { - // The background fill property state. - // - // Updating the fill on a page will implicitly update this field to - // `RENDERED`, unless another value is specified in the same request. To - // have no fill on a page, set this field to `NOT_RENDERED`. In this case, - // any other fill fields set in the same request will be ignored. - property_state: PropertyState, - // The kind of background fill. - kind: { - // Solid color fill. - solid_fill: SolidFill, - // Stretched picture fill. - stretched_picture_fill: StretchedPictureFill, - } - } - - // The properties of the Page. - // - // The page will inherit properties from the parent page. Depending on the page - // type the hierarchy is defined in either SlideProperties or - // LayoutProperties. - export interface PageProperties { - // The background fill of the page. If unset, the background fill is inherited - // from a parent page if it exists. If the page has no parent, then the - // background fill defaults to the corresponding fill in the Slides editor. - page_background_fill: PagePropertiesPageBackgroundFill, - // The color scheme of the page. If unset, the color scheme is inherited from - // a parent page. If the page has no parent, the color scheme uses a default - // Slides color scheme. This field is read-only. - color_scheme: ColorScheme, - } - - // The properties of Page that are only - // relevant for pages with page_type SLIDE. - export interface SlideProperties { - // The object ID of the layout that this slide is based on. This property is - // read-only. - layout_object_id: string - // The object ID of the master that this slide is based on. This property is - // read-only. - master_object_id: string - // The notes page that this slide is associated with. It defines the visual - // appearance of a notes page when printing or exporting slides with speaker - // notes. A notes page inherits properties from the notes master. - // The placeholder shape with type BODY on the notes page contains the speaker - // notes for this slide. The ID of this shape is identified by the speakerNotesObjectId field. - // The notes page is read-only except for the text content and styles of the - // speaker notes shape. This property is read-only. - notes_page: Page, - } - - // The properties of Page are only - // relevant for pages with page_type LAYOUT. - export interface LayoutProperties { - // The object ID of the master that this layout is based on. - master_object_id: string - // The name of the layout. - name: string - // The human-readable name of the layout. - display_name: string - } - - // The properties of Page that are only - // relevant for pages with page_type NOTES. - export interface NotesProperties { - // The object ID of the shape on this notes page that contains the speaker - // notes for the corresponding slide. - // The actual shape may not always exist on the notes page. Inserting text - // using this object ID will automatically create the shape. In this case, the - // actual shape may have different object ID. The `GetPresentation` or - // `GetPage` action will always return the latest object ID. - speaker_notes_object_id: string - } - - // The properties of Page that are only - // relevant for pages with page_type MASTER. - export interface MasterProperties { - // The human-readable name of the master. - display_name: string - } - - // A visual element rendered on a page. - // (== resource_for v1.presentations.pages.pageElements ==) - export interface PageElement { - // The object ID for this page element. Object IDs used by - // Page and PageElement share the same namespace. - object_id: string - // The size of the page element. - size: Size - // The transform of the page element. - // - // The visual appearance of the page element is determined by its absolute - // transform. To compute the absolute transform, preconcatenate a page - // element's transform with the transforms of all of its parent groups. If the - // page element is not in a group, its absolute transform is the same as the - // value in this field. - // - // The initial transform for the newly created Group is always the identity transform. - transform: AffineTransform - // The title of the page element. Combined with description to display alt - // text. - title: string - // The description of the page element. Combined with title to display alt - // text. - description: string - // The kind of element that this PageElement represents. Each message - // contains any properties that are specific to that kind of page element. - element_kind: { - // A collection of page elements joined as a single unit. - element_group: Group - // A generic shape. - shape: Shape - // An image page element. - image: Image - // A video page element. - video: Video - // A line page element. - line: Line - // A table page element. - table: Table - // A word art page element. - word_art: WordArt - // A linked chart embedded from Google Sheets. Unlinked charts are - // represented as images. - sheets_chart: SheetsChart - } - } - - // A PageElement kind representing a joined collection of PageElements. - export interface Group { - // The collection of elements in the group. The minimum size of a group is 2. - children: PageElement[] - } - - // The shape types. - export enum ShapeType { - // The shape type that is not predefined. - TYPE_UNSPECIFIED, - // Text box shape. - TEXT_BOX, - // Rectangle shape. Corresponds to ECMA-376 ST_ShapeType 'rect'. - RECTANGLE, - // Round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType - // 'roundRect' - ROUND_RECTANGLE, - // Ellipse shape. Corresponds to ECMA-376 ST_ShapeType 'ellipse' - ELLIPSE, - // Curved arc shape. Corresponds to ECMA-376 ST_ShapeType 'arc' - ARC, - // Bent arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentArrow' - BENT_ARROW, - // Bent up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'bentUpArrow' - BENT_UP_ARROW, - // Bevel shape. Corresponds to ECMA-376 ST_ShapeType 'bevel' - BEVEL, - // Block arc shape. Corresponds to ECMA-376 ST_ShapeType 'blockArc' - BLOCK_ARC, - // Brace pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracePair' - BRACE_PAIR, - // Bracket pair shape. Corresponds to ECMA-376 ST_ShapeType 'bracketPair' - BRACKET_PAIR, - // Can shape. Corresponds to ECMA-376 ST_ShapeType 'can' - CAN, - // Chevron shape. Corresponds to ECMA-376 ST_ShapeType 'chevron' - CHEVRON, - // Chord shape. Corresponds to ECMA-376 ST_ShapeType 'chord' - CHORD, - // Cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloud' - CLOUD, - // Corner shape. Corresponds to ECMA-376 ST_ShapeType 'corner' - CORNER, - // Cube shape. Corresponds to ECMA-376 ST_ShapeType 'cube' - CUBE, - // Curved down arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'curvedDownArrow' - CURVED_DOWN_ARROW, - // Curved left arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'curvedLeftArrow' - CURVED_LEFT_ARROW, - // Curved right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'curvedRightArrow' - CURVED_RIGHT_ARROW, - // Curved up arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'curvedUpArrow' - CURVED_UP_ARROW, - // Decagon shape. Corresponds to ECMA-376 ST_ShapeType 'decagon' - DECAGON, - // Diagonal stripe shape. Corresponds to ECMA-376 ST_ShapeType 'diagStripe' - DIAGONAL_STRIPE, - // Diamond shape. Corresponds to ECMA-376 ST_ShapeType 'diamond' - DIAMOND, - // Dodecagon shape. Corresponds to ECMA-376 ST_ShapeType 'dodecagon' - DODECAGON, - // Donut shape. Corresponds to ECMA-376 ST_ShapeType 'donut' - DONUT, - // Double wave shape. Corresponds to ECMA-376 ST_ShapeType 'doubleWave' - DOUBLE_WAVE, - // Down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'downArrow' - DOWN_ARROW, - // Callout down arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'downArrowCallout' - DOWN_ARROW_CALLOUT, - // Folded corner shape. Corresponds to ECMA-376 ST_ShapeType 'foldedCorner' - FOLDED_CORNER, - // Frame shape. Corresponds to ECMA-376 ST_ShapeType 'frame' - FRAME, - // Half frame shape. Corresponds to ECMA-376 ST_ShapeType 'halfFrame' - HALF_FRAME, - // Heart shape. Corresponds to ECMA-376 ST_ShapeType 'heart' - HEART, - // Heptagon shape. Corresponds to ECMA-376 ST_ShapeType 'heptagon' - HEPTAGON, - // Hexagon shape. Corresponds to ECMA-376 ST_ShapeType 'hexagon' - HEXAGON, - // Home plate shape. Corresponds to ECMA-376 ST_ShapeType 'homePlate' - HOME_PLATE, - // Horizontal scroll shape. Corresponds to ECMA-376 ST_ShapeType - // 'horizontalScroll' - HORIZONTAL_SCROLL, - // Irregular seal 1 shape. Corresponds to ECMA-376 ST_ShapeType - // 'irregularSeal1' - IRREGULAR_SEAL_1, - // Irregular seal 2 shape. Corresponds to ECMA-376 ST_ShapeType - // 'irregularSeal2' - IRREGULAR_SEAL_2, - // Left arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftArrow' - LEFT_ARROW, - // Callout left arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'leftArrowCallout' - LEFT_ARROW_CALLOUT, - // Left brace shape. Corresponds to ECMA-376 ST_ShapeType 'leftBrace' - LEFT_BRACE, - // Left bracket shape. Corresponds to ECMA-376 ST_ShapeType 'leftBracket' - LEFT_BRACKET, - // Left right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'leftRightArrow' - LEFT_RIGHT_ARROW, - // Callout left right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'leftRightArrowCallout' - LEFT_RIGHT_ARROW_CALLOUT, - // Left right up arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'leftRightUpArrow' - LEFT_RIGHT_UP_ARROW, - // Left up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'leftUpArrow' - LEFT_UP_ARROW, - // Lightning bolt shape. Corresponds to ECMA-376 ST_ShapeType - // 'lightningBolt' - LIGHTNING_BOLT, - // Divide math shape. Corresponds to ECMA-376 ST_ShapeType 'mathDivide' - MATH_DIVIDE, - // Equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathEqual' - MATH_EQUAL, - // Minus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMinus' - MATH_MINUS, - // Multiply math shape. Corresponds to ECMA-376 ST_ShapeType 'mathMultiply' - MATH_MULTIPLY, - // Not equal math shape. Corresponds to ECMA-376 ST_ShapeType 'mathNotEqual' - MATH_NOT_EQUAL, - // Plus math shape. Corresponds to ECMA-376 ST_ShapeType 'mathPlus' - MATH_PLUS, - // Moon shape. Corresponds to ECMA-376 ST_ShapeType 'moon' - MOON, - // No smoking shape. Corresponds to ECMA-376 ST_ShapeType 'noSmoking' - NO_SMOKING, - // Notched right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'notchedRightArrow' - NOTCHED_RIGHT_ARROW, - // Octagon shape. Corresponds to ECMA-376 ST_ShapeType 'octagon' - OCTAGON, - // Parallelogram shape. Corresponds to ECMA-376 ST_ShapeType 'parallelogram' - PARALLELOGRAM, - // Pentagon shape. Corresponds to ECMA-376 ST_ShapeType 'pentagon' - PENTAGON, - // Pie shape. Corresponds to ECMA-376 ST_ShapeType 'pie' - PIE, - // Plaque shape. Corresponds to ECMA-376 ST_ShapeType 'plaque' - PLAQUE, - // Plus shape. Corresponds to ECMA-376 ST_ShapeType 'plus' - PLUS, - // Quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType 'quadArrow' - QUAD_ARROW, - // Callout quad-arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'quadArrowCallout' - QUAD_ARROW_CALLOUT, - // Ribbon shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon' - RIBBON, - // Ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType 'ribbon2' - RIBBON_2, - // Right arrow shape. Corresponds to ECMA-376 ST_ShapeType 'rightArrow' - RIGHT_ARROW, - // Callout right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'rightArrowCallout' - RIGHT_ARROW_CALLOUT, - // Right brace shape. Corresponds to ECMA-376 ST_ShapeType 'rightBrace' - RIGHT_BRACE, - // Right bracket shape. Corresponds to ECMA-376 ST_ShapeType 'rightBracket' - RIGHT_BRACKET, - // One round corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType - // 'round1Rect' - ROUND_1_RECTANGLE, - // Two diagonal round corner rectangle shape. Corresponds to ECMA-376 - // ST_ShapeType 'round2DiagRect' - ROUND_2_DIAGONAL_RECTANGLE, - // Two same-side round corner rectangle shape. Corresponds to ECMA-376 - // ST_ShapeType 'round2SameRect' - ROUND_2_SAME_RECTANGLE, - // Right triangle shape. Corresponds to ECMA-376 ST_ShapeType 'rtTriangle' - RIGHT_TRIANGLE, - // Smiley face shape. Corresponds to ECMA-376 ST_ShapeType 'smileyFace' - SMILEY_FACE, - // One snip corner rectangle shape. Corresponds to ECMA-376 ST_ShapeType - // 'snip1Rect' - SNIP_1_RECTANGLE, - // Two diagonal snip corner rectangle shape. Corresponds to ECMA-376 - // ST_ShapeType 'snip2DiagRect' - SNIP_2_DIAGONAL_RECTANGLE, - // Two same-side snip corner rectangle shape. Corresponds to ECMA-376 - // ST_ShapeType 'snip2SameRect' - SNIP_2_SAME_RECTANGLE, - // One snip one round corner rectangle shape. Corresponds to ECMA-376 - // ST_ShapeType 'snipRoundRect' - SNIP_ROUND_RECTANGLE, - // Ten pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star10' - STAR_10, - // Twelve pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star12' - STAR_12, - // Sixteen pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star16' - STAR_16, - // Twenty four pointed star shape. Corresponds to ECMA-376 ST_ShapeType - // 'star24' - STAR_24, - // Thirty two pointed star shape. Corresponds to ECMA-376 ST_ShapeType - // 'star32' - STAR_32, - // Four pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star4' - STAR_4, - // Five pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star5' - STAR_5, - // Six pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star6' - STAR_6, - // Seven pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star7' - STAR_7, - // Eight pointed star shape. Corresponds to ECMA-376 ST_ShapeType 'star8' - STAR_8, - // Striped right arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'stripedRightArrow' - STRIPED_RIGHT_ARROW, - // Sun shape. Corresponds to ECMA-376 ST_ShapeType 'sun' - SUN, - // Trapezoid shape. Corresponds to ECMA-376 ST_ShapeType 'trapezoid' - TRAPEZOID, - // Triangle shape. Corresponds to ECMA-376 ST_ShapeType 'triangle' - TRIANGLE, - // Up arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upArrow' - UP_ARROW, - // Callout up arrow shape. Corresponds to ECMA-376 ST_ShapeType - // 'upArrowCallout' - UP_ARROW_CALLOUT, - // Up down arrow shape. Corresponds to ECMA-376 ST_ShapeType 'upDownArrow' - UP_DOWN_ARROW, - // U-turn arrow shape. Corresponds to ECMA-376 ST_ShapeType 'uturnArrow' - UTURN_ARROW, - // Vertical scroll shape. Corresponds to ECMA-376 ST_ShapeType - // 'verticalScroll' - VERTICAL_SCROLL, - // Wave shape. Corresponds to ECMA-376 ST_ShapeType 'wave' - WAVE, - // Callout wedge ellipse shape. Corresponds to ECMA-376 ST_ShapeType - // 'wedgeEllipseCallout' - WEDGE_ELLIPSE_CALLOUT, - // Callout wedge rectangle shape. Corresponds to ECMA-376 ST_ShapeType - // 'wedgeRectCallout' - WEDGE_RECTANGLE_CALLOUT, - // Callout wedge round rectangle shape. Corresponds to ECMA-376 ST_ShapeType - // 'wedgeRoundRectCallout' - WEDGE_ROUND_RECTANGLE_CALLOUT, - // Alternate process flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartAlternateProcess' - FLOW_CHART_ALTERNATE_PROCESS, - // Collate flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartCollate' - FLOW_CHART_COLLATE, - // Connector flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartConnector' - FLOW_CHART_CONNECTOR, - // Decision flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartDecision' - FLOW_CHART_DECISION, - // Delay flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartDelay' - FLOW_CHART_DELAY, - // Display flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartDisplay' - FLOW_CHART_DISPLAY, - // Document flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartDocument' - FLOW_CHART_DOCUMENT, - // Extract flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartExtract' - FLOW_CHART_EXTRACT, - // Input output flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartInputOutput' - FLOW_CHART_INPUT_OUTPUT, - // Internal storage flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartInternalStorage' - FLOW_CHART_INTERNAL_STORAGE, - // Magnetic disk flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartMagneticDisk' - FLOW_CHART_MAGNETIC_DISK, - // Magnetic drum flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartMagneticDrum' - FLOW_CHART_MAGNETIC_DRUM, - // Magnetic tape flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartMagneticTape' - FLOW_CHART_MAGNETIC_TAPE, - // Manual input flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartManualInput' - FLOW_CHART_MANUAL_INPUT, - // Manual operation flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartManualOperation' - FLOW_CHART_MANUAL_OPERATION, - // Merge flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartMerge' - FLOW_CHART_MERGE, - // Multi-document flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartMultidocument' - FLOW_CHART_MULTIDOCUMENT, - // Offline storage flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartOfflineStorage' - FLOW_CHART_OFFLINE_STORAGE, - // Off-page connector flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartOffpageConnector' - FLOW_CHART_OFFPAGE_CONNECTOR, - // Online storage flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartOnlineStorage' - FLOW_CHART_ONLINE_STORAGE, - // Or flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartOr' - FLOW_CHART_OR, - // Predefined process flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartPredefinedProcess' - FLOW_CHART_PREDEFINED_PROCESS, - // Preparation flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartPreparation' - FLOW_CHART_PREPARATION, - // Process flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartProcess' - FLOW_CHART_PROCESS, - // Punched card flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartPunchedCard' - FLOW_CHART_PUNCHED_CARD, - // Punched tape flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartPunchedTape' - FLOW_CHART_PUNCHED_TAPE, - // Sort flow shape. Corresponds to ECMA-376 ST_ShapeType 'flowChartSort' - FLOW_CHART_SORT, - // Summing junction flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartSummingJunction' - FLOW_CHART_SUMMING_JUNCTION, - // Terminator flow shape. Corresponds to ECMA-376 ST_ShapeType - // 'flowChartTerminator' - FLOW_CHART_TERMINATOR, - // East arrow shape. - ARROW_EAST, - // Northeast arrow shape. - ARROW_NORTH_EAST, - // North arrow shape. - ARROW_NORTH, - // Speech shape. - SPEECH, - // Star burst shape. - STARBURST, - // Teardrop shape. Corresponds to ECMA-376 ST_ShapeType 'teardrop' - TEARDROP, - // Ellipse ribbon shape. Corresponds to ECMA-376 ST_ShapeType - // 'ellipseRibbon' - ELLIPSE_RIBBON, - // Ellipse ribbon 2 shape. Corresponds to ECMA-376 ST_ShapeType - // 'ellipseRibbon2' - ELLIPSE_RIBBON_2, - // Callout cloud shape. Corresponds to ECMA-376 ST_ShapeType 'cloudCallout' - CLOUD_CALLOUT, - // Custom shape. - CUSTOM, - } - - // A PageElement kind representing a - // generic shape that does not have a more specific classification. - interface Shape { - // The shape types. - // - // Many of these shapes correspond to predefined shapes from the ECMA-376 - // standard. More information on those shapes can be found in the description - // of the "ST_ShapeType" simple type in section 20.1.10.55 of "Office Open XML - // File Formats - Fundamentals and Markup Language Reference", part 1 of - // [ECMA-376 4th - // edition](http://www.ecma-international.org/publications/standards/Ecma-376.htm). - - // The type of the shape. - shape_type: ShapeType - // The text content of the shape. - text: TextContent - // The properties of the shape. - shape_properties: ShapeProperties - // Placeholders are shapes that are inherit from corresponding placeholders on - // layouts and masters. - // - // If set, the shape is a placeholder shape and any inherited properties - // can be resolved by looking at the parent placeholder identified by the - // parent_object_id field. - placeholder: Placeholder - } - - // The type of the placeholder. - export enum PlaceholderType { - // Default value, signifies it is not a placeholder. - NONE, - // Body text. - BODY, - // Chart or graph. - CHART, - // Clip art image. - CLIP_ART, - // Title centered. - CENTERED_TITLE, - // Diagram. - DIAGRAM, - // Date and time. - DATE_AND_TIME, - // Footer text. - FOOTER, - // Header text. - HEADER, - // Multimedia. - MEDIA, - // Any content type. - OBJECT, - // Picture. - PICTURE, - // Number of a slide. - SLIDE_NUMBER, - // Subtitle. - SUBTITLE, - // Table. - TABLE, - // Slide title. - TITLE, - // Slide image. - SLIDE_IMAGE, - } - - // The placeholder information that uniquely identifies a placeholder shape. - export interface Placeholder { - // The type of a placeholder shape. - // - // Many of these placeholder types correspond to placeholder ids from the - // ECMA-376 standard. More information on those shapes can be found in the - // description of the "ST_PlaceholderType" type in section 19.7.10 of "Office - // Open XML File Formats - Fundamentals and Markup Language Reference", part - // 1 of [ECMA-376 4th - // edition](http://www.ecma-international.org/publications/standards/Ecma-376.htm). - // The type of the placeholder. - type: PlaceholderType - // The index of the placeholder. If the same placeholder types are present in - // the same page, they would have different index values. - index: number - // The object ID of this shape's parent placeholder. - // If unset, the parent placeholder shape does not exist, so the shape does - // not inherit properties from any other shape. - parent_object_id: string - } - - // The shape background fill. - interface ShapePropertiesShapeBackgroundFill { - // The background fill property state. - // - // Updating the fill on a shape will implicitly update this field to - // `RENDERED`, unless another value is specified in the same request. To - // have no fill on a shape, set this field to `NOT_RENDERED`. In this case, - // any other fill fields set in the same request will be ignored. - property_state: PropertyState - // The kind of background fill. - kind: { - // Solid color fill. - solid_fill: SolidFill - } - } - - // The properties of a Shape. - // - // If the shape is a placeholder shape as determined by the - // placeholder field, then these - // properties may be inherited from a parent placeholder shape. - // Determining the rendered value of the property depends on the corresponding - // property_state field value. - export interface ShapeProperties { - // The background fill of the shape. If unset, the background fill is - // inherited from a parent placeholder if it exists. If the shape has no - // parent, then the default background fill depends on the shape type, - // matching the defaults for new shapes created in the Slides editor. - shape_background_fill: ShapePropertiesShapeBackgroundFill - // The outline of the shape. If unset, the outline is inherited from a - // parent placeholder if it exists. If the shape has no parent, then the - // default outline depends on the shape type, matching the defaults for - // new shapes created in the Slides editor. - outline: Outline - // The shadow properties of the shape. If unset, the shadow is inherited from - // a parent placeholder if it exists. If the shape has no parent, then the - // default shadow matches the defaults for new shapes created in the Slides - // editor. This property is read-only. - shadow: Shadow - // The hyperlink destination of the shape. If unset, there is no link. Links - // are not inherited from parent placeholders. - link: Link - // The alignment of the content in the shape. If unspecified, - // the alignment is inherited from a parent placeholder if it exists. If the - // shape has no parent, the default alignment matches the alignment for new - // shapes created in the Slides editor. - content_alignment: ContentAlignment - } - - // The types of content alignment. - // - // Derived from a subset of the values of the "ST_TextAnchoringType" simple type - // in section 20.1.10.59 of "Office Open XML File Formats - Fundamentals and - // Markup Language Reference", part 1 of [ECMA-376 4th edition] - // (http://www.ecma-international.org/publications/standards/Ecma-376.htm). - export enum ContentAlignment { - // An unspecified content alignment. The content alignment is inherited from - // the parent if it exists. - CONTENT_ALIGNMENT_UNSPECIFIED, - // An unsupported content alignment. - CONTENT_ALIGNMENT_UNSUPPORTED, - // An alignment that aligns the content to the top of the content holder. - // Corresponds to ECMA-376 ST_TextAnchoringType 't'. - TOP, - // An alignment that aligns the content to the middle of the content - // holder. Corresponds to ECMA-376 ST_TextAnchoringType 'ctr'. - MIDDLE, - // An alignment that aligns the content to the bottom of the content - // holder. Corresponds to ECMA-376 ST_TextAnchoringType 'b'. - BOTTOM, - } - - // A PageElement kind representing an image. - export interface Image { - // An URL to an image with a default lifetime of 30 minutes. - // This URL is tagged with the account of the requester. Anyone with the URL - // effectively accesses the image as the original requester. Access to the - // image may be lost if the presentation's sharing settings change. - content_url: string - // The properties of the image. - image_properties: ImageProperties - // The source URL is the URL used to insert the image. The source URL can be - // empty. - source_url: string - } - - // The properties of the Image. - export interface ImageProperties { - // The crop properties of the image. If not set, the image is not cropped. - // This property is read-only. - crop_properties: CropProperties - // The transparency effect of the image. The value should be in the interval - // [0.0, 1.0], where 0 means no effect and 1 means completely transparent. - // This property is read-only. - transparency: number - // The brightness effect of the image. The value should be in the interval - // [-1.0, 1.0], where 0 means no effect. This property is read-only. - brightness: number - // The contrast effect of the image. The value should be in the interval - // [-1.0, 1.0], where 0 means no effect. This property is read-only. - contrast: number - // The recolor effect of the image. If not set, the image is not recolored. - // This property is read-only. - recolor: Recolor - // The outline of the image. If not set, the image has no outline. - outline: Outline - // The shadow of the image. If not set, the image has no shadow. This property - // is read-only. - shadow: Shadow - // The hyperlink destination of the image. If unset, there is no link. - link: Link - } - - // The video sources. - enum VideoSource { - // The video source is unspecified. - SOURCE_UNSPECIFIED, - // The video source is YouTube. - YOUTUBE, - // The video source is Google Drive. - DRIVE, - } - - // A PageElement kind representing a video. - export interface Video { - // An URL to a video. The URL is valid as long as the source video exists and - // sharing settings do not change. - url: string - // The video source. - source: VideoSource - // The video source's unique identifier for this video. - id: string - // The properties of the video. - video_properties: VideoProperties - } - - // The properties of the Video. - export interface VideoProperties { - // The outline of the video. The default outline matches the defaults for new - // videos created in the Slides editor. - outline: Outline - // Whether to enable video autoplay when the page is displayed in present - // mode. Defaults to false. - auto_play: boolean - // The time at which to start playback, measured in seconds from the beginning - // of the video. - // If set, the start time should be before the end time. - // If you set this to a value that exceeds the video's length in seconds, the - // video will be played from the last second. - // If not set, the video will be played from the beginning. - start: number - // The time at which to end playback, measured in seconds from the beginning - // of the video. - // If set, the end time should be after the start time. - // If not set or if you set this to a value that exceeds the video's length, - // the video will be played until its end. - end: number - // Whether to mute the audio during video playback. Defaults to false. - mute: boolean - } - - // Derived from a subset of the values of the "ST_ShapeType" simple type in - // section 20.1.10.55 of "Office Open XML File Formats - Fundamentals and - // Markup Language Reference", part 1 of [ECMA-376 4th edition] - // (http://www.ecma-international.org/publications/standards/Ecma-376.htm). - enum LineType { - // An unspecified line type. - TYPE_UNSPECIFIED, - // Straight connector 1 form. Corresponds to ECMA-376 ST_ShapeType - // 'straightConnector1'. - STRAIGHT_CONNECTOR_1, - // Bent connector 2 form. Corresponds to ECMA-376 ST_ShapeType - // 'bentConnector2'. - BENT_CONNECTOR_2, - // Bent connector 3 form. Corresponds to ECMA-376 ST_ShapeType - // 'bentConnector3'. - BENT_CONNECTOR_3, - // Bent connector 4 form. Corresponds to ECMA-376 ST_ShapeType - // 'bentConnector4'. - BENT_CONNECTOR_4, - // Bent connector 5 form. Corresponds to ECMA-376 ST_ShapeType - // 'bentConnector5'. - BENT_CONNECTOR_5, - // Curved connector 2 form. Corresponds to ECMA-376 ST_ShapeType - // 'curvedConnector2'. - CURVED_CONNECTOR_2, - // Curved connector 3 form. Corresponds to ECMA-376 ST_ShapeType - // 'curvedConnector3'. - CURVED_CONNECTOR_3, - // Curved connector 4 form. Corresponds to ECMA-376 ST_ShapeType - // 'curvedConnector4'. - CURVED_CONNECTOR_4, - // Curved connector 5 form. Corresponds to ECMA-376 ST_ShapeType - // 'curvedConnector5'. - CURVED_CONNECTOR_5, - // Straight line. Corresponds to ECMA-376 ST_ShapeType 'line'. This line - // type is not a connector. - STRAIGHT_LINE, - } - - // A PageElement kind representing a - // non-connector line, straight connector, curved connector, or bent connector. - export interface Line { - // The properties of the line. - line_properties: LineProperties - // The type of the line. - line_type: LineType - } - - // The catgory of a Line. - export enum LineCategory { - // Unspecified line category. - LINE_CATEGORY_UNSPECIFIED, - // Straight connectors, including straight connector 1. - STRAIGHT, - // Bent connectors, including bent connector 2 to 5. - BENT, - // Curved connectors, including curved connector 2 to 5. - CURVED, - } - - // The fill of the line. - export interface LinePropertiesLineFill { - // The kind of line fill. - kind: { - // Solid color fill. - solid_fill: SolidFill - } - } - - // The kinds of start and end forms with which linear geometry can be - // rendered. Some values are based on the "ST_LineEndType" simple type - // described in section 20.1.10.33 of "Office Open XML File Formats - - // Fundamentals and Markup Language Reference", part 1 of [ECMA-376 4th - // edition](http://www.ecma-international.org/publications/standards/Ecma-376.htm). - export enum LinePropertiesArrowStyle { - // An unspecified arrow style. - ARROW_STYLE_UNSPECIFIED, - // No arrow. - NONE, - // Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value - // 'stealth'. - STEALTH_ARROW, - // Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'. - FILL_ARROW, - // Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'. - FILL_CIRCLE, - // Filled square. - FILL_SQUARE, - // Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'. - FILL_DIAMOND, - // Hollow arrow. - OPEN_ARROW, - // Hollow circle. - OPEN_CIRCLE, - // Hollow square. - OPEN_SQUARE, - // Hollow diamond. - OPEN_DIAMOND, - } - - // The properties of the Line. - // - // When unset, these fields default to values that match the appearance of - // new lines created in the Slides editor. - export interface LineProperties { - // The fill of the line. The default line fill matches the defaults for new - // lines created in the Slides editor. - line_fill: LinePropertiesLineFill - // The thickness of the line. - weight: Dimension - // The dash style of the line. - dash_style: DashStyle - // The style of the arrow at the beginning of the line. - start_arrow: LinePropertiesArrowStyle - // The style of the arrow at the end of the line. - end_arrow: LinePropertiesArrowStyle - // The hyperlink destination of the line. If unset, there is no link. - link: Link - } - - // A PageElement kind representing a table. - export interface Table { - // Number of rows in the table. - rows: number - // Number of columns in the table. - columns: number - // Properties and contents of each row. - // - // Cells that span multiple rows are contained in only one of these rows and - // have a row_span greater than 1. - table_rows: TableRow[] - // Properties of each column. - table_columns: TableColumnProperties[] - // Properties of horizontal cell borders. - // - // A table's horizontal cell borders are represented as a grid. The grid has - // one more row than the number of rows in the table and the same number of - // columns as the table. For example, if the table is 3 x 3, its horizontal - // borders will be represented as a grid with 4 rows and 3 columns. - horizontal_border_rows: TableBorderRow[] - // Properties of vertical cell borders. - // - // A table's vertical cell borders are represented as a grid. The grid has the - // same number of rows as the table and one more column than the number of - // columns in the table. For example, if the table is 3 x 3, its vertical - // borders will be represented as a grid with 3 rows and 4 columns. - vertical_border_rows: TableBorderRow[] - } - - // Properties of each column in a table. - export interface TableColumnProperties { - // Width of a column. - column_width: Dimension - } - - // Properties and contents of each row in a table. - export interface TableRow { - // Height of a row. - row_height: Dimension - // Properties of the row. - table_row_properties: TableRowProperties - // Properties and contents of each cell. - // - // Cells that span multiple columns are represented only once with a - // column_span greater than 1. As a result, the length of this - // collection does not always match the number of columns of the entire table. - table_cells: TableCell[] - } - - // Properties of each row in a table. - export interface TableRowProperties { - // Minimum height of the row. The row will be rendered in the Slides editor at - // a height equal to or greater than this value in order to show all the text - // in the row's cell(s). - min_row_height: Dimension - } - - // Properties and contents of each table cell. - export interface TableCell { - // The location of the cell within the table. - location: TableCellLocation - // Row span of the cell. - row_span: number - // Column span of the cell. - column_span: number - // The text content of the cell. - text: TextContent - // The properties of the table cell. - table_cell_properties: TableCellProperties - } - - // The table cell background fill. - export interface TableCellPropertiesTableCellBackgroundFill { - // The background fill property state. - // - // Updating the fill on a table cell will implicitly update this field - // to `RENDERED`, unless another value is specified in the same request. To - // have no fill on a table cell, set this field to `NOT_RENDERED`. In this - // case, any other fill fields set in the same request will be ignored. - property_state: PropertyState - // The kind of background fill. - kind: { - // Solid color fill. - solid_fill: SolidFill - } - } - - // The properties of the TableCell. - export interface TableCellProperties { - // The background fill of the table cell. The default fill matches the fill - // for newly created table cells in the Slides editor. - table_cell_background_fill: TableCellPropertiesTableCellBackgroundFill - // The alignment of the content in the table cell. The default alignment - // matches the alignment for newly created table cells in the Slides editor. - content_alignment: ContentAlignment - } - - // Contents of each border row in a table. - export interface TableBorderRow { - // Properties of each border cell. When a border's adjacent table cells are - // merged, it is not included in the response. - table_border_cells: TableBorderCell[] - } - - // The properties of each border cell. - export interface TableBorderCell { - // The location of the border within the border table. - location: TableCellLocation - // The border properties. - table_border_properties: TableBorderProperties - } - - // The fill of the border. - export interface TableBorderPropertiesTableBorderFill { - // The kind of fill. - kind: { - // Solid fill. - solid_fill: SolidFill - } - } - - // The border styling properties of the TableBorderCell. - export interface TableBorderProperties { - // The fill of the table border. - table_border_fill: TableBorderPropertiesTableBorderFill - // The thickness of the border. - weight: Dimension - // The dash style of the border. - dash_style: DashStyle - } - - // A table range represents a reference to a subset of a table. - // - // It's important to note that the cells specified by a table range do not - // necessarily form a rectangle. For example, let's say we have a 3 x 3 table - // where all the cells of the last row are merged together. The table looks - // like this: - // - // [ ][ ][ ] - // [ ][ ][ ] - // [ ] - // - // A table range with location = (0, 0), row span = 3 and column span = 2 - // specifies the following cells: - // - // [ x ][ x ][ ] - // [ x ][ x ][ ] - // [ x ] - // - export interface TableRange { - // The starting location of the table range. - location: TableCellLocation - // The row span of the table range. - row_span: number - // The column span of the table range. - column_span: number - } - - // A PageElement kind representing word art. - export interface WordArt { - // The text rendered as word art. - rendered_text: string - } - - // A PageElement kind representing a linked chart embedded from Google Sheets. - export interface SheetsChart { - // The ID of the Google Sheets spreadsheet that contains the source chart. - spreadsheet_id: string - // The ID of the specific chart in the Google Sheets spreadsheet that is - // embedded. - chart_id: number - // The URL of an image of the embedded chart, with a default lifetime of 30 - // minutes. This URL is tagged with the account of the requester. Anyone with - // the URL effectively accesses the image as the original requester. Access to - // the image may be lost if the presentation's sharing settings change. - content_url: string - // The properties of the Sheets chart. - sheets_chart_properties: SheetsChartProperties - } - - // The properties of the SheetsChart. - export interface SheetsChartProperties { - // The kind of Sheets chart properties. - kind: { - // The properties of the embedded chart image. - chart_image_properties: ImageProperties - } - } - - //// FILE: properties.proto //// - // The possible states of a property. - enum PropertyState { - // If a property's state is RENDERED, then the element has the corresponding - // property when rendered on a page. If the element is a placeholder shape as - // determined by the placeholder - // field, and it inherits from a placeholder shape, the corresponding field - // may be unset, meaning that the property value is inherited from a parent - // placeholder. If the element does not inherit, then the field will contain - // the rendered value. This is the default value. - RENDERED, - // If a property's state is NOT_RENDERED, then the element does not have the - // corresponding property when rendered on a page. However, the field may - // still be set so it can be inherited by child shapes. To remove a property - // from a rendered element, set its property_state to NOT_RENDERED. - NOT_RENDERED, - // If a property's state is INHERIT, then the property state uses the value of - // corresponding `property_state` field on the parent shape. Elements that do - // not inherit will never have an INHERIT property state. - INHERIT, - } - - // The stretched picture fill. The page or page element is filled entirely with - // the specified picture. The picture is stretched to fit its container. - export interface StretchedPictureFill { - // Reading the content_url: - // - // An URL to a picture with a default lifetime of 30 minutes. - // This URL is tagged with the account of the requester. Anyone with the URL - // effectively accesses the picture as the original requester. Access to the - // picture may be lost if the presentation's sharing settings change. - // - // Writing the content_url: - // - // The picture is fetched once at insertion time and a copy is stored for - // display inside the presentation. Pictures must be less than 50MB in size, - // cannot exceed 25 megapixels, and must be in one of PNG, JPEG, or GIF - // format. - // - // The provided URL can be at most 2 kB in length. - // - content_url: string, - // The original size of the picture fill. This field is read-only. - size: Size, - } - - // A solid color fill. The page or page element is filled entirely with the - // specified color value. - // - // If any field is unset, its value may be inherited from a parent placeholder - // if it exists. - export interface SolidFill { - // The color value of the solid fill. - color: OpaqueColor, - // The fraction of this `color` that should be applied to the pixel. - // That is, the final pixel color is defined by the equation: - // - // pixel color = alpha * (color) + (1.0 - alpha) * (background color) - // - // This means that a value of 1.0 corresponds to a solid color, whereas - // a value of 0.0 corresponds to a completely transparent color. - alpha: number - } - - // The fill of the outline. - interface OutlineOutlineFill { - // The kind of outline fill. - kind: { - // Solid color fill. - solid_fill: SolidFill - } - } - - // The outline of a PageElement. - // - // If these fields are unset, they may be inherited from a parent placeholder - // if it exists. If there is no parent, the fields will default to the value - // used for new page elements created in the Slides editor, which may depend on - // the page element kind. - export interface Outline { - // Solid color fill. - solid_fill: SolidFill - // The fill of the outline. - outline_fill: OutlineOutlineFill - // The thickness of the outline. - weight: Dimension - // The dash style of the outline. - dash_style: DashStyle - // The outline property state. - // - // Updating the outline on a page element will implicitly update this field - // to `RENDERED`, unless another value is specified in the same request. To - // have no outline on a page element, set this field to `NOT_RENDERED`. In - // this case, any other outline fields set in the same request will be - // ignored. - property_state: PropertyState - } - - // The kinds of dashes with which linear geometry can be rendered. These - // values are based on the "ST_PresetLineDashVal" simple type described in - // section 20.1.10.48 of "Office Open XML File Formats - Fundamentals and - // Markup Language Reference", part 1 of [ECMA-376 4th - // edition](http://www.ecma-international.org/publications/standards/Ecma-376.htm). - export enum DashStyle { - // Unspecified dash style. - DASH_STYLE_UNSPECIFIED, - // Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'. - // This is the default dash style. - SOLID, - // Dotted line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dot'. - DOT, - // Dashed line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'dash'. - DASH, - // Alternating dashes and dots. Corresponds to ECMA-376 ST_PresetLineDashVal - // value 'dashDot'. - DASH_DOT, - // Line with large dashes. Corresponds to ECMA-376 ST_PresetLineDashVal - // value 'lgDash'. - LONG_DASH, - // Alternating large dashes and dots. Corresponds to ECMA-376 - // ST_PresetLineDashVal value 'lgDashDot'. - LONG_DASH_DOT, - } - - // Defines reference positions in a rectangle. - export enum RectanglePosition { - // Unspecified. - RECTANGLE_POSITION_UNSPECIFIED, - // Top left. - TOP_LEFT, - // Top center. - TOP_CENTER, - // Top right. - TOP_RIGHT, - // Left center. - LEFT_CENTER, - // Center. - CENTER, - // Right center. - RIGHT_CENTER, - // Bottom left. - BOTTOM_LEFT, - // Bottom center. - BOTTOM_CENTER, - // Bottom right. - BOTTOM_RIGHT, - } - - // The shadow types. - export enum ShadowType { - // Unspecified shadow type. - SHADOW_TYPE_UNSPECIFIED, - // Outer shadow. - OUTER, - } - - // The shadow properties of a page element. - // - // If these fields are unset, they may be inherited from a parent placeholder - // if it exists. If there is no parent, the fields will default to the value - // used for new page elements created in the Slides editor, which may depend on - // the page element kind. - export interface Shadow { - // The type of the shadow. - type: ShadowType, - // Transform that encodes the translate, scale, and skew of the shadow, - // relative to the alignment position. - transform: AffineTransform, - // The alignment point of the shadow, that sets the origin for translate, - // scale and skew of the shadow. - alignment: RectanglePosition, - // The radius of the shadow blur. The larger the radius, the more diffuse the - // shadow becomes. - blur_radius: Dimension, - // The shadow color value. - color: OpaqueColor, - // The alpha of the shadow's color, from 0.0 to 1.0. - alpha: number - // Whether the shadow should rotate with the shape. - rotate_with_shape: boolean - // The shadow property state. - // - // Updating the shadow on a page element will implicitly update this field to - // `RENDERED`, unless another value is specified in the same request. To have - // no shadow on a page element, set this field to `NOT_RENDERED`. In this - // case, any other shadow fields set in the same request will be ignored. - property_state: PropertyState - } - - // The crop properties of an object enclosed in a container. For example, an - // Image. - // - // The crop properties is represented by the offsets of four edges which define - // a crop rectangle. The offsets are measured in percentage from the - // corresponding edges of the object's original bounding rectangle towards - // inside, relative to the object's original dimensions. - // - // - If the offset is in the interval (0, 1), the corresponding edge of crop - // rectangle is positioned inside of the object's original bounding rectangle. - // - If the offset is negative or greater than 1, the corresponding edge of crop - // rectangle is positioned outside of the object's original bounding rectangle. - // - If the left edge of the crop rectangle is on the right side of its right - // edge, the object will be flipped horizontally. - // - If the top edge of the crop rectangle is below its bottom edge, the object - // will be flipped vertically. - // - If all offsets and rotation angle is 0, the object is not cropped. - // - // After cropping, the content in the crop rectangle will be stretched to fit - // its container. - export interface CropProperties { - // The offset specifies the left edge of the crop rectangle that is located to - // the right of the original bounding rectangle left edge, relative to the - // object's original width. - left_offset: number - // The offset specifies the right edge of the crop rectangle that is located - // to the left of the original bounding rectangle right edge, relative to the - // object's original width. - right_offset: number - // The offset specifies the top edge of the crop rectangle that is located - // below the original bounding rectangle top edge, relative to the object's - // original height. - top_offset: number - // The offset specifies the bottom edge of the crop rectangle that is located - // above the original bounding rectangle bottom edge, relative to the object's - // original height. - bottom_offset: number - // The rotation angle of the crop window around its center, in radians. - // Rotation angle is applied after the offset. - angle: number - } - - // A recolor effect applied on an image. - export enum RecolorName { - // No recolor effect. The default value. - NONE, - // A recolor effect that lightens the image using the page's first available - // color from its color scheme. - LIGHT1, - // A recolor effect that lightens the image using the page's second - // available color from its color scheme. - LIGHT2, - // A recolor effect that lightens the image using the page's third available - // color from its color scheme. - LIGHT3, - // A recolor effect that lightens the image using the page's forth available - // color from its color scheme. - LIGHT4, - // A recolor effect that lightens the image using the page's fifth available - // color from its color scheme. - LIGHT5, - // A recolor effect that lightens the image using the page's sixth available - // color from its color scheme. - LIGHT6, - // A recolor effect that lightens the image using the page's seventh - // available color from its color scheme.e. - LIGHT7, - // A recolor effect that lightens the image using the page's eighth - // available color from its color scheme. - LIGHT8, - // A recolor effect that lightens the image using the page's ninth available - // color from its color scheme. - LIGHT9, - // A recolor effect that lightens the image using the page's tenth available - // color from its color scheme. - LIGHT10, - // A recolor effect that darkens the image using the page's first available - // color from its color scheme. - DARK1, - // A recolor effect that darkens the image using the page's second available - // color from its color scheme. - DARK2, - // A recolor effect that darkens the image using the page's third available - // color from its color scheme. - DARK3, - // A recolor effect that darkens the image using the page's fourth available - // color from its color scheme. - DARK4, - // A recolor effect that darkens the image using the page's fifth available - // color from its color scheme. - DARK5, - // A recolor effect that darkens the image using the page's sixth available - // color from its color scheme. - DARK6, - // A recolor effect that darkens the image using the page's seventh - // available color from its color scheme. - DARK7, - // A recolor effect that darkens the image using the page's eighth available - // color from its color scheme. - DARK8, - // A recolor effect that darkens the image using the page's ninth available - // color from its color scheme. - DARK9, - // A recolor effect that darkens the image using the page's tenth available - // color from its color scheme. - DARK10, - // A recolor effect that recolors the image to grayscale. - GRAYSCALE, - // A recolor effect that recolors the image to negative grayscale. - NEGATIVE, - // A recolor effect that recolors the image using the sepia color. - SEPIA, - // Custom recolor effect. Refer to `recolor_stops` for the concrete - // gradient. - CUSTOM, - } - - // A recolor effect applied on an image. - export interface Recolor { - // The recolor effect is represented by a gradient, which is a list of color - // stops. - // - // The colors in the gradient will replace the corresponding colors at - // the same position in the color palette and apply to the image. This - // property is read-only. - recolor_stops: ColorStop[], - // The name of the recolor effect. - // - // The name is determined from the `recolor_stops` by matching the gradient - // against the colors in the page's current color scheme. This property is - // read-only. - name: RecolorName, - } - - //// FILE: requests.proto //// - - //// FILE: slides.proto //// - // GetPage, CreatePresentation, BatchUpdatePresentation, GetPageThumbnail are not used. - // TODO export top level methods - - //// FILE: text.proto //// - // A TextElement describes the content of a range of indices in the text content - // of a Shape or TableCell. - interface TextElement { - // The zero-based start index of this text element, in Unicode code units. - start_index: number - // The zero-based end index of this text element, exclusive, in Unicode code - // units. - end_index: number - // The kind of text that this element represents. - kind: { - // A marker representing the beginning of a new paragraph. - // - // The `start_index` and `end_index` of this TextElement represent the - // range of the paragraph. Other TextElements with an index range contained - // inside this paragraph's range are considered to be part of this - // paragraph. The range of indices of two separate paragraphs will never - // overlap. - paragraph_marker: ParagraphMarker - // A TextElement representing a run of text where all of the characters - // in the run have the same TextStyle. - // - // The `start_index` and `end_index` of TextRuns will always be fully - // contained in the index range of a single `paragraph_marker` TextElement. - // In other words, a TextRun will never span multiple paragraphs. - text_run: TextRun - // A TextElement representing a spot in the text that is dynamically - // replaced with content that can change over time. - auto_text: AutoText - } - } - - // A TextElement kind that represents the beginning of a new paragraph. - interface ParagraphMarker { - // The paragraph's style - style: ParagraphStyle - // The bullet for this paragraph. If not present, the paragraph does not - // belong to a list. - bullet: Bullet - } - - // A List describes the look and feel of bullets belonging to paragraphs - // associated with a list. A paragraph that is part of a list has an implicit - // reference to that list's ID. - interface List { - // The ID of the list. - list_id: string - // A map of nesting levels to the properties of bullets at the associated - // level. A list has at most nine levels of nesting, so the possible values - // for the keys of this map are 0 through 8, inclusive. - nesting_level: Map - } - - // Describes the bullet of a paragraph. - interface Bullet { - // The ID of the list this paragraph belongs to. - list_id: string - // The nesting level of this paragraph in the list. - nesting_level: number - // The rendered bullet glyph for this paragraph. - glyph: string - // The paragraph specific text style applied to this bullet. - bullet_style: TextStyle - } - - // Contains properties describing the look and feel of a list bullet at a given - // level of nesting. - interface NestingLevel { - // The style of a bullet at this level of nesting. - bullet_style: TextStyle - } - - // A TextElement kind that represents a run of text that all has the same - // styling. - interface TextRun { - // The text of this run. - content: string - // The styling applied to this run. - style: TextStyle - } - - // The types of auto text - enum AutoTextType { - // An unspecified autotext type. - TYPE_UNSPECIFIED, - // Type for autotext that represents the current slide number. - SLIDE_NUMBER - } - - // A TextElement kind that represents auto text. - interface AutoText { - // The type of this auto text. - type: AutoTextType - // The rendered content of this auto text, if available. - content: string, - // The styling applied to this auto text. - style: TextStyle - } - - // The types of text alignment for a paragraph. - enum ParagraphStyleAlignment { - // The paragraph alignment is inherited from the parent. - ALIGNMENT_UNSPECIFIED, - // The paragraph is aligned to the start of the line. Left-aligned for - // LTR text, right-aligned otherwise. - START, - // The paragraph is centered. - CENTER, - // The paragraph is aligned to the end of the line. Right-aligned for - // LTR text, left-aligned otherwise. - END, - // The paragraph is justified. - JUSTIFIED, - } - - // The directions text can flow in. - enum ParagraphStyleTextDirection { - // The text direction is inherited from the parent. - TEXT_DIRECTION_UNSPECIFIED, - // The text goes from left to right. - LEFT_TO_RIGHT, - // The text goes from right to left. - RIGHT_TO_LEFT, - } - - // The different modes for paragraph spacing. - enum ParagraphStyleSpacingMode { - // The spacing mode is inherited from the parent. - SPACING_MODE_UNSPECIFIED, - // Paragraph spacing is always rendered. - NEVER_COLLAPSE, - // Paragraph spacing is skipped between list elements. - COLLAPSE_LISTS, - } - - // Styles that apply to a whole paragraph. - // - // If this text is contained in a shape with a parent placeholder, then these - // paragraph styles may be inherited from the parent. Which paragraph styles - // are inherited depend on the nesting level of lists: - // - // * A paragraph not in a list will inherit its paragraph style from the - // paragraph at the 0 nesting level of the list inside the parent placeholder. - // * A paragraph in a list will inherit its paragraph style from the paragraph - // at its corresponding nesting level of the list inside the parent - // placeholder. - // - // Inherited paragraph styles are represented as unset fields in this message. - interface ParagraphStyle { - // The amount of space between lines, as a percentage of normal, where normal - // is represented as 100.0. If unset, the value is inherited from the parent. - line_spacing: number, - - // The text alignment for this paragraph. - alignment: ParagraphStyleAlignment - - // The amount indentation for the paragraph on the side that corresponds to - // the start of the text, based on the current text direction. If unset, the - // value is inherited from the parent. - indent_start: Dimension, - - // The amount indentation for the paragraph on the side that corresponds to - // the end of the text, based on the current text direction. If unset, the - // value is inherited from the parent. - indent_end: Dimension, - - // The amount of extra space above the paragraph. If unset, the value is - // inherited from the parent. - space_above: Dimension, - - // The amount of extra space below the paragraph. If unset, the value is - // inherited from the parent. - space_below: Dimension, - - // The amount of indentation for the start of the first line of the paragraph. - // If unset, the value is inherited from the parent. - indent_first_line: Dimension, - - // The text direction of this paragraph. If unset, the value defaults to - // LEFT_TO_RIGHT] since text direction is not inherited. - direction: ParagraphStyleTextDirection - - // The spacing mode for the paragraph. - spacing_mode: ParagraphStyleSpacingMode - } - - // The ways in which text can be vertically offset from its normal position. - enum TextStyleBaselineOffset { - // The text's baseline offset is inherited from the parent. - BASELINE_OFFSET_UNSPECIFIED, - // The text is not vertically offset. - NONE, - // The text is vertically offset upwards (superscript). - SUPERSCRIPT, - // The text is vertically offset downwards (subscript). - SUBSCRIPT, - } - - // Represents a font family and weight used to style a TextRun. - interface TextStyleWeightedFontFamily { - // The font family of the text. - // - // The font family can be any font from the Font menu in Slides or from - // [Google Fonts](https://fonts.google.com/). If the font name is - // unrecognized, the text is rendered in `Arial`. - font_family: string - - // The rendered weight of the text. This field can have any value that is a - // multiple of `100` between `100` and `900`, inclusive. This range - // corresponds to the numerical values described in the CSS 2.1 - // Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), - // with non-numerical values disallowed. Weights greater than or equal to - // `700` are considered bold, and weights less than `700`are not bold. The - // default value is `400` ("normal"). - weight: number - } - - // Represents the styling that can be applied to a TextRun. - // - // If this text is contained in a shape with a parent placeholder, then these text styles may be - // inherited from the parent. Which text styles are inherited depend on the - // nesting level of lists: - // - // * A text run in a paragraph that is not in a list will inherit its text style - // from the the newline character in the paragraph at the 0 nesting level of - // the list inside the parent placeholder. - // * A text run in a paragraph that is in a list will inherit its text style - // from the newline character in the paragraph at its corresponding nesting - // level of the list inside the parent placeholder. - // - // Inherited text styles are represented as unset fields in this message. If - // text is contained in a shape without a parent placeholder, unsetting these - // fields will revert the style to a value matching the defaults in the Slides - // editor. - interface TextStyle { - // The background color of the text. If set, the color is either opaque or - // transparent, depending on if the `opaque_color` field in it is set. - background_color: OptionalColor, - - // The color of the text itself. If set, the color is either opaque or - // transparent, depending on if the `opaque_color` field in it is set. - foreground_color: OptionalColor, - - // Whether or not the text is rendered as bold. - bold: boolean, - - // Whether or not the text is italicized. - italic: boolean, - - // The font family of the text. - // - // The font family can be any font from the Font menu in Slides or from - // [Google Fonts] (https://fonts.google.com/). If the font name is - // unrecognized, the text is rendered in `Arial`. - // - // Some fonts can affect the weight of the text. If an update request - // specifies values for both `font_family` and `bold`, the explicitly-set - // `bold` value is used. - font_family: string, - - // The size of the text's font. When read, the `font_size` will specified in - // points. - font_size: Dimension - - // The hyperlink destination of the text. If unset, there is no link. Links - // are not inherited from parent text. - // - // Changing the link in an update request causes some other changes to the - // text style of the range: - // - // * When setting a link, the text foreground color will be set to - // ThemeColorType.HYPERLINK and the text will - // be underlined. If these fields are modified in the same - // request, those values will be used instead of the link defaults. - // * Setting a link on a text range that overlaps with an existing link will - // also update the existing link to point to the new URL. - // * Links are not settable on newline characters. As a result, setting a link - // on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, - // will separate the newline character(s) into their own text runs. The - // link will be applied separately to the runs before and after the newline. - // * Removing a link will update the text style of the range to match the - // style of the preceding text (or the default text styles if the preceding - // text is another link) unless different styles are being set in the same - // request. - link: Link - - // The text's vertical offset from its normal position. - // - // Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically - // rendered in a smaller font size, computed based on the `font_size` field. - // The `font_size` itself is not affected by changes in this field. - baseline_offset: TextStyleBaselineOffset - - // Whether or not the text is in small capital letters. - small_caps: boolean, - - // Whether or not the text is struck through. - strikethrough: boolean, - - // Whether or not the text is underlined. - underline: boolean, - - // The font family and rendered weight of the text. - // - // This field is an extension of `font_family` meant to support explicit font - // weights without breaking backwards compatibility. As such, when reading the - // style of a range of text, the value of `weighted_font_family#font_family` - // will always be equal to that of `font_family`. However, when writing, if - // both fields are included in the field mask (either explicitly or through - // the wildcard `"*"`), their values are reconciled as follows: - // - // * If `font_family` is set and `weighted_font_family` is not, the value of - // `font_family` is applied with weight `400` ("normal"). - // * If both fields are set, the value of `font_family` must match that of - // `weighted_font_family#font_family`. If so, the font family and weight of - // `weighted_font_family` is applied. Otherwise, a 400 bad request error is - // returned. - // * If `weighted_font_family` is set and `font_family` is not, the font - // family and weight of `weighted_font_family` is applied. - // * If neither field is set, the font family and weight of the text inherit - // from the parent. Note that these properties cannot inherit separately - // from each other. - // - // If an update request specifies values for both `weighted_font_family` and - // `bold`, the `weighted_font_family` is applied first, then `bold`. - // - // If `weighted_font_family#weight` is not set, it defaults to `400`. - // - // If `weighted_font_family` is set, then `weighted_font_family#font_family` - // must also be set with a non-empty value. Otherwise, a 400 bad request error - // is returned. - weighted_font_family: TextStyleWeightedFontFamily - } - - // The kinds of relative links. - enum RelativeSlideLinkLink { - // An unspecified relative slide link. - RELATIVE_SLIDE_LINK_UNSPECIFIED, - // A link to the next slide. - NEXT_SLIDE, - // A link to the previous slide. - PREVIOUS_SLIDE, - // A link to the first slide in the presentation. - FIRST_SLIDE, - // A link to the last slide in the presentation. - LAST_SLIDE, - } - - // The kinds of links. - interface LinkKind { - // If set, indicates this is a link to the external web page at this URL. - url: string - // If set, indicates this is a link to a slide in this presentation, - // addressed by its position. - relative_link: RelativeSlideLinkLink - // If set, indicates this is a link to the specific page in this - // presentation with this ID. A page with this ID may not exist. - page_object_id: string - // If set, indicates this is a link to the slide at this zero-based index - // in the presentation. There may not be a slide at this index. - slide_index: number - } - - // A hypertext link. - interface Link { - // The kinds of links. - kind: LinkKind - } - - //// FILE: transform.proto //// - interface AffineTransform { - // The X coordinate scaling element. - scale_x: number - - // The Y coordinate scaling element. - scale_y: number - - // The X coordinate shearing element. - shear_x: number - - // The Y coordinate shearing element. - shear_y: number - - // The X coordinate translation element. - translate_x: number - - // The Y coordinate translation element. - translate_y: number - - // The units for translate elements. - unit: Unit - } - } -} diff --git a/types/google-apps-script/apis/slides_v1.d.ts b/types/google-apps-script/apis/slides_v1.d.ts new file mode 100644 index 0000000000..2999ab5c5b --- /dev/null +++ b/types/google-apps-script/apis/slides_v1.d.ts @@ -0,0 +1,1008 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Slides_v1 { + namespace Collection { + namespace Presentations { + export interface PagesCollection { + // Gets the latest version of the specified page in the presentation. + get(presentationId: string, pageObjectId: string): Slides_v1.Schema.Page; + // Generates a thumbnail of the latest version of the specified page in the + // presentation and returns a URL to the thumbnail image. + // This request counts as an [expensive read request](/slides/limits) for + // quota purposes. + getThumbnail(presentationId: string, pageObjectId: string): Slides_v1.Schema.Thumbnail; + // Generates a thumbnail of the latest version of the specified page in the + // presentation and returns a URL to the thumbnail image. + // This request counts as an [expensive read request](/slides/limits) for + // quota purposes. + getThumbnail(presentationId: string, pageObjectId: string, optionalArgs: object): Slides_v1.Schema.Thumbnail; + } + } + export interface PresentationsCollection { + Pages?: Slides_v1.Collection.Presentations.PagesCollection; + // Applies one or more updates to the presentation. + // Each request is validated before + // being applied. If any request is not valid, then the entire request will + // fail and nothing will be applied. + // Some requests have replies to + // give you some information about how they are applied. Other requests do + // not need to return information; these each return an empty reply. + // The order of replies matches that of the requests. + // For example, suppose you call batchUpdate with four updates, and only the + // third one returns information. The response would have two empty replies: + // the reply to the third request, and another empty reply, in that order. + // Because other users may be editing the presentation, the presentation + // might not exactly reflect your changes: your changes may + // be altered with respect to collaborator changes. If there are no + // collaborators, the presentation should reflect your changes. In any case, + // the updates in your request are guaranteed to be applied together + // atomically. + batchUpdate(resource: Schema.BatchUpdatePresentationRequest, presentationId: string): Slides_v1.Schema.BatchUpdatePresentationResponse; + // Creates a blank presentation using the title given in the request. If a + // `presentationId` is provided, it is used as the ID of the new presentation. + // Otherwise, a new ID is generated. Other fields in the request, including + // any provided content, are ignored. + // Returns the created presentation. + create(resource: Schema.Presentation): Slides_v1.Schema.Presentation; + // Gets the latest version of the specified presentation. + get(presentationId: string): Slides_v1.Schema.Presentation; + } + } + namespace Schema { + export interface AffineTransform { + scaleX?: Number; + scaleY?: Number; + shearX?: Number; + shearY?: Number; + translateX?: Number; + translateY?: Number; + unit?: string; + } + export interface AutoText { + content?: string; + style?: Slides_v1.Schema.TextStyle; + type?: string; + } + export interface BatchUpdatePresentationRequest { + requests?: Slides_v1.Schema.Request[]; + writeControl?: Slides_v1.Schema.WriteControl; + } + export interface BatchUpdatePresentationResponse { + presentationId?: string; + replies?: Slides_v1.Schema.Response[]; + writeControl?: Slides_v1.Schema.WriteControl; + } + export interface Bullet { + bulletStyle?: Slides_v1.Schema.TextStyle; + glyph?: string; + listId?: string; + nestingLevel?: number; + } + export interface ColorScheme { + colors?: Slides_v1.Schema.ThemeColorPair[]; + } + export interface ColorStop { + alpha?: Number; + color?: Slides_v1.Schema.OpaqueColor; + position?: Number; + } + export interface CreateImageRequest { + elementProperties?: Slides_v1.Schema.PageElementProperties; + objectId?: string; + url?: string; + } + export interface CreateImageResponse { + objectId?: string; + } + export interface CreateLineRequest { + category?: string; + elementProperties?: Slides_v1.Schema.PageElementProperties; + lineCategory?: string; + objectId?: string; + } + export interface CreateLineResponse { + objectId?: string; + } + export interface CreateParagraphBulletsRequest { + bulletPreset?: string; + cellLocation?: Slides_v1.Schema.TableCellLocation; + objectId?: string; + textRange?: Slides_v1.Schema.Range; + } + export interface CreateShapeRequest { + elementProperties?: Slides_v1.Schema.PageElementProperties; + objectId?: string; + shapeType?: string; + } + export interface CreateShapeResponse { + objectId?: string; + } + export interface CreateSheetsChartRequest { + chartId?: number; + elementProperties?: Slides_v1.Schema.PageElementProperties; + linkingMode?: string; + objectId?: string; + spreadsheetId?: string; + } + export interface CreateSheetsChartResponse { + objectId?: string; + } + export interface CreateSlideRequest { + insertionIndex?: number; + objectId?: string; + placeholderIdMappings?: Slides_v1.Schema.LayoutPlaceholderIdMapping[]; + slideLayoutReference?: Slides_v1.Schema.LayoutReference; + } + export interface CreateSlideResponse { + objectId?: string; + } + export interface CreateTableRequest { + columns?: number; + elementProperties?: Slides_v1.Schema.PageElementProperties; + objectId?: string; + rows?: number; + } + export interface CreateTableResponse { + objectId?: string; + } + export interface CreateVideoRequest { + elementProperties?: Slides_v1.Schema.PageElementProperties; + id?: string; + objectId?: string; + source?: string; + } + export interface CreateVideoResponse { + objectId?: string; + } + export interface CropProperties { + angle?: Number; + bottomOffset?: Number; + leftOffset?: Number; + rightOffset?: Number; + topOffset?: Number; + } + export interface DeleteObjectRequest { + objectId?: string; + } + export interface DeleteParagraphBulletsRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + objectId?: string; + textRange?: Slides_v1.Schema.Range; + } + export interface DeleteTableColumnRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + tableObjectId?: string; + } + export interface DeleteTableRowRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + tableObjectId?: string; + } + export interface DeleteTextRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + objectId?: string; + textRange?: Slides_v1.Schema.Range; + } + export interface Dimension { + magnitude?: Number; + unit?: string; + } + export interface DuplicateObjectRequest { + objectId?: string; + objectIds?: object; + } + export interface DuplicateObjectResponse { + objectId?: string; + } + export interface Group { + children?: Slides_v1.Schema.PageElement[]; + } + export interface GroupObjectsRequest { + childrenObjectIds?: string[]; + groupObjectId?: string; + } + export interface GroupObjectsResponse { + objectId?: string; + } + export interface Image { + contentUrl?: string; + imageProperties?: Slides_v1.Schema.ImageProperties; + sourceUrl?: string; + } + export interface ImageProperties { + brightness?: Number; + contrast?: Number; + cropProperties?: Slides_v1.Schema.CropProperties; + link?: Slides_v1.Schema.Link; + outline?: Slides_v1.Schema.Outline; + recolor?: Slides_v1.Schema.Recolor; + shadow?: Slides_v1.Schema.Shadow; + transparency?: Number; + } + export interface InsertTableColumnsRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + insertRight?: boolean; + number?: number; + tableObjectId?: string; + } + export interface InsertTableRowsRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + insertBelow?: boolean; + number?: number; + tableObjectId?: string; + } + export interface InsertTextRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + insertionIndex?: number; + objectId?: string; + text?: string; + } + export interface LayoutPlaceholderIdMapping { + layoutPlaceholder?: Slides_v1.Schema.Placeholder; + layoutPlaceholderObjectId?: string; + objectId?: string; + } + export interface LayoutProperties { + displayName?: string; + masterObjectId?: string; + name?: string; + } + export interface LayoutReference { + layoutId?: string; + predefinedLayout?: string; + } + export interface Line { + lineCategory?: string; + lineProperties?: Slides_v1.Schema.LineProperties; + lineType?: string; + } + export interface LineConnection { + connectedObjectId?: string; + connectionSiteIndex?: number; + } + export interface LineFill { + solidFill?: Slides_v1.Schema.SolidFill; + } + export interface LineProperties { + dashStyle?: string; + endArrow?: string; + endConnection?: Slides_v1.Schema.LineConnection; + lineFill?: Slides_v1.Schema.LineFill; + link?: Slides_v1.Schema.Link; + startArrow?: string; + startConnection?: Slides_v1.Schema.LineConnection; + weight?: Slides_v1.Schema.Dimension; + } + export interface Link { + pageObjectId?: string; + relativeLink?: string; + slideIndex?: number; + url?: string; + } + export interface List { + listId?: string; + nestingLevel?: object; + } + export interface MasterProperties { + displayName?: string; + } + export interface MergeTableCellsRequest { + objectId?: string; + tableRange?: Slides_v1.Schema.TableRange; + } + export interface NestingLevel { + bulletStyle?: Slides_v1.Schema.TextStyle; + } + export interface NotesProperties { + speakerNotesObjectId?: string; + } + export interface OpaqueColor { + rgbColor?: Slides_v1.Schema.RgbColor; + themeColor?: string; + } + export interface OptionalColor { + opaqueColor?: Slides_v1.Schema.OpaqueColor; + } + export interface Outline { + dashStyle?: string; + outlineFill?: Slides_v1.Schema.OutlineFill; + propertyState?: string; + weight?: Slides_v1.Schema.Dimension; + } + export interface OutlineFill { + solidFill?: Slides_v1.Schema.SolidFill; + } + export interface Page { + layoutProperties?: Slides_v1.Schema.LayoutProperties; + masterProperties?: Slides_v1.Schema.MasterProperties; + notesProperties?: Slides_v1.Schema.NotesProperties; + objectId?: string; + pageElements?: Slides_v1.Schema.PageElement[]; + pageProperties?: Slides_v1.Schema.PageProperties; + pageType?: string; + revisionId?: string; + slideProperties?: Slides_v1.Schema.SlideProperties; + } + export interface PageBackgroundFill { + propertyState?: string; + solidFill?: Slides_v1.Schema.SolidFill; + stretchedPictureFill?: Slides_v1.Schema.StretchedPictureFill; + } + export interface PageElement { + description?: string; + elementGroup?: Slides_v1.Schema.Group; + image?: Slides_v1.Schema.Image; + line?: Slides_v1.Schema.Line; + objectId?: string; + shape?: Slides_v1.Schema.Shape; + sheetsChart?: Slides_v1.Schema.SheetsChart; + size?: Slides_v1.Schema.Size; + table?: Slides_v1.Schema.Table; + title?: string; + transform?: Slides_v1.Schema.AffineTransform; + video?: Slides_v1.Schema.Video; + wordArt?: Slides_v1.Schema.WordArt; + } + export interface PageElementProperties { + pageObjectId?: string; + size?: Slides_v1.Schema.Size; + transform?: Slides_v1.Schema.AffineTransform; + } + export interface PageProperties { + colorScheme?: Slides_v1.Schema.ColorScheme; + pageBackgroundFill?: Slides_v1.Schema.PageBackgroundFill; + } + export interface ParagraphMarker { + bullet?: Slides_v1.Schema.Bullet; + style?: Slides_v1.Schema.ParagraphStyle; + } + export interface ParagraphStyle { + alignment?: string; + direction?: string; + indentEnd?: Slides_v1.Schema.Dimension; + indentFirstLine?: Slides_v1.Schema.Dimension; + indentStart?: Slides_v1.Schema.Dimension; + lineSpacing?: Number; + spaceAbove?: Slides_v1.Schema.Dimension; + spaceBelow?: Slides_v1.Schema.Dimension; + spacingMode?: string; + } + export interface Placeholder { + index?: number; + parentObjectId?: string; + type?: string; + } + export interface Presentation { + layouts?: Slides_v1.Schema.Page[]; + locale?: string; + masters?: Slides_v1.Schema.Page[]; + notesMaster?: Slides_v1.Schema.Page; + pageSize?: Slides_v1.Schema.Size; + presentationId?: string; + revisionId?: string; + slides?: Slides_v1.Schema.Page[]; + title?: string; + } + export interface Range { + endIndex?: number; + startIndex?: number; + type?: string; + } + export interface Recolor { + name?: string; + recolorStops?: Slides_v1.Schema.ColorStop[]; + } + export interface RefreshSheetsChartRequest { + objectId?: string; + } + export interface ReplaceAllShapesWithImageRequest { + containsText?: Slides_v1.Schema.SubstringMatchCriteria; + imageReplaceMethod?: string; + imageUrl?: string; + pageObjectIds?: string[]; + replaceMethod?: string; + } + export interface ReplaceAllShapesWithImageResponse { + occurrencesChanged?: number; + } + export interface ReplaceAllShapesWithSheetsChartRequest { + chartId?: number; + containsText?: Slides_v1.Schema.SubstringMatchCriteria; + linkingMode?: string; + pageObjectIds?: string[]; + spreadsheetId?: string; + } + export interface ReplaceAllShapesWithSheetsChartResponse { + occurrencesChanged?: number; + } + export interface ReplaceAllTextRequest { + containsText?: Slides_v1.Schema.SubstringMatchCriteria; + pageObjectIds?: string[]; + replaceText?: string; + } + export interface ReplaceAllTextResponse { + occurrencesChanged?: number; + } + export interface ReplaceImageRequest { + imageObjectId?: string; + imageReplaceMethod?: string; + url?: string; + } + export interface Request { + createImage?: Slides_v1.Schema.CreateImageRequest; + createLine?: Slides_v1.Schema.CreateLineRequest; + createParagraphBullets?: Slides_v1.Schema.CreateParagraphBulletsRequest; + createShape?: Slides_v1.Schema.CreateShapeRequest; + createSheetsChart?: Slides_v1.Schema.CreateSheetsChartRequest; + createSlide?: Slides_v1.Schema.CreateSlideRequest; + createTable?: Slides_v1.Schema.CreateTableRequest; + createVideo?: Slides_v1.Schema.CreateVideoRequest; + deleteObject?: Slides_v1.Schema.DeleteObjectRequest; + deleteParagraphBullets?: Slides_v1.Schema.DeleteParagraphBulletsRequest; + deleteTableColumn?: Slides_v1.Schema.DeleteTableColumnRequest; + deleteTableRow?: Slides_v1.Schema.DeleteTableRowRequest; + deleteText?: Slides_v1.Schema.DeleteTextRequest; + duplicateObject?: Slides_v1.Schema.DuplicateObjectRequest; + groupObjects?: Slides_v1.Schema.GroupObjectsRequest; + insertTableColumns?: Slides_v1.Schema.InsertTableColumnsRequest; + insertTableRows?: Slides_v1.Schema.InsertTableRowsRequest; + insertText?: Slides_v1.Schema.InsertTextRequest; + mergeTableCells?: Slides_v1.Schema.MergeTableCellsRequest; + refreshSheetsChart?: Slides_v1.Schema.RefreshSheetsChartRequest; + replaceAllShapesWithImage?: Slides_v1.Schema.ReplaceAllShapesWithImageRequest; + replaceAllShapesWithSheetsChart?: Slides_v1.Schema.ReplaceAllShapesWithSheetsChartRequest; + replaceAllText?: Slides_v1.Schema.ReplaceAllTextRequest; + replaceImage?: Slides_v1.Schema.ReplaceImageRequest; + rerouteLine?: Slides_v1.Schema.RerouteLineRequest; + ungroupObjects?: Slides_v1.Schema.UngroupObjectsRequest; + unmergeTableCells?: Slides_v1.Schema.UnmergeTableCellsRequest; + updateImageProperties?: Slides_v1.Schema.UpdateImagePropertiesRequest; + updateLineCategory?: Slides_v1.Schema.UpdateLineCategoryRequest; + updateLineProperties?: Slides_v1.Schema.UpdateLinePropertiesRequest; + updatePageElementAltText?: Slides_v1.Schema.UpdatePageElementAltTextRequest; + updatePageElementTransform?: Slides_v1.Schema.UpdatePageElementTransformRequest; + updatePageElementsZOrder?: Slides_v1.Schema.UpdatePageElementsZOrderRequest; + updatePageProperties?: Slides_v1.Schema.UpdatePagePropertiesRequest; + updateParagraphStyle?: Slides_v1.Schema.UpdateParagraphStyleRequest; + updateShapeProperties?: Slides_v1.Schema.UpdateShapePropertiesRequest; + updateSlidesPosition?: Slides_v1.Schema.UpdateSlidesPositionRequest; + updateTableBorderProperties?: Slides_v1.Schema.UpdateTableBorderPropertiesRequest; + updateTableCellProperties?: Slides_v1.Schema.UpdateTableCellPropertiesRequest; + updateTableColumnProperties?: Slides_v1.Schema.UpdateTableColumnPropertiesRequest; + updateTableRowProperties?: Slides_v1.Schema.UpdateTableRowPropertiesRequest; + updateTextStyle?: Slides_v1.Schema.UpdateTextStyleRequest; + updateVideoProperties?: Slides_v1.Schema.UpdateVideoPropertiesRequest; + } + export interface RerouteLineRequest { + objectId?: string; + } + export interface Response { + createImage?: Slides_v1.Schema.CreateImageResponse; + createLine?: Slides_v1.Schema.CreateLineResponse; + createShape?: Slides_v1.Schema.CreateShapeResponse; + createSheetsChart?: Slides_v1.Schema.CreateSheetsChartResponse; + createSlide?: Slides_v1.Schema.CreateSlideResponse; + createTable?: Slides_v1.Schema.CreateTableResponse; + createVideo?: Slides_v1.Schema.CreateVideoResponse; + duplicateObject?: Slides_v1.Schema.DuplicateObjectResponse; + groupObjects?: Slides_v1.Schema.GroupObjectsResponse; + replaceAllShapesWithImage?: Slides_v1.Schema.ReplaceAllShapesWithImageResponse; + replaceAllShapesWithSheetsChart?: Slides_v1.Schema.ReplaceAllShapesWithSheetsChartResponse; + replaceAllText?: Slides_v1.Schema.ReplaceAllTextResponse; + } + export interface RgbColor { + blue?: Number; + green?: Number; + red?: Number; + } + export interface Shadow { + alignment?: string; + alpha?: Number; + blurRadius?: Slides_v1.Schema.Dimension; + color?: Slides_v1.Schema.OpaqueColor; + propertyState?: string; + rotateWithShape?: boolean; + transform?: Slides_v1.Schema.AffineTransform; + type?: string; + } + export interface Shape { + placeholder?: Slides_v1.Schema.Placeholder; + shapeProperties?: Slides_v1.Schema.ShapeProperties; + shapeType?: string; + text?: Slides_v1.Schema.TextContent; + } + export interface ShapeBackgroundFill { + propertyState?: string; + solidFill?: Slides_v1.Schema.SolidFill; + } + export interface ShapeProperties { + contentAlignment?: string; + link?: Slides_v1.Schema.Link; + outline?: Slides_v1.Schema.Outline; + shadow?: Slides_v1.Schema.Shadow; + shapeBackgroundFill?: Slides_v1.Schema.ShapeBackgroundFill; + } + export interface SheetsChart { + chartId?: number; + contentUrl?: string; + sheetsChartProperties?: Slides_v1.Schema.SheetsChartProperties; + spreadsheetId?: string; + } + export interface SheetsChartProperties { + chartImageProperties?: Slides_v1.Schema.ImageProperties; + } + export interface Size { + height?: Slides_v1.Schema.Dimension; + width?: Slides_v1.Schema.Dimension; + } + export interface SlideProperties { + layoutObjectId?: string; + masterObjectId?: string; + notesPage?: Slides_v1.Schema.Page; + } + export interface SolidFill { + alpha?: Number; + color?: Slides_v1.Schema.OpaqueColor; + } + export interface StretchedPictureFill { + contentUrl?: string; + size?: Slides_v1.Schema.Size; + } + export interface SubstringMatchCriteria { + matchCase?: boolean; + text?: string; + } + export interface Table { + columns?: number; + horizontalBorderRows?: Slides_v1.Schema.TableBorderRow[]; + rows?: number; + tableColumns?: Slides_v1.Schema.TableColumnProperties[]; + tableRows?: Slides_v1.Schema.TableRow[]; + verticalBorderRows?: Slides_v1.Schema.TableBorderRow[]; + } + export interface TableBorderCell { + location?: Slides_v1.Schema.TableCellLocation; + tableBorderProperties?: Slides_v1.Schema.TableBorderProperties; + } + export interface TableBorderFill { + solidFill?: Slides_v1.Schema.SolidFill; + } + export interface TableBorderProperties { + dashStyle?: string; + tableBorderFill?: Slides_v1.Schema.TableBorderFill; + weight?: Slides_v1.Schema.Dimension; + } + export interface TableBorderRow { + tableBorderCells?: Slides_v1.Schema.TableBorderCell[]; + } + export interface TableCell { + columnSpan?: number; + location?: Slides_v1.Schema.TableCellLocation; + rowSpan?: number; + tableCellProperties?: Slides_v1.Schema.TableCellProperties; + text?: Slides_v1.Schema.TextContent; + } + export interface TableCellBackgroundFill { + propertyState?: string; + solidFill?: Slides_v1.Schema.SolidFill; + } + export interface TableCellLocation { + columnIndex?: number; + rowIndex?: number; + } + export interface TableCellProperties { + contentAlignment?: string; + tableCellBackgroundFill?: Slides_v1.Schema.TableCellBackgroundFill; + } + export interface TableColumnProperties { + columnWidth?: Slides_v1.Schema.Dimension; + } + export interface TableRange { + columnSpan?: number; + location?: Slides_v1.Schema.TableCellLocation; + rowSpan?: number; + } + export interface TableRow { + rowHeight?: Slides_v1.Schema.Dimension; + tableCells?: Slides_v1.Schema.TableCell[]; + tableRowProperties?: Slides_v1.Schema.TableRowProperties; + } + export interface TableRowProperties { + minRowHeight?: Slides_v1.Schema.Dimension; + } + export interface TextContent { + lists?: object; + textElements?: Slides_v1.Schema.TextElement[]; + } + export interface TextElement { + autoText?: Slides_v1.Schema.AutoText; + endIndex?: number; + paragraphMarker?: Slides_v1.Schema.ParagraphMarker; + startIndex?: number; + textRun?: Slides_v1.Schema.TextRun; + } + export interface TextRun { + content?: string; + style?: Slides_v1.Schema.TextStyle; + } + export interface TextStyle { + backgroundColor?: Slides_v1.Schema.OptionalColor; + baselineOffset?: string; + bold?: boolean; + fontFamily?: string; + fontSize?: Slides_v1.Schema.Dimension; + foregroundColor?: Slides_v1.Schema.OptionalColor; + italic?: boolean; + link?: Slides_v1.Schema.Link; + smallCaps?: boolean; + strikethrough?: boolean; + underline?: boolean; + weightedFontFamily?: Slides_v1.Schema.WeightedFontFamily; + } + export interface ThemeColorPair { + color?: Slides_v1.Schema.RgbColor; + type?: string; + } + export interface Thumbnail { + contentUrl?: string; + height?: number; + width?: number; + } + export interface UngroupObjectsRequest { + objectIds?: string[]; + } + export interface UnmergeTableCellsRequest { + objectId?: string; + tableRange?: Slides_v1.Schema.TableRange; + } + export interface UpdateImagePropertiesRequest { + fields?: string; + imageProperties?: Slides_v1.Schema.ImageProperties; + objectId?: string; + } + export interface UpdateLineCategoryRequest { + lineCategory?: string; + objectId?: string; + } + export interface UpdateLinePropertiesRequest { + fields?: string; + lineProperties?: Slides_v1.Schema.LineProperties; + objectId?: string; + } + export interface UpdatePageElementAltTextRequest { + description?: string; + objectId?: string; + title?: string; + } + export interface UpdatePageElementTransformRequest { + applyMode?: string; + objectId?: string; + transform?: Slides_v1.Schema.AffineTransform; + } + export interface UpdatePageElementsZOrderRequest { + operation?: string; + pageElementObjectIds?: string[]; + } + export interface UpdatePagePropertiesRequest { + fields?: string; + objectId?: string; + pageProperties?: Slides_v1.Schema.PageProperties; + } + export interface UpdateParagraphStyleRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + fields?: string; + objectId?: string; + style?: Slides_v1.Schema.ParagraphStyle; + textRange?: Slides_v1.Schema.Range; + } + export interface UpdateShapePropertiesRequest { + fields?: string; + objectId?: string; + shapeProperties?: Slides_v1.Schema.ShapeProperties; + } + export interface UpdateSlidesPositionRequest { + insertionIndex?: number; + slideObjectIds?: string[]; + } + export interface UpdateTableBorderPropertiesRequest { + borderPosition?: string; + fields?: string; + objectId?: string; + tableBorderProperties?: Slides_v1.Schema.TableBorderProperties; + tableRange?: Slides_v1.Schema.TableRange; + } + export interface UpdateTableCellPropertiesRequest { + fields?: string; + objectId?: string; + tableCellProperties?: Slides_v1.Schema.TableCellProperties; + tableRange?: Slides_v1.Schema.TableRange; + } + export interface UpdateTableColumnPropertiesRequest { + columnIndices?: number[]; + fields?: string; + objectId?: string; + tableColumnProperties?: Slides_v1.Schema.TableColumnProperties; + } + export interface UpdateTableRowPropertiesRequest { + fields?: string; + objectId?: string; + rowIndices?: number[]; + tableRowProperties?: Slides_v1.Schema.TableRowProperties; + } + export interface UpdateTextStyleRequest { + cellLocation?: Slides_v1.Schema.TableCellLocation; + fields?: string; + objectId?: string; + style?: Slides_v1.Schema.TextStyle; + textRange?: Slides_v1.Schema.Range; + } + export interface UpdateVideoPropertiesRequest { + fields?: string; + objectId?: string; + videoProperties?: Slides_v1.Schema.VideoProperties; + } + export interface Video { + id?: string; + source?: string; + url?: string; + videoProperties?: Slides_v1.Schema.VideoProperties; + } + export interface VideoProperties { + autoPlay?: boolean; + end?: number; + mute?: boolean; + outline?: Slides_v1.Schema.Outline; + start?: number; + } + export interface WeightedFontFamily { + fontFamily?: string; + weight?: number; + } + export interface WordArt { + renderedText?: string; + } + export interface WriteControl { + requiredRevisionId?: string; + } + } + } + export interface Slides_v1 { + Presentations?: Slides_v1.Collection.PresentationsCollection; + // Create a new instance of AffineTransform + newAffineTransform(): Slides_v1.Schema.AffineTransform; + // Create a new instance of AutoText + newAutoText(): Slides_v1.Schema.AutoText; + // Create a new instance of BatchUpdatePresentationRequest + newBatchUpdatePresentationRequest(): Slides_v1.Schema.BatchUpdatePresentationRequest; + // Create a new instance of Bullet + newBullet(): Slides_v1.Schema.Bullet; + // Create a new instance of ColorScheme + newColorScheme(): Slides_v1.Schema.ColorScheme; + // Create a new instance of ColorStop + newColorStop(): Slides_v1.Schema.ColorStop; + // Create a new instance of CreateImageRequest + newCreateImageRequest(): Slides_v1.Schema.CreateImageRequest; + // Create a new instance of CreateLineRequest + newCreateLineRequest(): Slides_v1.Schema.CreateLineRequest; + // Create a new instance of CreateParagraphBulletsRequest + newCreateParagraphBulletsRequest(): Slides_v1.Schema.CreateParagraphBulletsRequest; + // Create a new instance of CreateShapeRequest + newCreateShapeRequest(): Slides_v1.Schema.CreateShapeRequest; + // Create a new instance of CreateSheetsChartRequest + newCreateSheetsChartRequest(): Slides_v1.Schema.CreateSheetsChartRequest; + // Create a new instance of CreateSlideRequest + newCreateSlideRequest(): Slides_v1.Schema.CreateSlideRequest; + // Create a new instance of CreateTableRequest + newCreateTableRequest(): Slides_v1.Schema.CreateTableRequest; + // Create a new instance of CreateVideoRequest + newCreateVideoRequest(): Slides_v1.Schema.CreateVideoRequest; + // Create a new instance of CropProperties + newCropProperties(): Slides_v1.Schema.CropProperties; + // Create a new instance of DeleteObjectRequest + newDeleteObjectRequest(): Slides_v1.Schema.DeleteObjectRequest; + // Create a new instance of DeleteParagraphBulletsRequest + newDeleteParagraphBulletsRequest(): Slides_v1.Schema.DeleteParagraphBulletsRequest; + // Create a new instance of DeleteTableColumnRequest + newDeleteTableColumnRequest(): Slides_v1.Schema.DeleteTableColumnRequest; + // Create a new instance of DeleteTableRowRequest + newDeleteTableRowRequest(): Slides_v1.Schema.DeleteTableRowRequest; + // Create a new instance of DeleteTextRequest + newDeleteTextRequest(): Slides_v1.Schema.DeleteTextRequest; + // Create a new instance of Dimension + newDimension(): Slides_v1.Schema.Dimension; + // Create a new instance of DuplicateObjectRequest + newDuplicateObjectRequest(): Slides_v1.Schema.DuplicateObjectRequest; + // Create a new instance of Group + newGroup(): Slides_v1.Schema.Group; + // Create a new instance of GroupObjectsRequest + newGroupObjectsRequest(): Slides_v1.Schema.GroupObjectsRequest; + // Create a new instance of Image + newImage(): Slides_v1.Schema.Image; + // Create a new instance of ImageProperties + newImageProperties(): Slides_v1.Schema.ImageProperties; + // Create a new instance of InsertTableColumnsRequest + newInsertTableColumnsRequest(): Slides_v1.Schema.InsertTableColumnsRequest; + // Create a new instance of InsertTableRowsRequest + newInsertTableRowsRequest(): Slides_v1.Schema.InsertTableRowsRequest; + // Create a new instance of InsertTextRequest + newInsertTextRequest(): Slides_v1.Schema.InsertTextRequest; + // Create a new instance of LayoutPlaceholderIdMapping + newLayoutPlaceholderIdMapping(): Slides_v1.Schema.LayoutPlaceholderIdMapping; + // Create a new instance of LayoutProperties + newLayoutProperties(): Slides_v1.Schema.LayoutProperties; + // Create a new instance of LayoutReference + newLayoutReference(): Slides_v1.Schema.LayoutReference; + // Create a new instance of Line + newLine(): Slides_v1.Schema.Line; + // Create a new instance of LineConnection + newLineConnection(): Slides_v1.Schema.LineConnection; + // Create a new instance of LineFill + newLineFill(): Slides_v1.Schema.LineFill; + // Create a new instance of LineProperties + newLineProperties(): Slides_v1.Schema.LineProperties; + // Create a new instance of Link + newLink(): Slides_v1.Schema.Link; + // Create a new instance of MasterProperties + newMasterProperties(): Slides_v1.Schema.MasterProperties; + // Create a new instance of MergeTableCellsRequest + newMergeTableCellsRequest(): Slides_v1.Schema.MergeTableCellsRequest; + // Create a new instance of NotesProperties + newNotesProperties(): Slides_v1.Schema.NotesProperties; + // Create a new instance of OpaqueColor + newOpaqueColor(): Slides_v1.Schema.OpaqueColor; + // Create a new instance of OptionalColor + newOptionalColor(): Slides_v1.Schema.OptionalColor; + // Create a new instance of Outline + newOutline(): Slides_v1.Schema.Outline; + // Create a new instance of OutlineFill + newOutlineFill(): Slides_v1.Schema.OutlineFill; + // Create a new instance of Page + newPage(): Slides_v1.Schema.Page; + // Create a new instance of PageBackgroundFill + newPageBackgroundFill(): Slides_v1.Schema.PageBackgroundFill; + // Create a new instance of PageElement + newPageElement(): Slides_v1.Schema.PageElement; + // Create a new instance of PageElementProperties + newPageElementProperties(): Slides_v1.Schema.PageElementProperties; + // Create a new instance of PageProperties + newPageProperties(): Slides_v1.Schema.PageProperties; + // Create a new instance of ParagraphMarker + newParagraphMarker(): Slides_v1.Schema.ParagraphMarker; + // Create a new instance of ParagraphStyle + newParagraphStyle(): Slides_v1.Schema.ParagraphStyle; + // Create a new instance of Placeholder + newPlaceholder(): Slides_v1.Schema.Placeholder; + // Create a new instance of Presentation + newPresentation(): Slides_v1.Schema.Presentation; + // Create a new instance of Range + newRange(): Slides_v1.Schema.Range; + // Create a new instance of Recolor + newRecolor(): Slides_v1.Schema.Recolor; + // Create a new instance of RefreshSheetsChartRequest + newRefreshSheetsChartRequest(): Slides_v1.Schema.RefreshSheetsChartRequest; + // Create a new instance of ReplaceAllShapesWithImageRequest + newReplaceAllShapesWithImageRequest(): Slides_v1.Schema.ReplaceAllShapesWithImageRequest; + // Create a new instance of ReplaceAllShapesWithSheetsChartRequest + newReplaceAllShapesWithSheetsChartRequest(): Slides_v1.Schema.ReplaceAllShapesWithSheetsChartRequest; + // Create a new instance of ReplaceAllTextRequest + newReplaceAllTextRequest(): Slides_v1.Schema.ReplaceAllTextRequest; + // Create a new instance of ReplaceImageRequest + newReplaceImageRequest(): Slides_v1.Schema.ReplaceImageRequest; + // Create a new instance of Request + newRequest(): Slides_v1.Schema.Request; + // Create a new instance of RerouteLineRequest + newRerouteLineRequest(): Slides_v1.Schema.RerouteLineRequest; + // Create a new instance of RgbColor + newRgbColor(): Slides_v1.Schema.RgbColor; + // Create a new instance of Shadow + newShadow(): Slides_v1.Schema.Shadow; + // Create a new instance of Shape + newShape(): Slides_v1.Schema.Shape; + // Create a new instance of ShapeBackgroundFill + newShapeBackgroundFill(): Slides_v1.Schema.ShapeBackgroundFill; + // Create a new instance of ShapeProperties + newShapeProperties(): Slides_v1.Schema.ShapeProperties; + // Create a new instance of SheetsChart + newSheetsChart(): Slides_v1.Schema.SheetsChart; + // Create a new instance of SheetsChartProperties + newSheetsChartProperties(): Slides_v1.Schema.SheetsChartProperties; + // Create a new instance of Size + newSize(): Slides_v1.Schema.Size; + // Create a new instance of SlideProperties + newSlideProperties(): Slides_v1.Schema.SlideProperties; + // Create a new instance of SolidFill + newSolidFill(): Slides_v1.Schema.SolidFill; + // Create a new instance of StretchedPictureFill + newStretchedPictureFill(): Slides_v1.Schema.StretchedPictureFill; + // Create a new instance of SubstringMatchCriteria + newSubstringMatchCriteria(): Slides_v1.Schema.SubstringMatchCriteria; + // Create a new instance of Table + newTable(): Slides_v1.Schema.Table; + // Create a new instance of TableBorderCell + newTableBorderCell(): Slides_v1.Schema.TableBorderCell; + // Create a new instance of TableBorderFill + newTableBorderFill(): Slides_v1.Schema.TableBorderFill; + // Create a new instance of TableBorderProperties + newTableBorderProperties(): Slides_v1.Schema.TableBorderProperties; + // Create a new instance of TableBorderRow + newTableBorderRow(): Slides_v1.Schema.TableBorderRow; + // Create a new instance of TableCell + newTableCell(): Slides_v1.Schema.TableCell; + // Create a new instance of TableCellBackgroundFill + newTableCellBackgroundFill(): Slides_v1.Schema.TableCellBackgroundFill; + // Create a new instance of TableCellLocation + newTableCellLocation(): Slides_v1.Schema.TableCellLocation; + // Create a new instance of TableCellProperties + newTableCellProperties(): Slides_v1.Schema.TableCellProperties; + // Create a new instance of TableColumnProperties + newTableColumnProperties(): Slides_v1.Schema.TableColumnProperties; + // Create a new instance of TableRange + newTableRange(): Slides_v1.Schema.TableRange; + // Create a new instance of TableRow + newTableRow(): Slides_v1.Schema.TableRow; + // Create a new instance of TableRowProperties + newTableRowProperties(): Slides_v1.Schema.TableRowProperties; + // Create a new instance of TextContent + newTextContent(): Slides_v1.Schema.TextContent; + // Create a new instance of TextElement + newTextElement(): Slides_v1.Schema.TextElement; + // Create a new instance of TextRun + newTextRun(): Slides_v1.Schema.TextRun; + // Create a new instance of TextStyle + newTextStyle(): Slides_v1.Schema.TextStyle; + // Create a new instance of ThemeColorPair + newThemeColorPair(): Slides_v1.Schema.ThemeColorPair; + // Create a new instance of UngroupObjectsRequest + newUngroupObjectsRequest(): Slides_v1.Schema.UngroupObjectsRequest; + // Create a new instance of UnmergeTableCellsRequest + newUnmergeTableCellsRequest(): Slides_v1.Schema.UnmergeTableCellsRequest; + // Create a new instance of UpdateImagePropertiesRequest + newUpdateImagePropertiesRequest(): Slides_v1.Schema.UpdateImagePropertiesRequest; + // Create a new instance of UpdateLineCategoryRequest + newUpdateLineCategoryRequest(): Slides_v1.Schema.UpdateLineCategoryRequest; + // Create a new instance of UpdateLinePropertiesRequest + newUpdateLinePropertiesRequest(): Slides_v1.Schema.UpdateLinePropertiesRequest; + // Create a new instance of UpdatePageElementAltTextRequest + newUpdatePageElementAltTextRequest(): Slides_v1.Schema.UpdatePageElementAltTextRequest; + // Create a new instance of UpdatePageElementTransformRequest + newUpdatePageElementTransformRequest(): Slides_v1.Schema.UpdatePageElementTransformRequest; + // Create a new instance of UpdatePageElementsZOrderRequest + newUpdatePageElementsZOrderRequest(): Slides_v1.Schema.UpdatePageElementsZOrderRequest; + // Create a new instance of UpdatePagePropertiesRequest + newUpdatePagePropertiesRequest(): Slides_v1.Schema.UpdatePagePropertiesRequest; + // Create a new instance of UpdateParagraphStyleRequest + newUpdateParagraphStyleRequest(): Slides_v1.Schema.UpdateParagraphStyleRequest; + // Create a new instance of UpdateShapePropertiesRequest + newUpdateShapePropertiesRequest(): Slides_v1.Schema.UpdateShapePropertiesRequest; + // Create a new instance of UpdateSlidesPositionRequest + newUpdateSlidesPositionRequest(): Slides_v1.Schema.UpdateSlidesPositionRequest; + // Create a new instance of UpdateTableBorderPropertiesRequest + newUpdateTableBorderPropertiesRequest(): Slides_v1.Schema.UpdateTableBorderPropertiesRequest; + // Create a new instance of UpdateTableCellPropertiesRequest + newUpdateTableCellPropertiesRequest(): Slides_v1.Schema.UpdateTableCellPropertiesRequest; + // Create a new instance of UpdateTableColumnPropertiesRequest + newUpdateTableColumnPropertiesRequest(): Slides_v1.Schema.UpdateTableColumnPropertiesRequest; + // Create a new instance of UpdateTableRowPropertiesRequest + newUpdateTableRowPropertiesRequest(): Slides_v1.Schema.UpdateTableRowPropertiesRequest; + // Create a new instance of UpdateTextStyleRequest + newUpdateTextStyleRequest(): Slides_v1.Schema.UpdateTextStyleRequest; + // Create a new instance of UpdateVideoPropertiesRequest + newUpdateVideoPropertiesRequest(): Slides_v1.Schema.UpdateVideoPropertiesRequest; + // Create a new instance of Video + newVideo(): Slides_v1.Schema.Video; + // Create a new instance of VideoProperties + newVideoProperties(): Slides_v1.Schema.VideoProperties; + // Create a new instance of WeightedFontFamily + newWeightedFontFamily(): Slides_v1.Schema.WeightedFontFamily; + // Create a new instance of WordArt + newWordArt(): Slides_v1.Schema.WordArt; + // Create a new instance of WriteControl + newWriteControl(): Slides_v1.Schema.WriteControl; + } +} + +declare var Slides_v1: GoogleAppsScript.Slides_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/tagmanager/v1.d.ts b/types/google-apps-script/apis/tagmanager/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/tagmanager_v2.d.ts b/types/google-apps-script/apis/tagmanager_v2.d.ts new file mode 100644 index 0000000000..95bfe51acb --- /dev/null +++ b/types/google-apps-script/apis/tagmanager_v2.d.ts @@ -0,0 +1,710 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Tagmanager_v2 { + namespace Collection { + namespace Accounts { + namespace Containers { + namespace Workspaces { + export interface Built_in_variablesCollection { + // Creates one or more GTM Built-In Variables. + create(parent: string): Tagmanager_v2.Schema.CreateBuiltInVariableResponse; + // Creates one or more GTM Built-In Variables. + create(parent: string, optionalArgs: object): Tagmanager_v2.Schema.CreateBuiltInVariableResponse; + // Lists all the enabled Built-In Variables of a GTM Container. + list(parent: string): Tagmanager_v2.Schema.ListEnabledBuiltInVariablesResponse; + // Lists all the enabled Built-In Variables of a GTM Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListEnabledBuiltInVariablesResponse; + // Deletes one or more GTM Built-In Variables. + remove(path: string): void; + // Deletes one or more GTM Built-In Variables. + remove(path: string, optionalArgs: object): void; + // Reverts changes to a GTM Built-In Variables in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertBuiltInVariableResponse; + // Reverts changes to a GTM Built-In Variables in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertBuiltInVariableResponse; + } + export interface FoldersCollection { + // Creates a GTM Folder. + create(resource: Schema.Folder, parent: string): Tagmanager_v2.Schema.Folder; + // List all entities in a GTM Folder. + entities(path: string): Tagmanager_v2.Schema.FolderEntities; + // List all entities in a GTM Folder. + entities(path: string, optionalArgs: object): Tagmanager_v2.Schema.FolderEntities; + // Gets a GTM Folder. + get(path: string): Tagmanager_v2.Schema.Folder; + // Lists all GTM Folders of a Container. + list(parent: string): Tagmanager_v2.Schema.ListFoldersResponse; + // Lists all GTM Folders of a Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListFoldersResponse; + // Moves entities to a GTM Folder. + move_entities_to_folder(resource: Schema.Folder, path: string): void; + // Moves entities to a GTM Folder. + move_entities_to_folder(resource: Schema.Folder, path: string, optionalArgs: object): void; + // Deletes a GTM Folder. + remove(path: string): void; + // Reverts changes to a GTM Folder in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertFolderResponse; + // Reverts changes to a GTM Folder in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertFolderResponse; + // Updates a GTM Folder. + update(resource: Schema.Folder, path: string): Tagmanager_v2.Schema.Folder; + // Updates a GTM Folder. + update(resource: Schema.Folder, path: string, optionalArgs: object): Tagmanager_v2.Schema.Folder; + } + export interface TagsCollection { + // Creates a GTM Tag. + create(resource: Schema.Tag, parent: string): Tagmanager_v2.Schema.Tag; + // Gets a GTM Tag. + get(path: string): Tagmanager_v2.Schema.Tag; + // Lists all GTM Tags of a Container. + list(parent: string): Tagmanager_v2.Schema.ListTagsResponse; + // Lists all GTM Tags of a Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListTagsResponse; + // Deletes a GTM Tag. + remove(path: string): void; + // Reverts changes to a GTM Tag in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertTagResponse; + // Reverts changes to a GTM Tag in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertTagResponse; + // Updates a GTM Tag. + update(resource: Schema.Tag, path: string): Tagmanager_v2.Schema.Tag; + // Updates a GTM Tag. + update(resource: Schema.Tag, path: string, optionalArgs: object): Tagmanager_v2.Schema.Tag; + } + export interface TriggersCollection { + // Creates a GTM Trigger. + create(resource: Schema.Trigger, parent: string): Tagmanager_v2.Schema.Trigger; + // Gets a GTM Trigger. + get(path: string): Tagmanager_v2.Schema.Trigger; + // Lists all GTM Triggers of a Container. + list(parent: string): Tagmanager_v2.Schema.ListTriggersResponse; + // Lists all GTM Triggers of a Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListTriggersResponse; + // Deletes a GTM Trigger. + remove(path: string): void; + // Reverts changes to a GTM Trigger in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertTriggerResponse; + // Reverts changes to a GTM Trigger in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertTriggerResponse; + // Updates a GTM Trigger. + update(resource: Schema.Trigger, path: string): Tagmanager_v2.Schema.Trigger; + // Updates a GTM Trigger. + update(resource: Schema.Trigger, path: string, optionalArgs: object): Tagmanager_v2.Schema.Trigger; + } + export interface VariablesCollection { + // Creates a GTM Variable. + create(resource: Schema.Variable, parent: string): Tagmanager_v2.Schema.Variable; + // Gets a GTM Variable. + get(path: string): Tagmanager_v2.Schema.Variable; + // Lists all GTM Variables of a Container. + list(parent: string): Tagmanager_v2.Schema.ListVariablesResponse; + // Lists all GTM Variables of a Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListVariablesResponse; + // Deletes a GTM Variable. + remove(path: string): void; + // Reverts changes to a GTM Variable in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertVariableResponse; + // Reverts changes to a GTM Variable in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertVariableResponse; + // Updates a GTM Variable. + update(resource: Schema.Variable, path: string): Tagmanager_v2.Schema.Variable; + // Updates a GTM Variable. + update(resource: Schema.Variable, path: string, optionalArgs: object): Tagmanager_v2.Schema.Variable; + } + export interface ZonesCollection { + // Creates a GTM Zone. + create(resource: Schema.Zone, parent: string): Tagmanager_v2.Schema.Zone; + // Gets a GTM Zone. + get(path: string): Tagmanager_v2.Schema.Zone; + // Lists all GTM Zones of a GTM container workspace. + list(parent: string): Tagmanager_v2.Schema.ListZonesResponse; + // Lists all GTM Zones of a GTM container workspace. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListZonesResponse; + // Deletes a GTM Zone. + remove(path: string): void; + // Reverts changes to a GTM Zone in a GTM Workspace. + revert(path: string): Tagmanager_v2.Schema.RevertZoneResponse; + // Reverts changes to a GTM Zone in a GTM Workspace. + revert(path: string, optionalArgs: object): Tagmanager_v2.Schema.RevertZoneResponse; + // Updates a GTM Zone. + update(resource: Schema.Zone, path: string): Tagmanager_v2.Schema.Zone; + // Updates a GTM Zone. + update(resource: Schema.Zone, path: string, optionalArgs: object): Tagmanager_v2.Schema.Zone; + } + } + export interface EnvironmentsCollection { + // Creates a GTM Environment. + create(resource: Schema.Environment, parent: string): Tagmanager_v2.Schema.Environment; + // Gets a GTM Environment. + get(path: string): Tagmanager_v2.Schema.Environment; + // Lists all GTM Environments of a GTM Container. + list(parent: string): Tagmanager_v2.Schema.ListEnvironmentsResponse; + // Lists all GTM Environments of a GTM Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListEnvironmentsResponse; + // Re-generates the authorization code for a GTM Environment. + reauthorize(resource: Schema.Environment, path: string): Tagmanager_v2.Schema.Environment; + // Deletes a GTM Environment. + remove(path: string): void; + // Updates a GTM Environment. + update(resource: Schema.Environment, path: string): Tagmanager_v2.Schema.Environment; + // Updates a GTM Environment. + update(resource: Schema.Environment, path: string, optionalArgs: object): Tagmanager_v2.Schema.Environment; + } + export interface Version_headersCollection { + // Gets the latest container version header + latest(parent: string): Tagmanager_v2.Schema.ContainerVersionHeader; + // Lists all Container Versions of a GTM Container. + list(parent: string): Tagmanager_v2.Schema.ListContainerVersionsResponse; + // Lists all Container Versions of a GTM Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListContainerVersionsResponse; + } + export interface VersionsCollection { + // Gets a Container Version. + get(path: string): Tagmanager_v2.Schema.ContainerVersion; + // Gets a Container Version. + get(path: string, optionalArgs: object): Tagmanager_v2.Schema.ContainerVersion; + // Gets the live (i.e. published) container version + live(parent: string): Tagmanager_v2.Schema.ContainerVersion; + // Publishes a Container Version. + publish(path: string): Tagmanager_v2.Schema.PublishContainerVersionResponse; + // Publishes a Container Version. + publish(path: string, optionalArgs: object): Tagmanager_v2.Schema.PublishContainerVersionResponse; + // Deletes a Container Version. + remove(path: string): void; + // Sets the latest version used for synchronization of workspaces when detecting conflicts and errors. + set_latest(path: string): Tagmanager_v2.Schema.ContainerVersion; + // Undeletes a Container Version. + undelete(path: string): Tagmanager_v2.Schema.ContainerVersion; + // Updates a Container Version. + update(resource: Schema.ContainerVersion, path: string): Tagmanager_v2.Schema.ContainerVersion; + // Updates a Container Version. + update(resource: Schema.ContainerVersion, path: string, optionalArgs: object): Tagmanager_v2.Schema.ContainerVersion; + } + export interface WorkspacesCollection { + Built_in_variables?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.Built_in_variablesCollection; + Folders?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.FoldersCollection; + Tags?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.TagsCollection; + Triggers?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.TriggersCollection; + Variables?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.VariablesCollection; + Zones?: Tagmanager_v2.Collection.Accounts.Containers.Workspaces.ZonesCollection; + // Creates a Workspace. + create(resource: Schema.Workspace, parent: string): Tagmanager_v2.Schema.Workspace; + // Creates a Container Version from the entities present in the workspace, deletes the workspace, and sets the base container version to the newly created version. + create_version(resource: Schema.CreateContainerVersionRequestVersionOptions, path: string): Tagmanager_v2.Schema.CreateContainerVersionResponse; + // Gets a Workspace. + get(path: string): Tagmanager_v2.Schema.Workspace; + // Finds conflicting and modified entities in the workspace. + getStatus(path: string): Tagmanager_v2.Schema.GetWorkspaceStatusResponse; + // Lists all Workspaces that belong to a GTM Container. + list(parent: string): Tagmanager_v2.Schema.ListWorkspacesResponse; + // Lists all Workspaces that belong to a GTM Container. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListWorkspacesResponse; + // Quick previews a workspace by creating a fake container version from all entities in the provided workspace. + quick_preview(path: string): Tagmanager_v2.Schema.QuickPreviewResponse; + // Deletes a Workspace. + remove(path: string): void; + // Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. + resolve_conflict(resource: Schema.Entity, path: string): void; + // Resolves a merge conflict for a workspace entity by updating it to the resolved entity passed in the request. + resolve_conflict(resource: Schema.Entity, path: string, optionalArgs: object): void; + // Syncs a workspace to the latest container version by updating all unmodified workspace entities and displaying conflicts for modified entities. + sync(path: string): Tagmanager_v2.Schema.SyncWorkspaceResponse; + // Updates a Workspace. + update(resource: Schema.Workspace, path: string): Tagmanager_v2.Schema.Workspace; + // Updates a Workspace. + update(resource: Schema.Workspace, path: string, optionalArgs: object): Tagmanager_v2.Schema.Workspace; + } + } + export interface ContainersCollection { + Environments?: Tagmanager_v2.Collection.Accounts.Containers.EnvironmentsCollection; + Version_headers?: Tagmanager_v2.Collection.Accounts.Containers.Version_headersCollection; + Versions?: Tagmanager_v2.Collection.Accounts.Containers.VersionsCollection; + Workspaces?: Tagmanager_v2.Collection.Accounts.Containers.WorkspacesCollection; + // Creates a Container. + create(resource: Schema.Container, parent: string): Tagmanager_v2.Schema.Container; + // Gets a Container. + get(path: string): Tagmanager_v2.Schema.Container; + // Lists all Containers that belongs to a GTM Account. + list(parent: string): Tagmanager_v2.Schema.ListContainersResponse; + // Lists all Containers that belongs to a GTM Account. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListContainersResponse; + // Deletes a Container. + remove(path: string): void; + // Updates a Container. + update(resource: Schema.Container, path: string): Tagmanager_v2.Schema.Container; + // Updates a Container. + update(resource: Schema.Container, path: string, optionalArgs: object): Tagmanager_v2.Schema.Container; + } + export interface User_permissionsCollection { + // Creates a user's Account & Container access. + create(resource: Schema.UserPermission, parent: string): Tagmanager_v2.Schema.UserPermission; + // Gets a user's Account & Container access. + get(path: string): Tagmanager_v2.Schema.UserPermission; + // List all users that have access to the account along with Account and Container user access granted to each of them. + list(parent: string): Tagmanager_v2.Schema.ListUserPermissionsResponse; + // List all users that have access to the account along with Account and Container user access granted to each of them. + list(parent: string, optionalArgs: object): Tagmanager_v2.Schema.ListUserPermissionsResponse; + // Removes a user from the account, revoking access to it and all of its containers. + remove(path: string): void; + // Updates a user's Account & Container access. + update(resource: Schema.UserPermission, path: string): Tagmanager_v2.Schema.UserPermission; + } + } + export interface AccountsCollection { + Containers?: Tagmanager_v2.Collection.Accounts.ContainersCollection; + User_permissions?: Tagmanager_v2.Collection.Accounts.User_permissionsCollection; + // Gets a GTM Account. + get(path: string): Tagmanager_v2.Schema.Account; + // Lists all GTM Accounts that a user has access to. + list(): Tagmanager_v2.Schema.ListAccountsResponse; + // Lists all GTM Accounts that a user has access to. + list(optionalArgs: object): Tagmanager_v2.Schema.ListAccountsResponse; + // Updates a GTM Account. + update(resource: Schema.Account, path: string): Tagmanager_v2.Schema.Account; + // Updates a GTM Account. + update(resource: Schema.Account, path: string, optionalArgs: object): Tagmanager_v2.Schema.Account; + } + } + namespace Schema { + export interface Account { + accountId?: string; + fingerprint?: string; + name?: string; + path?: string; + shareData?: boolean; + tagManagerUrl?: string; + } + export interface AccountAccess { + permission?: string; + } + export interface BuiltInVariable { + accountId?: string; + containerId?: string; + name?: string; + path?: string; + type?: string; + workspaceId?: string; + } + export interface Condition { + parameter?: Tagmanager_v2.Schema.Parameter[]; + type?: string; + } + export interface Container { + accountId?: string; + containerId?: string; + domainName?: string[]; + fingerprint?: string; + name?: string; + notes?: string; + path?: string; + publicId?: string; + tagManagerUrl?: string; + usageContext?: string[]; + } + export interface ContainerAccess { + containerId?: string; + permission?: string; + } + export interface ContainerVersion { + accountId?: string; + builtInVariable?: Tagmanager_v2.Schema.BuiltInVariable[]; + container?: Tagmanager_v2.Schema.Container; + containerId?: string; + containerVersionId?: string; + customTemplate?: Tagmanager_v2.Schema.CustomTemplate[]; + deleted?: boolean; + description?: string; + fingerprint?: string; + folder?: Tagmanager_v2.Schema.Folder[]; + name?: string; + path?: string; + tag?: Tagmanager_v2.Schema.Tag[]; + tagManagerUrl?: string; + trigger?: Tagmanager_v2.Schema.Trigger[]; + variable?: Tagmanager_v2.Schema.Variable[]; + zone?: Tagmanager_v2.Schema.Zone[]; + } + export interface ContainerVersionHeader { + accountId?: string; + containerId?: string; + containerVersionId?: string; + deleted?: boolean; + name?: string; + numCustomTemplates?: string; + numMacros?: string; + numRules?: string; + numTags?: string; + numTriggers?: string; + numVariables?: string; + numZones?: string; + path?: string; + } + export interface CreateBuiltInVariableResponse { + builtInVariable?: Tagmanager_v2.Schema.BuiltInVariable[]; + } + export interface CreateContainerVersionRequestVersionOptions { + name?: string; + notes?: string; + } + export interface CreateContainerVersionResponse { + compilerError?: boolean; + containerVersion?: Tagmanager_v2.Schema.ContainerVersion; + newWorkspacePath?: string; + syncStatus?: Tagmanager_v2.Schema.SyncStatus; + } + export interface CustomTemplate { + accountId?: string; + containerId?: string; + fingerprint?: string; + name?: string; + path?: string; + tagManagerUrl?: string; + templateData?: string; + templateId?: string; + workspaceId?: string; + } + export interface Entity { + changeStatus?: string; + folder?: Tagmanager_v2.Schema.Folder; + tag?: Tagmanager_v2.Schema.Tag; + trigger?: Tagmanager_v2.Schema.Trigger; + variable?: Tagmanager_v2.Schema.Variable; + } + export interface Environment { + accountId?: string; + authorizationCode?: string; + authorizationTimestamp?: Tagmanager_v2.Schema.Timestamp; + containerId?: string; + containerVersionId?: string; + description?: string; + enableDebug?: boolean; + environmentId?: string; + fingerprint?: string; + name?: string; + path?: string; + tagManagerUrl?: string; + type?: string; + url?: string; + workspaceId?: string; + } + export interface Folder { + accountId?: string; + containerId?: string; + fingerprint?: string; + folderId?: string; + name?: string; + notes?: string; + path?: string; + tagManagerUrl?: string; + workspaceId?: string; + } + export interface FolderEntities { + nextPageToken?: string; + tag?: Tagmanager_v2.Schema.Tag[]; + trigger?: Tagmanager_v2.Schema.Trigger[]; + variable?: Tagmanager_v2.Schema.Variable[]; + } + export interface GetWorkspaceStatusResponse { + mergeConflict?: Tagmanager_v2.Schema.MergeConflict[]; + workspaceChange?: Tagmanager_v2.Schema.Entity[]; + } + export interface ListAccountsResponse { + account?: Tagmanager_v2.Schema.Account[]; + nextPageToken?: string; + } + export interface ListContainerVersionsResponse { + containerVersionHeader?: Tagmanager_v2.Schema.ContainerVersionHeader[]; + nextPageToken?: string; + } + export interface ListContainersResponse { + container?: Tagmanager_v2.Schema.Container[]; + nextPageToken?: string; + } + export interface ListEnabledBuiltInVariablesResponse { + builtInVariable?: Tagmanager_v2.Schema.BuiltInVariable[]; + nextPageToken?: string; + } + export interface ListEnvironmentsResponse { + environment?: Tagmanager_v2.Schema.Environment[]; + nextPageToken?: string; + } + export interface ListFoldersResponse { + folder?: Tagmanager_v2.Schema.Folder[]; + nextPageToken?: string; + } + export interface ListTagsResponse { + nextPageToken?: string; + tag?: Tagmanager_v2.Schema.Tag[]; + } + export interface ListTriggersResponse { + nextPageToken?: string; + trigger?: Tagmanager_v2.Schema.Trigger[]; + } + export interface ListUserPermissionsResponse { + nextPageToken?: string; + userPermission?: Tagmanager_v2.Schema.UserPermission[]; + } + export interface ListVariablesResponse { + nextPageToken?: string; + variable?: Tagmanager_v2.Schema.Variable[]; + } + export interface ListWorkspacesResponse { + nextPageToken?: string; + workspace?: Tagmanager_v2.Schema.Workspace[]; + } + export interface ListZonesResponse { + nextPageToken?: string; + zone?: Tagmanager_v2.Schema.Zone[]; + } + export interface MergeConflict { + entityInBaseVersion?: Tagmanager_v2.Schema.Entity; + entityInWorkspace?: Tagmanager_v2.Schema.Entity; + } + export interface Parameter { + key?: string; + list?: Tagmanager_v2.Schema.Parameter[]; + map?: Tagmanager_v2.Schema.Parameter[]; + type?: string; + value?: string; + } + export interface PublishContainerVersionResponse { + compilerError?: boolean; + containerVersion?: Tagmanager_v2.Schema.ContainerVersion; + } + export interface QuickPreviewResponse { + compilerError?: boolean; + containerVersion?: Tagmanager_v2.Schema.ContainerVersion; + syncStatus?: Tagmanager_v2.Schema.SyncStatus; + } + export interface RevertBuiltInVariableResponse { + enabled?: boolean; + } + export interface RevertFolderResponse { + folder?: Tagmanager_v2.Schema.Folder; + } + export interface RevertTagResponse { + tag?: Tagmanager_v2.Schema.Tag; + } + export interface RevertTriggerResponse { + trigger?: Tagmanager_v2.Schema.Trigger; + } + export interface RevertVariableResponse { + variable?: Tagmanager_v2.Schema.Variable; + } + export interface RevertZoneResponse { + zone?: Tagmanager_v2.Schema.Zone; + } + export interface SetupTag { + stopOnSetupFailure?: boolean; + tagName?: string; + } + export interface SyncStatus { + mergeConflict?: boolean; + syncError?: boolean; + } + export interface SyncWorkspaceResponse { + mergeConflict?: Tagmanager_v2.Schema.MergeConflict[]; + syncStatus?: Tagmanager_v2.Schema.SyncStatus; + } + export interface Tag { + accountId?: string; + blockingRuleId?: string[]; + blockingTriggerId?: string[]; + containerId?: string; + fingerprint?: string; + firingRuleId?: string[]; + firingTriggerId?: string[]; + liveOnly?: boolean; + name?: string; + notes?: string; + parameter?: Tagmanager_v2.Schema.Parameter[]; + parentFolderId?: string; + path?: string; + paused?: boolean; + priority?: Tagmanager_v2.Schema.Parameter; + scheduleEndMs?: string; + scheduleStartMs?: string; + setupTag?: Tagmanager_v2.Schema.SetupTag[]; + tagFiringOption?: string; + tagId?: string; + tagManagerUrl?: string; + teardownTag?: Tagmanager_v2.Schema.TeardownTag[]; + type?: string; + workspaceId?: string; + } + export interface TeardownTag { + stopTeardownOnFailure?: boolean; + tagName?: string; + } + export interface Timestamp { + nanos?: number; + seconds?: string; + } + export interface Trigger { + accountId?: string; + autoEventFilter?: Tagmanager_v2.Schema.Condition[]; + checkValidation?: Tagmanager_v2.Schema.Parameter; + containerId?: string; + continuousTimeMinMilliseconds?: Tagmanager_v2.Schema.Parameter; + customEventFilter?: Tagmanager_v2.Schema.Condition[]; + eventName?: Tagmanager_v2.Schema.Parameter; + filter?: Tagmanager_v2.Schema.Condition[]; + fingerprint?: string; + horizontalScrollPercentageList?: Tagmanager_v2.Schema.Parameter; + interval?: Tagmanager_v2.Schema.Parameter; + intervalSeconds?: Tagmanager_v2.Schema.Parameter; + limit?: Tagmanager_v2.Schema.Parameter; + maxTimerLengthSeconds?: Tagmanager_v2.Schema.Parameter; + name?: string; + notes?: string; + parameter?: Tagmanager_v2.Schema.Parameter[]; + parentFolderId?: string; + path?: string; + selector?: Tagmanager_v2.Schema.Parameter; + tagManagerUrl?: string; + totalTimeMinMilliseconds?: Tagmanager_v2.Schema.Parameter; + triggerId?: string; + type?: string; + uniqueTriggerId?: Tagmanager_v2.Schema.Parameter; + verticalScrollPercentageList?: Tagmanager_v2.Schema.Parameter; + visibilitySelector?: Tagmanager_v2.Schema.Parameter; + visiblePercentageMax?: Tagmanager_v2.Schema.Parameter; + visiblePercentageMin?: Tagmanager_v2.Schema.Parameter; + waitForTags?: Tagmanager_v2.Schema.Parameter; + waitForTagsTimeout?: Tagmanager_v2.Schema.Parameter; + workspaceId?: string; + } + export interface UserPermission { + accountAccess?: Tagmanager_v2.Schema.AccountAccess; + accountId?: string; + containerAccess?: Tagmanager_v2.Schema.ContainerAccess[]; + emailAddress?: string; + path?: string; + } + export interface Variable { + accountId?: string; + containerId?: string; + disablingTriggerId?: string[]; + enablingTriggerId?: string[]; + fingerprint?: string; + formatValue?: Tagmanager_v2.Schema.VariableFormatValue; + name?: string; + notes?: string; + parameter?: Tagmanager_v2.Schema.Parameter[]; + parentFolderId?: string; + path?: string; + scheduleEndMs?: string; + scheduleStartMs?: string; + tagManagerUrl?: string; + type?: string; + variableId?: string; + workspaceId?: string; + } + export interface VariableFormatValue { + caseConversionType?: string; + convertFalseToValue?: Tagmanager_v2.Schema.Parameter; + convertNullToValue?: Tagmanager_v2.Schema.Parameter; + convertTrueToValue?: Tagmanager_v2.Schema.Parameter; + convertUndefinedToValue?: Tagmanager_v2.Schema.Parameter; + } + export interface Workspace { + accountId?: string; + containerId?: string; + description?: string; + fingerprint?: string; + name?: string; + path?: string; + tagManagerUrl?: string; + workspaceId?: string; + } + export interface Zone { + accountId?: string; + boundary?: Tagmanager_v2.Schema.ZoneBoundary; + childContainer?: Tagmanager_v2.Schema.ZoneChildContainer[]; + containerId?: string; + fingerprint?: string; + name?: string; + notes?: string; + path?: string; + tagManagerUrl?: string; + typeRestriction?: Tagmanager_v2.Schema.ZoneTypeRestriction; + workspaceId?: string; + zoneId?: string; + } + export interface ZoneBoundary { + condition?: Tagmanager_v2.Schema.Condition[]; + customEvaluationTriggerId?: string[]; + } + export interface ZoneChildContainer { + nickname?: string; + publicId?: string; + } + export interface ZoneTypeRestriction { + enable?: boolean; + whitelistedTypeId?: string[]; + } + } + } + export interface Tagmanager_v2 { + Accounts?: Tagmanager_v2.Collection.AccountsCollection; + // Create a new instance of Account + newAccount(): Tagmanager_v2.Schema.Account; + // Create a new instance of AccountAccess + newAccountAccess(): Tagmanager_v2.Schema.AccountAccess; + // Create a new instance of BuiltInVariable + newBuiltInVariable(): Tagmanager_v2.Schema.BuiltInVariable; + // Create a new instance of Condition + newCondition(): Tagmanager_v2.Schema.Condition; + // Create a new instance of Container + newContainer(): Tagmanager_v2.Schema.Container; + // Create a new instance of ContainerAccess + newContainerAccess(): Tagmanager_v2.Schema.ContainerAccess; + // Create a new instance of ContainerVersion + newContainerVersion(): Tagmanager_v2.Schema.ContainerVersion; + // Create a new instance of CreateContainerVersionRequestVersionOptions + newCreateContainerVersionRequestVersionOptions(): Tagmanager_v2.Schema.CreateContainerVersionRequestVersionOptions; + // Create a new instance of CustomTemplate + newCustomTemplate(): Tagmanager_v2.Schema.CustomTemplate; + // Create a new instance of Entity + newEntity(): Tagmanager_v2.Schema.Entity; + // Create a new instance of Environment + newEnvironment(): Tagmanager_v2.Schema.Environment; + // Create a new instance of Folder + newFolder(): Tagmanager_v2.Schema.Folder; + // Create a new instance of Parameter + newParameter(): Tagmanager_v2.Schema.Parameter; + // Create a new instance of SetupTag + newSetupTag(): Tagmanager_v2.Schema.SetupTag; + // Create a new instance of Tag + newTag(): Tagmanager_v2.Schema.Tag; + // Create a new instance of TeardownTag + newTeardownTag(): Tagmanager_v2.Schema.TeardownTag; + // Create a new instance of Timestamp + newTimestamp(): Tagmanager_v2.Schema.Timestamp; + // Create a new instance of Trigger + newTrigger(): Tagmanager_v2.Schema.Trigger; + // Create a new instance of UserPermission + newUserPermission(): Tagmanager_v2.Schema.UserPermission; + // Create a new instance of Variable + newVariable(): Tagmanager_v2.Schema.Variable; + // Create a new instance of VariableFormatValue + newVariableFormatValue(): Tagmanager_v2.Schema.VariableFormatValue; + // Create a new instance of Workspace + newWorkspace(): Tagmanager_v2.Schema.Workspace; + // Create a new instance of Zone + newZone(): Tagmanager_v2.Schema.Zone; + // Create a new instance of ZoneBoundary + newZoneBoundary(): Tagmanager_v2.Schema.ZoneBoundary; + // Create a new instance of ZoneChildContainer + newZoneChildContainer(): Tagmanager_v2.Schema.ZoneChildContainer; + // Create a new instance of ZoneTypeRestriction + newZoneTypeRestriction(): Tagmanager_v2.Schema.ZoneTypeRestriction; + } +} + +declare var Tagmanager_v2: GoogleAppsScript.Tagmanager_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/tasks/v1.d.ts b/types/google-apps-script/apis/tasks/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/tasks_v1.d.ts b/types/google-apps-script/apis/tasks_v1.d.ts new file mode 100644 index 0000000000..399a65bfeb --- /dev/null +++ b/types/google-apps-script/apis/tasks_v1.d.ts @@ -0,0 +1,108 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Tasks_v1 { + namespace Collection { + export interface TasklistsCollection { + // Returns the authenticated user's specified task list. + get(tasklist: string): Tasks_v1.Schema.TaskList; + // Creates a new task list and adds it to the authenticated user's task lists. + insert(resource: Schema.TaskList): Tasks_v1.Schema.TaskList; + // Returns all the authenticated user's task lists. + list(): Tasks_v1.Schema.TaskLists; + // Returns all the authenticated user's task lists. + list(optionalArgs: object): Tasks_v1.Schema.TaskLists; + // Updates the authenticated user's specified task list. This method supports patch semantics. + patch(resource: Schema.TaskList, tasklist: string): Tasks_v1.Schema.TaskList; + // Deletes the authenticated user's specified task list. + remove(tasklist: string): void; + // Updates the authenticated user's specified task list. + update(resource: Schema.TaskList, tasklist: string): Tasks_v1.Schema.TaskList; + } + export interface TasksCollection { + // Clears all completed tasks from the specified task list. The affected tasks will be marked as 'hidden' and no longer be returned by default when retrieving all tasks for a task list. + clear(tasklist: string): void; + // Returns the specified task. + get(tasklist: string, task: string): Tasks_v1.Schema.Task; + // Creates a new task on the specified task list. + insert(resource: Schema.Task, tasklist: string): Tasks_v1.Schema.Task; + // Creates a new task on the specified task list. + insert(resource: Schema.Task, tasklist: string, optionalArgs: object): Tasks_v1.Schema.Task; + // Returns all tasks in the specified task list. + list(tasklist: string): Tasks_v1.Schema.Tasks; + // Returns all tasks in the specified task list. + list(tasklist: string, optionalArgs: object): Tasks_v1.Schema.Tasks; + // Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. + move(tasklist: string, task: string): Tasks_v1.Schema.Task; + // Moves the specified task to another position in the task list. This can include putting it as a child task under a new parent and/or move it to a different position among its sibling tasks. + move(tasklist: string, task: string, optionalArgs: object): Tasks_v1.Schema.Task; + // Updates the specified task. This method supports patch semantics. + patch(resource: Schema.Task, tasklist: string, task: string): Tasks_v1.Schema.Task; + // Deletes the specified task from the task list. + remove(tasklist: string, task: string): void; + // Updates the specified task. + update(resource: Schema.Task, tasklist: string, task: string): Tasks_v1.Schema.Task; + } + } + namespace Schema { + export interface Task { + completed?: string; + deleted?: boolean; + due?: string; + etag?: string; + hidden?: boolean; + id?: string; + kind?: string; + links?: Tasks_v1.Schema.TaskLinks[]; + notes?: string; + parent?: string; + position?: string; + selfLink?: string; + status?: string; + title?: string; + updated?: string; + } + export interface TaskLinks { + description?: string; + link?: string; + type?: string; + } + export interface TaskList { + etag?: string; + id?: string; + kind?: string; + selfLink?: string; + title?: string; + updated?: string; + } + export interface TaskLists { + etag?: string; + items?: Tasks_v1.Schema.TaskList[]; + kind?: string; + nextPageToken?: string; + } + export interface Tasks { + etag?: string; + items?: Tasks_v1.Schema.Task[]; + kind?: string; + nextPageToken?: string; + } + } + } + export interface Tasks_v1 { + Tasklists?: Tasks_v1.Collection.TasklistsCollection; + Tasks?: Tasks_v1.Collection.TasksCollection; + // Create a new instance of Task + newTask(): Tasks_v1.Schema.Task; + // Create a new instance of TaskLinks + newTaskLinks(): Tasks_v1.Schema.TaskLinks; + // Create a new instance of TaskList + newTaskList(): Tasks_v1.Schema.TaskList; + } +} + +declare var Tasks_v1: GoogleAppsScript.Tasks_v1; diff --git a/types/google-apps-script/apis/urlshortener/v1.d.ts b/types/google-apps-script/apis/urlshortener/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/urlshortener_v1.d.ts b/types/google-apps-script/apis/urlshortener_v1.d.ts new file mode 100644 index 0000000000..40d000daed --- /dev/null +++ b/types/google-apps-script/apis/urlshortener_v1.d.ts @@ -0,0 +1,73 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Urlshortener_v1 { + namespace Collection { + export interface UrlCollection { + // Expands a short URL or gets creation time and analytics. + get(shortUrl: string): Urlshortener_v1.Schema.Url; + // Expands a short URL or gets creation time and analytics. + get(shortUrl: string, optionalArgs: object): Urlshortener_v1.Schema.Url; + // Creates a new short URL. + insert(resource: Schema.Url): Urlshortener_v1.Schema.Url; + // Retrieves a list of URLs shortened by a user. + list(): Urlshortener_v1.Schema.UrlHistory; + // Retrieves a list of URLs shortened by a user. + list(optionalArgs: object): Urlshortener_v1.Schema.UrlHistory; + } + } + namespace Schema { + export interface AnalyticsSnapshot { + browsers?: Urlshortener_v1.Schema.StringCount[]; + countries?: Urlshortener_v1.Schema.StringCount[]; + longUrlClicks?: string; + platforms?: Urlshortener_v1.Schema.StringCount[]; + referrers?: Urlshortener_v1.Schema.StringCount[]; + shortUrlClicks?: string; + } + export interface AnalyticsSummary { + allTime?: Urlshortener_v1.Schema.AnalyticsSnapshot; + day?: Urlshortener_v1.Schema.AnalyticsSnapshot; + month?: Urlshortener_v1.Schema.AnalyticsSnapshot; + twoHours?: Urlshortener_v1.Schema.AnalyticsSnapshot; + week?: Urlshortener_v1.Schema.AnalyticsSnapshot; + } + export interface StringCount { + count?: string; + id?: string; + } + export interface Url { + analytics?: Urlshortener_v1.Schema.AnalyticsSummary; + created?: string; + id?: string; + kind?: string; + longUrl?: string; + status?: string; + } + export interface UrlHistory { + items?: Urlshortener_v1.Schema.Url[]; + itemsPerPage?: number; + kind?: string; + nextPageToken?: string; + totalItems?: number; + } + } + } + export interface Urlshortener_v1 { + Url?: Urlshortener_v1.Collection.UrlCollection; + // Create a new instance of AnalyticsSnapshot + newAnalyticsSnapshot(): Urlshortener_v1.Schema.AnalyticsSnapshot; + // Create a new instance of AnalyticsSummary + newAnalyticsSummary(): Urlshortener_v1.Schema.AnalyticsSummary; + // Create a new instance of StringCount + newStringCount(): Urlshortener_v1.Schema.StringCount; + // Create a new instance of Url + newUrl(): Urlshortener_v1.Schema.Url; + } +} + +declare var Urlshortener_v1: GoogleAppsScript.Urlshortener_v1; \ No newline at end of file diff --git a/types/google-apps-script/apis/youtube/v3.d.ts b/types/google-apps-script/apis/youtube/v3.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/youtubeAnalytics/v1.d.ts b/types/google-apps-script/apis/youtubeAnalytics/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/youtubePartner/v1.d.ts b/types/google-apps-script/apis/youtubePartner/v1.d.ts deleted file mode 100644 index e69de29bb2..0000000000 diff --git a/types/google-apps-script/apis/youtube_v3.d.ts b/types/google-apps-script/apis/youtube_v3.d.ts new file mode 100644 index 0000000000..8c6763b92e --- /dev/null +++ b/types/google-apps-script/apis/youtube_v3.d.ts @@ -0,0 +1,1911 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace Youtube_v3 { + namespace Collection { + export interface ActivitiesCollection { + // Posts a bulletin for a specific channel. (The user submitting the request must be authorized to act on the channel's behalf.) + // Note: Even though an activity resource can contain information about actions like a user rating a video or marking a video as a favorite, you need to use other API methods to generate those activity resources. For example, you would use the API's videos.rate() method to rate a video and the playlistItems.insert() method to mark a video as a favorite. + insert(resource: Schema.Activity, part: string): Youtube_v3.Schema.Activity; + // Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. + list(part: string): Youtube_v3.Schema.ActivityListResponse; + // Returns a list of channel activity events that match the request criteria. For example, you can retrieve events associated with a particular channel, events associated with the user's subscriptions and Google+ friends, or the YouTube home page feed, which is customized for each user. + list(part: string, optionalArgs: object): Youtube_v3.Schema.ActivityListResponse; + } + export interface CaptionsCollection { + // Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. + download(id: string): void; + // Downloads a caption track. The caption track is returned in its original format unless the request specifies a value for the tfmt parameter and in its original language unless the request specifies a value for the tlang parameter. + download(id: string, optionalArgs: object): void; + // Uploads a caption track. + insert(resource: Schema.Caption, part: string): Youtube_v3.Schema.Caption; + // Uploads a caption track. + insert(resource: Schema.Caption, part: string, mediaData: any): Youtube_v3.Schema.Caption; + // Uploads a caption track. + insert(resource: Schema.Caption, part: string, mediaData: any, optionalArgs: object): Youtube_v3.Schema.Caption; + // Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track. + list(part: string, videoId: string): Youtube_v3.Schema.CaptionListResponse; + // Returns a list of caption tracks that are associated with a specified video. Note that the API response does not contain the actual captions and that the captions.download method provides the ability to retrieve a caption track. + list(part: string, videoId: string, optionalArgs: object): Youtube_v3.Schema.CaptionListResponse; + // Deletes a specified caption track. + remove(id: string): void; + // Deletes a specified caption track. + remove(id: string, optionalArgs: object): void; + // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. + update(resource: Schema.Caption, part: string): Youtube_v3.Schema.Caption; + // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. + update(resource: Schema.Caption, part: string, mediaData: any): Youtube_v3.Schema.Caption; + // Updates a caption track. When updating a caption track, you can change the track's draft status, upload a new caption file for the track, or both. + update(resource: Schema.Caption, part: string, mediaData: any, optionalArgs: object): Youtube_v3.Schema.Caption; + } + export interface ChannelBannersCollection { + // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: + // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. + // - Extract the url property's value from the response that the API returns for step 1. + // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. + insert(resource: Schema.ChannelBannerResource): Youtube_v3.Schema.ChannelBannerResource; + // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: + // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. + // - Extract the url property's value from the response that the API returns for step 1. + // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. + insert(resource: Schema.ChannelBannerResource, mediaData: any): Youtube_v3.Schema.ChannelBannerResource; + // Uploads a channel banner image to YouTube. This method represents the first two steps in a three-step process to update the banner image for a channel: + // - Call the channelBanners.insert method to upload the binary image data to YouTube. The image must have a 16:9 aspect ratio and be at least 2120x1192 pixels. + // - Extract the url property's value from the response that the API returns for step 1. + // - Call the channels.update method to update the channel's branding settings. Set the brandingSettings.image.bannerExternalUrl property's value to the URL obtained in step 2. + insert(resource: Schema.ChannelBannerResource, mediaData: any, optionalArgs: object): Youtube_v3.Schema.ChannelBannerResource; + } + export interface ChannelSectionsCollection { + // Adds a channelSection for the authenticated user's channel. + insert(resource: Schema.ChannelSection, part: string): Youtube_v3.Schema.ChannelSection; + // Adds a channelSection for the authenticated user's channel. + insert(resource: Schema.ChannelSection, part: string, optionalArgs: object): Youtube_v3.Schema.ChannelSection; + // Returns channelSection resources that match the API request criteria. + list(part: string): Youtube_v3.Schema.ChannelSectionListResponse; + // Returns channelSection resources that match the API request criteria. + list(part: string, optionalArgs: object): Youtube_v3.Schema.ChannelSectionListResponse; + // Deletes a channelSection. + remove(id: string): void; + // Deletes a channelSection. + remove(id: string, optionalArgs: object): void; + // Update a channelSection. + update(resource: Schema.ChannelSection, part: string): Youtube_v3.Schema.ChannelSection; + // Update a channelSection. + update(resource: Schema.ChannelSection, part: string, optionalArgs: object): Youtube_v3.Schema.ChannelSection; + } + export interface ChannelsCollection { + // Returns a collection of zero or more channel resources that match the request criteria. + list(part: string): Youtube_v3.Schema.ChannelListResponse; + // Returns a collection of zero or more channel resources that match the request criteria. + list(part: string, optionalArgs: object): Youtube_v3.Schema.ChannelListResponse; + // Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties. + update(resource: Schema.Channel, part: string): Youtube_v3.Schema.Channel; + // Updates a channel's metadata. Note that this method currently only supports updates to the channel resource's brandingSettings and invideoPromotion objects and their child properties. + update(resource: Schema.Channel, part: string, optionalArgs: object): Youtube_v3.Schema.Channel; + } + export interface CommentThreadsCollection { + // Creates a new top-level comment. To add a reply to an existing comment, use the comments.insert method instead. + insert(resource: Schema.CommentThread, part: string): Youtube_v3.Schema.CommentThread; + // Returns a list of comment threads that match the API request parameters. + list(part: string): Youtube_v3.Schema.CommentThreadListResponse; + // Returns a list of comment threads that match the API request parameters. + list(part: string, optionalArgs: object): Youtube_v3.Schema.CommentThreadListResponse; + // Modifies the top-level comment in a comment thread. + update(resource: Schema.CommentThread, part: string): Youtube_v3.Schema.CommentThread; + } + export interface CommentsCollection { + // Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method. + insert(resource: Schema.Comment, part: string): Youtube_v3.Schema.Comment; + // Returns a list of comments that match the API request parameters. + list(part: string): Youtube_v3.Schema.CommentListResponse; + // Returns a list of comments that match the API request parameters. + list(part: string, optionalArgs: object): Youtube_v3.Schema.CommentListResponse; + // Expresses the caller's opinion that one or more comments should be flagged as spam. + markAsSpam(id: string): void; + // Deletes a comment. + remove(id: string): void; + // Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments. + setModerationStatus(id: string, moderationStatus: string): void; + // Sets the moderation status of one or more comments. The API request must be authorized by the owner of the channel or video associated with the comments. + setModerationStatus(id: string, moderationStatus: string, optionalArgs: object): void; + // Modifies a comment. + update(resource: Schema.Comment, part: string): Youtube_v3.Schema.Comment; + } + export interface GuideCategoriesCollection { + // Returns a list of categories that can be associated with YouTube channels. + list(part: string): Youtube_v3.Schema.GuideCategoryListResponse; + // Returns a list of categories that can be associated with YouTube channels. + list(part: string, optionalArgs: object): Youtube_v3.Schema.GuideCategoryListResponse; + } + export interface I18nLanguagesCollection { + // Returns a list of application languages that the YouTube website supports. + list(part: string): Youtube_v3.Schema.I18nLanguageListResponse; + // Returns a list of application languages that the YouTube website supports. + list(part: string, optionalArgs: object): Youtube_v3.Schema.I18nLanguageListResponse; + } + export interface I18nRegionsCollection { + // Returns a list of content regions that the YouTube website supports. + list(part: string): Youtube_v3.Schema.I18nRegionListResponse; + // Returns a list of content regions that the YouTube website supports. + list(part: string, optionalArgs: object): Youtube_v3.Schema.I18nRegionListResponse; + } + export interface LiveBroadcastsCollection { + // Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. + bind(id: string, part: string): Youtube_v3.Schema.LiveBroadcast; + // Binds a YouTube broadcast to a stream or removes an existing binding between a broadcast and a stream. A broadcast can only be bound to one video stream, though a video stream may be bound to more than one broadcast. + bind(id: string, part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcast; + // Controls the settings for a slate that can be displayed in the broadcast stream. + control(id: string, part: string): Youtube_v3.Schema.LiveBroadcast; + // Controls the settings for a slate that can be displayed in the broadcast stream. + control(id: string, part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcast; + // Creates a broadcast. + insert(resource: Schema.LiveBroadcast, part: string): Youtube_v3.Schema.LiveBroadcast; + // Creates a broadcast. + insert(resource: Schema.LiveBroadcast, part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcast; + // Returns a list of YouTube broadcasts that match the API request parameters. + list(part: string): Youtube_v3.Schema.LiveBroadcastListResponse; + // Returns a list of YouTube broadcasts that match the API request parameters. + list(part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcastListResponse; + // Deletes a broadcast. + remove(id: string): void; + // Deletes a broadcast. + remove(id: string, optionalArgs: object): void; + // Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. + transition(broadcastStatus: string, id: string, part: string): Youtube_v3.Schema.LiveBroadcast; + // Changes the status of a YouTube live broadcast and initiates any processes associated with the new status. For example, when you transition a broadcast's status to testing, YouTube starts to transmit video to that broadcast's monitor stream. Before calling this method, you should confirm that the value of the status.streamStatus property for the stream bound to your broadcast is active. + transition(broadcastStatus: string, id: string, part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcast; + // Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. + update(resource: Schema.LiveBroadcast, part: string): Youtube_v3.Schema.LiveBroadcast; + // Updates a broadcast. For example, you could modify the broadcast settings defined in the liveBroadcast resource's contentDetails object. + update(resource: Schema.LiveBroadcast, part: string, optionalArgs: object): Youtube_v3.Schema.LiveBroadcast; + } + export interface LiveChatBansCollection { + // Adds a new ban to the chat. + insert(resource: Schema.LiveChatBan, part: string): Youtube_v3.Schema.LiveChatBan; + // Removes a chat ban. + remove(id: string): void; + } + export interface LiveChatMessagesCollection { + // Adds a message to a live chat. + insert(resource: Schema.LiveChatMessage, part: string): Youtube_v3.Schema.LiveChatMessage; + // Lists live chat messages for a specific chat. + list(liveChatId: string, part: string): Youtube_v3.Schema.LiveChatMessageListResponse; + // Lists live chat messages for a specific chat. + list(liveChatId: string, part: string, optionalArgs: object): Youtube_v3.Schema.LiveChatMessageListResponse; + // Deletes a chat message. + remove(id: string): void; + } + export interface LiveChatModeratorsCollection { + // Adds a new moderator for the chat. + insert(resource: Schema.LiveChatModerator, part: string): Youtube_v3.Schema.LiveChatModerator; + // Lists moderators for a live chat. + list(liveChatId: string, part: string): Youtube_v3.Schema.LiveChatModeratorListResponse; + // Lists moderators for a live chat. + list(liveChatId: string, part: string, optionalArgs: object): Youtube_v3.Schema.LiveChatModeratorListResponse; + // Removes a chat moderator. + remove(id: string): void; + } + export interface LiveStreamsCollection { + // Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience. + insert(resource: Schema.LiveStream, part: string): Youtube_v3.Schema.LiveStream; + // Creates a video stream. The stream enables you to send your video to YouTube, which can then broadcast the video to your audience. + insert(resource: Schema.LiveStream, part: string, optionalArgs: object): Youtube_v3.Schema.LiveStream; + // Returns a list of video streams that match the API request parameters. + list(part: string): Youtube_v3.Schema.LiveStreamListResponse; + // Returns a list of video streams that match the API request parameters. + list(part: string, optionalArgs: object): Youtube_v3.Schema.LiveStreamListResponse; + // Deletes a video stream. + remove(id: string): void; + // Deletes a video stream. + remove(id: string, optionalArgs: object): void; + // Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings. + update(resource: Schema.LiveStream, part: string): Youtube_v3.Schema.LiveStream; + // Updates a video stream. If the properties that you want to change cannot be updated, then you need to create a new stream with the proper settings. + update(resource: Schema.LiveStream, part: string, optionalArgs: object): Youtube_v3.Schema.LiveStream; + } + export interface PlaylistItemsCollection { + // Adds a resource to a playlist. + insert(resource: Schema.PlaylistItem, part: string): Youtube_v3.Schema.PlaylistItem; + // Adds a resource to a playlist. + insert(resource: Schema.PlaylistItem, part: string, optionalArgs: object): Youtube_v3.Schema.PlaylistItem; + // Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. + list(part: string): Youtube_v3.Schema.PlaylistItemListResponse; + // Returns a collection of playlist items that match the API request parameters. You can retrieve all of the playlist items in a specified playlist or retrieve one or more playlist items by their unique IDs. + list(part: string, optionalArgs: object): Youtube_v3.Schema.PlaylistItemListResponse; + // Deletes a playlist item. + remove(id: string): void; + // Deletes a playlist item. + remove(id: string, optionalArgs: object): void; + // Modifies a playlist item. For example, you could update the item's position in the playlist. + update(resource: Schema.PlaylistItem, part: string): Youtube_v3.Schema.PlaylistItem; + // Modifies a playlist item. For example, you could update the item's position in the playlist. + update(resource: Schema.PlaylistItem, part: string, optionalArgs: object): Youtube_v3.Schema.PlaylistItem; + } + export interface PlaylistsCollection { + // Creates a playlist. + insert(resource: Schema.Playlist, part: string): Youtube_v3.Schema.Playlist; + // Creates a playlist. + insert(resource: Schema.Playlist, part: string, optionalArgs: object): Youtube_v3.Schema.Playlist; + // Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. + list(part: string): Youtube_v3.Schema.PlaylistListResponse; + // Returns a collection of playlists that match the API request parameters. For example, you can retrieve all playlists that the authenticated user owns, or you can retrieve one or more playlists by their unique IDs. + list(part: string, optionalArgs: object): Youtube_v3.Schema.PlaylistListResponse; + // Deletes a playlist. + remove(id: string): void; + // Deletes a playlist. + remove(id: string, optionalArgs: object): void; + // Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. + update(resource: Schema.Playlist, part: string): Youtube_v3.Schema.Playlist; + // Modifies a playlist. For example, you could change a playlist's title, description, or privacy status. + update(resource: Schema.Playlist, part: string, optionalArgs: object): Youtube_v3.Schema.Playlist; + } + export interface SearchCollection { + // Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. + list(part: string): Youtube_v3.Schema.SearchListResponse; + // Returns a collection of search results that match the query parameters specified in the API request. By default, a search result set identifies matching video, channel, and playlist resources, but you can also configure queries to only retrieve a specific type of resource. + list(part: string, optionalArgs: object): Youtube_v3.Schema.SearchListResponse; + } + export interface SponsorsCollection { + // Lists sponsors for a channel. + list(part: string): Youtube_v3.Schema.SponsorListResponse; + // Lists sponsors for a channel. + list(part: string, optionalArgs: object): Youtube_v3.Schema.SponsorListResponse; + } + export interface SubscriptionsCollection { + // Adds a subscription for the authenticated user's channel. + insert(resource: Schema.Subscription, part: string): Youtube_v3.Schema.Subscription; + // Returns subscription resources that match the API request criteria. + list(part: string): Youtube_v3.Schema.SubscriptionListResponse; + // Returns subscription resources that match the API request criteria. + list(part: string, optionalArgs: object): Youtube_v3.Schema.SubscriptionListResponse; + // Deletes a subscription. + remove(id: string): void; + } + export interface SuperChatEventsCollection { + // Lists Super Chat events for a channel. + list(part: string): Youtube_v3.Schema.SuperChatEventListResponse; + // Lists Super Chat events for a channel. + list(part: string, optionalArgs: object): Youtube_v3.Schema.SuperChatEventListResponse; + } + export interface ThumbnailsCollection { + // Uploads a custom video thumbnail to YouTube and sets it for a video. + set(videoId: string): Youtube_v3.Schema.ThumbnailSetResponse; + // Uploads a custom video thumbnail to YouTube and sets it for a video. + set(videoId: string, mediaData: any): Youtube_v3.Schema.ThumbnailSetResponse; + // Uploads a custom video thumbnail to YouTube and sets it for a video. + set(videoId: string, mediaData: any, optionalArgs: object): Youtube_v3.Schema.ThumbnailSetResponse; + } + export interface VideoAbuseReportReasonsCollection { + // Returns a list of abuse reasons that can be used for reporting abusive videos. + list(part: string): Youtube_v3.Schema.VideoAbuseReportReasonListResponse; + // Returns a list of abuse reasons that can be used for reporting abusive videos. + list(part: string, optionalArgs: object): Youtube_v3.Schema.VideoAbuseReportReasonListResponse; + } + export interface VideoCategoriesCollection { + // Returns a list of categories that can be associated with YouTube videos. + list(part: string): Youtube_v3.Schema.VideoCategoryListResponse; + // Returns a list of categories that can be associated with YouTube videos. + list(part: string, optionalArgs: object): Youtube_v3.Schema.VideoCategoryListResponse; + } + export interface VideosCollection { + // Retrieves the ratings that the authorized user gave to a list of specified videos. + getRating(id: string): Youtube_v3.Schema.VideoGetRatingResponse; + // Retrieves the ratings that the authorized user gave to a list of specified videos. + getRating(id: string, optionalArgs: object): Youtube_v3.Schema.VideoGetRatingResponse; + // Uploads a video to YouTube and optionally sets the video's metadata. + insert(resource: Schema.Video, part: string): Youtube_v3.Schema.Video; + // Uploads a video to YouTube and optionally sets the video's metadata. + insert(resource: Schema.Video, part: string, mediaData: any): Youtube_v3.Schema.Video; + // Uploads a video to YouTube and optionally sets the video's metadata. + insert(resource: Schema.Video, part: string, mediaData: any, optionalArgs: object): Youtube_v3.Schema.Video; + // Returns a list of videos that match the API request parameters. + list(part: string): Youtube_v3.Schema.VideoListResponse; + // Returns a list of videos that match the API request parameters. + list(part: string, optionalArgs: object): Youtube_v3.Schema.VideoListResponse; + // Add a like or dislike rating to a video or remove a rating from a video. + rate(id: string, rating: string): void; + // Deletes a YouTube video. + remove(id: string): void; + // Deletes a YouTube video. + remove(id: string, optionalArgs: object): void; + // Report abuse for a video. + reportAbuse(resource: Schema.VideoAbuseReport): void; + // Report abuse for a video. + reportAbuse(resource: Schema.VideoAbuseReport, optionalArgs: object): void; + // Updates a video's metadata. + update(resource: Schema.Video, part: string): Youtube_v3.Schema.Video; + // Updates a video's metadata. + update(resource: Schema.Video, part: string, optionalArgs: object): Youtube_v3.Schema.Video; + } + export interface WatermarksCollection { + // Uploads a watermark image to YouTube and sets it for a channel. + set(resource: Schema.InvideoBranding, channelId: string): void; + // Uploads a watermark image to YouTube and sets it for a channel. + set(resource: Schema.InvideoBranding, channelId: string, mediaData: any): void; + // Uploads a watermark image to YouTube and sets it for a channel. + set(resource: Schema.InvideoBranding, channelId: string, mediaData: any, optionalArgs: object): void; + // Deletes a channel's watermark image. + unset(channelId: string): void; + // Deletes a channel's watermark image. + unset(channelId: string, optionalArgs: object): void; + } + } + namespace Schema { + export interface AccessPolicy { + allowed?: boolean; + exception?: string[]; + } + export interface Activity { + contentDetails?: Youtube_v3.Schema.ActivityContentDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.ActivitySnippet; + } + export interface ActivityContentDetails { + bulletin?: Youtube_v3.Schema.ActivityContentDetailsBulletin; + channelItem?: Youtube_v3.Schema.ActivityContentDetailsChannelItem; + comment?: Youtube_v3.Schema.ActivityContentDetailsComment; + favorite?: Youtube_v3.Schema.ActivityContentDetailsFavorite; + like?: Youtube_v3.Schema.ActivityContentDetailsLike; + playlistItem?: Youtube_v3.Schema.ActivityContentDetailsPlaylistItem; + promotedItem?: Youtube_v3.Schema.ActivityContentDetailsPromotedItem; + recommendation?: Youtube_v3.Schema.ActivityContentDetailsRecommendation; + social?: Youtube_v3.Schema.ActivityContentDetailsSocial; + subscription?: Youtube_v3.Schema.ActivityContentDetailsSubscription; + upload?: Youtube_v3.Schema.ActivityContentDetailsUpload; + } + export interface ActivityContentDetailsBulletin { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsChannelItem { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsComment { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsFavorite { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsLike { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsPlaylistItem { + playlistId?: string; + playlistItemId?: string; + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsPromotedItem { + adTag?: string; + clickTrackingUrl?: string; + creativeViewUrl?: string; + ctaType?: string; + customCtaButtonText?: string; + descriptionText?: string; + destinationUrl?: string; + forecastingUrl?: string[]; + impressionUrl?: string[]; + videoId?: string; + } + export interface ActivityContentDetailsRecommendation { + reason?: string; + resourceId?: Youtube_v3.Schema.ResourceId; + seedResourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsSocial { + author?: string; + imageUrl?: string; + referenceUrl?: string; + resourceId?: Youtube_v3.Schema.ResourceId; + type?: string; + } + export interface ActivityContentDetailsSubscription { + resourceId?: Youtube_v3.Schema.ResourceId; + } + export interface ActivityContentDetailsUpload { + videoId?: string; + } + export interface ActivityListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Activity[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface ActivitySnippet { + channelId?: string; + channelTitle?: string; + description?: string; + groupId?: string; + publishedAt?: string; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + type?: string; + } + export interface Caption { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.CaptionSnippet; + } + export interface CaptionListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Caption[]; + kind?: string; + visitorId?: string; + } + export interface CaptionSnippet { + audioTrackType?: string; + failureReason?: string; + isAutoSynced?: boolean; + isCC?: boolean; + isDraft?: boolean; + isEasyReader?: boolean; + isLarge?: boolean; + language?: string; + lastUpdated?: string; + name?: string; + status?: string; + trackKind?: string; + videoId?: string; + } + export interface CdnSettings { + format?: string; + frameRate?: string; + ingestionInfo?: Youtube_v3.Schema.IngestionInfo; + ingestionType?: string; + resolution?: string; + } + export interface Channel { + auditDetails?: Youtube_v3.Schema.ChannelAuditDetails; + brandingSettings?: Youtube_v3.Schema.ChannelBrandingSettings; + contentDetails?: Youtube_v3.Schema.ChannelContentDetails; + contentOwnerDetails?: Youtube_v3.Schema.ChannelContentOwnerDetails; + conversionPings?: Youtube_v3.Schema.ChannelConversionPings; + etag?: string; + id?: string; + invideoPromotion?: Youtube_v3.Schema.InvideoPromotion; + kind?: string; + localizations?: object; + snippet?: Youtube_v3.Schema.ChannelSnippet; + statistics?: Youtube_v3.Schema.ChannelStatistics; + status?: Youtube_v3.Schema.ChannelStatus; + topicDetails?: Youtube_v3.Schema.ChannelTopicDetails; + } + export interface ChannelAuditDetails { + communityGuidelinesGoodStanding?: boolean; + contentIdClaimsGoodStanding?: boolean; + copyrightStrikesGoodStanding?: boolean; + } + export interface ChannelBannerResource { + etag?: string; + kind?: string; + url?: string; + } + export interface ChannelBrandingSettings { + channel?: Youtube_v3.Schema.ChannelSettings; + hints?: Youtube_v3.Schema.PropertyValue[]; + image?: Youtube_v3.Schema.ImageSettings; + watch?: Youtube_v3.Schema.WatchSettings; + } + export interface ChannelContentDetails { + relatedPlaylists?: Youtube_v3.Schema.ChannelContentDetailsRelatedPlaylists; + } + export interface ChannelContentDetailsRelatedPlaylists { + favorites?: string; + likes?: string; + uploads?: string; + watchHistory?: string; + watchLater?: string; + } + export interface ChannelContentOwnerDetails { + contentOwner?: string; + timeLinked?: string; + } + export interface ChannelConversionPing { + context?: string; + conversionUrl?: string; + } + export interface ChannelConversionPings { + pings?: Youtube_v3.Schema.ChannelConversionPing[]; + } + export interface ChannelListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Channel[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface ChannelLocalization { + description?: string; + title?: string; + } + export interface ChannelProfileDetails { + channelId?: string; + channelUrl?: string; + displayName?: string; + profileImageUrl?: string; + } + export interface ChannelSection { + contentDetails?: Youtube_v3.Schema.ChannelSectionContentDetails; + etag?: string; + id?: string; + kind?: string; + localizations?: object; + snippet?: Youtube_v3.Schema.ChannelSectionSnippet; + targeting?: Youtube_v3.Schema.ChannelSectionTargeting; + } + export interface ChannelSectionContentDetails { + channels?: string[]; + playlists?: string[]; + } + export interface ChannelSectionListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.ChannelSection[]; + kind?: string; + visitorId?: string; + } + export interface ChannelSectionLocalization { + title?: string; + } + export interface ChannelSectionSnippet { + channelId?: string; + defaultLanguage?: string; + localized?: Youtube_v3.Schema.ChannelSectionLocalization; + position?: number; + style?: string; + title?: string; + type?: string; + } + export interface ChannelSectionTargeting { + countries?: string[]; + languages?: string[]; + regions?: string[]; + } + export interface ChannelSettings { + country?: string; + defaultLanguage?: string; + defaultTab?: string; + description?: string; + featuredChannelsTitle?: string; + featuredChannelsUrls?: string[]; + keywords?: string; + moderateComments?: boolean; + profileColor?: string; + showBrowseView?: boolean; + showRelatedChannels?: boolean; + title?: string; + trackingAnalyticsAccountId?: string; + unsubscribedTrailer?: string; + } + export interface ChannelSnippet { + country?: string; + customUrl?: string; + defaultLanguage?: string; + description?: string; + localized?: Youtube_v3.Schema.ChannelLocalization; + publishedAt?: string; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface ChannelStatistics { + commentCount?: string; + hiddenSubscriberCount?: boolean; + subscriberCount?: string; + videoCount?: string; + viewCount?: string; + } + export interface ChannelStatus { + isLinked?: boolean; + longUploadsStatus?: string; + privacyStatus?: string; + } + export interface ChannelTopicDetails { + topicCategories?: string[]; + topicIds?: string[]; + } + export interface Comment { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.CommentSnippet; + } + export interface CommentListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Comment[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface CommentSnippet { + authorChannelId?: object; + authorChannelUrl?: string; + authorDisplayName?: string; + authorProfileImageUrl?: string; + canRate?: boolean; + channelId?: string; + likeCount?: number; + moderationStatus?: string; + parentId?: string; + publishedAt?: string; + textDisplay?: string; + textOriginal?: string; + updatedAt?: string; + videoId?: string; + viewerRating?: string; + } + export interface CommentThread { + etag?: string; + id?: string; + kind?: string; + replies?: Youtube_v3.Schema.CommentThreadReplies; + snippet?: Youtube_v3.Schema.CommentThreadSnippet; + } + export interface CommentThreadListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.CommentThread[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface CommentThreadReplies { + comments?: Youtube_v3.Schema.Comment[]; + } + export interface CommentThreadSnippet { + canReply?: boolean; + channelId?: string; + isPublic?: boolean; + topLevelComment?: Youtube_v3.Schema.Comment; + totalReplyCount?: number; + videoId?: string; + } + export interface ContentRating { + acbRating?: string; + agcomRating?: string; + anatelRating?: string; + bbfcRating?: string; + bfvcRating?: string; + bmukkRating?: string; + catvRating?: string; + catvfrRating?: string; + cbfcRating?: string; + cccRating?: string; + cceRating?: string; + chfilmRating?: string; + chvrsRating?: string; + cicfRating?: string; + cnaRating?: string; + cncRating?: string; + csaRating?: string; + cscfRating?: string; + czfilmRating?: string; + djctqRating?: string; + djctqRatingReasons?: string[]; + ecbmctRating?: string; + eefilmRating?: string; + egfilmRating?: string; + eirinRating?: string; + fcbmRating?: string; + fcoRating?: string; + fmocRating?: string; + fpbRating?: string; + fpbRatingReasons?: string[]; + fskRating?: string; + grfilmRating?: string; + icaaRating?: string; + ifcoRating?: string; + ilfilmRating?: string; + incaaRating?: string; + kfcbRating?: string; + kijkwijzerRating?: string; + kmrbRating?: string; + lsfRating?: string; + mccaaRating?: string; + mccypRating?: string; + mcstRating?: string; + mdaRating?: string; + medietilsynetRating?: string; + mekuRating?: string; + menaMpaaRating?: string; + mibacRating?: string; + mocRating?: string; + moctwRating?: string; + mpaaRating?: string; + mpaatRating?: string; + mtrcbRating?: string; + nbcRating?: string; + nbcplRating?: string; + nfrcRating?: string; + nfvcbRating?: string; + nkclvRating?: string; + oflcRating?: string; + pefilmRating?: string; + rcnofRating?: string; + resorteviolenciaRating?: string; + rtcRating?: string; + rteRating?: string; + russiaRating?: string; + skfilmRating?: string; + smaisRating?: string; + smsaRating?: string; + tvpgRating?: string; + ytRating?: string; + } + export interface GeoPoint { + altitude?: Number; + latitude?: Number; + longitude?: Number; + } + export interface GuideCategory { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.GuideCategorySnippet; + } + export interface GuideCategoryListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.GuideCategory[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface GuideCategorySnippet { + channelId?: string; + title?: string; + } + export interface I18nLanguage { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.I18nLanguageSnippet; + } + export interface I18nLanguageListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.I18nLanguage[]; + kind?: string; + visitorId?: string; + } + export interface I18nLanguageSnippet { + hl?: string; + name?: string; + } + export interface I18nRegion { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.I18nRegionSnippet; + } + export interface I18nRegionListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.I18nRegion[]; + kind?: string; + visitorId?: string; + } + export interface I18nRegionSnippet { + gl?: string; + name?: string; + } + export interface ImageSettings { + backgroundImageUrl?: Youtube_v3.Schema.LocalizedProperty; + bannerExternalUrl?: string; + bannerImageUrl?: string; + bannerMobileExtraHdImageUrl?: string; + bannerMobileHdImageUrl?: string; + bannerMobileImageUrl?: string; + bannerMobileLowImageUrl?: string; + bannerMobileMediumHdImageUrl?: string; + bannerTabletExtraHdImageUrl?: string; + bannerTabletHdImageUrl?: string; + bannerTabletImageUrl?: string; + bannerTabletLowImageUrl?: string; + bannerTvHighImageUrl?: string; + bannerTvImageUrl?: string; + bannerTvLowImageUrl?: string; + bannerTvMediumImageUrl?: string; + largeBrandedBannerImageImapScript?: Youtube_v3.Schema.LocalizedProperty; + largeBrandedBannerImageUrl?: Youtube_v3.Schema.LocalizedProperty; + smallBrandedBannerImageImapScript?: Youtube_v3.Schema.LocalizedProperty; + smallBrandedBannerImageUrl?: Youtube_v3.Schema.LocalizedProperty; + trackingImageUrl?: string; + watchIconImageUrl?: string; + } + export interface IngestionInfo { + backupIngestionAddress?: string; + ingestionAddress?: string; + streamName?: string; + } + export interface InvideoBranding { + imageBytes?: string; + imageUrl?: string; + position?: Youtube_v3.Schema.InvideoPosition; + targetChannelId?: string; + timing?: Youtube_v3.Schema.InvideoTiming; + } + export interface InvideoPosition { + cornerPosition?: string; + type?: string; + } + export interface InvideoPromotion { + defaultTiming?: Youtube_v3.Schema.InvideoTiming; + items?: Youtube_v3.Schema.PromotedItem[]; + position?: Youtube_v3.Schema.InvideoPosition; + useSmartTiming?: boolean; + } + export interface InvideoTiming { + durationMs?: string; + offsetMs?: string; + type?: string; + } + export interface LanguageTag { + value?: string; + } + export interface LiveBroadcast { + contentDetails?: Youtube_v3.Schema.LiveBroadcastContentDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.LiveBroadcastSnippet; + statistics?: Youtube_v3.Schema.LiveBroadcastStatistics; + status?: Youtube_v3.Schema.LiveBroadcastStatus; + } + export interface LiveBroadcastContentDetails { + boundStreamId?: string; + boundStreamLastUpdateTimeMs?: string; + closedCaptionsType?: string; + enableAutoStart?: boolean; + enableClosedCaptions?: boolean; + enableContentEncryption?: boolean; + enableDvr?: boolean; + enableEmbed?: boolean; + enableLowLatency?: boolean; + latencyPreference?: string; + mesh?: string; + monitorStream?: Youtube_v3.Schema.MonitorStreamInfo; + projection?: string; + recordFromStart?: boolean; + startWithSlate?: boolean; + stereoLayout?: string; + } + export interface LiveBroadcastListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.LiveBroadcast[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface LiveBroadcastSnippet { + actualEndTime?: string; + actualStartTime?: string; + channelId?: string; + description?: string; + isDefaultBroadcast?: boolean; + liveChatId?: string; + publishedAt?: string; + scheduledEndTime?: string; + scheduledStartTime?: string; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface LiveBroadcastStatistics { + concurrentViewers?: string; + totalChatCount?: string; + } + export interface LiveBroadcastStatus { + lifeCycleStatus?: string; + liveBroadcastPriority?: string; + privacyStatus?: string; + recordingStatus?: string; + } + export interface LiveChatBan { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.LiveChatBanSnippet; + } + export interface LiveChatBanSnippet { + banDurationSeconds?: string; + bannedUserDetails?: Youtube_v3.Schema.ChannelProfileDetails; + liveChatId?: string; + type?: string; + } + export interface LiveChatFanFundingEventDetails { + amountDisplayString?: string; + amountMicros?: string; + currency?: string; + userComment?: string; + } + export interface LiveChatMessage { + authorDetails?: Youtube_v3.Schema.LiveChatMessageAuthorDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.LiveChatMessageSnippet; + } + export interface LiveChatMessageAuthorDetails { + channelId?: string; + channelUrl?: string; + displayName?: string; + isChatModerator?: boolean; + isChatOwner?: boolean; + isChatSponsor?: boolean; + isVerified?: boolean; + profileImageUrl?: string; + } + export interface LiveChatMessageDeletedDetails { + deletedMessageId?: string; + } + export interface LiveChatMessageListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.LiveChatMessage[]; + kind?: string; + nextPageToken?: string; + offlineAt?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + pollingIntervalMillis?: number; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface LiveChatMessageRetractedDetails { + retractedMessageId?: string; + } + export interface LiveChatMessageSnippet { + authorChannelId?: string; + displayMessage?: string; + fanFundingEventDetails?: Youtube_v3.Schema.LiveChatFanFundingEventDetails; + hasDisplayContent?: boolean; + liveChatId?: string; + messageDeletedDetails?: Youtube_v3.Schema.LiveChatMessageDeletedDetails; + messageRetractedDetails?: Youtube_v3.Schema.LiveChatMessageRetractedDetails; + pollClosedDetails?: Youtube_v3.Schema.LiveChatPollClosedDetails; + pollEditedDetails?: Youtube_v3.Schema.LiveChatPollEditedDetails; + pollOpenedDetails?: Youtube_v3.Schema.LiveChatPollOpenedDetails; + pollVotedDetails?: Youtube_v3.Schema.LiveChatPollVotedDetails; + publishedAt?: string; + superChatDetails?: Youtube_v3.Schema.LiveChatSuperChatDetails; + superStickerDetails?: Youtube_v3.Schema.LiveChatSuperStickerDetails; + textMessageDetails?: Youtube_v3.Schema.LiveChatTextMessageDetails; + type?: string; + userBannedDetails?: Youtube_v3.Schema.LiveChatUserBannedMessageDetails; + } + export interface LiveChatModerator { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.LiveChatModeratorSnippet; + } + export interface LiveChatModeratorListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.LiveChatModerator[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface LiveChatModeratorSnippet { + liveChatId?: string; + moderatorDetails?: Youtube_v3.Schema.ChannelProfileDetails; + } + export interface LiveChatPollClosedDetails { + pollId?: string; + } + export interface LiveChatPollEditedDetails { + id?: string; + items?: Youtube_v3.Schema.LiveChatPollItem[]; + prompt?: string; + } + export interface LiveChatPollItem { + description?: string; + itemId?: string; + } + export interface LiveChatPollOpenedDetails { + id?: string; + items?: Youtube_v3.Schema.LiveChatPollItem[]; + prompt?: string; + } + export interface LiveChatPollVotedDetails { + itemId?: string; + pollId?: string; + } + export interface LiveChatSuperChatDetails { + amountDisplayString?: string; + amountMicros?: string; + currency?: string; + tier?: number; + userComment?: string; + } + export interface LiveChatSuperStickerDetails { + amountDisplayString?: string; + amountMicros?: string; + currency?: string; + superStickerMetadata?: Youtube_v3.Schema.SuperStickerMetadata; + tier?: number; + } + export interface LiveChatTextMessageDetails { + messageText?: string; + } + export interface LiveChatUserBannedMessageDetails { + banDurationSeconds?: string; + banType?: string; + bannedUserDetails?: Youtube_v3.Schema.ChannelProfileDetails; + } + export interface LiveStream { + cdn?: Youtube_v3.Schema.CdnSettings; + contentDetails?: Youtube_v3.Schema.LiveStreamContentDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.LiveStreamSnippet; + status?: Youtube_v3.Schema.LiveStreamStatus; + } + export interface LiveStreamConfigurationIssue { + description?: string; + reason?: string; + severity?: string; + type?: string; + } + export interface LiveStreamContentDetails { + closedCaptionsIngestionUrl?: string; + isReusable?: boolean; + } + export interface LiveStreamHealthStatus { + configurationIssues?: Youtube_v3.Schema.LiveStreamConfigurationIssue[]; + lastUpdateTimeSeconds?: string; + status?: string; + } + export interface LiveStreamListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.LiveStream[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface LiveStreamSnippet { + channelId?: string; + description?: string; + isDefaultStream?: boolean; + publishedAt?: string; + title?: string; + } + export interface LiveStreamStatus { + healthStatus?: Youtube_v3.Schema.LiveStreamHealthStatus; + streamStatus?: string; + } + export interface LocalizedProperty { + default?: string; + defaultLanguage?: Youtube_v3.Schema.LanguageTag; + localized?: Youtube_v3.Schema.LocalizedString[]; + } + export interface LocalizedString { + language?: string; + value?: string; + } + export interface MonitorStreamInfo { + broadcastStreamDelayMs?: number; + embedHtml?: string; + enableMonitorStream?: boolean; + } + export interface Nonprofit { + nonprofitId?: Youtube_v3.Schema.NonprofitId; + nonprofitLegalName?: string; + } + export interface NonprofitId { + value?: string; + } + export interface PageInfo { + resultsPerPage?: number; + totalResults?: number; + } + export interface Playlist { + contentDetails?: Youtube_v3.Schema.PlaylistContentDetails; + etag?: string; + id?: string; + kind?: string; + localizations?: object; + player?: Youtube_v3.Schema.PlaylistPlayer; + snippet?: Youtube_v3.Schema.PlaylistSnippet; + status?: Youtube_v3.Schema.PlaylistStatus; + } + export interface PlaylistContentDetails { + itemCount?: number; + } + export interface PlaylistItem { + contentDetails?: Youtube_v3.Schema.PlaylistItemContentDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.PlaylistItemSnippet; + status?: Youtube_v3.Schema.PlaylistItemStatus; + } + export interface PlaylistItemContentDetails { + endAt?: string; + note?: string; + startAt?: string; + videoId?: string; + videoPublishedAt?: string; + } + export interface PlaylistItemListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.PlaylistItem[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface PlaylistItemSnippet { + channelId?: string; + channelTitle?: string; + description?: string; + playlistId?: string; + position?: number; + publishedAt?: string; + resourceId?: Youtube_v3.Schema.ResourceId; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface PlaylistItemStatus { + privacyStatus?: string; + } + export interface PlaylistListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Playlist[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface PlaylistLocalization { + description?: string; + title?: string; + } + export interface PlaylistPlayer { + embedHtml?: string; + } + export interface PlaylistSnippet { + channelId?: string; + channelTitle?: string; + defaultLanguage?: string; + description?: string; + localized?: Youtube_v3.Schema.PlaylistLocalization; + publishedAt?: string; + tags?: string[]; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface PlaylistStatus { + privacyStatus?: string; + } + export interface PromotedItem { + customMessage?: string; + id?: Youtube_v3.Schema.PromotedItemId; + promotedByContentOwner?: boolean; + timing?: Youtube_v3.Schema.InvideoTiming; + } + export interface PromotedItemId { + recentlyUploadedBy?: string; + type?: string; + videoId?: string; + websiteUrl?: string; + } + export interface PropertyValue { + property?: string; + value?: string; + } + export interface ResourceId { + channelId?: string; + kind?: string; + playlistId?: string; + videoId?: string; + } + export interface SearchListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.SearchResult[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + regionCode?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface SearchResult { + etag?: string; + id?: Youtube_v3.Schema.ResourceId; + kind?: string; + snippet?: Youtube_v3.Schema.SearchResultSnippet; + } + export interface SearchResultSnippet { + channelId?: string; + channelTitle?: string; + description?: string; + liveBroadcastContent?: string; + publishedAt?: string; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface Sponsor { + etag?: string; + kind?: string; + snippet?: Youtube_v3.Schema.SponsorSnippet; + } + export interface SponsorListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Sponsor[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface SponsorSnippet { + channelId?: string; + cumulativeDurationMonths?: number; + sponsorDetails?: Youtube_v3.Schema.ChannelProfileDetails; + sponsorSince?: string; + } + export interface Subscription { + contentDetails?: Youtube_v3.Schema.SubscriptionContentDetails; + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.SubscriptionSnippet; + subscriberSnippet?: Youtube_v3.Schema.SubscriptionSubscriberSnippet; + } + export interface SubscriptionContentDetails { + activityType?: string; + newItemCount?: number; + totalItemCount?: number; + } + export interface SubscriptionListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Subscription[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface SubscriptionSnippet { + channelId?: string; + channelTitle?: string; + description?: string; + publishedAt?: string; + resourceId?: Youtube_v3.Schema.ResourceId; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface SubscriptionSubscriberSnippet { + channelId?: string; + description?: string; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface SuperChatEvent { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.SuperChatEventSnippet; + } + export interface SuperChatEventListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.SuperChatEvent[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface SuperChatEventSnippet { + amountMicros?: string; + channelId?: string; + commentText?: string; + createdAt?: string; + currency?: string; + displayString?: string; + isSuperChatForGood?: boolean; + isSuperStickerEvent?: boolean; + messageType?: number; + nonprofit?: Youtube_v3.Schema.Nonprofit; + superStickerMetadata?: Youtube_v3.Schema.SuperStickerMetadata; + supporterDetails?: Youtube_v3.Schema.ChannelProfileDetails; + } + export interface SuperStickerMetadata { + altText?: string; + altTextLanguage?: string; + stickerId?: string; + } + export interface Thumbnail { + height?: number; + url?: string; + width?: number; + } + export interface ThumbnailDetails { + default?: Youtube_v3.Schema.Thumbnail; + high?: Youtube_v3.Schema.Thumbnail; + maxres?: Youtube_v3.Schema.Thumbnail; + medium?: Youtube_v3.Schema.Thumbnail; + standard?: Youtube_v3.Schema.Thumbnail; + } + export interface ThumbnailSetResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.ThumbnailDetails[]; + kind?: string; + visitorId?: string; + } + export interface Video { + ageGating?: Youtube_v3.Schema.VideoAgeGating; + contentDetails?: Youtube_v3.Schema.VideoContentDetails; + etag?: string; + fileDetails?: Youtube_v3.Schema.VideoFileDetails; + id?: string; + kind?: string; + liveStreamingDetails?: Youtube_v3.Schema.VideoLiveStreamingDetails; + localizations?: object; + monetizationDetails?: Youtube_v3.Schema.VideoMonetizationDetails; + player?: Youtube_v3.Schema.VideoPlayer; + processingDetails?: Youtube_v3.Schema.VideoProcessingDetails; + projectDetails?: Youtube_v3.Schema.VideoProjectDetails; + recordingDetails?: Youtube_v3.Schema.VideoRecordingDetails; + snippet?: Youtube_v3.Schema.VideoSnippet; + statistics?: Youtube_v3.Schema.VideoStatistics; + status?: Youtube_v3.Schema.VideoStatus; + suggestions?: Youtube_v3.Schema.VideoSuggestions; + topicDetails?: Youtube_v3.Schema.VideoTopicDetails; + } + export interface VideoAbuseReport { + comments?: string; + language?: string; + reasonId?: string; + secondaryReasonId?: string; + videoId?: string; + } + export interface VideoAbuseReportReason { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.VideoAbuseReportReasonSnippet; + } + export interface VideoAbuseReportReasonListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.VideoAbuseReportReason[]; + kind?: string; + visitorId?: string; + } + export interface VideoAbuseReportReasonSnippet { + label?: string; + secondaryReasons?: Youtube_v3.Schema.VideoAbuseReportSecondaryReason[]; + } + export interface VideoAbuseReportSecondaryReason { + id?: string; + label?: string; + } + export interface VideoAgeGating { + alcoholContent?: boolean; + restricted?: boolean; + videoGameRating?: string; + } + export interface VideoCategory { + etag?: string; + id?: string; + kind?: string; + snippet?: Youtube_v3.Schema.VideoCategorySnippet; + } + export interface VideoCategoryListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.VideoCategory[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface VideoCategorySnippet { + assignable?: boolean; + channelId?: string; + title?: string; + } + export interface VideoContentDetails { + caption?: string; + contentRating?: Youtube_v3.Schema.ContentRating; + countryRestriction?: Youtube_v3.Schema.AccessPolicy; + definition?: string; + dimension?: string; + duration?: string; + hasCustomThumbnail?: boolean; + licensedContent?: boolean; + projection?: string; + regionRestriction?: Youtube_v3.Schema.VideoContentDetailsRegionRestriction; + } + export interface VideoContentDetailsRegionRestriction { + allowed?: string[]; + blocked?: string[]; + } + export interface VideoFileDetails { + audioStreams?: Youtube_v3.Schema.VideoFileDetailsAudioStream[]; + bitrateBps?: string; + container?: string; + creationTime?: string; + durationMs?: string; + fileName?: string; + fileSize?: string; + fileType?: string; + videoStreams?: Youtube_v3.Schema.VideoFileDetailsVideoStream[]; + } + export interface VideoFileDetailsAudioStream { + bitrateBps?: string; + channelCount?: number; + codec?: string; + vendor?: string; + } + export interface VideoFileDetailsVideoStream { + aspectRatio?: Number; + bitrateBps?: string; + codec?: string; + frameRateFps?: Number; + heightPixels?: number; + rotation?: string; + vendor?: string; + widthPixels?: number; + } + export interface VideoGetRatingResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.VideoRating[]; + kind?: string; + visitorId?: string; + } + export interface VideoListResponse { + etag?: string; + eventId?: string; + items?: Youtube_v3.Schema.Video[]; + kind?: string; + nextPageToken?: string; + pageInfo?: Youtube_v3.Schema.PageInfo; + prevPageToken?: string; + tokenPagination?: any; // Schema.TokenPagination + visitorId?: string; + } + export interface VideoLiveStreamingDetails { + activeLiveChatId?: string; + actualEndTime?: string; + actualStartTime?: string; + concurrentViewers?: string; + scheduledEndTime?: string; + scheduledStartTime?: string; + } + export interface VideoLocalization { + description?: string; + title?: string; + } + export interface VideoMonetizationDetails { + access?: Youtube_v3.Schema.AccessPolicy; + } + export interface VideoPlayer { + embedHeight?: string; + embedHtml?: string; + embedWidth?: string; + } + export interface VideoProcessingDetails { + editorSuggestionsAvailability?: string; + fileDetailsAvailability?: string; + processingFailureReason?: string; + processingIssuesAvailability?: string; + processingProgress?: Youtube_v3.Schema.VideoProcessingDetailsProcessingProgress; + processingStatus?: string; + tagSuggestionsAvailability?: string; + thumbnailsAvailability?: string; + } + export interface VideoProcessingDetailsProcessingProgress { + partsProcessed?: string; + partsTotal?: string; + timeLeftMs?: string; + } + export interface VideoProjectDetails { + tags?: string[]; + } + export interface VideoRating { + rating?: string; + videoId?: string; + } + export interface VideoRecordingDetails { + location?: Youtube_v3.Schema.GeoPoint; + locationDescription?: string; + recordingDate?: string; + } + export interface VideoSnippet { + categoryId?: string; + channelId?: string; + channelTitle?: string; + defaultAudioLanguage?: string; + defaultLanguage?: string; + description?: string; + liveBroadcastContent?: string; + localized?: Youtube_v3.Schema.VideoLocalization; + publishedAt?: string; + tags?: string[]; + thumbnails?: Youtube_v3.Schema.ThumbnailDetails; + title?: string; + } + export interface VideoStatistics { + commentCount?: string; + dislikeCount?: string; + favoriteCount?: string; + likeCount?: string; + viewCount?: string; + } + export interface VideoStatus { + embeddable?: boolean; + failureReason?: string; + license?: string; + privacyStatus?: string; + publicStatsViewable?: boolean; + publishAt?: string; + rejectionReason?: string; + uploadStatus?: string; + } + export interface VideoSuggestions { + editorSuggestions?: string[]; + processingErrors?: string[]; + processingHints?: string[]; + processingWarnings?: string[]; + tagSuggestions?: Youtube_v3.Schema.VideoSuggestionsTagSuggestion[]; + } + export interface VideoSuggestionsTagSuggestion { + categoryRestricts?: string[]; + tag?: string; + } + export interface VideoTopicDetails { + relevantTopicIds?: string[]; + topicCategories?: string[]; + topicIds?: string[]; + } + export interface WatchSettings { + backgroundColor?: string; + featuredPlaylistId?: string; + textColor?: string; + } + } + } + export interface Youtube_v3 { + Activities?: Youtube_v3.Collection.ActivitiesCollection; + Captions?: Youtube_v3.Collection.CaptionsCollection; + ChannelBanners?: Youtube_v3.Collection.ChannelBannersCollection; + ChannelSections?: Youtube_v3.Collection.ChannelSectionsCollection; + Channels?: Youtube_v3.Collection.ChannelsCollection; + CommentThreads?: Youtube_v3.Collection.CommentThreadsCollection; + Comments?: Youtube_v3.Collection.CommentsCollection; + GuideCategories?: Youtube_v3.Collection.GuideCategoriesCollection; + I18nLanguages?: Youtube_v3.Collection.I18nLanguagesCollection; + I18nRegions?: Youtube_v3.Collection.I18nRegionsCollection; + LiveBroadcasts?: Youtube_v3.Collection.LiveBroadcastsCollection; + LiveChatBans?: Youtube_v3.Collection.LiveChatBansCollection; + LiveChatMessages?: Youtube_v3.Collection.LiveChatMessagesCollection; + LiveChatModerators?: Youtube_v3.Collection.LiveChatModeratorsCollection; + LiveStreams?: Youtube_v3.Collection.LiveStreamsCollection; + PlaylistItems?: Youtube_v3.Collection.PlaylistItemsCollection; + Playlists?: Youtube_v3.Collection.PlaylistsCollection; + Search?: Youtube_v3.Collection.SearchCollection; + Sponsors?: Youtube_v3.Collection.SponsorsCollection; + Subscriptions?: Youtube_v3.Collection.SubscriptionsCollection; + SuperChatEvents?: Youtube_v3.Collection.SuperChatEventsCollection; + Thumbnails?: Youtube_v3.Collection.ThumbnailsCollection; + VideoAbuseReportReasons?: Youtube_v3.Collection.VideoAbuseReportReasonsCollection; + VideoCategories?: Youtube_v3.Collection.VideoCategoriesCollection; + Videos?: Youtube_v3.Collection.VideosCollection; + Watermarks?: Youtube_v3.Collection.WatermarksCollection; + // Create a new instance of AccessPolicy + newAccessPolicy(): Youtube_v3.Schema.AccessPolicy; + // Create a new instance of Activity + newActivity(): Youtube_v3.Schema.Activity; + // Create a new instance of ActivityContentDetails + newActivityContentDetails(): Youtube_v3.Schema.ActivityContentDetails; + // Create a new instance of ActivityContentDetailsBulletin + newActivityContentDetailsBulletin(): Youtube_v3.Schema.ActivityContentDetailsBulletin; + // Create a new instance of ActivityContentDetailsChannelItem + newActivityContentDetailsChannelItem(): Youtube_v3.Schema.ActivityContentDetailsChannelItem; + // Create a new instance of ActivityContentDetailsComment + newActivityContentDetailsComment(): Youtube_v3.Schema.ActivityContentDetailsComment; + // Create a new instance of ActivityContentDetailsFavorite + newActivityContentDetailsFavorite(): Youtube_v3.Schema.ActivityContentDetailsFavorite; + // Create a new instance of ActivityContentDetailsLike + newActivityContentDetailsLike(): Youtube_v3.Schema.ActivityContentDetailsLike; + // Create a new instance of ActivityContentDetailsPlaylistItem + newActivityContentDetailsPlaylistItem(): Youtube_v3.Schema.ActivityContentDetailsPlaylistItem; + // Create a new instance of ActivityContentDetailsPromotedItem + newActivityContentDetailsPromotedItem(): Youtube_v3.Schema.ActivityContentDetailsPromotedItem; + // Create a new instance of ActivityContentDetailsRecommendation + newActivityContentDetailsRecommendation(): Youtube_v3.Schema.ActivityContentDetailsRecommendation; + // Create a new instance of ActivityContentDetailsSocial + newActivityContentDetailsSocial(): Youtube_v3.Schema.ActivityContentDetailsSocial; + // Create a new instance of ActivityContentDetailsSubscription + newActivityContentDetailsSubscription(): Youtube_v3.Schema.ActivityContentDetailsSubscription; + // Create a new instance of ActivityContentDetailsUpload + newActivityContentDetailsUpload(): Youtube_v3.Schema.ActivityContentDetailsUpload; + // Create a new instance of ActivitySnippet + newActivitySnippet(): Youtube_v3.Schema.ActivitySnippet; + // Create a new instance of Caption + newCaption(): Youtube_v3.Schema.Caption; + // Create a new instance of CaptionSnippet + newCaptionSnippet(): Youtube_v3.Schema.CaptionSnippet; + // Create a new instance of CdnSettings + newCdnSettings(): Youtube_v3.Schema.CdnSettings; + // Create a new instance of Channel + newChannel(): Youtube_v3.Schema.Channel; + // Create a new instance of ChannelAuditDetails + newChannelAuditDetails(): Youtube_v3.Schema.ChannelAuditDetails; + // Create a new instance of ChannelBannerResource + newChannelBannerResource(): Youtube_v3.Schema.ChannelBannerResource; + // Create a new instance of ChannelBrandingSettings + newChannelBrandingSettings(): Youtube_v3.Schema.ChannelBrandingSettings; + // Create a new instance of ChannelContentDetails + newChannelContentDetails(): Youtube_v3.Schema.ChannelContentDetails; + // Create a new instance of ChannelContentDetailsRelatedPlaylists + newChannelContentDetailsRelatedPlaylists(): Youtube_v3.Schema.ChannelContentDetailsRelatedPlaylists; + // Create a new instance of ChannelContentOwnerDetails + newChannelContentOwnerDetails(): Youtube_v3.Schema.ChannelContentOwnerDetails; + // Create a new instance of ChannelConversionPing + newChannelConversionPing(): Youtube_v3.Schema.ChannelConversionPing; + // Create a new instance of ChannelConversionPings + newChannelConversionPings(): Youtube_v3.Schema.ChannelConversionPings; + // Create a new instance of ChannelLocalization + newChannelLocalization(): Youtube_v3.Schema.ChannelLocalization; + // Create a new instance of ChannelProfileDetails + newChannelProfileDetails(): Youtube_v3.Schema.ChannelProfileDetails; + // Create a new instance of ChannelSection + newChannelSection(): Youtube_v3.Schema.ChannelSection; + // Create a new instance of ChannelSectionContentDetails + newChannelSectionContentDetails(): Youtube_v3.Schema.ChannelSectionContentDetails; + // Create a new instance of ChannelSectionLocalization + newChannelSectionLocalization(): Youtube_v3.Schema.ChannelSectionLocalization; + // Create a new instance of ChannelSectionSnippet + newChannelSectionSnippet(): Youtube_v3.Schema.ChannelSectionSnippet; + // Create a new instance of ChannelSectionTargeting + newChannelSectionTargeting(): Youtube_v3.Schema.ChannelSectionTargeting; + // Create a new instance of ChannelSettings + newChannelSettings(): Youtube_v3.Schema.ChannelSettings; + // Create a new instance of ChannelSnippet + newChannelSnippet(): Youtube_v3.Schema.ChannelSnippet; + // Create a new instance of ChannelStatistics + newChannelStatistics(): Youtube_v3.Schema.ChannelStatistics; + // Create a new instance of ChannelStatus + newChannelStatus(): Youtube_v3.Schema.ChannelStatus; + // Create a new instance of ChannelTopicDetails + newChannelTopicDetails(): Youtube_v3.Schema.ChannelTopicDetails; + // Create a new instance of Comment + newComment(): Youtube_v3.Schema.Comment; + // Create a new instance of CommentSnippet + newCommentSnippet(): Youtube_v3.Schema.CommentSnippet; + // Create a new instance of CommentThread + newCommentThread(): Youtube_v3.Schema.CommentThread; + // Create a new instance of CommentThreadReplies + newCommentThreadReplies(): Youtube_v3.Schema.CommentThreadReplies; + // Create a new instance of CommentThreadSnippet + newCommentThreadSnippet(): Youtube_v3.Schema.CommentThreadSnippet; + // Create a new instance of ContentRating + newContentRating(): Youtube_v3.Schema.ContentRating; + // Create a new instance of GeoPoint + newGeoPoint(): Youtube_v3.Schema.GeoPoint; + // Create a new instance of ImageSettings + newImageSettings(): Youtube_v3.Schema.ImageSettings; + // Create a new instance of IngestionInfo + newIngestionInfo(): Youtube_v3.Schema.IngestionInfo; + // Create a new instance of InvideoBranding + newInvideoBranding(): Youtube_v3.Schema.InvideoBranding; + // Create a new instance of InvideoPosition + newInvideoPosition(): Youtube_v3.Schema.InvideoPosition; + // Create a new instance of InvideoPromotion + newInvideoPromotion(): Youtube_v3.Schema.InvideoPromotion; + // Create a new instance of InvideoTiming + newInvideoTiming(): Youtube_v3.Schema.InvideoTiming; + // Create a new instance of LanguageTag + newLanguageTag(): Youtube_v3.Schema.LanguageTag; + // Create a new instance of LiveBroadcast + newLiveBroadcast(): Youtube_v3.Schema.LiveBroadcast; + // Create a new instance of LiveBroadcastContentDetails + newLiveBroadcastContentDetails(): Youtube_v3.Schema.LiveBroadcastContentDetails; + // Create a new instance of LiveBroadcastSnippet + newLiveBroadcastSnippet(): Youtube_v3.Schema.LiveBroadcastSnippet; + // Create a new instance of LiveBroadcastStatistics + newLiveBroadcastStatistics(): Youtube_v3.Schema.LiveBroadcastStatistics; + // Create a new instance of LiveBroadcastStatus + newLiveBroadcastStatus(): Youtube_v3.Schema.LiveBroadcastStatus; + // Create a new instance of LiveChatBan + newLiveChatBan(): Youtube_v3.Schema.LiveChatBan; + // Create a new instance of LiveChatBanSnippet + newLiveChatBanSnippet(): Youtube_v3.Schema.LiveChatBanSnippet; + // Create a new instance of LiveChatFanFundingEventDetails + newLiveChatFanFundingEventDetails(): Youtube_v3.Schema.LiveChatFanFundingEventDetails; + // Create a new instance of LiveChatMessage + newLiveChatMessage(): Youtube_v3.Schema.LiveChatMessage; + // Create a new instance of LiveChatMessageAuthorDetails + newLiveChatMessageAuthorDetails(): Youtube_v3.Schema.LiveChatMessageAuthorDetails; + // Create a new instance of LiveChatMessageDeletedDetails + newLiveChatMessageDeletedDetails(): Youtube_v3.Schema.LiveChatMessageDeletedDetails; + // Create a new instance of LiveChatMessageRetractedDetails + newLiveChatMessageRetractedDetails(): Youtube_v3.Schema.LiveChatMessageRetractedDetails; + // Create a new instance of LiveChatMessageSnippet + newLiveChatMessageSnippet(): Youtube_v3.Schema.LiveChatMessageSnippet; + // Create a new instance of LiveChatModerator + newLiveChatModerator(): Youtube_v3.Schema.LiveChatModerator; + // Create a new instance of LiveChatModeratorSnippet + newLiveChatModeratorSnippet(): Youtube_v3.Schema.LiveChatModeratorSnippet; + // Create a new instance of LiveChatPollClosedDetails + newLiveChatPollClosedDetails(): Youtube_v3.Schema.LiveChatPollClosedDetails; + // Create a new instance of LiveChatPollEditedDetails + newLiveChatPollEditedDetails(): Youtube_v3.Schema.LiveChatPollEditedDetails; + // Create a new instance of LiveChatPollItem + newLiveChatPollItem(): Youtube_v3.Schema.LiveChatPollItem; + // Create a new instance of LiveChatPollOpenedDetails + newLiveChatPollOpenedDetails(): Youtube_v3.Schema.LiveChatPollOpenedDetails; + // Create a new instance of LiveChatPollVotedDetails + newLiveChatPollVotedDetails(): Youtube_v3.Schema.LiveChatPollVotedDetails; + // Create a new instance of LiveChatSuperChatDetails + newLiveChatSuperChatDetails(): Youtube_v3.Schema.LiveChatSuperChatDetails; + // Create a new instance of LiveChatSuperStickerDetails + newLiveChatSuperStickerDetails(): Youtube_v3.Schema.LiveChatSuperStickerDetails; + // Create a new instance of LiveChatTextMessageDetails + newLiveChatTextMessageDetails(): Youtube_v3.Schema.LiveChatTextMessageDetails; + // Create a new instance of LiveChatUserBannedMessageDetails + newLiveChatUserBannedMessageDetails(): Youtube_v3.Schema.LiveChatUserBannedMessageDetails; + // Create a new instance of LiveStream + newLiveStream(): Youtube_v3.Schema.LiveStream; + // Create a new instance of LiveStreamConfigurationIssue + newLiveStreamConfigurationIssue(): Youtube_v3.Schema.LiveStreamConfigurationIssue; + // Create a new instance of LiveStreamContentDetails + newLiveStreamContentDetails(): Youtube_v3.Schema.LiveStreamContentDetails; + // Create a new instance of LiveStreamHealthStatus + newLiveStreamHealthStatus(): Youtube_v3.Schema.LiveStreamHealthStatus; + // Create a new instance of LiveStreamSnippet + newLiveStreamSnippet(): Youtube_v3.Schema.LiveStreamSnippet; + // Create a new instance of LiveStreamStatus + newLiveStreamStatus(): Youtube_v3.Schema.LiveStreamStatus; + // Create a new instance of LocalizedProperty + newLocalizedProperty(): Youtube_v3.Schema.LocalizedProperty; + // Create a new instance of LocalizedString + newLocalizedString(): Youtube_v3.Schema.LocalizedString; + // Create a new instance of MonitorStreamInfo + newMonitorStreamInfo(): Youtube_v3.Schema.MonitorStreamInfo; + // Create a new instance of Playlist + newPlaylist(): Youtube_v3.Schema.Playlist; + // Create a new instance of PlaylistContentDetails + newPlaylistContentDetails(): Youtube_v3.Schema.PlaylistContentDetails; + // Create a new instance of PlaylistItem + newPlaylistItem(): Youtube_v3.Schema.PlaylistItem; + // Create a new instance of PlaylistItemContentDetails + newPlaylistItemContentDetails(): Youtube_v3.Schema.PlaylistItemContentDetails; + // Create a new instance of PlaylistItemSnippet + newPlaylistItemSnippet(): Youtube_v3.Schema.PlaylistItemSnippet; + // Create a new instance of PlaylistItemStatus + newPlaylistItemStatus(): Youtube_v3.Schema.PlaylistItemStatus; + // Create a new instance of PlaylistLocalization + newPlaylistLocalization(): Youtube_v3.Schema.PlaylistLocalization; + // Create a new instance of PlaylistPlayer + newPlaylistPlayer(): Youtube_v3.Schema.PlaylistPlayer; + // Create a new instance of PlaylistSnippet + newPlaylistSnippet(): Youtube_v3.Schema.PlaylistSnippet; + // Create a new instance of PlaylistStatus + newPlaylistStatus(): Youtube_v3.Schema.PlaylistStatus; + // Create a new instance of PromotedItem + newPromotedItem(): Youtube_v3.Schema.PromotedItem; + // Create a new instance of PromotedItemId + newPromotedItemId(): Youtube_v3.Schema.PromotedItemId; + // Create a new instance of PropertyValue + newPropertyValue(): Youtube_v3.Schema.PropertyValue; + // Create a new instance of ResourceId + newResourceId(): Youtube_v3.Schema.ResourceId; + // Create a new instance of Subscription + newSubscription(): Youtube_v3.Schema.Subscription; + // Create a new instance of SubscriptionContentDetails + newSubscriptionContentDetails(): Youtube_v3.Schema.SubscriptionContentDetails; + // Create a new instance of SubscriptionSnippet + newSubscriptionSnippet(): Youtube_v3.Schema.SubscriptionSnippet; + // Create a new instance of SubscriptionSubscriberSnippet + newSubscriptionSubscriberSnippet(): Youtube_v3.Schema.SubscriptionSubscriberSnippet; + // Create a new instance of SuperStickerMetadata + newSuperStickerMetadata(): Youtube_v3.Schema.SuperStickerMetadata; + // Create a new instance of Thumbnail + newThumbnail(): Youtube_v3.Schema.Thumbnail; + // Create a new instance of ThumbnailDetails + newThumbnailDetails(): Youtube_v3.Schema.ThumbnailDetails; + // Create a new instance of Video + newVideo(): Youtube_v3.Schema.Video; + // Create a new instance of VideoAbuseReport + newVideoAbuseReport(): Youtube_v3.Schema.VideoAbuseReport; + // Create a new instance of VideoAgeGating + newVideoAgeGating(): Youtube_v3.Schema.VideoAgeGating; + // Create a new instance of VideoContentDetails + newVideoContentDetails(): Youtube_v3.Schema.VideoContentDetails; + // Create a new instance of VideoContentDetailsRegionRestriction + newVideoContentDetailsRegionRestriction(): Youtube_v3.Schema.VideoContentDetailsRegionRestriction; + // Create a new instance of VideoFileDetails + newVideoFileDetails(): Youtube_v3.Schema.VideoFileDetails; + // Create a new instance of VideoFileDetailsAudioStream + newVideoFileDetailsAudioStream(): Youtube_v3.Schema.VideoFileDetailsAudioStream; + // Create a new instance of VideoFileDetailsVideoStream + newVideoFileDetailsVideoStream(): Youtube_v3.Schema.VideoFileDetailsVideoStream; + // Create a new instance of VideoLiveStreamingDetails + newVideoLiveStreamingDetails(): Youtube_v3.Schema.VideoLiveStreamingDetails; + // Create a new instance of VideoLocalization + newVideoLocalization(): Youtube_v3.Schema.VideoLocalization; + // Create a new instance of VideoMonetizationDetails + newVideoMonetizationDetails(): Youtube_v3.Schema.VideoMonetizationDetails; + // Create a new instance of VideoPlayer + newVideoPlayer(): Youtube_v3.Schema.VideoPlayer; + // Create a new instance of VideoProcessingDetails + newVideoProcessingDetails(): Youtube_v3.Schema.VideoProcessingDetails; + // Create a new instance of VideoProcessingDetailsProcessingProgress + newVideoProcessingDetailsProcessingProgress(): Youtube_v3.Schema.VideoProcessingDetailsProcessingProgress; + // Create a new instance of VideoProjectDetails + newVideoProjectDetails(): Youtube_v3.Schema.VideoProjectDetails; + // Create a new instance of VideoRecordingDetails + newVideoRecordingDetails(): Youtube_v3.Schema.VideoRecordingDetails; + // Create a new instance of VideoSnippet + newVideoSnippet(): Youtube_v3.Schema.VideoSnippet; + // Create a new instance of VideoStatistics + newVideoStatistics(): Youtube_v3.Schema.VideoStatistics; + // Create a new instance of VideoStatus + newVideoStatus(): Youtube_v3.Schema.VideoStatus; + // Create a new instance of VideoSuggestions + newVideoSuggestions(): Youtube_v3.Schema.VideoSuggestions; + // Create a new instance of VideoSuggestionsTagSuggestion + newVideoSuggestionsTagSuggestion(): Youtube_v3.Schema.VideoSuggestionsTagSuggestion; + // Create a new instance of VideoTopicDetails + newVideoTopicDetails(): Youtube_v3.Schema.VideoTopicDetails; + // Create a new instance of WatchSettings + newWatchSettings(): Youtube_v3.Schema.WatchSettings; + } +} + +declare var Youtube_v3: GoogleAppsScript.Youtube_v3; \ No newline at end of file diff --git a/types/google-apps-script/apis/youtubeanalytics_v2.d.ts b/types/google-apps-script/apis/youtubeanalytics_v2.d.ts new file mode 100644 index 0000000000..df59e7eb33 --- /dev/null +++ b/types/google-apps-script/apis/youtubeanalytics_v2.d.ts @@ -0,0 +1,146 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace YoutubeAnalytics_v2 { + namespace Collection { + export interface GroupItemsCollection { + // Creates a group item. + insert(resource: Schema.GroupItem): YoutubeAnalytics_v2.Schema.GroupItem; + // Creates a group item. + insert(resource: Schema.GroupItem, optionalArgs: object): YoutubeAnalytics_v2.Schema.GroupItem; + // Returns a collection of group items that match the API request parameters. + list(): YoutubeAnalytics_v2.Schema.ListGroupItemsResponse; + // Returns a collection of group items that match the API request parameters. + list(optionalArgs: object): YoutubeAnalytics_v2.Schema.ListGroupItemsResponse; + // Removes an item from a group. + remove(): YoutubeAnalytics_v2.Schema.EmptyResponse; + // Removes an item from a group. + remove(optionalArgs: object): YoutubeAnalytics_v2.Schema.EmptyResponse; + } + export interface GroupsCollection { + // Creates a group. + insert(resource: Schema.Group): YoutubeAnalytics_v2.Schema.Group; + // Creates a group. + insert(resource: Schema.Group, optionalArgs: object): YoutubeAnalytics_v2.Schema.Group; + // Returns a collection of groups that match the API request parameters. For + // example, you can retrieve all groups that the authenticated user owns, + // or you can retrieve one or more groups by their unique IDs. + list(): YoutubeAnalytics_v2.Schema.ListGroupsResponse; + // Returns a collection of groups that match the API request parameters. For + // example, you can retrieve all groups that the authenticated user owns, + // or you can retrieve one or more groups by their unique IDs. + list(optionalArgs: object): YoutubeAnalytics_v2.Schema.ListGroupsResponse; + // Deletes a group. + remove(): YoutubeAnalytics_v2.Schema.EmptyResponse; + // Deletes a group. + remove(optionalArgs: object): YoutubeAnalytics_v2.Schema.EmptyResponse; + // Modifies a group. For example, you could change a group's title. + update(resource: Schema.Group): YoutubeAnalytics_v2.Schema.Group; + // Modifies a group. For example, you could change a group's title. + update(resource: Schema.Group, optionalArgs: object): YoutubeAnalytics_v2.Schema.Group; + } + export interface ReportsCollection { + // Retrieve your YouTube Analytics reports. + query(): YoutubeAnalytics_v2.Schema.QueryResponse; + // Retrieve your YouTube Analytics reports. + query(optionalArgs: object): YoutubeAnalytics_v2.Schema.QueryResponse; + } + } + namespace Schema { + export interface EmptyResponse { + errors?: YoutubeAnalytics_v2.Schema.Errors; + } + export interface ErrorProto { + argument?: string[]; + code?: string; + debugInfo?: string; + domain?: string; + externalErrorMessage?: string; + location?: string; + locationType?: string; + } + export interface Errors { + code?: string; + error?: YoutubeAnalytics_v2.Schema.ErrorProto[]; + requestId?: string; + } + export interface Group { + contentDetails?: YoutubeAnalytics_v2.Schema.GroupContentDetails; + errors?: YoutubeAnalytics_v2.Schema.Errors; + etag?: string; + id?: string; + kind?: string; + snippet?: YoutubeAnalytics_v2.Schema.GroupSnippet; + } + export interface GroupContentDetails { + itemCount?: string; + itemType?: string; + } + export interface GroupItem { + errors?: YoutubeAnalytics_v2.Schema.Errors; + etag?: string; + groupId?: string; + id?: string; + kind?: string; + resource?: YoutubeAnalytics_v2.Schema.GroupItemResource; + } + export interface GroupItemResource { + id?: string; + kind?: string; + } + export interface GroupSnippet { + publishedAt?: string; + title?: string; + } + export interface ListGroupItemsResponse { + errors?: YoutubeAnalytics_v2.Schema.Errors; + etag?: string; + items?: YoutubeAnalytics_v2.Schema.GroupItem[]; + kind?: string; + } + export interface ListGroupsResponse { + errors?: YoutubeAnalytics_v2.Schema.Errors; + etag?: string; + items?: YoutubeAnalytics_v2.Schema.Group[]; + kind?: string; + nextPageToken?: string; + } + export interface QueryResponse { + columnHeaders?: YoutubeAnalytics_v2.Schema.ResultTableColumnHeader[]; + errors?: YoutubeAnalytics_v2.Schema.Errors; + kind?: string; + rows?: Object[][]; + } + export interface ResultTableColumnHeader { + columnType?: string; + dataType?: string; + name?: string; + } + } + } + export interface YoutubeAnalytics_v2 { + GroupItems?: YoutubeAnalytics_v2.Collection.GroupItemsCollection; + Groups?: YoutubeAnalytics_v2.Collection.GroupsCollection; + Reports?: YoutubeAnalytics_v2.Collection.ReportsCollection; + // Create a new instance of ErrorProto + newErrorProto(): YoutubeAnalytics_v2.Schema.ErrorProto; + // Create a new instance of Errors + newErrors(): YoutubeAnalytics_v2.Schema.Errors; + // Create a new instance of Group + newGroup(): YoutubeAnalytics_v2.Schema.Group; + // Create a new instance of GroupContentDetails + newGroupContentDetails(): YoutubeAnalytics_v2.Schema.GroupContentDetails; + // Create a new instance of GroupItem + newGroupItem(): YoutubeAnalytics_v2.Schema.GroupItem; + // Create a new instance of GroupItemResource + newGroupItemResource(): YoutubeAnalytics_v2.Schema.GroupItemResource; + // Create a new instance of GroupSnippet + newGroupSnippet(): YoutubeAnalytics_v2.Schema.GroupSnippet; + } +} + +declare var YoutubeAnalytics_v2: GoogleAppsScript.YoutubeAnalytics_v2; \ No newline at end of file diff --git a/types/google-apps-script/apis/youtubepartner_v1.d.ts b/types/google-apps-script/apis/youtubepartner_v1.d.ts new file mode 100644 index 0000000000..c376e52320 --- /dev/null +++ b/types/google-apps-script/apis/youtubepartner_v1.d.ts @@ -0,0 +1,1142 @@ +// Type definitions for Google Apps Script 2019-03-25 +// Project: https://developers.google.com/apps-script/ +// Generator: https://github.com/grant/google-apps-script-dts +// Definitions by: grant +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare namespace GoogleAppsScript { + namespace YoutubePartner_v1 { + namespace Collection { + export interface AssetLabelsCollection { + // Insert an asset label for an owner. + insert(resource: Schema.AssetLabel): YoutubePartner_v1.Schema.AssetLabel; + // Insert an asset label for an owner. + insert(resource: Schema.AssetLabel, optionalArgs: object): YoutubePartner_v1.Schema.AssetLabel; + // Retrieves a list of all asset labels for an owner. + list(): YoutubePartner_v1.Schema.AssetLabelListResponse; + // Retrieves a list of all asset labels for an owner. + list(optionalArgs: object): YoutubePartner_v1.Schema.AssetLabelListResponse; + } + export 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_v1.Schema.AssetMatchPolicy; + // Retrieves the match policy assigned to the specified asset by the content owner associated with the authenticated user. This information is only accessible to an owner of the asset. + get(assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.AssetMatchPolicy; + // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. This method supports patch semantics. + patch(resource: Schema.AssetMatchPolicy, assetId: string): YoutubePartner_v1.Schema.AssetMatchPolicy; + // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. This method supports patch semantics. + patch(resource: Schema.AssetMatchPolicy, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.AssetMatchPolicy; + // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. + update(resource: Schema.AssetMatchPolicy, assetId: string): YoutubePartner_v1.Schema.AssetMatchPolicy; + // Updates the asset's match policy. If an asset has multiple owners, each owner may set its own match policy for the asset. YouTube then computes the match policy that is actually applied for the asset based on the territories where each owner owns the asset. + update(resource: Schema.AssetMatchPolicy, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.AssetMatchPolicy; + } + export interface AssetRelationshipsCollection { + // Creates a relationship that links two assets. + insert(resource: Schema.AssetRelationship): YoutubePartner_v1.Schema.AssetRelationship; + // Creates a relationship that links two assets. + insert(resource: Schema.AssetRelationship, optionalArgs: object): YoutubePartner_v1.Schema.AssetRelationship; + // Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship. + list(assetId: string): YoutubePartner_v1.Schema.AssetRelationshipListResponse; + // Retrieves a list of relationships for a given asset. The list contains relationships where the specified asset is either the parent (embedding) or child (embedded) asset in the relationship. + list(assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.AssetRelationshipListResponse; + // Deletes a relationship between two assets. + remove(assetRelationshipId: string): void; + // Deletes a relationship between two assets. + remove(assetRelationshipId: string, optionalArgs: object): void; + } + export 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_v1.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_v1.Schema.AssetSearchResponse; + } + export 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_v1.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_v1.Schema.AssetShareListResponse; + } + export 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_v1.Schema.Asset; + // Retrieves the metadata for the specified asset. Note that if the request identifies an asset that has been merged with another asset, meaning that YouTube identified the requested asset as a duplicate, then the request retrieves the merged, or synthesized, asset. + get(assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.Asset; + // Inserts an asset with the specified metadata. After inserting an asset, you can set its ownership data and match policy. + insert(resource: Schema.Asset): YoutubePartner_v1.Schema.Asset; + // Inserts an asset with the specified metadata. After inserting an asset, you can set its ownership data and match policy. + insert(resource: Schema.Asset, optionalArgs: object): YoutubePartner_v1.Schema.Asset; + // Retrieves a list of assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. + // Note that in cases where duplicate assets have been merged, the API response only contains the synthesized asset. (It does not contain the constituent assets that were merged into the synthesized asset.) + list(id: string): YoutubePartner_v1.Schema.AssetListResponse; + // Retrieves a list of assets based on asset metadata. The method can retrieve all assets or only assets owned by the content owner. + // Note that in cases where duplicate assets have been merged, the API response only contains the synthesized asset. (It does not contain the constituent assets that were merged into the synthesized asset.) + list(id: string, optionalArgs: object): YoutubePartner_v1.Schema.AssetListResponse; + // Updates the metadata for the specified asset. This method supports patch semantics. + patch(resource: Schema.Asset, assetId: string): YoutubePartner_v1.Schema.Asset; + // Updates the metadata for the specified asset. This method supports patch semantics. + patch(resource: Schema.Asset, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.Asset; + // Updates the metadata for the specified asset. + update(resource: Schema.Asset, assetId: string): YoutubePartner_v1.Schema.Asset; + // Updates the metadata for the specified asset. + update(resource: Schema.Asset, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.Asset; + } + export interface CampaignsCollection { + // Retrieves a particular campaign for an owner. + get(campaignId: string): YoutubePartner_v1.Schema.Campaign; + // Retrieves a particular campaign for an owner. + get(campaignId: string, optionalArgs: object): YoutubePartner_v1.Schema.Campaign; + // Insert a new campaign for an owner using the specified campaign data. + insert(resource: Schema.Campaign): YoutubePartner_v1.Schema.Campaign; + // Insert a new campaign for an owner using the specified campaign data. + insert(resource: Schema.Campaign, optionalArgs: object): YoutubePartner_v1.Schema.Campaign; + // Retrieves a list of campaigns for an owner. + list(): YoutubePartner_v1.Schema.CampaignList; + // Retrieves a list of campaigns for an owner. + list(optionalArgs: object): YoutubePartner_v1.Schema.CampaignList; + // Update the data for a specific campaign. This method supports patch semantics. + patch(resource: Schema.Campaign, campaignId: string): YoutubePartner_v1.Schema.Campaign; + // Update the data for a specific campaign. This method supports patch semantics. + patch(resource: Schema.Campaign, campaignId: string, optionalArgs: object): YoutubePartner_v1.Schema.Campaign; + // Deletes a specified campaign for an owner. + remove(campaignId: string): void; + // Deletes a specified campaign for an owner. + remove(campaignId: string, optionalArgs: object): void; + // Update the data for a specific campaign. + update(resource: Schema.Campaign, campaignId: string): YoutubePartner_v1.Schema.Campaign; + // Update the data for a specific campaign. + update(resource: Schema.Campaign, campaignId: string, optionalArgs: object): YoutubePartner_v1.Schema.Campaign; + } + export interface ClaimHistoryCollection { + // Retrieves the claim history for a specified claim. + get(claimId: string): YoutubePartner_v1.Schema.ClaimHistory; + // Retrieves the claim history for a specified claim. + get(claimId: string, optionalArgs: object): YoutubePartner_v1.Schema.ClaimHistory; + } + export 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_v1.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_v1.Schema.ClaimSearchResponse; + } + export interface ClaimsCollection { + // Retrieves a specific claim by ID. + get(claimId: string): YoutubePartner_v1.Schema.Claim; + // Retrieves a specific claim by ID. + get(claimId: string, optionalArgs: object): YoutubePartner_v1.Schema.Claim; + // Creates a claim. The video being claimed must have been uploaded to a channel associated with the same content owner as the API user sending the request. You can set the claim's policy in any of the following ways: + // - Use the claim resource's policy property to identify a saved policy by its unique ID. + // - Use the claim resource's policy property to specify a custom set of rules. + insert(resource: Schema.Claim): YoutubePartner_v1.Schema.Claim; + // Creates a claim. The video being claimed must have been uploaded to a channel associated with the same content owner as the API user sending the request. You can set the claim's policy in any of the following ways: + // - Use the claim resource's policy property to identify a saved policy by its unique ID. + // - Use the claim resource's policy property to specify a custom set of rules. + insert(resource: Schema.Claim, optionalArgs: object): YoutubePartner_v1.Schema.Claim; + // Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time. + list(): YoutubePartner_v1.Schema.ClaimListResponse; + // Retrieves a list of claims administered by the content owner associated with the currently authenticated user. Results are sorted in descending order of creation time. + list(optionalArgs: object): YoutubePartner_v1.Schema.ClaimListResponse; + // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. This method supports patch semantics. + patch(resource: Schema.Claim, claimId: string): YoutubePartner_v1.Schema.Claim; + // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. This method supports patch semantics. + patch(resource: Schema.Claim, claimId: string, optionalArgs: object): YoutubePartner_v1.Schema.Claim; + // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. + update(resource: Schema.Claim, claimId: string): YoutubePartner_v1.Schema.Claim; + // Updates an existing claim by either changing its policy or its status. You can update a claim's status from active to inactive to effectively release the claim. + update(resource: Schema.Claim, claimId: string, optionalArgs: object): YoutubePartner_v1.Schema.Claim; + } + export interface ContentOwnerAdvertisingOptionsCollection { + // Retrieves advertising options for the content owner associated with the authenticated user. + get(): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Retrieves advertising options for the content owner associated with the authenticated user. + get(optionalArgs: object): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Updates advertising options for the content owner associated with the authenticated API user. This method supports patch semantics. + patch(resource: Schema.ContentOwnerAdvertisingOption): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Updates advertising options for the content owner associated with the authenticated API user. This method supports patch semantics. + patch(resource: Schema.ContentOwnerAdvertisingOption, optionalArgs: object): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Updates advertising options for the content owner associated with the authenticated API user. + update(resource: Schema.ContentOwnerAdvertisingOption): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Updates advertising options for the content owner associated with the authenticated API user. + update(resource: Schema.ContentOwnerAdvertisingOption, optionalArgs: object): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + } + export interface ContentOwnersCollection { + // Retrieves information about the specified content owner. + get(contentOwnerId: string): YoutubePartner_v1.Schema.ContentOwner; + // Retrieves information about the specified content owner. + get(contentOwnerId: string, optionalArgs: object): YoutubePartner_v1.Schema.ContentOwner; + // Retrieves a list of content owners that match the request criteria. + list(): YoutubePartner_v1.Schema.ContentOwnerListResponse; + // Retrieves a list of content owners that match the request criteria. + list(optionalArgs: object): YoutubePartner_v1.Schema.ContentOwnerListResponse; + } + export interface LiveCuepointsCollection { + // Inserts a cuepoint into a live broadcast. + insert(resource: Schema.LiveCuepoint, channelId: string): YoutubePartner_v1.Schema.LiveCuepoint; + // Inserts a cuepoint into a live broadcast. + insert(resource: Schema.LiveCuepoint, channelId: string, optionalArgs: object): YoutubePartner_v1.Schema.LiveCuepoint; + } + export interface MetadataHistoryCollection { + // Retrieves a list of all metadata provided for an asset, regardless of which content owner provided the data. + list(assetId: string): YoutubePartner_v1.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_v1.Schema.MetadataHistoryListResponse; + } + export interface OrdersCollection { + // Retrieve the details of an existing order. + get(orderId: string): YoutubePartner_v1.Schema.Order; + // Retrieve the details of an existing order. + get(orderId: string, optionalArgs: object): YoutubePartner_v1.Schema.Order; + // Creates a new basic order entry in the YouTube premium asset order management system. You must supply at least a country and channel in the new order. + insert(resource: Schema.Order): YoutubePartner_v1.Schema.Order; + // Creates a new basic order entry in the YouTube premium asset order management system. You must supply at least a country and channel in the new order. + insert(resource: Schema.Order, optionalArgs: object): YoutubePartner_v1.Schema.Order; + // Return a list of orders, filtered by the parameters below, may return more than a single page of results. + list(): YoutubePartner_v1.Schema.OrderListResponse; + // Return a list of orders, filtered by the parameters below, may return more than a single page of results. + list(optionalArgs: object): YoutubePartner_v1.Schema.OrderListResponse; + // Update the values in an existing order. This method supports patch semantics. + patch(resource: Schema.Order, orderId: string): YoutubePartner_v1.Schema.Order; + // Update the values in an existing order. This method supports patch semantics. + patch(resource: Schema.Order, orderId: string, optionalArgs: object): YoutubePartner_v1.Schema.Order; + // Delete an order, which moves orders to inactive state and removes any associated video. + remove(orderId: string): void; + // Delete an order, which moves orders to inactive state and removes any associated video. + remove(orderId: string, optionalArgs: object): void; + // Update the values in an existing order. + update(resource: Schema.Order, orderId: string): YoutubePartner_v1.Schema.Order; + // Update the values in an existing order. + update(resource: Schema.Order, orderId: string, optionalArgs: object): YoutubePartner_v1.Schema.Order; + } + export interface OwnershipCollection { + // Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user. + get(assetId: string): YoutubePartner_v1.Schema.RightsOwnership; + // Retrieves the ownership data provided for the specified asset by the content owner associated with the authenticated user. + get(assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.RightsOwnership; + // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. This method supports patch semantics. + patch(resource: Schema.RightsOwnership, assetId: string): YoutubePartner_v1.Schema.RightsOwnership; + // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. This method supports patch semantics. + patch(resource: Schema.RightsOwnership, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.RightsOwnership; + // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. + update(resource: Schema.RightsOwnership, assetId: string): YoutubePartner_v1.Schema.RightsOwnership; + // Provides new ownership information for the specified asset. Note that YouTube may receive ownership information from multiple sources. For example, if an asset has multiple owners, each owner might send ownership data for the asset. YouTube algorithmically combines the ownership data received from all of those sources to generate the asset's canonical ownership data, which should provide the most comprehensive and accurate representation of the asset's ownership. + update(resource: Schema.RightsOwnership, assetId: string, optionalArgs: object): YoutubePartner_v1.Schema.RightsOwnership; + } + export 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_v1.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_v1.Schema.OwnershipHistoryListResponse; + } + export interface PackageCollection { + // Retrieves information for the specified package. + get(packageId: string): YoutubePartner_v1.Schema.Package; + // Retrieves information for the specified package. + get(packageId: string, optionalArgs: object): YoutubePartner_v1.Schema.Package; + // Inserts a metadata-only package. + insert(resource: Schema.Package): YoutubePartner_v1.Schema.PackageInsertResponse; + // Inserts a metadata-only package. + insert(resource: Schema.Package, optionalArgs: object): YoutubePartner_v1.Schema.PackageInsertResponse; + } + export interface PoliciesCollection { + // Retrieves the specified saved policy. + get(policyId: string): YoutubePartner_v1.Schema.Policy; + // Retrieves the specified saved policy. + get(policyId: string, optionalArgs: object): YoutubePartner_v1.Schema.Policy; + // Creates a saved policy. + insert(resource: Schema.Policy): YoutubePartner_v1.Schema.Policy; + // Creates a saved policy. + insert(resource: Schema.Policy, optionalArgs: object): YoutubePartner_v1.Schema.Policy; + // Retrieves a list of the content owner's saved policies. + list(): YoutubePartner_v1.Schema.PolicyList; + // Retrieves a list of the content owner's saved policies. + list(optionalArgs: object): YoutubePartner_v1.Schema.PolicyList; + // Updates the specified saved policy. This method supports patch semantics. + patch(resource: Schema.Policy, policyId: string): YoutubePartner_v1.Schema.Policy; + // Updates the specified saved policy. This method supports patch semantics. + patch(resource: Schema.Policy, policyId: string, optionalArgs: object): YoutubePartner_v1.Schema.Policy; + // Updates the specified saved policy. + update(resource: Schema.Policy, policyId: string): YoutubePartner_v1.Schema.Policy; + // Updates the specified saved policy. + update(resource: Schema.Policy, policyId: string, optionalArgs: object): YoutubePartner_v1.Schema.Policy; + } + export interface PublishersCollection { + // Retrieves information about the specified publisher. + get(publisherId: string): YoutubePartner_v1.Schema.Publisher; + // Retrieves information about the specified publisher. + get(publisherId: string, optionalArgs: object): YoutubePartner_v1.Schema.Publisher; + // Retrieves a list of publishers that match the request criteria. This method is analogous to a publisher search function. + list(): YoutubePartner_v1.Schema.PublisherList; + // Retrieves a list of publishers that match the request criteria. This method is analogous to a publisher search function. + list(optionalArgs: object): YoutubePartner_v1.Schema.PublisherList; + } + export interface ReferenceConflictsCollection { + // Retrieves information about the specified reference conflict. + get(referenceConflictId: string): YoutubePartner_v1.Schema.ReferenceConflict; + // Retrieves information about the specified reference conflict. + get(referenceConflictId: string, optionalArgs: object): YoutubePartner_v1.Schema.ReferenceConflict; + // Retrieves a list of unresolved reference conflicts. + list(): YoutubePartner_v1.Schema.ReferenceConflictListResponse; + // Retrieves a list of unresolved reference conflicts. + list(optionalArgs: object): YoutubePartner_v1.Schema.ReferenceConflictListResponse; + } + export interface ReferencesCollection { + // Retrieves information about the specified reference. + get(referenceId: string): YoutubePartner_v1.Schema.Reference; + // Retrieves information about the specified reference. + get(referenceId: string, optionalArgs: object): YoutubePartner_v1.Schema.Reference; + // Creates a reference in one of the following ways: + // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. + // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. + insert(resource: Schema.Reference): YoutubePartner_v1.Schema.Reference; + // Creates a reference in one of the following ways: + // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. + // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. + insert(resource: Schema.Reference, mediaData: any): YoutubePartner_v1.Schema.Reference; + // Creates a reference in one of the following ways: + // - If your request is uploading a reference file, YouTube creates the reference from the provided content. You can provide either a video/audio file or a pre-generated fingerprint. If you are providing a pre-generated fingerprint, set the reference resource's fpDirect property to true in the request body. In this flow, you can use either the multipart or resumable upload flows to provide the reference content. + // - If you want to create a reference using a claimed video as the reference content, use the claimId parameter to identify the claim. + insert(resource: Schema.Reference, mediaData: any, optionalArgs: object): YoutubePartner_v1.Schema.Reference; + // Retrieves a list of references by ID or the list of references for the specified asset. + list(): YoutubePartner_v1.Schema.ReferenceListResponse; + // Retrieves a list of references by ID or the list of references for the specified asset. + list(optionalArgs: object): YoutubePartner_v1.Schema.ReferenceListResponse; + // Updates a reference. This method supports patch semantics. + patch(resource: Schema.Reference, referenceId: string): YoutubePartner_v1.Schema.Reference; + // Updates a reference. This method supports patch semantics. + patch(resource: Schema.Reference, referenceId: string, optionalArgs: object): YoutubePartner_v1.Schema.Reference; + // Updates a reference. + update(resource: Schema.Reference, referenceId: string): YoutubePartner_v1.Schema.Reference; + // Updates a reference. + update(resource: Schema.Reference, referenceId: string, optionalArgs: object): YoutubePartner_v1.Schema.Reference; + } + export interface SpreadsheetTemplateCollection { + // Retrieves a list of spreadsheet templates for a content owner. + list(): YoutubePartner_v1.Schema.SpreadsheetTemplateListResponse; + // Retrieves a list of spreadsheet templates for a content owner. + list(optionalArgs: object): YoutubePartner_v1.Schema.SpreadsheetTemplateListResponse; + } + export interface UploaderCollection { + // Retrieves a list of uploaders for a content owner. + list(): YoutubePartner_v1.Schema.UploaderListResponse; + // Retrieves a list of uploaders for a content owner. + list(optionalArgs: object): YoutubePartner_v1.Schema.UploaderListResponse; + } + export interface ValidatorCollection { + // Validate a metadata file. + validate(resource: Schema.ValidateRequest): YoutubePartner_v1.Schema.ValidateResponse; + // Validate a metadata file. + validate(resource: Schema.ValidateRequest, optionalArgs: object): YoutubePartner_v1.Schema.ValidateResponse; + // Validate a metadata file asynchronously. + validateAsync(resource: Schema.ValidateAsyncRequest): YoutubePartner_v1.Schema.ValidateAsyncResponse; + // Validate a metadata file asynchronously. + validateAsync(resource: Schema.ValidateAsyncRequest, optionalArgs: object): YoutubePartner_v1.Schema.ValidateAsyncResponse; + // Get the asynchronous validation status. + validateAsyncStatus(resource: Schema.ValidateStatusRequest): YoutubePartner_v1.Schema.ValidateStatusResponse; + // Get the asynchronous validation status. + validateAsyncStatus(resource: Schema.ValidateStatusRequest, optionalArgs: object): YoutubePartner_v1.Schema.ValidateStatusResponse; + } + export interface VideoAdvertisingOptionsCollection { + // Retrieves advertising settings for the specified video. + get(videoId: string): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Retrieves advertising settings for the specified video. + get(videoId: string, optionalArgs: object): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video. + getEnabledAds(videoId: string): YoutubePartner_v1.Schema.VideoAdvertisingOptionGetEnabledAdsResponse; + // Retrieves details about the types of allowed ads for a specified partner- or user-uploaded video. + getEnabledAds(videoId: string, optionalArgs: object): YoutubePartner_v1.Schema.VideoAdvertisingOptionGetEnabledAdsResponse; + // Updates the advertising settings for the specified video. This method supports patch semantics. + patch(resource: Schema.VideoAdvertisingOption, videoId: string): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Updates the advertising settings for the specified video. This method supports patch semantics. + patch(resource: Schema.VideoAdvertisingOption, videoId: string, optionalArgs: object): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Updates the advertising settings for the specified video. + update(resource: Schema.VideoAdvertisingOption, videoId: string): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Updates the advertising settings for the specified video. + update(resource: Schema.VideoAdvertisingOption, videoId: string, optionalArgs: object): YoutubePartner_v1.Schema.VideoAdvertisingOption; + } + export interface WhitelistsCollection { + // Retrieves a specific whitelisted channel by ID. + get(id: string): YoutubePartner_v1.Schema.Whitelist; + // Retrieves a specific whitelisted channel by ID. + get(id: string, optionalArgs: object): YoutubePartner_v1.Schema.Whitelist; + // Whitelist a YouTube channel for your content owner. Whitelisted channels are channels that are not owned or managed by you, but you would like to whitelist so that no claims from your assets are placed on videos uploaded to these channels. + insert(resource: Schema.Whitelist): YoutubePartner_v1.Schema.Whitelist; + // Whitelist a YouTube channel for your content owner. Whitelisted channels are channels that are not owned or managed by you, but you would like to whitelist so that no claims from your assets are placed on videos uploaded to these channels. + insert(resource: Schema.Whitelist, optionalArgs: object): YoutubePartner_v1.Schema.Whitelist; + // Retrieves a list of whitelisted channels for a content owner. + list(): YoutubePartner_v1.Schema.WhitelistListResponse; + // Retrieves a list of whitelisted channels for a content owner. + list(optionalArgs: object): YoutubePartner_v1.Schema.WhitelistListResponse; + // Removes a whitelisted channel for a content owner. + remove(id: string): void; + // Removes a whitelisted channel for a content owner. + remove(id: string, optionalArgs: object): void; + } + } + namespace Schema { + export interface AdBreak { + midrollSeconds?: number; + position?: string; + slot?: YoutubePartner_v1.Schema.AdSlot[]; + } + export interface AdSlot { + id?: string; + type?: string; + } + export interface AllowedAdvertisingOptions { + adsOnEmbeds?: boolean; + kind?: string; + licAdFormats?: string[]; + ugcAdFormats?: string[]; + } + export interface Asset { + aliasId?: string[]; + id?: string; + kind?: string; + label?: string[]; + matchPolicy?: YoutubePartner_v1.Schema.AssetMatchPolicy; + matchPolicyEffective?: YoutubePartner_v1.Schema.AssetMatchPolicy; + matchPolicyMine?: YoutubePartner_v1.Schema.AssetMatchPolicy; + metadata?: YoutubePartner_v1.Schema.Metadata; + metadataEffective?: YoutubePartner_v1.Schema.Metadata; + metadataMine?: YoutubePartner_v1.Schema.Metadata; + ownership?: YoutubePartner_v1.Schema.RightsOwnership; + ownershipConflicts?: YoutubePartner_v1.Schema.OwnershipConflicts; + ownershipEffective?: YoutubePartner_v1.Schema.RightsOwnership; + ownershipMine?: YoutubePartner_v1.Schema.RightsOwnership; + status?: string; + timeCreated?: string; + type?: string; + } + export interface AssetLabel { + kind?: string; + labelName?: string; + } + export interface AssetLabelListResponse { + items?: YoutubePartner_v1.Schema.AssetLabel[]; + kind?: string; + } + export interface AssetListResponse { + items?: YoutubePartner_v1.Schema.Asset[]; + kind?: string; + } + export interface AssetMatchPolicy { + kind?: string; + policyId?: string; + rules?: YoutubePartner_v1.Schema.PolicyRule[]; + } + export interface AssetRelationship { + childAssetId?: string; + id?: string; + kind?: string; + parentAssetId?: string; + } + export interface AssetRelationshipListResponse { + items?: YoutubePartner_v1.Schema.AssetRelationship[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface AssetSearchResponse { + items?: YoutubePartner_v1.Schema.AssetSnippet[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface AssetShare { + kind?: string; + shareId?: string; + viewId?: string; + } + export interface AssetShareListResponse { + items?: YoutubePartner_v1.Schema.AssetShare[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface AssetSnippet { + customId?: string; + id?: string; + isrc?: string; + iswc?: string; + kind?: string; + timeCreated?: string; + title?: string; + type?: string; + } + export interface Campaign { + campaignData?: YoutubePartner_v1.Schema.CampaignData; + id?: string; + kind?: string; + status?: string; + timeCreated?: string; + timeLastModified?: string; + } + export interface CampaignData { + campaignSource?: YoutubePartner_v1.Schema.CampaignSource; + expireTime?: string; + name?: string; + promotedContent?: YoutubePartner_v1.Schema.PromotedContent[]; + startTime?: string; + } + export interface CampaignList { + items?: YoutubePartner_v1.Schema.Campaign[]; + kind?: string; + } + export interface CampaignSource { + sourceType?: string; + sourceValue?: string[]; + } + export interface CampaignTargetLink { + targetId?: string; + targetType?: string; + } + export interface Claim { + appliedPolicy?: YoutubePartner_v1.Schema.Policy; + assetId?: string; + blockOutsideOwnership?: boolean; + contentType?: string; + id?: string; + isPartnerUploaded?: boolean; + kind?: string; + matchInfo?: YoutubePartner_v1.Schema.ClaimMatchInfo; + origin?: YoutubePartner_v1.Schema.ClaimOrigin; + policy?: YoutubePartner_v1.Schema.Policy; + status?: string; + timeCreated?: string; + videoId?: string; + } + export interface ClaimEvent { + kind?: string; + reason?: string; + source?: YoutubePartner_v1.Schema.ClaimEventSource; + time?: string; + type?: string; + typeDetails?: YoutubePartner_v1.Schema.ClaimEventTypeDetails; + } + export interface ClaimEventSource { + contentOwnerId?: string; + type?: string; + userEmail?: string; + } + export interface ClaimEventTypeDetails { + appealExplanation?: string; + disputeNotes?: string; + disputeReason?: string; + updateStatus?: string; + } + export interface ClaimHistory { + event?: YoutubePartner_v1.Schema.ClaimEvent[]; + id?: string; + kind?: string; + uploaderChannelId?: string; + } + export interface ClaimListResponse { + items?: YoutubePartner_v1.Schema.Claim[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + previousPageToken?: string; + } + export interface ClaimMatchInfo { + longestMatch?: YoutubePartner_v1.Schema.ClaimMatchInfoLongestMatch; + matchSegments?: YoutubePartner_v1.Schema.MatchSegment[]; + referenceId?: string; + totalMatch?: YoutubePartner_v1.Schema.ClaimMatchInfoTotalMatch; + } + export interface ClaimMatchInfoLongestMatch { + durationSecs?: string; + referenceOffset?: string; + userVideoOffset?: string; + } + export interface ClaimMatchInfoTotalMatch { + referenceDurationSecs?: string; + userVideoDurationSecs?: string; + } + export interface ClaimOrigin { + source?: string; + } + export interface ClaimSearchResponse { + items?: YoutubePartner_v1.Schema.ClaimSnippet[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + previousPageToken?: string; + } + export interface ClaimSnippet { + assetId?: string; + contentType?: string; + id?: string; + isPartnerUploaded?: boolean; + kind?: string; + origin?: YoutubePartner_v1.Schema.ClaimSnippetOrigin; + status?: string; + thirdPartyClaim?: boolean; + timeCreated?: string; + timeStatusLastModified?: string; + videoId?: string; + videoTitle?: string; + videoViews?: string; + } + export interface ClaimSnippetOrigin { + source?: string; + } + export interface ClaimedVideoDefaults { + autoGeneratedBreaks?: boolean; + channelOverride?: boolean; + kind?: string; + newVideoDefaults?: string[]; + } + export interface Conditions { + contentMatchType?: string[]; + matchDuration?: YoutubePartner_v1.Schema.IntervalCondition[]; + matchPercent?: YoutubePartner_v1.Schema.IntervalCondition[]; + referenceDuration?: YoutubePartner_v1.Schema.IntervalCondition[]; + referencePercent?: YoutubePartner_v1.Schema.IntervalCondition[]; + requiredTerritories?: YoutubePartner_v1.Schema.TerritoryCondition; + } + export interface ConflictingOwnership { + owner?: string; + ratio?: Number; + } + export interface ContentOwner { + conflictNotificationEmail?: string; + displayName?: string; + disputeNotificationEmails?: string[]; + fingerprintReportNotificationEmails?: string[]; + id?: string; + kind?: string; + primaryNotificationEmails?: string[]; + } + export interface ContentOwnerAdvertisingOption { + allowedOptions?: YoutubePartner_v1.Schema.AllowedAdvertisingOptions; + claimedVideoOptions?: YoutubePartner_v1.Schema.ClaimedVideoDefaults; + id?: string; + kind?: string; + } + export interface ContentOwnerListResponse { + items?: YoutubePartner_v1.Schema.ContentOwner[]; + kind?: string; + } + export interface CountriesRestriction { + adFormats?: string[]; + territories?: string[]; + } + export interface CuepointSettings { + cueType?: string; + durationSecs?: number; + offsetTimeMs?: string; + walltime?: string; + } + export interface Date { + day?: number; + month?: number; + year?: number; + } + export interface DateRange { + end?: YoutubePartner_v1.Schema.Date; + kind?: string; + start?: YoutubePartner_v1.Schema.Date; + } + export interface ExcludedInterval { + high?: Number; + low?: Number; + origin?: string; + timeCreated?: string; + } + export interface IntervalCondition { + high?: Number; + low?: Number; + } + export interface LiveCuepoint { + broadcastId?: string; + id?: string; + kind?: string; + settings?: YoutubePartner_v1.Schema.CuepointSettings; + } + export interface MatchSegment { + channel?: string; + reference_segment?: YoutubePartner_v1.Schema.Segment; + video_segment?: YoutubePartner_v1.Schema.Segment; + } + export interface Metadata { + actor?: string[]; + album?: string; + artist?: string[]; + broadcaster?: string[]; + category?: string; + contentType?: string; + copyrightDate?: YoutubePartner_v1.Schema.Date; + customId?: string; + description?: string; + director?: string[]; + eidr?: string; + endYear?: number; + episodeNumber?: string; + episodesAreUntitled?: boolean; + genre?: string[]; + grid?: string; + hfa?: string; + infoUrl?: string; + isan?: string; + isrc?: string; + iswc?: string; + keyword?: string[]; + label?: string; + notes?: string; + originalReleaseMedium?: string; + producer?: string[]; + ratings?: YoutubePartner_v1.Schema.Rating[]; + releaseDate?: YoutubePartner_v1.Schema.Date; + seasonNumber?: string; + showCustomId?: string; + showTitle?: string; + spokenLanguage?: string; + startYear?: number; + subtitledLanguage?: string[]; + title?: string; + tmsId?: string; + totalEpisodesExpected?: number; + upc?: string; + writer?: string[]; + } + export interface MetadataHistory { + kind?: string; + metadata?: YoutubePartner_v1.Schema.Metadata; + origination?: YoutubePartner_v1.Schema.Origination; + timeProvided?: string; + } + export interface MetadataHistoryListResponse { + items?: YoutubePartner_v1.Schema.MetadataHistory[]; + kind?: string; + } + export interface Order { + availGroupId?: string; + channelId?: string; + contentType?: string; + country?: string; + customId?: string; + dvdReleaseDate?: YoutubePartner_v1.Schema.Date; + estDates?: YoutubePartner_v1.Schema.DateRange; + events?: YoutubePartner_v1.Schema.StateCompleted[]; + id?: string; + kind?: string; + movie?: string; + originalReleaseDate?: YoutubePartner_v1.Schema.Date; + priority?: string; + productionHouse?: string; + purchaseOrder?: string; + requirements?: YoutubePartner_v1.Schema.Requirements; + show?: YoutubePartner_v1.Schema.ShowDetails; + status?: string; + videoId?: string; + vodDates?: YoutubePartner_v1.Schema.DateRange; + } + export interface OrderListResponse { + items?: YoutubePartner_v1.Schema.Order[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + previousPageToken?: string; + } + export interface Origination { + owner?: string; + source?: string; + } + export interface OwnershipConflicts { + general?: YoutubePartner_v1.Schema.TerritoryConflicts[]; + kind?: string; + mechanical?: YoutubePartner_v1.Schema.TerritoryConflicts[]; + performance?: YoutubePartner_v1.Schema.TerritoryConflicts[]; + synchronization?: YoutubePartner_v1.Schema.TerritoryConflicts[]; + } + export interface OwnershipHistoryListResponse { + items?: YoutubePartner_v1.Schema.RightsOwnershipHistory[]; + kind?: string; + } + export interface Package { + content?: string; + customIds?: string[]; + id?: string; + kind?: string; + locale?: string; + name?: string; + status?: string; + statusReports?: YoutubePartner_v1.Schema.StatusReport[]; + timeCreated?: string; + type?: string; + uploaderName?: string; + } + export interface PackageInsertResponse { + errors?: YoutubePartner_v1.Schema.ValidateError[]; + kind?: string; + resource?: YoutubePartner_v1.Schema.Package; + status?: string; + } + export interface PageInfo { + resultsPerPage?: number; + startIndex?: number; + totalResults?: number; + } + export interface Policy { + description?: string; + id?: string; + kind?: string; + name?: string; + rules?: YoutubePartner_v1.Schema.PolicyRule[]; + timeUpdated?: string; + } + export interface PolicyList { + items?: YoutubePartner_v1.Schema.Policy[]; + kind?: string; + } + export interface PolicyRule { + action?: string; + conditions?: YoutubePartner_v1.Schema.Conditions; + subaction?: string[]; + } + export interface PromotedContent { + link?: YoutubePartner_v1.Schema.CampaignTargetLink[]; + } + export interface Publisher { + caeNumber?: string; + id?: string; + ipiNumber?: string; + kind?: string; + name?: string; + } + export interface PublisherList { + items?: YoutubePartner_v1.Schema.Publisher[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface Rating { + rating?: string; + ratingSystem?: string; + } + export interface Reference { + assetId?: string; + audioswapEnabled?: boolean; + claimId?: string; + contentType?: string; + duplicateLeader?: string; + excludedIntervals?: YoutubePartner_v1.Schema.ExcludedInterval[]; + fpDirect?: boolean; + hashCode?: string; + id?: string; + ignoreFpMatch?: boolean; + kind?: string; + length?: Number; + origination?: YoutubePartner_v1.Schema.Origination; + status?: string; + statusReason?: string; + urgent?: boolean; + videoId?: string; + } + export interface ReferenceConflict { + conflictingReferenceId?: string; + expiryTime?: string; + id?: string; + kind?: string; + matches?: YoutubePartner_v1.Schema.ReferenceConflictMatch[]; + originalReferenceId?: string; + status?: string; + } + export interface ReferenceConflictListResponse { + items?: YoutubePartner_v1.Schema.ReferenceConflict[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface ReferenceConflictMatch { + conflicting_reference_offset_ms?: string; + length_ms?: string; + original_reference_offset_ms?: string; + type?: string; + } + export interface ReferenceListResponse { + items?: YoutubePartner_v1.Schema.Reference[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + export interface Requirements { + caption?: boolean; + hdTranscode?: boolean; + posterArt?: boolean; + spotlightArt?: boolean; + spotlightReview?: boolean; + trailer?: boolean; + } + export interface RightsOwnership { + general?: YoutubePartner_v1.Schema.TerritoryOwners[]; + kind?: string; + mechanical?: YoutubePartner_v1.Schema.TerritoryOwners[]; + performance?: YoutubePartner_v1.Schema.TerritoryOwners[]; + synchronization?: YoutubePartner_v1.Schema.TerritoryOwners[]; + } + export interface RightsOwnershipHistory { + kind?: string; + origination?: YoutubePartner_v1.Schema.Origination; + ownership?: YoutubePartner_v1.Schema.RightsOwnership; + timeProvided?: string; + } + export interface Segment { + duration?: string; + kind?: string; + start?: string; + } + export interface ShowDetails { + episodeNumber?: string; + episodeTitle?: string; + seasonNumber?: string; + title?: string; + } + export interface SpreadsheetTemplate { + kind?: string; + status?: string; + templateContent?: string; + templateName?: string; + templateType?: string; + } + export interface SpreadsheetTemplateListResponse { + items?: YoutubePartner_v1.Schema.SpreadsheetTemplate[]; + kind?: string; + status?: string; + } + export interface StateCompleted { + state?: string; + timeCompleted?: string; + } + export interface StatusReport { + statusContent?: string; + statusFileName?: string; + } + export interface TerritoryCondition { + territories?: string[]; + type?: string; + } + export interface TerritoryConflicts { + conflictingOwnership?: YoutubePartner_v1.Schema.ConflictingOwnership[]; + territory?: string; + } + export interface TerritoryOwners { + owner?: string; + publisher?: string; + ratio?: Number; + territories?: string[]; + type?: string; + } + export interface Uploader { + kind?: string; + uploaderName?: string; + } + export interface UploaderListResponse { + items?: YoutubePartner_v1.Schema.Uploader[]; + kind?: string; + } + export interface ValidateAsyncRequest { + content?: string; + kind?: string; + uploaderName?: string; + } + export interface ValidateAsyncResponse { + kind?: string; + status?: string; + validationId?: string; + } + export interface ValidateError { + columnName?: string; + columnNumber?: number; + lineNumber?: number; + message?: string; + messageCode?: number; + severity?: string; + } + export interface ValidateRequest { + content?: string; + kind?: string; + locale?: string; + uploaderName?: string; + } + export interface ValidateResponse { + errors?: YoutubePartner_v1.Schema.ValidateError[]; + kind?: string; + status?: string; + } + export interface ValidateStatusRequest { + kind?: string; + locale?: string; + validationId?: string; + } + export interface ValidateStatusResponse { + errors?: YoutubePartner_v1.Schema.ValidateError[]; + isMetadataOnly?: boolean; + kind?: string; + status?: string; + } + export interface VideoAdvertisingOption { + adBreaks?: YoutubePartner_v1.Schema.AdBreak[]; + adFormats?: string[]; + autoGeneratedBreaks?: boolean; + breakPosition?: string[]; + id?: string; + kind?: string; + tpAdServerVideoId?: string; + tpTargetingUrl?: string; + tpUrlParameters?: string; + } + export interface VideoAdvertisingOptionGetEnabledAdsResponse { + adBreaks?: YoutubePartner_v1.Schema.AdBreak[]; + adsOnEmbeds?: boolean; + countriesRestriction?: YoutubePartner_v1.Schema.CountriesRestriction[]; + id?: string; + kind?: string; + } + export interface Whitelist { + id?: string; + kind?: string; + title?: string; + } + export interface WhitelistListResponse { + items?: YoutubePartner_v1.Schema.Whitelist[]; + kind?: string; + nextPageToken?: string; + pageInfo?: YoutubePartner_v1.Schema.PageInfo; + } + } + } + export interface YoutubePartner_v1 { + AssetLabels?: YoutubePartner_v1.Collection.AssetLabelsCollection; + AssetMatchPolicy?: YoutubePartner_v1.Collection.AssetMatchPolicyCollection; + AssetRelationships?: YoutubePartner_v1.Collection.AssetRelationshipsCollection; + AssetSearch?: YoutubePartner_v1.Collection.AssetSearchCollection; + AssetShares?: YoutubePartner_v1.Collection.AssetSharesCollection; + Assets?: YoutubePartner_v1.Collection.AssetsCollection; + Campaigns?: YoutubePartner_v1.Collection.CampaignsCollection; + ClaimHistory?: YoutubePartner_v1.Collection.ClaimHistoryCollection; + ClaimSearch?: YoutubePartner_v1.Collection.ClaimSearchCollection; + Claims?: YoutubePartner_v1.Collection.ClaimsCollection; + ContentOwnerAdvertisingOptions?: YoutubePartner_v1.Collection.ContentOwnerAdvertisingOptionsCollection; + ContentOwners?: YoutubePartner_v1.Collection.ContentOwnersCollection; + LiveCuepoints?: YoutubePartner_v1.Collection.LiveCuepointsCollection; + MetadataHistory?: YoutubePartner_v1.Collection.MetadataHistoryCollection; + Orders?: YoutubePartner_v1.Collection.OrdersCollection; + Ownership?: YoutubePartner_v1.Collection.OwnershipCollection; + OwnershipHistory?: YoutubePartner_v1.Collection.OwnershipHistoryCollection; + Package?: YoutubePartner_v1.Collection.PackageCollection; + Policies?: YoutubePartner_v1.Collection.PoliciesCollection; + Publishers?: YoutubePartner_v1.Collection.PublishersCollection; + ReferenceConflicts?: YoutubePartner_v1.Collection.ReferenceConflictsCollection; + References?: YoutubePartner_v1.Collection.ReferencesCollection; + SpreadsheetTemplate?: YoutubePartner_v1.Collection.SpreadsheetTemplateCollection; + Uploader?: YoutubePartner_v1.Collection.UploaderCollection; + Validator?: YoutubePartner_v1.Collection.ValidatorCollection; + VideoAdvertisingOptions?: YoutubePartner_v1.Collection.VideoAdvertisingOptionsCollection; + Whitelists?: YoutubePartner_v1.Collection.WhitelistsCollection; + // Create a new instance of AdBreak + newAdBreak(): YoutubePartner_v1.Schema.AdBreak; + // Create a new instance of AdSlot + newAdSlot(): YoutubePartner_v1.Schema.AdSlot; + // Create a new instance of AllowedAdvertisingOptions + newAllowedAdvertisingOptions(): YoutubePartner_v1.Schema.AllowedAdvertisingOptions; + // Create a new instance of Asset + newAsset(): YoutubePartner_v1.Schema.Asset; + // Create a new instance of AssetLabel + newAssetLabel(): YoutubePartner_v1.Schema.AssetLabel; + // Create a new instance of AssetMatchPolicy + newAssetMatchPolicy(): YoutubePartner_v1.Schema.AssetMatchPolicy; + // Create a new instance of AssetRelationship + newAssetRelationship(): YoutubePartner_v1.Schema.AssetRelationship; + // Create a new instance of Campaign + newCampaign(): YoutubePartner_v1.Schema.Campaign; + // Create a new instance of CampaignData + newCampaignData(): YoutubePartner_v1.Schema.CampaignData; + // Create a new instance of CampaignSource + newCampaignSource(): YoutubePartner_v1.Schema.CampaignSource; + // Create a new instance of CampaignTargetLink + newCampaignTargetLink(): YoutubePartner_v1.Schema.CampaignTargetLink; + // Create a new instance of Claim + newClaim(): YoutubePartner_v1.Schema.Claim; + // Create a new instance of ClaimMatchInfo + newClaimMatchInfo(): YoutubePartner_v1.Schema.ClaimMatchInfo; + // Create a new instance of ClaimMatchInfoLongestMatch + newClaimMatchInfoLongestMatch(): YoutubePartner_v1.Schema.ClaimMatchInfoLongestMatch; + // Create a new instance of ClaimMatchInfoTotalMatch + newClaimMatchInfoTotalMatch(): YoutubePartner_v1.Schema.ClaimMatchInfoTotalMatch; + // Create a new instance of ClaimOrigin + newClaimOrigin(): YoutubePartner_v1.Schema.ClaimOrigin; + // Create a new instance of ClaimedVideoDefaults + newClaimedVideoDefaults(): YoutubePartner_v1.Schema.ClaimedVideoDefaults; + // Create a new instance of Conditions + newConditions(): YoutubePartner_v1.Schema.Conditions; + // Create a new instance of ConflictingOwnership + newConflictingOwnership(): YoutubePartner_v1.Schema.ConflictingOwnership; + // Create a new instance of ContentOwnerAdvertisingOption + newContentOwnerAdvertisingOption(): YoutubePartner_v1.Schema.ContentOwnerAdvertisingOption; + // Create a new instance of CuepointSettings + newCuepointSettings(): YoutubePartner_v1.Schema.CuepointSettings; + // Create a new instance of Date + newDate(): YoutubePartner_v1.Schema.Date; + // Create a new instance of DateRange + newDateRange(): YoutubePartner_v1.Schema.DateRange; + // Create a new instance of ExcludedInterval + newExcludedInterval(): YoutubePartner_v1.Schema.ExcludedInterval; + // Create a new instance of IntervalCondition + newIntervalCondition(): YoutubePartner_v1.Schema.IntervalCondition; + // Create a new instance of LiveCuepoint + newLiveCuepoint(): YoutubePartner_v1.Schema.LiveCuepoint; + // Create a new instance of MatchSegment + newMatchSegment(): YoutubePartner_v1.Schema.MatchSegment; + // Create a new instance of Metadata + newMetadata(): YoutubePartner_v1.Schema.Metadata; + // Create a new instance of Order + newOrder(): YoutubePartner_v1.Schema.Order; + // Create a new instance of Origination + newOrigination(): YoutubePartner_v1.Schema.Origination; + // Create a new instance of OwnershipConflicts + newOwnershipConflicts(): YoutubePartner_v1.Schema.OwnershipConflicts; + // Create a new instance of Package + newPackage(): YoutubePartner_v1.Schema.Package; + // Create a new instance of Policy + newPolicy(): YoutubePartner_v1.Schema.Policy; + // Create a new instance of PolicyRule + newPolicyRule(): YoutubePartner_v1.Schema.PolicyRule; + // Create a new instance of PromotedContent + newPromotedContent(): YoutubePartner_v1.Schema.PromotedContent; + // Create a new instance of Rating + newRating(): YoutubePartner_v1.Schema.Rating; + // Create a new instance of Reference + newReference(): YoutubePartner_v1.Schema.Reference; + // Create a new instance of Requirements + newRequirements(): YoutubePartner_v1.Schema.Requirements; + // Create a new instance of RightsOwnership + newRightsOwnership(): YoutubePartner_v1.Schema.RightsOwnership; + // Create a new instance of Segment + newSegment(): YoutubePartner_v1.Schema.Segment; + // Create a new instance of ShowDetails + newShowDetails(): YoutubePartner_v1.Schema.ShowDetails; + // Create a new instance of StateCompleted + newStateCompleted(): YoutubePartner_v1.Schema.StateCompleted; + // Create a new instance of StatusReport + newStatusReport(): YoutubePartner_v1.Schema.StatusReport; + // Create a new instance of TerritoryCondition + newTerritoryCondition(): YoutubePartner_v1.Schema.TerritoryCondition; + // Create a new instance of TerritoryConflicts + newTerritoryConflicts(): YoutubePartner_v1.Schema.TerritoryConflicts; + // Create a new instance of TerritoryOwners + newTerritoryOwners(): YoutubePartner_v1.Schema.TerritoryOwners; + // Create a new instance of ValidateAsyncRequest + newValidateAsyncRequest(): YoutubePartner_v1.Schema.ValidateAsyncRequest; + // Create a new instance of ValidateRequest + newValidateRequest(): YoutubePartner_v1.Schema.ValidateRequest; + // Create a new instance of ValidateStatusRequest + newValidateStatusRequest(): YoutubePartner_v1.Schema.ValidateStatusRequest; + // Create a new instance of VideoAdvertisingOption + newVideoAdvertisingOption(): YoutubePartner_v1.Schema.VideoAdvertisingOption; + // Create a new instance of Whitelist + newWhitelist(): YoutubePartner_v1.Schema.Whitelist; + } +} + +declare var YoutubePartner_v1: GoogleAppsScript.YoutubePartner_v1; \ No newline at end of file diff --git a/types/google-apps-script/google-apps-script-tests.ts b/types/google-apps-script/google-apps-script-tests.ts index a6a3ac8437..54248f511d 100644 --- a/types/google-apps-script/google-apps-script-tests.ts +++ b/types/google-apps-script/google-apps-script-tests.ts @@ -35,4 +35,61 @@ const postTest = (payload: Object): string => { payload: payload }; return UrlFetchApp.fetch(url, params).getContentText(); -}; \ No newline at end of file +}; + +// Advanced Services +Slides_v1.Presentations.Pages.getThumbnail('presentationId', 'pageId'); + +// Calendar (Advanced service) +declare const Calendar: GoogleAppsScript.Calendar_v3; +const createEvent = (): void => { + const calendarId = 'primary'; + const start = new Date(); + const end = new Date(); + start.setHours(10); + end.setHours(11); + let event: GoogleAppsScript.Calendar_v3.Schema.Event = { + summary: 'Lunch Meeting', + location: 'The Deli', + description: 'To discuss our plans for the presentation next week.', + start: { + dateTime: start.toISOString() + }, + end: { + dateTime: end.toISOString() + }, + attendees: [ + {email: 'alice@example.com'}, + {email: 'bob@example.com'} + ], + // Red background. Use Calendar.Colors.get() for the full list. + colorId: "11" + }; + event = Calendar.Events.insert(event, calendarId); + Logger.log('Event ID: ' + event.id); +} + +// Admin Directory (Advanced service) +declare const AdminDirectory: GoogleAppsScript.Admin_directory_v1; + +const listAllUsers = () => { + let pageToken: string; + let page: GoogleAppsScript.Admin_directory_v1.Schema.Users; + do { + page = AdminDirectory.Users.list({ + domain: 'example.com', + orderBy: 'givenName', + maxResults: 100, + pageToken: pageToken + }); + const users: GoogleAppsScript.Admin_directory_v1.Schema.User[] = page.users; + if (users) { + for (const user of users) { + Logger.log('%s (%s)', user.name.fullName, user.primaryEmail); + } + } else { + Logger.log('No users found.'); + } + pageToken = page.nextPageToken; + } while (pageToken); +} diff --git a/types/google-apps-script/google-apps-script.base.d.ts b/types/google-apps-script/google-apps-script.base.d.ts index 5c2a8d9155..be1bad95d5 100644 --- a/types/google-apps-script/google-apps-script.base.d.ts +++ b/types/google-apps-script/google-apps-script.base.d.ts @@ -326,3 +326,4 @@ declare var Logger: GoogleAppsScript.Base.Logger; // conflicts with MimeType in lib.d.ts // declare var MimeType: GoogleAppsScript.Base.MimeType; declare var Session: GoogleAppsScript.Base.Session; +declare var console: GoogleAppsScript.Base.console; diff --git a/types/google-apps-script/index.d.ts b/types/google-apps-script/index.d.ts index 8e565f334f..caefcbb697 100644 --- a/types/google-apps-script/index.d.ts +++ b/types/google-apps-script/index.d.ts @@ -41,36 +41,33 @@ /// // API Types (Advanced Google Services) -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// -/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// +/// diff --git a/types/google-apps-script/tslint.json b/types/google-apps-script/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-apps-script/tslint.json +++ b/types/google-apps-script/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-closure-compiler/tslint.json b/types/google-closure-compiler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-closure-compiler/tslint.json +++ b/types/google-closure-compiler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-cloud__text-to-speech/google-cloud__text-to-speech-tests.ts b/types/google-cloud__text-to-speech/google-cloud__text-to-speech-tests.ts new file mode 100644 index 0000000000..79c368c8e3 --- /dev/null +++ b/types/google-cloud__text-to-speech/google-cloud__text-to-speech-tests.ts @@ -0,0 +1,56 @@ +import textToSpeech from "@google-cloud/text-to-speech"; + +const client = new textToSpeech.TextToSpeechClient({}); + +/* listVoices */ + +client.listVoices({}); + +client.listVoices({}, (err, res) => { + if (res) { + res.map(voice => + console.log( + voice.language_codes, + voice.name, + voice.naturalSampleRateHertz, + voice.ssmlGender + ) + ); + } +}); + +client.listVoices({ languageCode: "en-GB" }).then(res => { + res[0].map(voice => + console.log( + voice.language_codes, + voice.name, + voice.naturalSampleRateHertz, + voice.ssmlGender + ) + ); +}); + +/* synthesizeSpeech */ + +client.synthesizeSpeech( + { + input: { text: "Hello world." }, + audioConfig: { audioEncoding: "MP3" }, + voice: { name: "Alice" } + }, + (err, res) => { + if (res) { + console.log(res.audioContent); + } + } +); + +client + .synthesizeSpeech({ + input: { ssml: "Hello world." }, + audioConfig: { audioEncoding: "OGG_OPUS" }, + voice: { name: "Bob", languageCode: "en-GB" } + }) + .then(res => { + console.log(res[0].audioContent); + }); diff --git a/types/google-cloud__text-to-speech/index.d.ts b/types/google-cloud__text-to-speech/index.d.ts new file mode 100644 index 0000000000..9e0c80cac2 --- /dev/null +++ b/types/google-cloud__text-to-speech/index.d.ts @@ -0,0 +1,123 @@ +// Type definitions for google-cloud__text-to-speech 0.5 +// Project: https://github.com/googleapis/nodejs-text-to-speech +// Definitions by: Ben James +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +// TypeScript Version: 2.8 + +/// + +export type GoogleError = any; + +export type APICallback = ( + err: GoogleError | null, + response?: T +) => void; + +export interface PromiseLike extends Promise { + /** + * Cancel the ongoing promise + */ + cancel(): void; +} + +export interface MethodOverload { + (data: T, options?: CallOptions): PromiseLike<[R]>; + (data: T, options: CallOptions, callback: APICallback): void; + (data: T, callback: APICallback): void; +} + +export interface CallOptions { + timeout?: number; + retry?: any; + autoPaginate?: boolean; + pageToken?: any; + isBundling: boolean; + longrunning?: any; + promise?: any; +} + +export interface ClientOptionsCredentials { + client_email: string; + private_key: string; +} + +export interface ClientOptions { + credentials?: ClientOptionsCredentials; + email?: string; + keyFilename?: string; + port?: number; + projectId?: string; + promise?: any; + servicePath?: string; +} + +export interface ListVoicesRequest { + languageCode?: string; +} + +export type ListVoicesOptions = CallOptions; + +export type SsmlVoiceGender = + | "SSML_VOICE_GENDER_UNSPECIFIED" + | "MALE" + | "FEMALE" + | "NEUTRAL"; + +export interface Voice { + language_codes: string[]; + name: string; + ssmlGender: SsmlVoiceGender; + naturalSampleRateHertz: number; +} + +export type ListVoicesResponse = Voice[]; + +export type SynthesisInput = { text: string } | { ssml: string }; + +export interface VoiceSelectionParams { + languageCode?: string; + name?: string; + ssmlGender?: SsmlVoiceGender; +} + +export type AudioEncoding = + | "AUDIO_ENCODING_UNSPECIFIED" + | "LINEAR16" + | "MP3" + | "OGG_OPUS"; + +export interface AudioConfig { + audioEncoding: AudioEncoding; + effectsProfileId?: string[]; + pitch?: number; + sampleRateHertz?: number; + speakingRate?: number; + volumeGainDb?: number; +} + +export interface SynthesizeSpeechRequest { + input: SynthesisInput; + voice: VoiceSelectionParams; + audioConfig: AudioConfig; +} + +export type SynthesizeSpeechOptions = CallOptions; + +export interface SynthesizeSpeechResponse { + audioContent: Buffer; +} + +declare class TextToSpeechClient { + constructor(options?: ClientOptions); + + listVoices: MethodOverload; + synthesizeSpeech: MethodOverload< + SynthesizeSpeechRequest, + SynthesizeSpeechResponse + >; +} + +declare const TextToSpeech: { TextToSpeechClient: typeof TextToSpeechClient }; + +export default TextToSpeech; diff --git a/types/google-cloud__text-to-speech/tsconfig.json b/types/google-cloud__text-to-speech/tsconfig.json new file mode 100644 index 0000000000..a682d930a1 --- /dev/null +++ b/types/google-cloud__text-to-speech/tsconfig.json @@ -0,0 +1,19 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": ["es6"], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": ["../"], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true, + "paths": { + "@google-cloud/text-to-speech": ["google-cloud__text-to-speech"] + } + }, + "files": ["index.d.ts", "google-cloud__text-to-speech-tests.ts"] +} diff --git a/types/google-cloud__text-to-speech/tslint.json b/types/google-cloud__text-to-speech/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/google-cloud__text-to-speech/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/google-drive-realtime-api/tslint.json b/types/google-drive-realtime-api/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-drive-realtime-api/tslint.json +++ b/types/google-drive-realtime-api/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-earth/tslint.json b/types/google-earth/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-earth/tslint.json +++ b/types/google-earth/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-libphonenumber/tslint.json b/types/google-libphonenumber/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-libphonenumber/tslint.json +++ b/types/google-libphonenumber/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google-maps/tslint.json b/types/google-maps/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google-maps/tslint.json +++ b/types/google-maps/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google.analytics/tslint.json b/types/google.analytics/tslint.json index d802652174..8c0a18b10a 100644 --- a/types/google.analytics/tslint.json +++ b/types/google.analytics/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { "dt-header": false, + "npm-naming": false, "ban-types": false, "unified-signatures": false, "no-unnecessary-generics": false diff --git a/types/google.feeds/tslint.json b/types/google.feeds/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google.feeds/tslint.json +++ b/types/google.feeds/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google.geolocation/tslint.json b/types/google.geolocation/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google.geolocation/tslint.json +++ b/types/google.geolocation/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google.picker/tslint.json b/types/google.picker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google.picker/tslint.json +++ b/types/google.picker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google.visualization/tslint.json b/types/google.visualization/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/google.visualization/tslint.json +++ b/types/google.visualization/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/google__maps/index.d.ts b/types/google__maps/index.d.ts index f1df5d8f38..2745cafe62 100644 --- a/types/google__maps/index.d.ts +++ b/types/google__maps/index.d.ts @@ -2404,9 +2404,36 @@ export interface PlaceDetailsRequest { * parameter from a request, ALL possible fields will be returned, and you will be billed accordingly. * This applies only to Place Details requests. */ - fields?: Array; + fields?: PlaceDetailsRequestField[]; } +export type PlaceDetailsRequestField = ( + "address_component" | + "adr_address" | + "alt_id" | + "formatted_address" | + "geometry" | + "icon" | + "id" | + "name" | + "permanently_closed" | + "photo" | + "place_id" | + "plus_code" | + "scope" | + "type" | + "url" | + "user_ratings_total" | + "utc_offset" | + "vicinity" | + "formatted_phone_number" | + "international_phone_number" | + "opening_hours" | + "website" | + "price_level" | + "rating" | + "review"); + export interface PlaceDetailsResponse { /** contains metadata on the request. */ status: PlaceDetailsResponseStatus; diff --git a/types/googlemaps.infobubble/tslint.json b/types/googlemaps.infobubble/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/googlemaps.infobubble/tslint.json +++ b/types/googlemaps.infobubble/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/googlemaps/tslint.json b/types/googlemaps/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/googlemaps/tslint.json +++ b/types/googlemaps/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/graham_scan/tslint.json b/types/graham_scan/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/graham_scan/tslint.json +++ b/types/graham_scan/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/graphlib/tslint.json b/types/graphlib/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/graphlib/tslint.json +++ b/types/graphlib/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/graphql/execution/execute.d.ts b/types/graphql/execution/execute.d.ts index fc6ad898d1..1791ed9222 100644 --- a/types/graphql/execution/execute.d.ts +++ b/types/graphql/execution/execute.d.ts @@ -17,7 +17,7 @@ import { InlineFragmentNode, FragmentDefinitionNode, } from "../language/ast"; -import { MaybePromise } from "../jsutils/MaybePromise"; +import { PromiseOrValue } from "../jsutils/PromiseOrValue"; /** * Data that must be available at all points during query execution. @@ -37,7 +37,7 @@ export interface ExecutionContext { } export interface ExecutionResultDataDefault { - [key: string]: any + [key: string]: any; } /** @@ -73,7 +73,9 @@ export type ExecutionArgs = { * * Accepts either an object with named arguments, or individual arguments. */ -export function execute(args: ExecutionArgs): MaybePromise>; +export function execute( + args: ExecutionArgs +): PromiseOrValue>; export function execute( schema: GraphQLSchema, document: DocumentNode, @@ -82,7 +84,7 @@ export function execute( variableValues?: Maybe<{ [key: string]: any }>, operationName?: Maybe, fieldResolver?: Maybe> -): MaybePromise>; +): PromiseOrValue>; /** * Given a ResponsePath (found in the `path` entry in the information provided diff --git a/types/graphql/graphql-tests.ts b/types/graphql/graphql-tests.ts index e75fecb329..77787aa436 100644 --- a/types/graphql/graphql-tests.ts +++ b/types/graphql/graphql-tests.ts @@ -1,4 +1,4 @@ -import { assertInputType, isInputType, isOutputType } from 'graphql'; +import { assertInputType, isInputType, isOutputType } from "graphql"; /////////////////////////// // graphql // diff --git a/types/graphql/index.d.ts b/types/graphql/index.d.ts index 0206859643..d152dba8c5 100644 --- a/types/graphql/index.d.ts +++ b/types/graphql/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for graphql 14.0 +// Type definitions for graphql 14.2 // Project: https://github.com/graphql/graphql-js // Definitions by: TonyYang // Caleb Meredith @@ -18,6 +18,7 @@ // Jonathan Cardoso // Pavel Lang // Mark Caudill +// Martijn Walraven // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.6 diff --git a/types/graphql/jsutils/MaybePromise.d.ts b/types/graphql/jsutils/MaybePromise.d.ts deleted file mode 100644 index 5eb85a3f92..0000000000 --- a/types/graphql/jsutils/MaybePromise.d.ts +++ /dev/null @@ -1 +0,0 @@ -export type MaybePromise = Promise | T; diff --git a/types/graphql/jsutils/PromiseOrValue.d.ts b/types/graphql/jsutils/PromiseOrValue.d.ts new file mode 100644 index 0000000000..6b2517ee62 --- /dev/null +++ b/types/graphql/jsutils/PromiseOrValue.d.ts @@ -0,0 +1 @@ +export type PromiseOrValue = Promise | T; diff --git a/types/graphql/language/blockStringValue.d.ts b/types/graphql/language/blockString.d.ts similarity index 78% rename from types/graphql/language/blockStringValue.d.ts rename to types/graphql/language/blockString.d.ts index 64fb87dafd..a6bf5f6f0c 100644 --- a/types/graphql/language/blockStringValue.d.ts +++ b/types/graphql/language/blockString.d.ts @@ -4,4 +4,4 @@ * * This implements the GraphQL spec's BlockStringValue() static algorithm. */ -export default function blockStringValue(rawString: string): string; +export function dedentBlockStringValue(rawString: string): string; diff --git a/types/graphql/language/printer.d.ts b/types/graphql/language/printer.d.ts index de823b5b3e..6b5635a06a 100644 --- a/types/graphql/language/printer.d.ts +++ b/types/graphql/language/printer.d.ts @@ -1,5 +1,7 @@ +import { ASTNode } from "./ast"; + /** * Converts an AST into a string, using one set of reasonable * formatting rules. */ -export function print(ast: any): string; +export function print(ast: ASTNode): string; diff --git a/types/graphql/tsutils/Maybe.d.ts b/types/graphql/tsutils/Maybe.d.ts index 7ad0bc85a4..6a3391138f 100644 --- a/types/graphql/tsutils/Maybe.d.ts +++ b/types/graphql/tsutils/Maybe.d.ts @@ -1,4 +1,4 @@ // Conveniently represents flow's "Maybe" type https://flow.org/en/docs/types/maybe/ -type Maybe = null | undefined | T +type Maybe = null | undefined | T; -export default Maybe +export default Maybe; diff --git a/types/graphql/type/definition.d.ts b/types/graphql/type/definition.d.ts index f491919a13..b36c75539c 100644 --- a/types/graphql/type/definition.d.ts +++ b/types/graphql/type/definition.d.ts @@ -1,5 +1,5 @@ import Maybe from "../tsutils/Maybe"; -import { MaybePromise } from "../jsutils/MaybePromise"; +import { PromiseOrValue } from "../jsutils/PromiseOrValue"; import { ScalarTypeDefinitionNode, ObjectTypeDefinitionNode, @@ -161,7 +161,6 @@ interface GraphQLList { inspect(): string; } - interface _GraphQLList { (type: T): GraphQLList; new (type: T): GraphQLList; @@ -280,6 +279,12 @@ export class GraphQLScalarType { extensionASTNodes: Maybe>; constructor(config: GraphQLScalarTypeConfig); + toConfig(): GraphQLScalarTypeConfig & { + parseValue: GraphQLScalarValueParser; + parseLiteral: GraphQLScalarLiteralParser; + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; @@ -342,11 +347,7 @@ export interface GraphQLScalarTypeConfig { * }); * */ -export class GraphQLObjectType< - TSource = any, - TContext = any, - TArgs = { [key: string]: any } -> { +export class GraphQLObjectType { name: string; description: Maybe; astNode: Maybe; @@ -356,16 +357,19 @@ export class GraphQLObjectType< constructor(config: GraphQLObjectTypeConfig); getFields(): GraphQLFieldMap; getInterfaces(): GraphQLInterfaceType[]; + + toConfig(): GraphQLObjectTypeConfig & { + interfaces: GraphQLInterfaceType[]; + fields: GraphQLFieldConfigMap; + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; } -export interface GraphQLObjectTypeConfig< - TSource, - TContext, - TArgs = { [key: string]: any } -> { +export interface GraphQLObjectTypeConfig { name: string; interfaces?: Thunk>; fields: Thunk>; @@ -375,21 +379,17 @@ export interface GraphQLObjectTypeConfig< extensionASTNodes?: Maybe>; } -export type GraphQLTypeResolver< - TSource, - TContext, - TArgs = { [key: string]: any } -> = ( +export type GraphQLTypeResolver = ( value: TSource, context: TContext, info: GraphQLResolveInfo -) => MaybePromise | string>>; +) => PromiseOrValue | string>>; export type GraphQLIsTypeOfFn = ( source: TSource, context: TContext, info: GraphQLResolveInfo -) => MaybePromise; +) => PromiseOrValue; export type GraphQLFieldResolver = ( source: TSource, @@ -461,11 +461,7 @@ export interface GraphQLArgument { export function isRequiredArgument(arg: GraphQLArgument): boolean; -export type GraphQLFieldMap< - TSource, - TContext, - TArgs = { [key: string]: any } -> = { +export type GraphQLFieldMap = { [key: string]: GraphQLField; }; @@ -498,16 +494,17 @@ export class GraphQLInterfaceType { getFields(): GraphQLFieldMap; + toConfig(): GraphQLInterfaceTypeConfig & { + fields: GraphQLFieldConfigMap; + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; } -export interface GraphQLInterfaceTypeConfig< - TSource, - TContext, - TArgs = { [key: string]: any } -> { +export interface GraphQLInterfaceTypeConfig { name: string; fields: Thunk>; /** @@ -555,6 +552,11 @@ export class GraphQLUnionType { getTypes(): GraphQLObjectType[]; + toConfig(): GraphQLUnionTypeConfig & { + types: GraphQLObjectType[]; + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; @@ -607,6 +609,11 @@ export class GraphQLEnumType { serialize(value: any): Maybe; parseValue(value: any): Maybe; parseLiteral(valueNode: ValueNode, _variables: Maybe<{ [key: string]: any }>): Maybe; + + toConfig(): GraphQLEnumTypeConfig & { + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; @@ -665,6 +672,12 @@ export class GraphQLInputObjectType { extensionASTNodes: Maybe>; constructor(config: GraphQLInputObjectTypeConfig); getFields(): GraphQLInputFieldMap; + + toConfig(): GraphQLInputObjectTypeConfig & { + fields: GraphQLInputFieldConfigMap; + extensionASTNodes: ReadonlyArray; + }; + toString(): string; toJSON(): string; inspect(): string; diff --git a/types/graphql/type/directives.d.ts b/types/graphql/type/directives.d.ts index ca9e947640..b3995704a7 100644 --- a/types/graphql/type/directives.d.ts +++ b/types/graphql/type/directives.d.ts @@ -20,6 +20,10 @@ export class GraphQLDirective { astNode: Maybe; constructor(config: GraphQLDirectiveConfig); + + toConfig(): GraphQLDirectiveConfig & { + args: GraphQLFieldConfigArgumentMap; + }; } export interface GraphQLDirectiveConfig { diff --git a/types/graphql/type/schema.d.ts b/types/graphql/type/schema.d.ts index 7ccb390dbe..a1722844e4 100644 --- a/types/graphql/type/schema.d.ts +++ b/types/graphql/type/schema.d.ts @@ -52,6 +52,12 @@ export class GraphQLSchema { getDirectives(): ReadonlyArray; getDirective(name: string): Maybe; + + toConfig(): GraphQLSchemaConfig & { + types: GraphQLNamedType[]; + directives: GraphQLDirective[]; + extensionASTNodes: ReadonlyArray; + }; } type TypeMap = { [key: string]: GraphQLNamedType }; diff --git a/types/graphql/utilities/buildASTSchema.d.ts b/types/graphql/utilities/buildASTSchema.d.ts index 1390601f65..8b7a725ec8 100644 --- a/types/graphql/utilities/buildASTSchema.d.ts +++ b/types/graphql/utilities/buildASTSchema.d.ts @@ -15,7 +15,7 @@ import { GraphQLDirective } from "../type/directives"; import { Source } from "../language/source"; import { GraphQLSchema, GraphQLSchemaValidationOptions } from "../type/schema"; import { ParseOptions } from "../language/parser"; -import blockStringValue from "../language/blockStringValue"; +import { dedentBlockStringValue } from "../language/blockString"; interface BuildSchemaOptions extends GraphQLSchemaValidationOptions { /** diff --git a/types/graphql/validation/validate.d.ts b/types/graphql/validation/validate.d.ts index 6c0e644ea3..aee901bbb5 100644 --- a/types/graphql/validation/validate.d.ts +++ b/types/graphql/validation/validate.d.ts @@ -2,7 +2,7 @@ import { GraphQLError } from "../error"; import { DocumentNode } from "../language/ast"; import { GraphQLSchema } from "../type/schema"; import { TypeInfo } from "../utilities/TypeInfo"; -import { ValidationRule } from "./ValidationContext"; +import { ValidationRule, SDLValidationRule } from "./ValidationContext"; /** * Implements the "Validation" section of the spec. @@ -27,6 +27,13 @@ export function validate( typeInfo?: TypeInfo ): ReadonlyArray; +// @internal +export function validateSDL( + documentAST: DocumentNode, + schemaToExtend?: GraphQLSchema | null, + rules?: ReadonlyArray +): GraphQLError[]; + /** * Utility function which asserts a SDL document is valid by throwing an error * if it is invalid. diff --git a/types/graphviz/tslint.json b/types/graphviz/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/graphviz/tslint.json +++ b/types/graphviz/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gravatar/tslint.json b/types/gravatar/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gravatar/tslint.json +++ b/types/gravatar/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/grecaptcha/tslint.json b/types/grecaptcha/tslint.json index bafaae7817..f6fabe4180 100644 --- a/types/grecaptcha/tslint.json +++ b/types/grecaptcha/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO + "npm-naming": false, "dt-header": false } } diff --git a/types/gregorian-calendar/tslint.json b/types/gregorian-calendar/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gregorian-calendar/tslint.json +++ b/types/gregorian-calendar/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gridfs-stream/tslint.json b/types/gridfs-stream/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gridfs-stream/tslint.json +++ b/types/gridfs-stream/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gridstack/tslint.json b/types/gridstack/tslint.json index 67293bd146..0a7abf97f8 100644 --- a/types/gridstack/tslint.json +++ b/types/gridstack/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/grunt/tslint.json b/types/grunt/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/grunt/tslint.json +++ b/types/grunt/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gsap/tslint.json b/types/gsap/tslint.json index 9081f7897d..972c8224ab 100644 --- a/types/gsap/tslint.json +++ b/types/gsap/tslint.json @@ -3,6 +3,7 @@ "rules": { // All are TODOs "dt-header": false, + "npm-naming": false, "jsdoc-format": false, "max-line-length": false, "no-consecutive-blank-lines": false, diff --git a/types/gtag.js/gtag.js-tests.ts b/types/gtag.js/gtag.js-tests.ts new file mode 100644 index 0000000000..c25db26c5f --- /dev/null +++ b/types/gtag.js/gtag.js-tests.ts @@ -0,0 +1,12 @@ +gtag('config', 'GA-TRACKING_ID'); +gtag('config', 'GA-TRACKING_ID', {send_page_view: false}); + +gtag('event', 'login', { + method: 'Google' +}); + +gtag('set', {currency: 'USD'}); +gtag('set', { + country: 'US', + currency: 'USD' +}); diff --git a/types/gtag.js/index.d.ts b/types/gtag.js/index.d.ts new file mode 100644 index 0000000000..6f7715b1b1 --- /dev/null +++ b/types/gtag.js/index.d.ts @@ -0,0 +1,93 @@ +// Type definitions for Google gtag.js API +// Project: https://developers.google.com/gtagjs +// Definitions by: Junyoung Choi +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +declare var gtag: Gtag.Gtag; +declare namespace Gtag { + interface Gtag { + (command: 'config', targetId: string, config?: ControlParams | EventParams | CustomParams): void; + (command: 'set', config: CustomParams): void; + (command: 'event', eventName: EventNames | string, eventParams?: ControlParams | EventParams | CustomParams): void; + } + + interface CustomParams { + [key: string]: any; + } + + interface ControlParams { + groups?: string | string[]; + send_to?: string | string[]; + event_callback?: () => void; + event_timeout?: number; + } + + type EventNames = 'add_payment_info' + | 'add_payment_info' + | 'add_to_cart' + | 'add_to_wishlist' + | 'begin_checkout' + | 'checkout_progress' + | 'exception' + | 'generate_lead' + | 'login' + | 'page_view' + | 'purchase' + | 'refund' + | 'remove_from_cart' + | 'screen_view' + | 'search' + | 'select_content' + | 'set_checkout_option' + | 'share' + | 'sign_up' + | 'timing_complete' + | 'view_item' + | 'view_item_list' + | 'view_promotion' + | 'view_search_results'; + + interface EventParams { + checkout_option?: string; + checkout_step?: number; + content_id?: string; + content_type?: string; + coupon?: string; + currency?: string; + description?: string; + fatal?: boolean; + items?: Item[]; + method?: string; + number?: string; + promotions?: Promotion[]; + screen_name?: string; + search_term?: string; + shipping?: Currency; + tax?: Currency; + transaction_id?: string; + value?: number; + event_label?: string; + event_category: string; + } + + type Currency = string | number; + + interface Item { + brand?: string; + category?: string; + creative_name?: string; + creative_slot?: string; + id?: string; + location_id?: string; + name?: string; + price?: Currency; + quantity?: number; + } + + interface Promotion { + creative_name?: string; + creative_slot?: string; + id?: string; + name?: string; + } +} diff --git a/types/gtag.js/tsconfig.json b/types/gtag.js/tsconfig.json new file mode 100644 index 0000000000..4e8cd26f3f --- /dev/null +++ b/types/gtag.js/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": false, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "gtag.js-tests.ts" + ] +} \ No newline at end of file diff --git a/types/gtag.js/tslint.json b/types/gtag.js/tslint.json new file mode 100644 index 0000000000..035c359a3d --- /dev/null +++ b/types/gtag.js/tslint.json @@ -0,0 +1,6 @@ +{ + "extends": "dtslint/dt.json", + "rules": { + "dt-header": false + } +} diff --git a/types/gulp-angular-templatecache/tslint.json b/types/gulp-angular-templatecache/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-angular-templatecache/tslint.json +++ b/types/gulp-angular-templatecache/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-autoprefixer/tslint.json b/types/gulp-autoprefixer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-autoprefixer/tslint.json +++ b/types/gulp-autoprefixer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-babel/tslint.json b/types/gulp-babel/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-babel/tslint.json +++ b/types/gulp-babel/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-cache/tslint.json b/types/gulp-cache/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-cache/tslint.json +++ b/types/gulp-cache/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-cached/tslint.json b/types/gulp-cached/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-cached/tslint.json +++ b/types/gulp-cached/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-changed/tslint.json b/types/gulp-changed/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-changed/tslint.json +++ b/types/gulp-changed/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-cheerio/tslint.json b/types/gulp-cheerio/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-cheerio/tslint.json +++ b/types/gulp-cheerio/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-coffeeify/tslint.json b/types/gulp-coffeeify/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-coffeeify/tslint.json +++ b/types/gulp-coffeeify/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-coffeelint/tslint.json b/types/gulp-coffeelint/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-coffeelint/tslint.json +++ b/types/gulp-coffeelint/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-concat/tslint.json b/types/gulp-concat/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-concat/tslint.json +++ b/types/gulp-concat/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-copy/tslint.json b/types/gulp-copy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-copy/tslint.json +++ b/types/gulp-copy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-csso/tslint.json b/types/gulp-csso/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-csso/tslint.json +++ b/types/gulp-csso/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-debug/tslint.json b/types/gulp-debug/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-debug/tslint.json +++ b/types/gulp-debug/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-dtsm/tslint.json b/types/gulp-dtsm/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-dtsm/tslint.json +++ b/types/gulp-dtsm/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-espower/tslint.json b/types/gulp-espower/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-espower/tslint.json +++ b/types/gulp-espower/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-file-include/tslint.json b/types/gulp-file-include/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-file-include/tslint.json +++ b/types/gulp-file-include/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-filter/tslint.json b/types/gulp-filter/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-filter/tslint.json +++ b/types/gulp-filter/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-flatten/tslint.json b/types/gulp-flatten/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-flatten/tslint.json +++ b/types/gulp-flatten/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-gh-pages/tslint.json b/types/gulp-gh-pages/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-gh-pages/tslint.json +++ b/types/gulp-gh-pages/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-gzip/tslint.json b/types/gulp-gzip/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-gzip/tslint.json +++ b/types/gulp-gzip/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-help-doc/tslint.json b/types/gulp-help-doc/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-help-doc/tslint.json +++ b/types/gulp-help-doc/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-help/tslint.json b/types/gulp-help/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-help/tslint.json +++ b/types/gulp-help/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-html-replace/tslint.json b/types/gulp-html-replace/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-html-replace/tslint.json +++ b/types/gulp-html-replace/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-htmlmin/tslint.json b/types/gulp-htmlmin/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-htmlmin/tslint.json +++ b/types/gulp-htmlmin/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-if/tslint.json b/types/gulp-if/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-if/tslint.json +++ b/types/gulp-if/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-inject/tslint.json b/types/gulp-inject/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-inject/tslint.json +++ b/types/gulp-inject/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-insert/tslint.json b/types/gulp-insert/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-insert/tslint.json +++ b/types/gulp-insert/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-install/tslint.json b/types/gulp-install/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-install/tslint.json +++ b/types/gulp-install/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-intercept/gulp-intercept-tests.ts b/types/gulp-intercept/gulp-intercept-tests.ts new file mode 100644 index 0000000000..36952e438f --- /dev/null +++ b/types/gulp-intercept/gulp-intercept-tests.ts @@ -0,0 +1,14 @@ +import gulpIntercept = require('gulp-intercept'); +import gulp = require('gulp'); +import Vinyl = require('vinyl'); + +gulp.task('testTask', () => { + return gulp.src(['src/*.html']) + + .pipe(gulpIntercept((sourceFile: Vinyl) => { + console.log(sourceFile.path); + return sourceFile; + })) + + .pipe(gulp.dest('dist/')); +}); diff --git a/types/gulp-intercept/index.d.ts b/types/gulp-intercept/index.d.ts new file mode 100644 index 0000000000..1a73d899ae --- /dev/null +++ b/types/gulp-intercept/index.d.ts @@ -0,0 +1,22 @@ +// Type definitions for gulp-intercept 0.1 +// Project: https://github.com/khilnani/gulp-intercept +// Definitions by: Takesi Tokugawa +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +import Vinyl = require('vinyl'); + +declare namespace intercept { + interface Intercept { + (interceptFunction: InterceptFunction): NodeJS.ReadWriteStream; + } + + interface InterceptFunction { + (file: Vinyl): Vinyl; + } +} + +declare var intercept: intercept.Intercept; + +export = intercept; diff --git a/types/gulp-intercept/tsconfig.json b/types/gulp-intercept/tsconfig.json new file mode 100644 index 0000000000..07acf8c416 --- /dev/null +++ b/types/gulp-intercept/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "gulp-intercept-tests.ts" + ] +} diff --git a/types/screenfull/tslint.json b/types/gulp-intercept/tslint.json similarity index 100% rename from types/screenfull/tslint.json rename to types/gulp-intercept/tslint.json diff --git a/types/gulp-istanbul/tslint.json b/types/gulp-istanbul/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-istanbul/tslint.json +++ b/types/gulp-istanbul/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-jade/tslint.json b/types/gulp-jade/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-jade/tslint.json +++ b/types/gulp-jade/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-jasmine-browser/tslint.json b/types/gulp-jasmine-browser/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-jasmine-browser/tslint.json +++ b/types/gulp-jasmine-browser/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-json-editor/tslint.json b/types/gulp-json-editor/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-json-editor/tslint.json +++ b/types/gulp-json-editor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-jspm/tslint.json b/types/gulp-jspm/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-jspm/tslint.json +++ b/types/gulp-jspm/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-less/tslint.json b/types/gulp-less/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-less/tslint.json +++ b/types/gulp-less/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-load-plugins/tslint.json b/types/gulp-load-plugins/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-load-plugins/tslint.json +++ b/types/gulp-load-plugins/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-minify-css/tslint.json b/types/gulp-minify-css/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-minify-css/tslint.json +++ b/types/gulp-minify-css/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-minify-html/tslint.json b/types/gulp-minify-html/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-minify-html/tslint.json +++ b/types/gulp-minify-html/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-mocha/tslint.json b/types/gulp-mocha/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-mocha/tslint.json +++ b/types/gulp-mocha/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-msbuild/tslint.json b/types/gulp-msbuild/tslint.json index 65c83fb1e3..1c56ba06b6 100644 --- a/types/gulp-msbuild/tslint.json +++ b/types/gulp-msbuild/tslint.json @@ -1,6 +1,7 @@ { "extends": "dtslint/dt.json", "rules": { + "npm-naming": false, "dt-header": false } } diff --git a/types/gulp-mustache/tslint.json b/types/gulp-mustache/tslint.json index 946c3b6691..0831709701 100644 --- a/types/gulp-mustache/tslint.json +++ b/types/gulp-mustache/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO - "dt-header": false + "npm-naming": false, + "dt-header": false } } diff --git a/types/gulp-newer/tslint.json b/types/gulp-newer/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-newer/tslint.json +++ b/types/gulp-newer/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-ng-annotate/tslint.json b/types/gulp-ng-annotate/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-ng-annotate/tslint.json +++ b/types/gulp-ng-annotate/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-nodemon/tslint.json b/types/gulp-nodemon/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-nodemon/tslint.json +++ b/types/gulp-nodemon/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-nunit-runner/tslint.json b/types/gulp-nunit-runner/tslint.json index bafaae7817..f6fabe4180 100644 --- a/types/gulp-nunit-runner/tslint.json +++ b/types/gulp-nunit-runner/tslint.json @@ -2,6 +2,7 @@ "extends": "dtslint/dt.json", "rules": { // TODO + "npm-naming": false, "dt-header": false } } diff --git a/types/gulp-plumber/tslint.json b/types/gulp-plumber/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-plumber/tslint.json +++ b/types/gulp-plumber/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-protractor/tslint.json b/types/gulp-protractor/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-protractor/tslint.json +++ b/types/gulp-protractor/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-remember/tslint.json b/types/gulp-remember/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-remember/tslint.json +++ b/types/gulp-remember/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-rename/tslint.json b/types/gulp-rename/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-rename/tslint.json +++ b/types/gulp-rename/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-replace/tslint.json b/types/gulp-replace/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-replace/tslint.json +++ b/types/gulp-replace/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-rev-replace/tslint.json b/types/gulp-rev-replace/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-rev-replace/tslint.json +++ b/types/gulp-rev-replace/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-rev/tslint.json b/types/gulp-rev/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-rev/tslint.json +++ b/types/gulp-rev/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-ruby-sass/tslint.json b/types/gulp-ruby-sass/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-ruby-sass/tslint.json +++ b/types/gulp-ruby-sass/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-sass/tslint.json b/types/gulp-sass/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-sass/tslint.json +++ b/types/gulp-sass/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-shell/tslint.json b/types/gulp-shell/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-shell/tslint.json +++ b/types/gulp-shell/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-sort/tslint.json b/types/gulp-sort/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-sort/tslint.json +++ b/types/gulp-sort/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-sourcemaps/tslint.json b/types/gulp-sourcemaps/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-sourcemaps/tslint.json +++ b/types/gulp-sourcemaps/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-strip-debug/tslint.json b/types/gulp-strip-debug/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-strip-debug/tslint.json +++ b/types/gulp-strip-debug/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-svg-sprite/tslint.json b/types/gulp-svg-sprite/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-svg-sprite/tslint.json +++ b/types/gulp-svg-sprite/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-tap/gulp-tap-tests.ts b/types/gulp-tap/gulp-tap-tests.ts new file mode 100644 index 0000000000..7d89c50ba0 --- /dev/null +++ b/types/gulp-tap/gulp-tap-tests.ts @@ -0,0 +1,11 @@ +import gulpTap = require('gulp-tap'); +import gulp = require('gulp'); +import Vinyl = require('vinyl'); + +gulp.task('testTask', () => { + return gulp.src(['src/*.html']) + .pipe(gulpTap((sourceFile: Vinyl) => { + console.log(sourceFile.path); + })) + .pipe(gulp.dest('dist/')); +}); diff --git a/types/gulp-tap/index.d.ts b/types/gulp-tap/index.d.ts new file mode 100644 index 0000000000..30af7663f8 --- /dev/null +++ b/types/gulp-tap/index.d.ts @@ -0,0 +1,22 @@ +// Type definitions for gulp-tap 1.0 +// Project: https://github.com/geejs/gulp-tap +// Definitions by: Takesi Tokugawa +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped + +/// + +import Vinyl = require('vinyl'); + +declare namespace tap { + interface Tap { + (tapFunction: TapFunction, t?: any): NodeJS.ReadWriteStream; + } + + interface TapFunction { + (file: Vinyl): any; + } +} + +declare function tap(tapFunction: (file: Vinyl, t?: {}) => void): NodeJS.ReadWriteStream; + +export = tap; diff --git a/types/gulp-tap/tsconfig.json b/types/gulp-tap/tsconfig.json new file mode 100644 index 0000000000..d48ac90475 --- /dev/null +++ b/types/gulp-tap/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictFunctionTypes": true, + "strictNullChecks": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "gulp-tap-tests.ts" + ] +} diff --git a/types/gulp-tap/tslint.json b/types/gulp-tap/tslint.json new file mode 100644 index 0000000000..f93cf8562a --- /dev/null +++ b/types/gulp-tap/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "dtslint/dt.json" +} diff --git a/types/gulp-task-listing/tslint.json b/types/gulp-task-listing/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-task-listing/tslint.json +++ b/types/gulp-task-listing/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-tsd/tslint.json b/types/gulp-tsd/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-tsd/tslint.json +++ b/types/gulp-tsd/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-useref/tslint.json b/types/gulp-useref/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-useref/tslint.json +++ b/types/gulp-useref/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp-watch/tslint.json b/types/gulp-watch/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/gulp-watch/tslint.json +++ b/types/gulp-watch/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/gulp/tslint.json b/types/gulp/tslint.json index 0ba754a19a..19067f25e6 100644 --- a/types/gulp/tslint.json +++ b/types/gulp/tslint.json @@ -3,6 +3,7 @@ "rules": { // TODOs "dt-header": false, + "npm-naming": false, "no-object-literal-type-assertion": false } } diff --git a/types/gun/gun-tests.ts b/types/gun/gun-tests.ts index d196fba695..e399414e0a 100644 --- a/types/gun/gun-tests.ts +++ b/types/gun/gun-tests.ts @@ -28,7 +28,9 @@ interface AppState { object: { num: number; str: string; + /** Comment test */ bool: boolean; + specstr: 'a' | 'b'; obj: { arr2: Array<{ foo: number; bar: string }>; }; @@ -47,6 +49,9 @@ app.get('object') .get('obj') .get('arr2') .set({ foo: 1, bar: '2' }); +app.get('object').put({ + bool: true +}); app.get('object') .get('bool') @@ -70,3 +75,40 @@ app.get('chatRoom').time!(msg => { }, 20); // $ExpectError app.get('object').time!({ a: 1 }); + +class X { + val: string; + b() {} +} +interface BadState { + // Top level primitives + a: 1; + b: { + // Ban functions + c: () => void; + // Ban class + d: typeof X; + // Recursive check for banned types + e: { + f: () => void; + }; + }; + // Filter, remove functions on prototype. + c: X; +} +const bad = new Gun(); +// $ExpectError +bad.get('a').put(1); +bad.get('b') + .get('c') + // $ExpectError + .put(() => {}); +bad.get('b') + .get('d') + // $ExpectError + .put(X); + +// $ExpectError +bad.get('b').put({ c: () => {}, d: X, e: { f: () => {} } }); +// $ExpectError +bad.get('c').put(new X()); diff --git a/types/gun/index.d.ts b/types/gun/index.d.ts index 51d02b68d5..0cba9d6620 100644 --- a/types/gun/index.d.ts +++ b/types/gun/index.d.ts @@ -2,7 +2,7 @@ // Project: https://github.com/amark/gun#readme // Definitions by: Jack Works // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped -// TypeScript Version: 2.9 +// TypeScript Version: 3.1 declare const cons: Gun.Constructor; export = cons; @@ -12,6 +12,30 @@ declare namespace Gun { /** Gun does not accept Array value, so we need extract to make types correct */ type AllowArray = ArrayOf extends never ? T : ArrayOf; type DisallowArray = ArrayOf extends never ? T : never; + /** These types cannot be stored on Gun */ + + type AlwaysDisallowedType = T extends (...args: any[]) => void + ? never + : T extends { new (...args: any[]): any } + ? never + : AccessObject; + type AccessObject = T extends object + ? { [key in keyof T]: (AlwaysDisallowedType extends never ? never : AccessObject) } + : T; + /** These types cannot be stored on Gun's root level */ + type DisallowPrimitives = Open extends false + ? T + : T extends string + ? never + : T extends number + ? never + : T extends boolean + ? never + : T extends null + ? never + : T extends undefined + ? never + : T; type ArrayAsRecord = ArrayOf extends never ? DataType : Record; /** * options['module name'] allows you to pass options to a 3rd party module. @@ -45,7 +69,9 @@ declare namespace Gun { }>; type Saveable = Partial | string | number | boolean | null | ChainReference; type AckCallback = (ack: { err: Error; ok: any } | { err: undefined; ok: string }) => void; - interface ChainReference { + type Parameters any> = T extends (...args: infer P) => any ? P : never; + interface ChainReference { + //#region API /** * Save data into gun, syncing it with your connected peers. * @@ -59,7 +85,10 @@ declare namespace Gun { * * @param callback invoked on each acknowledgment */ - put(data: DisallowArray, callback?: AckCallback): ChainReference; + put( + data: Partial>>>, + callback?: AckCallback + ): ChainReference; /** * Where to read data from. * @param key The key is the ID or property name of the data that you saved from earlier @@ -83,7 +112,7 @@ declare namespace Gun { /** the key, ID, or property name of the data. */ paramB: Record<'off' | 'to' | 'next' | 'the' | 'on' | 'as' | 'back' | 'rid' | 'id', any> ) => void - ): ChainReference; + ): ChainReference; /** * Change the configuration of the gun database instance. * @param options The options argument is the same object you pass to the constructor. @@ -115,7 +144,10 @@ declare namespace Gun { * To remove a listener call .off() on the same property or node. */ on( - callback: (data: ArrayAsRecord, key: ReferenceKey) => void, + callback: ( + data: DisallowPrimitives>>, + key: ReferenceKey + ) => void, option?: { change: boolean } | boolean ): ChainReference; /** @@ -123,7 +155,10 @@ declare namespace Gun { * @returns In the document, it said the return value may change in the future. Don't rely on it. */ once( - callback?: (data: (ArrayAsRecord) | undefined, key: ReferenceKey) => void, + callback?: ( + data: (DisallowPrimitives>>) | undefined, + key: ReferenceKey + ) => void, option?: { wait: number } ): ChainReference; /** @@ -136,11 +171,13 @@ declare namespace Gun { * **This means only objects, for now, are supported.** */ set( - data: DataType extends Array - ? U extends { [key: string]: any; [key: number]: any } - ? ArrayOf + data: AlwaysDisallowedType< + DataType extends Array + ? U extends { [key: string]: any; [key: number]: any } + ? ArrayOf + : never : never - : never, + >, callback?: AckCallback ): ChainReference>; /** @@ -157,8 +194,8 @@ declare namespace Gun { * Remove **all** listener on this node. */ off(): void; - - // Extended API + //#endregion + //#region Extended API /** * * Path does the same thing as `.get` but has some conveniences built in. @@ -256,15 +293,76 @@ declare namespace Gun { ): ChainReference; /** Pushes data to a Timegraph with it's time set to Gun.state()'s time */ time?(data: ArrayOf): void; + //#endregion + //#region User + /** + * Creates a new user and calls callback upon completion. + * @param alias Username or Alias which can be used to find a user. + * @param pass Passphrase that will be extended with PBKDF2 to make it a secure way to login. + * @param cb Callback that is to be called upon creation of the user. + * @param opt Option Object containing options for creation. (In gun options are added at end of syntax. opt is rarely used, hence is added at the end.) + */ + create( + alias: string, + pass: string, + cb?: (ack: { ok: 0; pub: string } | { err: string }) => void, + opt?: {} + ): ChainReference; + /** + * Authenticates a user, previously created via User.create. + * @param alias Username or Alias which can be used to find a user. + * @param pass Passphrase for the user + * @param cb Callback that is to be called upon authentication of the user. + * @param opt Option Object containing options for authentiaction. (In gun options are added at end of syntax. opt is rarely used, hence is added at the end.) + */ + auth( + alias: string, + pass: string, + cb?: ( + ack: + | { + ack: 2; + get: string; + on: (...args: [unknown, unknown, unknown]) => unknown; + put: { alias: string; auth: any; epub: string; pub: string }; + sea: CryptoKeyPair; + soul: string; + } + | { err: string } + ) => void, + opt?: {} + ): ChainReference; + /** + * Returns the key pair in the form of an object as below. + */ + pair(): CryptoKeyPair; + /** + * Log out currently authenticated user. Parameters are unused in the current implementation. + * @param opt unused in current implementation. + * @param cb unused in current implementation. + */ + leave(opt?: never, cb?: never): ChainReference; + /** + * Deletes a user from the current gun instance and propagates the delete to other peers. + * @param alias Username or alias. + * @param pass Passphrase for the user. + * @param cb Callback that is called when the user was successfully deleted. + */ + delete(alias: string, pass: string, cb?: (ack: { ok: 0 }) => void): Promise; + /** + * Recall saves a users credentials in sessionStorage of the browser. As long as the tab of your app is not closed the user stays logged in, even through page refreshes and reloads. + * @param opt option object If you want to use browser sessionStorage to allow users to stay logged in as long as the session is open, set opt.sessionStorage to true + * @param cb internally the callback is passed on to the user.auth function to logged the user back in. Refer to user.auth for callback documentation. + */ + recall(opt?: { sessionStorage: boolean }, cb?: Parameters[2]): ChainReference; + /** + * @param publicKey If you know a users publicKey you can get his user graph and see any unencrypted data he may have stored there. + */ + user(publicKey?: string): ChainReference; + //#endregion } - interface GunSEA { - // There is no the only content in the api document. - user: { - create(alias: string, passphrase: string, callback: (...args: any[]) => void): any; - }; - } - + type CryptoKeyPair = Record<'pub' | 'priv' | 'epub' | 'epriv', string>; interface Constructor { /** * @description @@ -274,8 +372,12 @@ declare namespace Gun { * * or you can pass in an array of URLs to sync with multiple peers. */ - (options?: string | string[] | ConstructorOptions): ChainReference & GunSEA; - new (options?: string | string[] | ConstructorOptions): ChainReference & GunSEA; + (options?: string | string[] | ConstructorOptions): ChainReference; + new (options?: string | string[] | ConstructorOptions): ChainReference< + DataType, + any, + 'pre_root' + >; node: { /** Returns true if data is a gun node, otherwise false. */ is(anything: any): anything is ChainReference; @@ -289,7 +391,66 @@ declare namespace Gun { ify(json: any): any; }; /** @see https://gun.eco/docs/SEA */ - SEA: any; + SEA: { + /** If you want SEA to throw while in development, turn SEA.throw = true on, but please do not use this in production. */ + throw?: boolean; + /** Last known error */ + err?: Error; + /** + * This gives you a Proof of Work (POW) / Hashing of Data + * @param data The data to be hashed, work to be performed on. + * @param pair (salt) You can pass pair of keys to use as salt. Salt will prevent others to pre-compute the work, + * so using your public key is not a good idea. If it is not specified, it will be random, + * which ruins your chance of ever being able to re-derive the work deterministically + * @param callback function to executed upon execution of proof + * @param opt default: {name: 'PBKDF2', encode: 'base64'} + */ + work( + data: any, + pair?: any, + callback?: (data: string | undefined) => void, + opt?: Partial<{ + name: 'SHA-256' | 'PBKDF2'; + encode: 'base64' | 'base32' | 'base16'; + /** iterations to use on subtle.deriveBits */ + iterations: number; + salt: any; + hash: string; + length: any; + }> + ): Promise; + /** + * This generates a cryptographically secure public/private key pair - be careful not to leak the private keys! + * Note: API subject to change we may change the parameters to accept data and work, in addition to generation. + * You will need this for most of SEA's API, see those method's examples. + * The default cryptographic primitives for the asymmetric keys are ECDSA for signing and ECDH for encryption. + */ + pair(cb: (data: CryptoKeyPair) => void, opt?: {}): Promise; + /** + * Adds a signature to a message, for data that you want to prevent attackers tampering with. + * @param data is the content that you want to prove is authorized. + * @param pair is from .pair. + */ + sign(data: any, pair: CryptoKeyPair): Promise; + /** + * Gets the data if and only if the message can be verified as coming from the person you expect. + * @param message is what comes from .sign. + * @param pair from .pair or its public key text (pair.pub). + */ + verify(message: any, pair: CryptoKeyPair | string): Promise; + /** + * Takes some data that you want to keep secret and encrypts it so nobody else can read it. + * @param data is the content that you want to encrypt. + * @param pair from .pair or a passphrase you want to use as a cypher to encrypt with. + */ + encrypt(data: any, pair: CryptoKeyPair | string): Promise; + /** + * Read the secret data, if and only if you are allowed to. + * @param message is what comes from .encrypt. + * @param pair from .pair or the passphrase to decypher the message. + */ + decrypt(message: any, pair: CryptoKeyPair | string): Promise; + }; } } declare const Gun: Gun.Constructor; diff --git a/types/h2o2/tslint.json b/types/h2o2/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/h2o2/tslint.json +++ b/types/h2o2/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/halfred/tslint.json b/types/halfred/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/halfred/tslint.json +++ b/types/halfred/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hammerjs/tslint.json b/types/hammerjs/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hammerjs/tslint.json +++ b/types/hammerjs/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hapi-auth-basic/tslint.json b/types/hapi-auth-basic/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hapi-auth-basic/tslint.json +++ b/types/hapi-auth-basic/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hapi-decorators/tslint.json b/types/hapi-decorators/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hapi-decorators/tslint.json +++ b/types/hapi-decorators/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/harmony-proxy/tslint.json b/types/harmony-proxy/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/harmony-proxy/tslint.json +++ b/types/harmony-proxy/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hasher/tslint.json b/types/hasher/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hasher/tslint.json +++ b/types/hasher/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hashids/tslint.json b/types/hashids/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hashids/tslint.json +++ b/types/hashids/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hashmap/tslint.json b/types/hashmap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hashmap/tslint.json +++ b/types/hashmap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hashset/tslint.json b/types/hashset/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hashset/tslint.json +++ b/types/hashset/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hashtable/tslint.json b/types/hashtable/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hashtable/tslint.json +++ b/types/hashtable/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/he/tslint.json b/types/he/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/he/tslint.json +++ b/types/he/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/headroom/tslint.json b/types/headroom/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/headroom/tslint.json +++ b/types/headroom/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/heap/tslint.json b/types/heap/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/heap/tslint.json +++ b/types/heap/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hellosign-embedded/tslint.json b/types/hellosign-embedded/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hellosign-embedded/tslint.json +++ b/types/hellosign-embedded/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/helmet/tslint.json b/types/helmet/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/helmet/tslint.json +++ b/types/helmet/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/highcharts-ng/tslint.json b/types/highcharts-ng/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/highcharts-ng/tslint.json +++ b/types/highcharts-ng/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/highcharts/index.d.ts b/types/highcharts/index.d.ts index b3900154cd..8001ab7884 100644 --- a/types/highcharts/index.d.ts +++ b/types/highcharts/index.d.ts @@ -5,6 +5,7 @@ // Albert Ozimek // Juliën Hanssens // Johns Gresham +// ArunkeshavaReddy Sankaramaddi // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped // TypeScript Version: 2.3 @@ -4458,7 +4459,10 @@ declare namespace Highcharts { * @default 'Solid' */ dashStyle?: string; - dataLabels?: DataLabels; + /** + * Gantt charts use one or more data labels for each series, for showing multiple date periods. + */ + dataLabels?: DataLabels | DataLabels[]; /** * Enable or disable the mouse tracking for a specific series. This includes point tooltips and click events on * graphs and points. For large datasets it improves performance. @@ -5984,6 +5988,7 @@ declare namespace Highcharts { interface ColumnRangeChartSeriesOptions extends IndividualSeriesOptions, ColumnRangeChart { } interface ErrorBarChartSeriesOptions extends IndividualSeriesOptions, ErrorBarChart { } interface FunnelChartSeriesOptions extends IndividualSeriesOptions, FunnelChart { } + interface GanttChartSeriesOptions extends IndividualSeriesOptions, SeriesChart { } interface GaugeChartSeriesOptions extends IndividualSeriesOptions, GaugeChart { } interface HeatMapSeriesOptions extends IndividualSeriesOptions, HeatMapChart { } interface LineChartSeriesOptions extends IndividualSeriesOptions, LineChart { } @@ -6023,11 +6028,11 @@ declare namespace Highcharts { * The id of a series in the drilldown.series array to use for a drilldown for this point. * @since 3.0.8 */ - drilldown?: string; - /** - * The end value of the point. For gantt datetime axes, the end value is the timestamp in milliseconds since 1970. - */ - end?: number; + drilldown?: string; + /** + * The end value of the point. For gantt datetime axes, the end value is the timestamp in milliseconds since 1970. + */ + end?: number; /** * Individual point events */ @@ -6106,11 +6111,11 @@ declare namespace Highcharts { * Whether to display a slice offset from the center. * @default false */ - sliced?: boolean; - /** - * The start value of the point. For gantt datetime axes, the start value is the timestamp in milliseconds since 1970. - */ - start?: number; + sliced?: boolean; + /** + * The start value of the point. For gantt datetime axes, the start value is the timestamp in milliseconds since 1970. + */ + start?: number; /** * The value of the point, resulting in a relative area of the point in the treemap. */ @@ -6686,6 +6691,16 @@ declare namespace Highcharts { yAxis?: AxisOptions[] | AxisOptions; } + /** + * The Gantt chart uses different plot options than the base Highcharts chart Options. + */ + interface GanttOptions extends Options { + /** + * The specific Gantt Series to append the GanttChart. + */ + series?: GanttChartSeriesOptions[]; + } + interface GlobalOptions extends Options { /** * Global options that don't apply to each chart. These options, like the lang options, must be set using the @@ -7269,11 +7284,11 @@ declare namespace Highcharts { * As Highcharts.Chart, but without need for the new keyword. * @since 4.2.0 */ - chart(renderTo: string | HTMLElement, options: Options, callback?: (chart: ChartObject) => void): ChartObject; - /** - * Highcharts ganttChart which doesn't require the new keyword. Required Highcharts Gantt module. - */ - ganttChart(renderTo: string | HTMLElement, options: Options, callback?: (chart: ChartObject) => void): ChartObject; + chart(renderTo: string | HTMLElement, options: Options, callback?: (chart: ChartObject) => void): ChartObject; + /** + * Highcharts ganttChart which doesn't require the new keyword. Required Highcharts Gantt module. + */ + ganttChart(renderTo: string | HTMLElement, options: GanttOptions, callback?: (chart: ChartObject) => void): ChartObject; /** * An array containing the current chart objects in the page. A chart's position in the array is preserved * throughout the page's lifetime. When a chart is destroyed, the array item becomes undefined. diff --git a/types/highcharts/test/index.ts b/types/highcharts/test/index.ts index 9ac03d1f81..358064b877 100644 --- a/types/highcharts/test/index.ts +++ b/types/highcharts/test/index.ts @@ -2886,3 +2886,46 @@ function test_GanttChart() { }], }); } + +// Tests DataLabels types for Highcharts.ganttChart, which uses the Gantt module +function test_GanttChartDataLabels() { + Highcharts.ganttChart('ganttChartContainer', { + xAxis: { + min: Date.UTC(2014, 9, 18), + max: Date.UTC(2014, 12, 20) + }, + series: [{ + name: 'Project 1', + data: [ + { + name: 'Lemon Tea', + start: Date.UTC(2014, 10, 18), + end: Date.UTC(2014, 11, 20) + }, + { + name: 'Stapler', + start: Date.UTC(2014, 11, 18), + end: Date.UTC(2014, 12, 20) + }, + { + name: 'Sierra', + start: Date.UTC(2014, 12, 18), + end: Date.UTC(2014, 12, 20) + }, + ], + dataLabels: [{ + enabled: true, + format: 'Data Label Left', + useHTML: true, + align: 'left', + allowOverlap: true, + }, { + enabled: true, + format: 'Data Label Right', + useHTML: true, + align: 'right', + allowOverlap: true, + }] + }], + }); +} diff --git a/types/highland/tslint.json b/types/highland/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/highland/tslint.json +++ b/types/highland/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/highlight.js/tslint.json b/types/highlight.js/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/highlight.js/tslint.json +++ b/types/highlight.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/history.js/tslint.json b/types/history.js/tslint.json index d67ffb3a73..6c7fd03ccd 100644 --- a/types/history.js/tslint.json +++ b/types/history.js/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/history/tslint.json b/types/history/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/history/tslint.json +++ b/types/history/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hls.js/index.d.ts b/types/hls.js/index.d.ts index 52967890bd..a2b6486668 100644 --- a/types/hls.js/index.d.ts +++ b/types/hls.js/index.d.ts @@ -1641,7 +1641,7 @@ declare class Hls { /** * return array of available quality levels */ - levels: Hls.Level[]; + readonly levels: Hls.Level[]; /** * get: return current playback quality level * set: trigger an immediate quality level switch to new quality level @@ -1666,16 +1666,6 @@ declare class Hls { * default valus is hls.firstLevel */ startLevel: number; - /** - * (default: true) - * if set to true, start level playlist and first fragments will be loaded automatically, after triggering of Hls.Events.MANIFEST_PARSED event - * if set to false, an explicit API call (hls.startLoad(startPosition=-1)) will be needed to start quality level/fragment loading. - */ - autoStartLoad: boolean; - /** - * get: Return the bound videoElement from the hls instance - */ - media: HTMLVideoElement; /** * hls.js config */ @@ -1709,7 +1699,7 @@ declare class Hls { /** * array of audio tracks exposed in manifest */ - audioTracks: AudioTrack[]; + readonly audioTracks: AudioTrack[]; /** * get: returns audio track id * set: sets audio track id (returned by) @@ -1718,11 +1708,11 @@ declare class Hls { /** * position of live sync point (ie edge of live position minus safety delay defined by hls.config.liveSyncDuration) */ - liveSyncPosition: number; + readonly liveSyncPosition: number; /** * get : array of subtitle tracks exposed in manifest */ - subtitleTracks: any[]; + readonly subtitleTracks: any[]; /** * get/set : subtitle track id (returned by). * Returns -1 if no track is visible. @@ -1735,11 +1725,6 @@ declare class Hls { * If set to false, the mode will be set to hidden. */ subtitleDisplay: boolean; - /** - * (default: NaN) - * Return current download bandwidth in bits/s if available - */ - bandwidthEstimate: number; /** * calling this method will: * bind videoElement and hls instances @@ -1757,7 +1742,7 @@ declare class Hls { /** * tell whether auto level selection is enabled or not */ - autoLevelEnabled(enabled: boolean): boolean; + readonly autoLevelEnabled: boolean; /** * loads provided url as media source */ diff --git a/types/hooker/tslint.json b/types/hooker/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hooker/tslint.json +++ b/types/hooker/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/hopscotch/tslint.json b/types/hopscotch/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/hopscotch/tslint.json +++ b/types/hopscotch/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/howler/tslint.json b/types/howler/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/howler/tslint.json +++ b/types/howler/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/html-entities/tslint.json b/types/html-entities/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/html-entities/tslint.json +++ b/types/html-entities/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/html-pdf/tslint.json b/types/html-pdf/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/html-pdf/tslint.json +++ b/types/html-pdf/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/html-to-text/tslint.json b/types/html-to-text/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/html-to-text/tslint.json +++ b/types/html-to-text/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/html2canvas/tslint.json b/types/html2canvas/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/html2canvas/tslint.json +++ b/types/html2canvas/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/html5-to-pdf/html5-to-pdf-tests.ts b/types/html5-to-pdf/html5-to-pdf-tests.ts new file mode 100644 index 0000000000..1081f5fa12 --- /dev/null +++ b/types/html5-to-pdf/html5-to-pdf-tests.ts @@ -0,0 +1,9 @@ +import * as HTML5ToPDF from "html5-to-pdf"; + +const options = { inputBody: "Hello World" }; +const converter = new HTML5ToPDF(options); +converter.parseOptions(options); // $ExpectType ParsedOptions +converter.build(); // $ExpectType Promise +converter.includeAssets(); // $ExpectType Promise +converter.start(); // $ExpectType Promise +converter.close(); // $ExpectType Promise diff --git a/types/html5-to-pdf/index.d.ts b/types/html5-to-pdf/index.d.ts new file mode 100644 index 0000000000..a4967ed199 --- /dev/null +++ b/types/html5-to-pdf/index.d.ts @@ -0,0 +1,118 @@ +// Type definitions for html5-to-pdf 3.1 +// Project: https://github.com/peterdemartini/html5-to-pdf +// Definitions by: Sam Alexander +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.8 + +import { LaunchOptions, PDFOptions, Page } from "puppeteer"; + +declare class HTML5ToPDF { + constructor(options: HTML5ToPDF.Options); + + build(): Promise; + + close(): Promise; + + includeAssets(): Promise; + + parseOptions(options: HTML5ToPDF.Options): HTML5ToPDF.ParsedOptions; + + start(): Promise; +} + +declare namespace HTML5ToPDF { + interface FileDef { + /** + * File type + */ + type: "css" | "js"; + /** + * File path + */ + filePath: string; + } + + interface ParsedOptions { + body: string | Buffer; + pdf: PDFOptions; + templatePath: string; + templateUrl: string; + launchOptions: LaunchOptions; + include: FileDef[]; + renderDelay: number; + } + + interface LegacyOptions { + /** + * [COMPATIBLE]\ + * Page size + */ + pageSize?: "A3" | "A4" | "Legal" | "Tabloid"; + /** + * [COMPATIBLE]\ + * True for landscape, false for portrait. + */ + landscape?: boolean; + /** + * [NOT COMPATIBLE]\ + * 0 - default\ + * 1 - none\ + * 2 - minimum + */ + marginsType?: number; + /** + * [COMPATIBLE]\ + * Whether to print CSS backgrounds. + */ + printBackground?: boolean; + } + + interface Options { + /** + * Path to the input HTML. + */ + inputPath?: string; + /** + * Path to the input html as a String, or Buffer. If specified this will override inputPath. + */ + inputBody?: string | Buffer; + /** + * Path to the output pdf file. + */ + outputPath?: string; + /** + * Delay in milliseconds before rendering the PDF (give HTML and CSS a chance to load). + */ + rendererDelay?: number; + /** + * A list of CSS or JS assets to include. + */ + include?: Array; + /** + * The template to use when rendering the html. + */ + template?: string; + /** + * The template to use for rendering the html. If this is set, it will use this instead of the template path. + */ + templateUrl?: string; + /** + * This object will be passed directly to `puppeteer`. + */ + pdf?: PDFOptions; + /** + * This object will be passed directly to `puppeteer`. + */ + launchOptions?: LaunchOptions; + /** + * @deprecated Legacy Options. + * See `options.pdf` for pdf options. Since some of these options are converted over to work with `puppeteer`, + * this is automatically done if `options.pdf` is left empty. + */ + options?: LegacyOptions; + } +} + +export = HTML5ToPDF; + +export as namespace HTML5ToPDF; diff --git a/types/html5-to-pdf/tsconfig.json b/types/html5-to-pdf/tsconfig.json new file mode 100644 index 0000000000..a2ee9070de --- /dev/null +++ b/types/html5-to-pdf/tsconfig.json @@ -0,0 +1,26 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6", + "dom", + "es2017" + ], + "target": "es2017", + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "html5-to-pdf-tests.ts" + ] +} diff --git a/types/html5-to-pdf/tslint.json b/types/html5-to-pdf/tslint.json new file mode 100644 index 0000000000..3db14f85ea --- /dev/null +++ b/types/html5-to-pdf/tslint.json @@ -0,0 +1 @@ +{ "extends": "dtslint/dt.json" } diff --git a/types/htmlescape/tslint.json b/types/htmlescape/tslint.json index cb07a85b4e..6439f14555 100644 --- a/types/htmlescape/tslint.json +++ b/types/htmlescape/tslint.json @@ -3,6 +3,7 @@ "rules": { // TODO "dt-header": false, + "npm-naming": false, "no-duplicate-imports": false } } diff --git a/types/htmlhint/tslint.json b/types/htmlhint/tslint.json index a41bf5d19a..3d59f55fda 100644 --- a/types/htmlhint/tslint.json +++ b/types/htmlhint/tslint.json @@ -8,6 +8,7 @@ "callable-types": false, "comment-format": false, "dt-header": false, + "npm-naming": false, "eofline": false, "export-just-namespace": false, "import-spacing": false, diff --git a/types/htmlparser2/htmlparser2-tests.ts b/types/htmlparser2/htmlparser2-tests.ts index 21289b96f5..807f2fe904 100644 --- a/types/htmlparser2/htmlparser2-tests.ts +++ b/types/htmlparser2/htmlparser2-tests.ts @@ -1,23 +1,30 @@ /** * Created by staticfunction on 8/4/14. */ -import htmlparser = require("htmlparser2"); +import htmlparser = require('htmlparser2'); -var parser = new htmlparser.Parser({ - onopentag: (name:string, attribs:{[s:string]:string}) => { - if(name === "script" && attribs['type'] === "text/javascript"){ - console.log("JS! Hooray!"); - } - }, - ontext: (text: string) => { - console.log("-->", text); - }, - onclosetag: (tagname:string) => { - if(tagname === "script"){ - console.log("That's it?!"); - } +const options: htmlparser.DomHandlerOptions = { withEndIndices: false, withDomLvl1: true } +const dh = new htmlparser.DomHandler((err: Error, dom: htmlparser.DomElement[]) => { + if(err) { + throw err; } -}); + + // Use DomUtils to get name of first element in dom + console.log(htmlparser.DomUtils.getName(dom[0])); +}, options); +dh.onopentag = (name:string, attribs:{[s:string]:string}) => { + if(name === "script" && attribs['type'] === "text/javascript"){ + console.log("JS! Hooray!"); + } +}; +dh.ontext = (text: string) => { + console.log("-->", text); +}; +dh.onclosetag = () => { + console.log("That's it?!"); +}; + +var parser = new htmlparser.Parser(dh); parser.write("Xyz "); parser.end(); diff --git a/types/htmlparser2/index.d.ts b/types/htmlparser2/index.d.ts index 313ff56a96..c10dea047e 100644 --- a/types/htmlparser2/index.d.ts +++ b/types/htmlparser2/index.d.ts @@ -1,30 +1,20 @@ -// Type definitions for htmlparser2 v3.7.x +// Type definitions for htmlparser2 v3.10.x // Project: https://github.com/fb55/htmlparser2/ // Definitions by: James Roland Cabresos // Linus Unnebäck +// Johan Davidsson // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped /// +/// +/// import { Writable } from 'stream' +import { DomHandler } from 'domhandler'; +import * as DomUtils from 'domutils'; +export { DomElement, DomHandlerOptions, DomHandler, Element, Node } from 'domhandler'; -export interface Handler { - onopentag?: (name: string, attribs: { [type: string]: string }) => void; - onopentagname?: (name: string) => void; - onattribute?: (name: string, value: string) => void; - ontext?: (text: string) => void; - onclosetag?: (text: string) => void; - onprocessinginstruction?: (name: string, data: string) => void; - oncomment?: (data: string) => void; - oncommentend?: () => void; - oncdatastart?: () => void; - oncdataend?: () => void; - onerror?: (error: Error) => void; - onreset?: () => void; - onend?: () => void; -} - -export interface Options { +export interface ParserOptions { /*** * Indicates whether special tags (