@rnsk/toolkits 0.0.7 → 0.0.9

package/dist/toolkits/google-ads/tools/index.d.ts

@@ -0,0 +1,520 @@
+import { addOrRemoveToCustomerList } from './add-or-remove-to-customer-list.js';
+import { createCalloutAsset } from './create-callout-asset.js';
+import { createCustomerList } from './create-customer-list.js';
+import { getCampaignById } from './get-campaign-by-id.js';
+import { getCampaignByName } from './get-campaign-by-name.js';
+import { getConversionActionTagSnippets } from './get-conversion-action-tag-snippets.js';
+import { getCustomerLists } from './get-customer-lists.js';
+import { getRmfReport } from './get-rmf-report.js';
+import { listAccessibleCustomers } from './list-accessible-customers.js';
+import { listSubAccounts } from './list-sub-accounts.js';
+import { mutateAdGroupAds } from './mutate-ad-group-ads.js';
+import { mutateAdGroupAssets } from './mutate-ad-group-assets.js';
+import { mutateAdGroupBidModifiers } from './mutate-ad-group-bid-modifiers.js';
+import { mutateAdGroupCriteria } from './mutate-ad-group-criteria.js';
+import { mutateAdGroups } from './mutate-ad-groups.js';
+import { mutateAssets } from './mutate-assets.js';
+import { mutateBiddingStrategies } from './mutate-bidding-strategies.js';
+import { mutateCampaignAssets } from './mutate-campaign-assets.js';
+import { mutateCampaignBudgets } from './mutate-campaign-budgets.js';
+import { mutateCampaignCriteria } from './mutate-campaign-criteria.js';
+import { mutateCampaignLabels } from './mutate-campaign-labels.js';
+import { mutateCampaigns } from './mutate-campaigns.js';
+import { mutateCampaignsV2 } from './mutate-campaigns-v2.js';
+import { mutateConversionActions } from './mutate-conversion-actions.js';
+import { mutateCustomerAssets } from './mutate-customer-assets.js';
+import { mutateLabels } from './mutate-labels.js';
+import { mutatePortfolioBiddingStrategies } from './mutate-portfolio-bidding-strategies.js';
+import { searchStreamGaql } from './search-stream-gaql.js';
+export { addOrRemoveToCustomerList, createCalloutAsset, createCustomerList, getCampaignById, getCampaignByName, getConversionActionTagSnippets, getCustomerLists, getRmfReport, listAccessibleCustomers, listSubAccounts, mutateAdGroupAds, mutateAdGroupAssets, mutateAdGroupBidModifiers, mutateAdGroupCriteria, mutateAdGroups, mutateAssets, mutateBiddingStrategies, mutateCampaignAssets, mutateCampaignBudgets, mutateCampaignCriteria, mutateCampaignLabels, mutateCampaigns, mutateCampaignsV2, mutateConversionActions, mutateCustomerAssets, mutateLabels, mutatePortfolioBiddingStrategies, searchStreamGaql, };
+export declare const googleAdsTools: ({
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        resourceName: string;
+        googleAdsToken: string;
+        developerToken: string;
+        emails: string[];
+        operation?: "create" | "remove" | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        status?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        status?: undefined;
+        message?: undefined;
+    } | {
+        status: string;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        status?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        callout: {
+            calloutText: string;
+            startDate?: string | undefined;
+            endDate?: string | undefined;
+            adScheduleTargets?: {
+                dayOfWeek: "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY";
+                startHour: number;
+                startMinute: "ZERO" | "FIFTEEN" | "THIRTY" | "FORTY_FIVE";
+                endHour: number;
+                endMinute: "ZERO" | "FIFTEEN" | "THIRTY" | "FORTY_FIVE";
+            }[] | undefined;
+        };
+        name?: string | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: "RESOURCE_NAME_ONLY" | "MUTABLE_RESOURCE" | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        name: string;
+        googleAdsToken: string;
+        developerToken: string;
+        description?: string | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        id: string;
+        googleAdsToken: string;
+        developerToken: string;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        result?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        result?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        result: Record<string, unknown>;
+        requestId: string | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        result?: undefined;
+        requestId?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        name: string;
+        googleAdsToken: string;
+        developerToken: string;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        result?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        result?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        result: Record<string, unknown>;
+        requestId: string | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        result?: undefined;
+        requestId?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        conversionActionId: string;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        conversionAction?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        conversionAction?: undefined;
+        message?: undefined;
+    } | {
+        conversionAction: any;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        conversionAction?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        pageToken?: string | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        userLists?: undefined;
+        nextPageToken?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        userLists?: undefined;
+        nextPageToken?: undefined;
+        message?: undefined;
+    } | {
+        userLists: (Record<string, unknown> | undefined)[];
+        nextPageToken: string | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        userLists?: undefined;
+        nextPageToken?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        report: "CUSTOMER" | "CAMPAIGN" | "AD_GROUP_AD" | "KEYWORD" | "SEARCH_TERM" | "DYNAMIC_SEARCH_AD_SEARCH_TERM" | "BIDDING_STRATEGY";
+        startDate?: string | undefined;
+        endDate?: string | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        maxRows?: number | undefined;
+        optionalMetrics?: string[] | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        report?: undefined;
+        dateRange?: undefined;
+        columns?: undefined;
+        requiredColumns?: undefined;
+        optionalMetrics?: undefined;
+        results?: undefined;
+        truncated?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        report?: undefined;
+        dateRange?: undefined;
+        columns?: undefined;
+        requiredColumns?: undefined;
+        optionalMetrics?: undefined;
+        results?: undefined;
+        truncated?: undefined;
+        requestId?: undefined;
+        message?: undefined;
+    } | {
+        report: "CUSTOMER" | "CAMPAIGN" | "AD_GROUP_AD" | "KEYWORD" | "SEARCH_TERM" | "DYNAMIC_SEARCH_AD_SEARCH_TERM" | "BIDDING_STRATEGY";
+        dateRange: string;
+        columns: string[];
+        requiredColumns: string[];
+        optionalMetrics: string[];
+        results: Record<string, unknown>[];
+        truncated: boolean;
+        requestId: string | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        report?: undefined;
+        dateRange?: undefined;
+        columns?: undefined;
+        requiredColumns?: undefined;
+        optionalMetrics?: undefined;
+        results?: undefined;
+        truncated?: undefined;
+        requestId?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        pageToken?: string | undefined;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        subAccounts?: undefined;
+        nextPageToken?: undefined;
+        fieldMask?: undefined;
+        requestId?: undefined;
+        queryResourceConsumption?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        subAccounts?: undefined;
+        nextPageToken?: undefined;
+        fieldMask?: undefined;
+        requestId?: undefined;
+        queryResourceConsumption?: undefined;
+        message?: undefined;
+    } | {
+        subAccounts: {
+            customerId: unknown;
+            resourceName: unknown;
+            descriptiveName: unknown;
+            manager: unknown;
+            status: unknown;
+            level: unknown;
+        }[];
+        nextPageToken: string | undefined;
+        fieldMask: string | undefined;
+        requestId: string | undefined;
+        queryResourceConsumption: string | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        subAccounts?: undefined;
+        nextPageToken?: undefined;
+        fieldMask?: undefined;
+        requestId?: undefined;
+        queryResourceConsumption?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: Record<string, any>[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: "RESOURCE_NAME_ONLY" | "MUTABLE_RESOURCE" | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: Record<string, any>[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: "RESOURCE_NAME_ONLY" | "MUTABLE_RESOURCE" | "UNSPECIFIED" | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: Record<string, any>[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: {
+            operationType: "create" | "update" | "remove";
+            create?: Record<string, any> | undefined;
+            update?: Record<string, any> | undefined;
+            remove?: string | undefined;
+        }[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: string | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: {
+            operationType: "create" | "update" | "remove";
+            create?: Record<string, any> | undefined;
+            update?: Record<string, any> | undefined;
+            updateMask?: string | undefined;
+            remove?: string | undefined;
+        }[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: "RESOURCE_NAME_ONLY" | "MUTABLE_RESOURCE" | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        googleAdsToken: string;
+        developerToken: string;
+        operations: {
+            create?: {
+                asset: string;
+                fieldType: string;
+            } | undefined;
+            remove?: string | undefined;
+        }[];
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        validateOnly?: boolean | undefined;
+        partialFailure?: boolean | undefined;
+        responseContentType?: "RESOURCE_NAME_ONLY" | "MUTABLE_RESOURCE" | undefined;
+    }, any>;
+    requiredAuth: "googleAdsToken";
+    scope: "write";
+} | {
+    name: string;
+    description: string;
+    tool: import("ai").Tool<{
+        query: string;
+        googleAdsToken: string;
+        developerToken: string;
+        customerId?: string | undefined;
+        loginCustomerId?: string | undefined;
+        summaryRowSetting?: "UNSPECIFIED" | "NO_SUMMARY_ROW" | "SUMMARY_ROW_ONLY" | "SUMMARY_ROW_WITH_RESULTS" | undefined;
+    }, {
+        error: string;
+        details?: undefined;
+        results?: undefined;
+        requestId?: undefined;
+        summaryRow?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        details: any;
+        results?: undefined;
+        requestId?: undefined;
+        summaryRow?: undefined;
+        message?: undefined;
+    } | {
+        results: Record<string, unknown>[];
+        requestId: string | undefined;
+        summaryRow: Record<string, unknown> | undefined;
+        error?: undefined;
+        details?: undefined;
+        message?: undefined;
+    } | {
+        error: string;
+        message: string;
+        details?: undefined;
+        results?: undefined;
+        requestId?: undefined;
+        summaryRow?: undefined;
+    }>;
+    requiredAuth: "googleAdsToken";
+    scope: "read";
+})[];
+//# sourceMappingURL=index.d.ts.map