google-ads-api-client/dist/protos/bindings/ads/services/customer_manager_link_service.d.ts

A friendly and exhaustive client to the google-ads-api, code generated directly from google's published protobuf schema.

import { ServiceType } from "@protobuf-ts/runtime-rpc";
import type { BinaryWriteOptions } from "@protobuf-ts/runtime";
import type { IBinaryWriter } from "@protobuf-ts/runtime";
import type { BinaryReadOptions } from "@protobuf-ts/runtime";
import type { IBinaryReader } from "@protobuf-ts/runtime";
import type { PartialMessage } from "@protobuf-ts/runtime";
import { MessageType } from "@protobuf-ts/runtime";
import { CustomerManagerLink } from "../resources/customer_manager_link";
import { FieldMask } from "../../google/protobuf/field_mask";
/**
 * Request message for [CustomerManagerLinkService.MutateCustomerManagerLink][google.ads.googleads.v11.services.CustomerManagerLinkService.MutateCustomerManagerLink].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkRequest
 */
export interface MutateCustomerManagerLinkRequest {
    /**
     * Required. The ID of the customer whose customer manager links are being modified.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The list of operations to perform on individual customer manager links.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.CustomerManagerLinkOperation operations = 2;
     */
    operations: CustomerManagerLinkOperation[];
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 3;
     */
    validateOnly: boolean;
}
/**
 * Request message for [CustomerManagerLinkService.MoveManagerLink][google.ads.googleads.v11.services.CustomerManagerLinkService.MoveManagerLink].
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MoveManagerLinkRequest
 */
export interface MoveManagerLinkRequest {
    /**
     * Required. The ID of the client customer that is being moved.
     *
     * @generated from protobuf field: string customer_id = 1;
     */
    customerId: string;
    /**
     * Required. The resource name of the previous CustomerManagerLink.
     * The resource name has the form:
     * `customers/{customer_id}/customerManagerLinks/{manager_customer_id}~{manager_link_id}`
     *
     * @generated from protobuf field: string previous_customer_manager_link = 2;
     */
    previousCustomerManagerLink: string;
    /**
     * Required. The resource name of the new manager customer that the client wants to move
     * to. Customer resource names have the format: "customers/{customer_id}"
     *
     * @generated from protobuf field: string new_manager = 3;
     */
    newManager: string;
    /**
     * If true, the request is validated but not executed. Only errors are
     * returned, not results.
     *
     * @generated from protobuf field: bool validate_only = 4;
     */
    validateOnly: boolean;
}
/**
 * Updates the status of a CustomerManagerLink.
 * The following actions are possible:
 * 1. Update operation with status ACTIVE accepts a pending invitation.
 * 2. Update operation with status REFUSED declines a pending invitation.
 * 3. Update operation with status INACTIVE terminates link to manager.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.CustomerManagerLinkOperation
 */
export interface CustomerManagerLinkOperation {
    /**
     * FieldMask that determines which resource fields are modified in an update.
     *
     * @generated from protobuf field: google.protobuf.FieldMask update_mask = 4;
     */
    updateMask?: FieldMask;
    /**
     * @generated from protobuf oneof: operation
     */
    operation: {
        oneofKind: "update";
        /**
         * Update operation: The link is expected to have a valid resource name.
         *
         * @generated from protobuf field: google.ads.googleads.v11.resources.CustomerManagerLink update = 2;
         */
        update: CustomerManagerLink;
    } | {
        oneofKind: undefined;
    };
}
/**
 * Response message for a CustomerManagerLink mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkResponse
 */
export interface MutateCustomerManagerLinkResponse {
    /**
     * A result that identifies the resource affected by the mutate request.
     *
     * @generated from protobuf field: repeated google.ads.googleads.v11.services.MutateCustomerManagerLinkResult results = 1;
     */
    results: MutateCustomerManagerLinkResult[];
}
/**
 * Response message for a CustomerManagerLink moveManagerLink.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MoveManagerLinkResponse
 */
export interface MoveManagerLinkResponse {
    /**
     * Returned for successful operations. Represents a CustomerManagerLink
     * resource of the newly created link between client customer and new manager
     * customer.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
/**
 * The result for the customer manager link mutate.
 *
 * @generated from protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkResult
 */
export interface MutateCustomerManagerLinkResult {
    /**
     * Returned for successful operations.
     *
     * @generated from protobuf field: string resource_name = 1;
     */
    resourceName: string;
}
declare class MutateCustomerManagerLinkRequest$Type extends MessageType<MutateCustomerManagerLinkRequest> {
    constructor();
    create(value?: PartialMessage<MutateCustomerManagerLinkRequest>): MutateCustomerManagerLinkRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerManagerLinkRequest): MutateCustomerManagerLinkRequest;
    internalBinaryWrite(message: MutateCustomerManagerLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkRequest
 */
export declare const MutateCustomerManagerLinkRequest: MutateCustomerManagerLinkRequest$Type;
declare class MoveManagerLinkRequest$Type extends MessageType<MoveManagerLinkRequest> {
    constructor();
    create(value?: PartialMessage<MoveManagerLinkRequest>): MoveManagerLinkRequest;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MoveManagerLinkRequest): MoveManagerLinkRequest;
    internalBinaryWrite(message: MoveManagerLinkRequest, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MoveManagerLinkRequest
 */
export declare const MoveManagerLinkRequest: MoveManagerLinkRequest$Type;
declare class CustomerManagerLinkOperation$Type extends MessageType<CustomerManagerLinkOperation> {
    constructor();
    create(value?: PartialMessage<CustomerManagerLinkOperation>): CustomerManagerLinkOperation;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: CustomerManagerLinkOperation): CustomerManagerLinkOperation;
    internalBinaryWrite(message: CustomerManagerLinkOperation, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.CustomerManagerLinkOperation
 */
export declare const CustomerManagerLinkOperation: CustomerManagerLinkOperation$Type;
declare class MutateCustomerManagerLinkResponse$Type extends MessageType<MutateCustomerManagerLinkResponse> {
    constructor();
    create(value?: PartialMessage<MutateCustomerManagerLinkResponse>): MutateCustomerManagerLinkResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerManagerLinkResponse): MutateCustomerManagerLinkResponse;
    internalBinaryWrite(message: MutateCustomerManagerLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkResponse
 */
export declare const MutateCustomerManagerLinkResponse: MutateCustomerManagerLinkResponse$Type;
declare class MoveManagerLinkResponse$Type extends MessageType<MoveManagerLinkResponse> {
    constructor();
    create(value?: PartialMessage<MoveManagerLinkResponse>): MoveManagerLinkResponse;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MoveManagerLinkResponse): MoveManagerLinkResponse;
    internalBinaryWrite(message: MoveManagerLinkResponse, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MoveManagerLinkResponse
 */
export declare const MoveManagerLinkResponse: MoveManagerLinkResponse$Type;
declare class MutateCustomerManagerLinkResult$Type extends MessageType<MutateCustomerManagerLinkResult> {
    constructor();
    create(value?: PartialMessage<MutateCustomerManagerLinkResult>): MutateCustomerManagerLinkResult;
    internalBinaryRead(reader: IBinaryReader, length: number, options: BinaryReadOptions, target?: MutateCustomerManagerLinkResult): MutateCustomerManagerLinkResult;
    internalBinaryWrite(message: MutateCustomerManagerLinkResult, writer: IBinaryWriter, options: BinaryWriteOptions): IBinaryWriter;
}
/**
 * @generated MessageType for protobuf message google.ads.googleads.v11.services.MutateCustomerManagerLinkResult
 */
export declare const MutateCustomerManagerLinkResult: MutateCustomerManagerLinkResult$Type;
/**
 * @generated ServiceType for protobuf service google.ads.googleads.v11.services.CustomerManagerLinkService
 */
export declare const CustomerManagerLinkService: ServiceType;
export {};