google-ads-api 13.0.0 → 14.1.0-beta-0

package/README.md

@@ -7,7 +7,7 @@
 </p>
 <p align="center">
   <a href="https://developers.google.com/google-ads/api/docs/release-notes">
-    <img src="https://img.shields.io/badge/google%20ads-v13.0.0-009688.svg?style=flat-square">
+    <img src="https://img.shields.io/badge/google%20ads-v14.1.0-009688.svg?style=flat-square">
   </a>
   <a href="https://www.npmjs.com/package/google-ads-api">
     <img src="https://img.shields.io/npm/v/google-ads-api.svg?style=flat-square">
@@ -30,12 +30,6 @@
 - Typescript definitions for all resources, enums, errors and services
 - Provides all API functionality
 
-> The Google Ads API is the new replacement to the AdWords API. Google will deprecate the AdWords API on the 27th of April, 2022.
-
-# Hiring
-
-We're currently hiring full-stack engineers at [Opteo](https://opteo.com)! If you're interested in working on this library and other exciting projects, say hello at [louis@opteo.com](mailto:louis@opteo.com)
-
 # Installation
 
 ```bash

package/build/src/customer.d.ts

@@ -10,7 +10,7 @@ export declare class Customer extends ServiceFactory {
       @description Single query using a raw GAQL string.
       @hooks onQueryStart, onQueryError, onQueryEnd
     */
-    query<T = services.IGoogleAdsRow[]>(gaqlQuery: string, requestOptions?: RequestOptions): Promise<T>;
+    query<T = services.IGoogleAdsRow[]>(gaqlQuery: string, requestOptions?: Readonly<RequestOptions>): Promise<T>;
     /**
       @description Stream query using a raw GAQL string. If a generic type is provided, it must be the type of a single row.
       If a summary row is requested then this will be the last emitted row of the stream.
@@ -19,18 +19,18 @@ export declare class Customer extends ServiceFactory {
       const stream = queryStream<T>(gaqlQuery)
       for await (const row of stream) { ... }
     */
-    queryStream<T = services.IGoogleAdsRow>(gaqlQuery: string, requestOptions?: RequestOptions): AsyncGenerator<T>;
+    queryStream<T = services.IGoogleAdsRow>(gaqlQuery: string, requestOptions?: Readonly<RequestOptions>): AsyncGenerator<T>;
     /**
       @description Single query using ReportOptions.
       If a summary row is requested then this will be the first row of the results.
       @hooks onQueryStart, onQueryError, onQueryEnd
     */
-    report<T = services.IGoogleAdsRow[]>(options: ReportOptions): Promise<T>;
+    report<T = services.IGoogleAdsRow[]>(options: Readonly<ReportOptions>): Promise<T>;
     /**
       @description Get the total row count of a report.
       @hooks none
     */
-    reportCount(options: ReportOptions): Promise<number | undefined>;
+    reportCount(options: Readonly<ReportOptions>): Promise<number | undefined>;
     /**
       @description Stream query using ReportOptions. If a generic type is provided, it must be the type of a single row.
       If a summary row is requested then this will be the last emitted row of the stream.
@@ -39,7 +39,7 @@ export declare class Customer extends ServiceFactory {
       const stream = reportStream<T>(reportOptions)
       for await (const row of stream) { ... }
     */
-    reportStream<T = services.IGoogleAdsRow>(reportOptions: ReportOptions): AsyncGenerator<T>;
+    reportStream<T = services.IGoogleAdsRow>(reportOptions: Readonly<ReportOptions>): AsyncGenerator<T>;
     /**
       @description Retreive the raw stream using ReportOptions.
       @hooks onStreamStart
@@ -49,7 +49,7 @@ export declare class Customer extends ServiceFactory {
       stream.on('error', (error) => { ... })
       stream.on('end', () => { ... })
     */
-    reportStreamRaw(reportOptions: ReportOptions): Promise<CancellableStream | void>;
+    reportStreamRaw(reportOptions: Readonly<ReportOptions>): Promise<CancellableStream | void>;
     private search;
     private paginatedSearch;
     private querier;

package/build/src/customer.js

@@ -49,8 +49,7 @@ class Customer extends serviceFactory_1.default {
       @hooks none
     */
     async reportCount(options) {
-        options.limit = 1; // must get at least one row
-        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)(options);
+        const { gaqlQuery, requestOptions } = (0, query_1.buildQuery)({ ...options, limit: 1 }); // must get at least one row
         // @ts-expect-error we do not allow this field in reportOptions, however it is still a valid request option
         requestOptions.return_total_results_count = true;
         const useHooks = false; // to avoid cacheing conflicts