@google-ads/admanager 0.8.0 → 0.10.0

package/build/src/v1/company_service_client.d.ts

@@ -3,7 +3,8 @@ import type { Callback, CallOptions, Descriptors, ClientOptions, PaginationCallb
 import { Transform } from 'stream';
 import * as protos from '../../protos/protos';
 /**
- *  Provides methods for handling `Company` objects.
+ *  Provides methods for handling {@link protos.google.ads.admanager.v1.Company|Company}
+ *  objects.
  * @class
  * @memberof v1
  */
@@ -116,7 +117,7 @@ export declare class CompanyServiceClient {
     getProjectId(): Promise<string>;
     getProjectId(callback: Callback<string, undefined, undefined>): void;
     /**
-     * Retrieves a `Company` object.
+     * Retrieves a {@link protos.google.ads.admanager.v1.Company|Company} object.
      *
      * @param {Object} request
      *   The request object that will be sent.
@@ -140,45 +141,157 @@ export declare class CompanyServiceClient {
     getCompany(request: protos.google.ads.admanager.v1.IGetCompanyRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.IGetCompanyRequest | null | undefined, {} | null | undefined>): void;
     getCompany(request: protos.google.ads.admanager.v1.IGetCompanyRequest, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.IGetCompanyRequest | null | undefined, {} | null | undefined>): void;
     /**
-     * Lists `Company` objects.
+     * Creates a {@link protos.google.ads.admanager.v1.Company|Company} object.
      *
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent, which owns this collection of Companies.
+     *   Required. The parent resource where this
+     *   {@link protos.google.ads.admanager.v1.Company|Company} will be created. Format:
+     *   `networks/{network_code}`
+     * @param {google.ads.admanager.v1.Company} request.company
+     *   Required. The {@link protos.google.ads.admanager.v1.Company|Company} to create.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Company|Company}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/company_service.create_company.js</caption>
+     * region_tag:admanager_v1_generated_CompanyService_CreateCompany_async
+     */
+    createCompany(request?: protos.google.ads.admanager.v1.ICreateCompanyRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ICompany,
+        protos.google.ads.admanager.v1.ICreateCompanyRequest | undefined,
+        {} | undefined
+    ]>;
+    createCompany(request: protos.google.ads.admanager.v1.ICreateCompanyRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.ICreateCompanyRequest | null | undefined, {} | null | undefined>): void;
+    createCompany(request: protos.google.ads.admanager.v1.ICreateCompanyRequest, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.ICreateCompanyRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Creates {@link protos.google.ads.admanager.v1.Company|Company} objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where {@link protos.|Companies} will be created.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the CreateCompanyRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The {@link protos.google.ads.admanager.v1.Company|Company} objects to create.
+     *   A maximum of 100 objects can be created in a batch.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchCreateCompaniesResponse|BatchCreateCompaniesResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/company_service.batch_create_companies.js</caption>
+     * region_tag:admanager_v1_generated_CompanyService_BatchCreateCompanies_async
+     */
+    batchCreateCompanies(request?: protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchCreateCompaniesResponse,
+        protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest | undefined,
+        {} | undefined
+    ]>;
+    batchCreateCompanies(request: protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateCompaniesResponse, protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest | null | undefined, {} | null | undefined>): void;
+    batchCreateCompanies(request: protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchCreateCompaniesResponse, protos.google.ads.admanager.v1.IBatchCreateCompaniesRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Updates a {@link protos.google.ads.admanager.v1.Company|Company} object.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {google.ads.admanager.v1.Company} request.company
+     *   Required. The {@link protos.google.ads.admanager.v1.Company|Company} to update.
+     *
+     *   The {@link protos.google.ads.admanager.v1.Company|Company}'s `name` is used to identify
+     *   the {@link protos.google.ads.admanager.v1.Company|Company} to update.
+     * @param {google.protobuf.FieldMask} [request.updateMask]
+     *   Optional. The list of fields to update.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.Company|Company}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/company_service.update_company.js</caption>
+     * region_tag:admanager_v1_generated_CompanyService_UpdateCompany_async
+     */
+    updateCompany(request?: protos.google.ads.admanager.v1.IUpdateCompanyRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.ICompany,
+        protos.google.ads.admanager.v1.IUpdateCompanyRequest | undefined,
+        {} | undefined
+    ]>;
+    updateCompany(request: protos.google.ads.admanager.v1.IUpdateCompanyRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.IUpdateCompanyRequest | null | undefined, {} | null | undefined>): void;
+    updateCompany(request: protos.google.ads.admanager.v1.IUpdateCompanyRequest, callback: Callback<protos.google.ads.admanager.v1.ICompany, protos.google.ads.admanager.v1.IUpdateCompanyRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Batch updates {@link protos.google.ads.admanager.v1.Company|Company} objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent resource where {@link protos.|Companies} will be updated.
+     *   Format: `networks/{network_code}`
+     *   The parent field in the UpdateCompanyRequest must match this
+     *   field.
+     * @param {number[]} request.requests
+     *   Required. The {@link protos.google.ads.admanager.v1.Company|Company} objects to update.
+     *   A maximum of 100 objects can be updated in a batch.
+     * @param {object} [options]
+     *   Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
+     * @returns {Promise} - The promise which resolves to an array.
+     *   The first element of the array is an object representing {@link protos.google.ads.admanager.v1.BatchUpdateCompaniesResponse|BatchUpdateCompaniesResponse}.
+     *   Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
+     *   for more details and examples.
+     * @example <caption>include:samples/generated/v1/company_service.batch_update_companies.js</caption>
+     * region_tag:admanager_v1_generated_CompanyService_BatchUpdateCompanies_async
+     */
+    batchUpdateCompanies(request?: protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest, options?: CallOptions): Promise<[
+        protos.google.ads.admanager.v1.IBatchUpdateCompaniesResponse,
+        protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest | undefined,
+        {} | undefined
+    ]>;
+    batchUpdateCompanies(request: protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest, options: CallOptions, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateCompaniesResponse, protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest | null | undefined, {} | null | undefined>): void;
+    batchUpdateCompanies(request: protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest, callback: Callback<protos.google.ads.admanager.v1.IBatchUpdateCompaniesResponse, protos.google.ads.admanager.v1.IBatchUpdateCompaniesRequest | null | undefined, {} | null | undefined>): void;
+    /**
+     * Lists {@link protos.google.ads.admanager.v1.Company|Company} objects.
+     *
+     * @param {Object} request
+     *   The request object that will be sent.
+     * @param {string} request.parent
+     *   Required. The parent, which owns this collection of {@link protos.|Companies}.
      *   Format: `networks/{network_code}`
      * @param {number} [request.pageSize]
-     *   Optional. The maximum number of `Companies` to return. The service may
-     *   return fewer than this value. If unspecified, at most 50 `Companies` will
+     *   Optional. The maximum number of {@link protos.|Companies} to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 {@link protos.|Companies} will
      *   be returned. The maximum value is 1000; values greater than 1000 will be
      *   coerced to 1000.
      * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListCompanies` call.
+     *   Optional. A page token, received from a previous {@link protos.|ListCompanies} call.
      *   Provide this to retrieve the subsequent page.
      *
-     *   When paginating, all other parameters provided to `ListCompanies` must
+     *   When paginating, all other parameters provided to {@link protos.|ListCompanies} must
      *   match the call that provided the page token.
      * @param {string} [request.filter]
      *   Optional. Expression to filter the response.
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>address</code></li>
-     *     <li><code>comment</code></li>
-     *     <li><code>companyId</code></li>
-     *     <li><code>creditStatus</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>email</code></li>
-     *     <li><code>externalId</code></li>
-     *     <li><code>fax</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>phone</code></li>
-     *     <li><code>thirdPartyCompanyId</code></li>
-     *     <li><code>type</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `address`
+     *   * `comment`
+     *   * `companyId`
+     *   * `creditStatus`
+     *   * `displayName`
+     *   * `email`
+     *   * `externalId`
+     *   * `fax`
+     *   * `name`
+     *   * `phone`
+     *   * `thirdPartyCompanyId`
+     *   * `type`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -209,40 +322,39 @@ export declare class CompanyServiceClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent, which owns this collection of Companies.
+     *   Required. The parent, which owns this collection of {@link protos.|Companies}.
      *   Format: `networks/{network_code}`
      * @param {number} [request.pageSize]
-     *   Optional. The maximum number of `Companies` to return. The service may
-     *   return fewer than this value. If unspecified, at most 50 `Companies` will
+     *   Optional. The maximum number of {@link protos.|Companies} to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 {@link protos.|Companies} will
      *   be returned. The maximum value is 1000; values greater than 1000 will be
      *   coerced to 1000.
      * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListCompanies` call.
+     *   Optional. A page token, received from a previous {@link protos.|ListCompanies} call.
      *   Provide this to retrieve the subsequent page.
      *
-     *   When paginating, all other parameters provided to `ListCompanies` must
+     *   When paginating, all other parameters provided to {@link protos.|ListCompanies} must
      *   match the call that provided the page token.
      * @param {string} [request.filter]
      *   Optional. Expression to filter the response.
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>address</code></li>
-     *     <li><code>comment</code></li>
-     *     <li><code>companyId</code></li>
-     *     <li><code>creditStatus</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>email</code></li>
-     *     <li><code>externalId</code></li>
-     *     <li><code>fax</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>phone</code></li>
-     *     <li><code>thirdPartyCompanyId</code></li>
-     *     <li><code>type</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `address`
+     *   * `comment`
+     *   * `companyId`
+     *   * `creditStatus`
+     *   * `displayName`
+     *   * `email`
+     *   * `externalId`
+     *   * `fax`
+     *   * `name`
+     *   * `phone`
+     *   * `thirdPartyCompanyId`
+     *   * `type`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -268,40 +380,39 @@ export declare class CompanyServiceClient {
      * @param {Object} request
      *   The request object that will be sent.
      * @param {string} request.parent
-     *   Required. The parent, which owns this collection of Companies.
+     *   Required. The parent, which owns this collection of {@link protos.|Companies}.
      *   Format: `networks/{network_code}`
      * @param {number} [request.pageSize]
-     *   Optional. The maximum number of `Companies` to return. The service may
-     *   return fewer than this value. If unspecified, at most 50 `Companies` will
+     *   Optional. The maximum number of {@link protos.|Companies} to return. The service may
+     *   return fewer than this value. If unspecified, at most 50 {@link protos.|Companies} will
      *   be returned. The maximum value is 1000; values greater than 1000 will be
      *   coerced to 1000.
      * @param {string} [request.pageToken]
-     *   Optional. A page token, received from a previous `ListCompanies` call.
+     *   Optional. A page token, received from a previous {@link protos.|ListCompanies} call.
      *   Provide this to retrieve the subsequent page.
      *
-     *   When paginating, all other parameters provided to `ListCompanies` must
+     *   When paginating, all other parameters provided to {@link protos.|ListCompanies} must
      *   match the call that provided the page token.
      * @param {string} [request.filter]
      *   Optional. Expression to filter the response.
      *    See syntax details at
      *    https://developers.google.com/ad-manager/api/beta/filters
      *
-     *   <b>Filterable fields:</b>
-     *   <ul style="list-style-type:none">
-     *     <li><code>address</code></li>
-     *     <li><code>comment</code></li>
-     *     <li><code>companyId</code></li>
-     *     <li><code>creditStatus</code></li>
-     *     <li><code>displayName</code></li>
-     *     <li><code>email</code></li>
-     *     <li><code>externalId</code></li>
-     *     <li><code>fax</code></li>
-     *     <li><code>name</code></li>
-     *     <li><code>phone</code></li>
-     *     <li><code>thirdPartyCompanyId</code></li>
-     *     <li><code>type</code></li>
-     *     <li><code>updateTime</code></li>
-     *   </ul>
+     *   **Filterable fields:**
+     *
+     *   * `address`
+     *   * `comment`
+     *   * `companyId`
+     *   * `creditStatus`
+     *   * `displayName`
+     *   * `email`
+     *   * `externalId`
+     *   * `fax`
+     *   * `name`
+     *   * `phone`
+     *   * `thirdPartyCompanyId`
+     *   * `type`
+     *   * `updateTime`
      * @param {string} [request.orderBy]
      *   Optional. Expression to specify sorting order.
      *   See syntax details at
@@ -867,6 +978,30 @@ export declare class CompanyServiceClient {
      * @returns {string} A string representing the creative_template.
      */
     matchCreativeTemplateFromCreativeTemplateName(creativeTemplateName: string): string | number;
+    /**
+     * Return a fully-qualified creativeWrapper resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} creative_wrapper
+     * @returns {string} Resource name string.
+     */
+    creativeWrapperPath(networkCode: string, creativeWrapper: string): string;
+    /**
+     * Parse the network_code from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromCreativeWrapperName(creativeWrapperName: string): string | number;
+    /**
+     * Parse the creative_wrapper from CreativeWrapper resource.
+     *
+     * @param {string} creativeWrapperName
+     *   A fully-qualified path representing CreativeWrapper resource.
+     * @returns {string} A string representing the creative_wrapper.
+     */
+    matchCreativeWrapperFromCreativeWrapperName(creativeWrapperName: string): string | number;
     /**
      * Return a fully-qualified customField resource name string.
      *
@@ -939,6 +1074,54 @@ export declare class CompanyServiceClient {
      * @returns {string} A string representing the custom_targeting_value.
      */
     matchCustomTargetingValueFromCustomTargetingValueName(customTargetingValueName: string): string | number;
+    /**
+     * Return a fully-qualified daiAuthenticationKey resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_authentication_key
+     * @returns {string} Resource name string.
+     */
+    daiAuthenticationKeyPath(networkCode: string, daiAuthenticationKey: string): string;
+    /**
+     * Parse the network_code from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiAuthenticationKeyName(daiAuthenticationKeyName: string): string | number;
+    /**
+     * Parse the dai_authentication_key from DaiAuthenticationKey resource.
+     *
+     * @param {string} daiAuthenticationKeyName
+     *   A fully-qualified path representing DaiAuthenticationKey resource.
+     * @returns {string} A string representing the dai_authentication_key.
+     */
+    matchDaiAuthenticationKeyFromDaiAuthenticationKeyName(daiAuthenticationKeyName: string): string | number;
+    /**
+     * Return a fully-qualified daiEncodingProfile resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} dai_encoding_profile
+     * @returns {string} Resource name string.
+     */
+    daiEncodingProfilePath(networkCode: string, daiEncodingProfile: string): string;
+    /**
+     * Parse the network_code from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromDaiEncodingProfileName(daiEncodingProfileName: string): string | number;
+    /**
+     * Parse the dai_encoding_profile from DaiEncodingProfile resource.
+     *
+     * @param {string} daiEncodingProfileName
+     *   A fully-qualified path representing DaiEncodingProfile resource.
+     * @returns {string} A string representing the dai_encoding_profile.
+     */
+    matchDaiEncodingProfileFromDaiEncodingProfileName(daiEncodingProfileName: string): string | number;
     /**
      * Return a fully-qualified deviceCapability resource name string.
      *
@@ -1338,6 +1521,30 @@ export declare class CompanyServiceClient {
      * @returns {string} A string representing the order.
      */
     matchOrderFromOrderName(orderName: string): string | number;
+    /**
+     * Return a fully-qualified partner resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} partner
+     * @returns {string} Resource name string.
+     */
+    partnerPath(networkCode: string, partner: string): string;
+    /**
+     * Parse the network_code from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromPartnerName(partnerName: string): string | number;
+    /**
+     * Parse the partner from Partner resource.
+     *
+     * @param {string} partnerName
+     *   A fully-qualified path representing Partner resource.
+     * @returns {string} A string representing the partner.
+     */
+    matchPartnerFromPartnerName(partnerName: string): string | number;
     /**
      * Return a fully-qualified placement resource name string.
      *
@@ -1698,6 +1905,30 @@ export declare class CompanyServiceClient {
      * @returns {string} A string representing the user.
      */
     matchUserFromUserName(userName: string): string | number;
+    /**
+     * Return a fully-qualified viewabilityProvider resource name string.
+     *
+     * @param {string} network_code
+     * @param {string} viewability_provider
+     * @returns {string} Resource name string.
+     */
+    viewabilityProviderPath(networkCode: string, viewabilityProvider: string): string;
+    /**
+     * Parse the network_code from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the network_code.
+     */
+    matchNetworkCodeFromViewabilityProviderName(viewabilityProviderName: string): string | number;
+    /**
+     * Parse the viewability_provider from ViewabilityProvider resource.
+     *
+     * @param {string} viewabilityProviderName
+     *   A fully-qualified path representing ViewabilityProvider resource.
+     * @returns {string} A string representing the viewability_provider.
+     */
+    matchViewabilityProviderFromViewabilityProviderName(viewabilityProviderName: string): string | number;
     /**
      * Return a fully-qualified webProperty resource name string.
      *