Class: HubSpotSDK::Resources::Marketing::Campaigns::Spend

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/marketing/campaigns/spend.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Spend

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Spend.

Parameters:



143
144
145
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/spend.rb', line 143

def initialize(client:)
  @client = client
end

Instance Method Details

#create(campaign_guid, amount:, name:, order:, description: nil, request_options: {}) ⇒ HubSpotSDK::Models::Marketing::PublicSpendItem

Some parameter documentations has been truncated, see Models::Marketing::Campaigns::SpendCreateParams for more details.

Create a new campaign spend item

Parameters:

  • campaign_guid (String) —

    The UUID of the campaign, required

  • amount (Float) —

    The monetary value of the spend item.

  • name (String) —

    The name of the spend item.

  • order (Integer) —

    The sequence number indicating the order of the spend item.

  • description (String) —

    A brief description of the spend item.

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/spend.rb', line 30

def create(campaign_guid, params)
  parsed, options = HubSpotSDK::Marketing::Campaigns::SpendCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["marketing/campaigns/2026-03/%1$s/spend", campaign_guid],
    body: parsed,
    model: HubSpotSDK::Marketing::PublicSpendItem,
    options: options
  )
end

#delete(spend_id, campaign_guid:, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::Marketing::Campaigns::SpendDeleteParams for more details.

Delete a specific campaign spend item by ID

Parameters:

  • spend_id (Integer) —

    The ID of the spend item, required. Example: 491

  • campaign_guid (String) —

    The UUID of the campaign, required

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/spend.rb', line 96

def delete(spend_id, params)
  parsed, options = HubSpotSDK::Marketing::Campaigns::SpendDeleteParams.dump_request(params)
  campaign_guid =
    parsed.delete(:campaign_guid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["marketing/campaigns/2026-03/%1$s/spend/%2$s", campaign_guid, spend_id],
    model: NilClass,
    options: options
  )
end

#get(spend_id, campaign_guid:, request_options: {}) ⇒ HubSpotSDK::Models::Marketing::PublicSpendItem

Some parameter documentations has been truncated, see Models::Marketing::Campaigns::SpendGetParams for more details.

Read a campaign spend item by its spendId

Parameters:

  • spend_id (Integer) —

    The ID of the spend item, required. Example: 491

  • campaign_guid (String) —

    The UUID of the campaign, required

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/spend.rb', line 126

def get(spend_id, params)
  parsed, options = HubSpotSDK::Marketing::Campaigns::SpendGetParams.dump_request(params)
  campaign_guid =
    parsed.delete(:campaign_guid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["marketing/campaigns/2026-03/%1$s/spend/%2$s", campaign_guid, spend_id],
    model: HubSpotSDK::Marketing::PublicSpendItem,
    options: options
  )
end

#update(spend_id, campaign_guid:, amount:, name:, order:, description: nil, request_options: {}) ⇒ HubSpotSDK::Models::Marketing::PublicSpendItem

Some parameter documentations has been truncated, see Models::Marketing::Campaigns::SpendUpdateParams for more details.

Update a specific campaign spend item by ID

Parameters:

  • spend_id (Integer) —

    Path param: The ID of the spend item, required. Example: 491

  • campaign_guid (String) —

    Path param: The UUID of the campaign, required

  • amount (Float) —

    Body param: The monetary value of the spend item.

  • name (String) —

    Body param: The name of the spend item.

  • order (Integer) —

    Body param: The sequence number indicating the order of the spend item.

  • description (String) —

    Body param: A brief description of the spend item.

  • request_options (HubSpotSDK::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/hubspot_sdk/resources/marketing/campaigns/spend.rb', line 65

def update(spend_id, params)
  parsed, options = HubSpotSDK::Marketing::Campaigns::SpendUpdateParams.dump_request(params)
  campaign_guid =
    parsed.delete(:campaign_guid) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["marketing/campaigns/2026-03/%1$s/spend/%2$s", campaign_guid, spend_id],
    body: parsed,
    model: HubSpotSDK::Marketing::PublicSpendItem,
    options: options
  )
end