@hubspot/app-connect-sdk 1.0.0-alpha.1

package/dist/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts

@@ -0,0 +1,989 @@
+import { Operation } from "../../types.js";
+
+//#region src/server/api-client-core/apis/marketing/campaigns-public-api-types.generated.d.ts
+declare namespace MarketingCampaignsPublicApi {
+  namespace Assets {
+    interface DeleteInput {
+      /**
+       * The id of asset to disassociate, required
+       * Example: 154543
+       */
+      assetId: string;
+      /**
+       * The type of asset to disassociate, required
+       * Example: OBJECT_LIST
+       */
+      assetType: string;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type DeleteOutput = void;
+    interface ListInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      /**
+       * The type of asset to fetch, required
+       * Example: MARKETING_EVENT
+       */
+      assetType: string;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      /**
+       * End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.  If not provided, no asset metrics will be fetched.
+       * Example: 2024-01-27
+       */
+      endDate?: string;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: string;
+      /**
+       * Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.  If not provided, no asset metrics will be fetched.
+       * Example: 2023-01-20
+       */
+      startDate?: string;
+    }
+    type ListOutput = Schemas.CollectionResponsePublicCampaignAssetForwardPaging;
+    interface UpdateInput {
+      /**
+       * The id of asset to disassociate, required
+       * Example: 154543
+       */
+      assetId: string;
+      /**
+       * The type of asset to disassociate, required
+       * Example: OBJECT_LIST
+       */
+      assetType: string;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type UpdateOutput = void;
+  }
+  namespace Basic {
+    type CreateInput = Schemas.PublicCampaignInput;
+    type CreateOutput = Schemas.PublicCampaign;
+    interface DeleteInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      /**
+       * The end date for fetching asset metrics, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-27
+       */
+      endDate?: string;
+      /**
+       * A comma-separated list of properties to include in the response.
+       *   Unrecognized properties are ignored. Optional. Example: hs_name,hs_budget, hs_notes
+       */
+      properties?: string[];
+      /**
+       * The start date for fetching asset metrics, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-20
+       */
+      startDate?: string;
+    }
+    type GetOutput = Schemas.PublicCampaignWithAssets;
+    interface ListInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      /**
+       * Filter campaigns by name. Optional.
+       */
+      name?: string;
+      /**
+       * A comma-separated list of properties to include in the response.
+       *   Unrecognized properties are ignored. Optional. Example:
+       *   hs_name, hs_budget,hs_notes
+       */
+      properties?: string[];
+      /**
+       * The property to sort results by. Optional.
+       */
+      sort?: string;
+    }
+    type ListOutput = Schemas.CollectionResponseWithTotalPublicCampaign;
+    interface UpdateInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      data: Schemas.PublicCampaignInput;
+    }
+    type UpdateOutput = Schemas.PublicCampaign;
+  }
+  namespace Batch {
+    type CreateInput = Schemas.BatchInputPublicCampaignInput;
+    type CreateOutput = Schemas.BatchResponsePublicCampaign;
+    type DeleteInput = Schemas.BatchInputPublicCampaignDeleteInput;
+    type DeleteOutput = void;
+    interface GetInput {
+      data: Schemas.BatchInputPublicCampaignReadInput;
+      /**
+       * End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.  If not provided, no asset metrics will be fetched.
+       * Example: 2024-01-27
+       */
+      endDate?: string;
+      /**
+       * A comma-separated list of the properties to be returned in the response. If any of the specified properties has empty value on the requested object(s), they will be ignored and not returned in response. If this parameter is empty, the response will include an empty properties map.
+       * Example: hs_name, hs_campaign_status, hs_notes
+       */
+      properties?: string[];
+      /**
+       * Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.  If not provided, no asset metrics will be fetched.
+       * Example: 2023-01-20
+       */
+      startDate?: string;
+    }
+    type GetOutput = Schemas.BatchResponsePublicCampaignWithAssets;
+    type UpdateInput = Schemas.BatchInputPublicCampaignBatchUpdateItem;
+    type UpdateOutput = Schemas.BatchResponsePublicCampaign;
+  }
+  namespace Budget {
+    interface CreateInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      data: Schemas.PublicBudgetItemInput;
+    }
+    type CreateOutput = Schemas.PublicBudgetItem;
+    interface DeleteInput {
+      /**
+       * The ID of the budget item, required. Example: 352
+       */
+      budgetId: number;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      /**
+       * The ID of the budget item, required. Example: 352
+       */
+      budgetId: number;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type GetOutput = Schemas.PublicBudgetItem;
+    interface GetTotalsInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+    }
+    type GetTotalsOutput = Schemas.PublicBudgetTotals;
+    interface UpdateInput {
+      /**
+       * The ID of the budget item, required. Example: 352
+       */
+      budgetId: number;
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      data: Schemas.PublicBudgetItemInput;
+    }
+    type UpdateOutput = Schemas.PublicBudgetItem;
+  }
+  namespace Metrics {
+    interface GetAttributionMetricsInput {
+      /**
+       * The unique identifier of the campaign
+       */
+      campaignGuid: string;
+      /**
+       * The end date for fetching attribution data, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-27
+       */
+      endDate?: string;
+      /**
+       * The start date for fetching attribution data, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-20
+       */
+      startDate?: string;
+    }
+    type GetAttributionMetricsOutput = Schemas.MetricsCounters;
+    interface GetRevenueAttributionInput {
+      /**
+       * The revenue attribution model used to calculate deal revenue credit. Defaults to LINEAR if not specified. Enum values: LINEAR,            FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED,          TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED
+       */
+      attributionModel?: string;
+      /**
+       * The unique identifier of the campaign
+       */
+      campaignGuid: string;
+      /**
+       * End date to fetch attribution data, YYYY-MM-DD
+       */
+      endDate?: string;
+      /**
+       * Start date to fetch attribution data, YYYY-MM-DD
+       */
+      startDate?: string;
+    }
+    type GetRevenueAttributionOutput = Schemas.RevenueAttributionAggregate;
+    interface ListContactIdsByTypeInput {
+      /**
+       * The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
+       */
+      after?: string;
+      /**
+       * The unique identifier of the campaign
+       */
+      campaignGuid: string;
+      /**
+       * The type of contact to filter the list
+       */
+      contactType: string;
+      /**
+       * The end date for fetching contact data, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-27
+       */
+      endDate?: string;
+      /**
+       * The maximum number of results to display per page.
+       */
+      limit?: number;
+      /**
+       * The start date for fetching contact data, in YYYY-MM-DD format.
+       * Optional. Example: 2000-01-20
+       */
+      startDate?: string;
+    }
+    type ListContactIdsByTypeOutput = Schemas.CollectionResponseContactReferenceForwardPaging;
+  }
+  namespace Schemas {
+    interface BatchInputPublicCampaignBatchUpdateItem {
+      /**
+       * An array of PublicCampaignBatchUpdateItem objects, each containing the ID and properties to update for a specific campaign.
+       */
+      inputs: Schemas.PublicCampaignBatchUpdateItem[];
+    }
+    interface BatchInputPublicCampaignDeleteInput {
+      /**
+       * An array of PublicCampaignDeleteInput objects, each specifying a campaign to be deleted. Each object must include the campaign's unique identifier.
+       */
+      inputs: Schemas.PublicCampaignDeleteInput[];
+    }
+    interface BatchInputPublicCampaignInput {
+      /**
+       * An array of PublicCampaignInput objects, each representing the properties of a campaign to be created in the batch. This property is required.
+       */
+      inputs: Schemas.PublicCampaignInput[];
+    }
+    interface BatchInputPublicCampaignReadInput {
+      /**
+       * An array of PublicCampaignReadInput objects, each containing the ID of a campaign to be read. This property is required.
+       */
+      inputs: Schemas.PublicCampaignReadInput[];
+    }
+    interface BatchResponsePublicCampaign {
+      /**
+       * The date and time when the batch operation was completed, formatted as a date-time string.
+       */
+      completedAt: string;
+      /**
+       * A map of related links associated with the batch operation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The date and time when the batch operation was requested, formatted as a date-time string.
+       */
+      requestedAt?: string;
+      /**
+       * An array of results from the batch operation, each item representing a public campaign.
+       */
+      results: Schemas.PublicCampaign[];
+      /**
+       * The date and time when the batch operation started, formatted as a date-time string.
+       */
+      startedAt: string;
+      /**
+       * The current status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    interface BatchResponsePublicCampaignWithAssets {
+      /**
+       * The timestamp when the batch request processing was completed.
+       */
+      completedAt: string;
+      /**
+       * A collection of URLs linking to related resources or documentation.
+       */
+      links?: Record<string, string>;
+      /**
+       * The timestamp when the batch request was initially made.
+       */
+      requestedAt?: string;
+      /**
+       * An array of results from the batch operation, each representing a public campaign with assets.
+       */
+      results: Schemas.PublicCampaignWithAssets[];
+      /**
+       * The timestamp when the processing of the batch request began.
+       */
+      startedAt: string;
+      /**
+       * The current processing status of the batch operation, with possible values: CANCELED, COMPLETE, PENDING, PROCESSING.
+       */
+      status: 'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING';
+    }
+    interface CollectionResponseContactReferenceForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      /**
+       * An array of contact references, each containing an identifier for a contact.
+       */
+      results: Schemas.ContactReference[];
+    }
+    interface CollectionResponsePublicCampaignAsset {
+      paging?: Schemas.Paging;
+      /**
+       * An array of public campaign assets. Each item in the array is an object representing a campaign asset.
+       */
+      results: Schemas.PublicCampaignAsset[];
+    }
+    interface CollectionResponsePublicCampaignAssetForwardPaging {
+      paging?: Schemas.ForwardPaging;
+      /**
+       * An array of public campaign assets. Each item in the array is a reference to a PublicCampaignAsset object.
+       */
+      results: Schemas.PublicCampaignAsset[];
+    }
+    interface CollectionResponseWithTotalPublicCampaign {
+      paging?: Schemas.Paging;
+      /**
+       * An array of PublicCampaign objects, each representing a campaign with its associated properties.
+       */
+      results: Schemas.PublicCampaign[];
+      /**
+       * An integer representing the total number of public campaigns available.
+       */
+      total: number;
+    }
+    interface ContactReference {
+      /**
+       * Unique identifier for the contact.
+       */
+      id: string;
+    }
+    interface ForwardPaging {
+      next?: Schemas.NextPage;
+    }
+    interface MetricsCounters {
+      /**
+       * The number of contacts influenced by the campaign.
+       */
+      influencedContacts: number;
+      /**
+       * The number of new contacts attributed to the campaign as the first touchpoint.
+       */
+      newContactsFirstTouch: number;
+      /**
+       * The number of new contacts attributed to the campaign as the last touchpoint.
+       */
+      newContactsLastTouch: number;
+      /**
+       * The total number of sessions generated by the campaign.
+       */
+      sessions: number;
+    }
+    /**
+     * Specifies the paging information needed to retrieve the next set of results in a paginated API response
+     */
+    interface NextPage {
+      /**
+       * A string token used as a cursor to retrieve the next page of results.
+       */
+      after: string;
+      /**
+       * A string URL that provides the link to the next page of results.
+       */
+      link?: string;
+    }
+    interface Paging {
+      next?: Schemas.NextPage;
+      prev?: Schemas.PreviousPage;
+    }
+    /**
+     * specifies the paging information needed to retrieve the previous set of results in a paginated API response
+     */
+    interface PreviousPage {
+      /**
+       * A string token that indicates the position in the list before the current page of results.
+       */
+      before: string;
+      /**
+       * A string containing the URL link to the previous page of results.
+       */
+      link?: string;
+    }
+    interface PublicBudgetItem {
+      /**
+       * The monetary amount allocated for the budget item.
+       */
+      amount: number;
+      /**
+       * The timestamp when the budget item was created.
+       */
+      createdAt: number;
+      /**
+       * A description of the budget item.
+       */
+      description?: string;
+      /**
+       * The unique identifier for the budget item.
+       */
+      id: string;
+      /**
+       * The name of the budget item.
+       */
+      name: string;
+      /**
+       * The order of the budget item, indicating its sequence based on creation date.
+       */
+      order: number;
+      /**
+       * The timestamp when the budget item was last updated.
+       */
+      updatedAt: number;
+    }
+    interface PublicBudgetItemInput {
+      /**
+       * The monetary value assigned to the budget item.
+       */
+      amount: number;
+      /**
+       * A detailed explanation or notes about the budget item.
+       */
+      description?: string;
+      /**
+       * The name of the budget item.
+       */
+      name: string;
+      /**
+       * The sequence number indicating the order of the budget item.
+       */
+      order: number;
+    }
+    interface PublicBudgetTotals {
+      /**
+       * An array of budget items associated with the campaign. Each item is represented by a PublicBudgetItem object.
+       */
+      budgetItems: Schemas.PublicBudgetItem[];
+      /**
+       * The total budget allocated for the campaign.
+       */
+      budgetTotal?: number;
+      /**
+       * The currency code used for the budget and spend amounts, following ISO 4217 standards.
+       */
+      currencyCode: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
+      /**
+       * The remaining budget available for the campaign after accounting for all spend items.
+       */
+      remainingBudget?: number;
+      /**
+       * An array of spend items associated with the campaign. Each item is represented by a PublicSpendItem object.
+       */
+      spendItems: Schemas.PublicSpendItem[];
+      /**
+       * The total amount spent across all spend items in the campaign.
+       */
+      spendTotal?: number;
+    }
+    interface PublicBusinessUnit {
+      /**
+       * The unique identifier for the business unit, represented as an integer.
+       */
+      id: number;
+    }
+    interface PublicCampaign {
+      /**
+       * An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
+       */
+      businessUnits: Schemas.PublicBusinessUnit[];
+      /**
+       * The date and time when the campaign was created, formatted as a date-time string.
+       */
+      createdAt: string;
+      /**
+       * The unique identifier for the campaign.
+       */
+      id: string;
+      /**
+       * A collection of key-value pairs representing additional properties of the campaign.
+       */
+      properties: Record<string, string>;
+      /**
+       * The date and time when the campaign was last updated, formatted as a date-time string.
+       */
+      updatedAt: string;
+    }
+    interface PublicCampaignAsset {
+      /**
+       * The unique identifier for the campaign asset.
+       */
+      id: string;
+      /**
+       * A collection of metrics associated with the campaign asset, represented as key-value pairs.
+       */
+      metrics?: Record<string, number>;
+      /**
+       * The name of the campaign asset.
+       */
+      name?: string;
+    }
+    interface PublicCampaignBatchUpdateItem {
+      /**
+       * The unique identifier for the campaign to be updated.
+       */
+      id: string;
+      /**
+       * A set of key-value pairs representing the properties to be updated for the campaign.
+       */
+      properties: Record<string, string>;
+    }
+    interface PublicCampaignDeleteInput {
+      /**
+       * The unique identifier for the campaign to be deleted.
+       */
+      id: string;
+    }
+    interface PublicCampaignInput {
+      /**
+       * A collection of key-value pairs representing the properties of the campaign. Each key is a property name, and the corresponding value is the property's value.
+       */
+      properties: Record<string, string>;
+    }
+    interface PublicCampaignReadInput {
+      /**
+       * The unique identifier for a campaign.
+       */
+      id: string;
+    }
+    interface PublicCampaignWithAssets {
+      /**
+       * Contains the assets associated with the campaign, each represented as a collection of campaign assets.
+       */
+      assets: Record<string, Schemas.CollectionResponsePublicCampaignAsset>;
+      /**
+       * An array of business units associated with the campaign, each represented by a PublicBusinessUnit object.
+       */
+      businessUnits: Schemas.PublicBusinessUnit[];
+      /**
+       * The date and time when the campaign was created, formatted as a date-time string.
+       */
+      createdAt: string;
+      /**
+       * The unique identifier for the campaign.
+       */
+      id: string;
+      /**
+       * A map of key-value pairs representing the properties of the campaign.
+       */
+      properties: Record<string, string>;
+      /**
+       * The date and time when the campaign was last updated, formatted as a date-time string.
+       */
+      updatedAt: string;
+    }
+    interface PublicSpendItem {
+      /**
+       * The monetary value associated with the spend item.
+       */
+      amount: number;
+      /**
+       * The timestamp indicating when the spend item was created.
+       */
+      createdAt: number;
+      /**
+       * A detailed explanation or notes about the spend item.
+       */
+      description?: string;
+      /**
+       * Unique identifier for the spend item.
+       */
+      id: string;
+      /**
+       * The name assigned to the spend item.
+       */
+      name: string;
+      /**
+       * The sequence order of the spend item, where 0 is the oldest.
+       */
+      order: number;
+      /**
+       * The timestamp indicating when the spend item was last updated.
+       */
+      updatedAt: number;
+    }
+    interface PublicSpendItemInput {
+      /**
+       * The monetary value of the spend item.
+       */
+      amount: number;
+      /**
+       * A brief description of the spend item.
+       */
+      description?: string;
+      /**
+       * The name of the spend item.
+       */
+      name: string;
+      /**
+       * The sequence number indicating the order of the spend item.
+       */
+      order: number;
+    }
+    interface RevenueAttributionAggregate {
+      /**
+       * The number of contacts attributed to the campaign.
+       */
+      contactsNumber?: number;
+      /**
+       * The currency code used for the revenue attribution, with accepted values including AED, AFN, ALL, and others.
+       */
+      currencyCode?: 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XSU' | 'XUA' | 'YER' | 'ZAR' | 'ZMW' | 'ZWL';
+      /**
+       * The total amount of deals attributed to the campaign.
+       */
+      dealAmount?: number;
+      /**
+       * The number of deals attributed to the campaign.
+       */
+      dealsNumber?: number;
+      /**
+       * The total revenue amount attributed to the campaign.
+       */
+      revenueAmount?: number;
+    }
+  }
+  namespace Spend {
+    interface CreateInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      data: Schemas.PublicSpendItemInput;
+    }
+    type CreateOutput = Schemas.PublicSpendItem;
+    interface DeleteInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      /**
+       * The ID of the spend item, required. Example: 491
+       */
+      spendId: number;
+    }
+    type DeleteOutput = void;
+    interface GetInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      /**
+       * The ID of the spend item, required. Example: 491
+       */
+      spendId: number;
+    }
+    type GetOutput = Schemas.PublicSpendItem;
+    interface UpdateInput {
+      /**
+       * The UUID of the campaign, required
+       * Example: 9dbec438-53e2-4b28-8c0f-38f56574a6e8
+       */
+      campaignGuid: string;
+      data: Schemas.PublicSpendItemInput;
+      /**
+       * The ID of the spend item, required. Example: 491
+       */
+      spendId: number;
+    }
+    type UpdateOutput = Schemas.PublicSpendItem;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.assets.delete(input));
+   * ```
+   */
+  interface AssetsAPI {
+    /**
+     * Remove asset association
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
+     * @apiMethod DELETE
+     * @requiredScopes campaigns-write
+     */
+    delete: (input: Assets.DeleteInput) => Operation<Assets.DeleteOutput>;
+    /**
+     * List assets
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    list: (input: Assets.ListInput) => Operation<Assets.ListOutput>;
+    /**
+     * Add asset association
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/assets/{assetType}/{assetId}
+     * @apiMethod PUT
+     * @requiredScopes campaigns-write
+     */
+    update: (input: Assets.UpdateInput) => Operation<Assets.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.basic.create(input));
+   * ```
+   */
+  interface BasicAPI {
+    /**
+     * Create a campaign
+     * @apiPath /marketing/campaigns/2026-03
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    create: (input: Basic.CreateInput) => Operation<Basic.CreateOutput>;
+    /**
+     * Delete campaign
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}
+     * @apiMethod DELETE
+     * @requiredScopes campaigns-write
+     */
+    delete: (input: Basic.DeleteInput) => Operation<Basic.DeleteOutput>;
+    /**
+     * Read a campaign
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    get: (input: Basic.GetInput) => Operation<Basic.GetOutput>;
+    /**
+     * Retrieve campaigns
+     * @apiPath /marketing/campaigns/2026-03
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    list: (input?: Basic.ListInput) => Operation<Basic.ListOutput>;
+    /**
+     * Update campaign
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}
+     * @apiMethod PATCH
+     * @requiredScopes campaigns-write
+     */
+    update: (input: Basic.UpdateInput) => Operation<Basic.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.batch.create(input));
+   * ```
+   */
+  interface BatchAPI {
+    /**
+     * Create a batch of campaigns
+     * @apiPath /marketing/campaigns/2026-03/batch/create
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    create: (input: Batch.CreateInput) => Operation<Batch.CreateOutput>;
+    /**
+     * Delete a batch of campaigns
+     * @apiPath /marketing/campaigns/2026-03/batch/archive
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    delete: (input: Batch.DeleteInput) => Operation<Batch.DeleteOutput>;
+    /**
+     * Read a batch of campaigns
+     * @apiPath /marketing/campaigns/2026-03/batch/read
+     * @apiMethod POST
+     * @requiredScopes campaigns-access
+     */
+    get: (input: Batch.GetInput) => Operation<Batch.GetOutput>;
+    /**
+     * Update a batch of campaigns
+     * @apiPath /marketing/campaigns/2026-03/batch/update
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    update: (input: Batch.UpdateInput) => Operation<Batch.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.budget.create(input));
+   * ```
+   */
+  interface BudgetAPI {
+    /**
+     * Add budget item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    create: (input: Budget.CreateInput) => Operation<Budget.CreateOutput>;
+    /**
+     * Delete budget item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
+     * @apiMethod DELETE
+     * @requiredScopes campaigns-write
+     */
+    delete: (input: Budget.DeleteInput) => Operation<Budget.DeleteOutput>;
+    /**
+     * Get budget item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    get: (input: Budget.GetInput) => Operation<Budget.GetOutput>;
+    /**
+     * Read budget
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/totals
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    getTotals: (input: Budget.GetTotalsInput) => Operation<Budget.GetTotalsOutput>;
+    /**
+     * Update budget item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/budget/{budgetId}
+     * @apiMethod PUT
+     * @requiredScopes campaigns-write
+     */
+    update: (input: Budget.UpdateInput) => Operation<Budget.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.metrics.getAttributionMetrics(input));
+   * ```
+   */
+  interface MetricsAPI {
+    /**
+     * Get Campaign Metrics
+     *
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/metrics
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    getAttributionMetrics: (input: Metrics.GetAttributionMetricsInput) => Operation<Metrics.GetAttributionMetricsOutput>;
+    /**
+     * Fetch revenue
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/revenue
+     * @apiMethod GET
+     * @requiredScopes campaigns-revenue-pro, revenue-attribution-read
+     */
+    getRevenueAttribution: (input: Metrics.GetRevenueAttributionInput) => Operation<Metrics.GetRevenueAttributionOutput>;
+    /**
+     * Fetch contact IDs
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/reports/contacts/{contactType}
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    listContactIdsByType: (input: Metrics.ListContactIdsByTypeInput) => Operation<Metrics.ListContactIdsByTypeOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.spend.create(input));
+   * ```
+   */
+  interface SpendAPI {
+    /**
+     * Create campaign spend item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend
+     * @apiMethod POST
+     * @requiredScopes campaigns-write
+     */
+    create: (input: Spend.CreateInput) => Operation<Spend.CreateOutput>;
+    /**
+     * Delete campaign spend item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
+     * @apiMethod DELETE
+     * @requiredScopes campaigns-write
+     */
+    delete: (input: Spend.DeleteInput) => Operation<Spend.DeleteOutput>;
+    /**
+     * Read campaign spend item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
+     * @apiMethod GET
+     * @requiredScopes campaigns-access
+     */
+    get: (input: Spend.GetInput) => Operation<Spend.GetOutput>;
+    /**
+     * Update campaign spend item
+     * @apiPath /marketing/campaigns/2026-03/{campaignGuid}/spend/{spendId}
+     * @apiMethod PUT
+     * @requiredScopes campaigns-write
+     */
+    update: (input: Spend.UpdateInput) => Operation<Spend.UpdateOutput>;
+  }
+  /**
+   * Usage example:
+   * ```ts
+   * import { marketingCampaignsPublicApi } from '@hubspot/api-client-core';
+   * client.send(marketingCampaignsPublicApi.assets.delete(input));
+   * ```
+   */
+  interface API {
+    assets: AssetsAPI;
+    basic: BasicAPI;
+    batch: BatchAPI;
+    budget: BudgetAPI;
+    metrics: MetricsAPI;
+    spend: SpendAPI;
+  }
+}
+//#endregion
+export { MarketingCampaignsPublicApi };
+//# sourceMappingURL=campaigns-public-api-types.generated.d.ts.map