Class: HubSpotSDK::Resources::Meta::Origins::IPRanges

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/meta/origins/ip_ranges.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ IPRanges

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 IPRanges.

Parameters:



63
64
65
 
# File 'lib/hubspot_sdk/resources/meta/origins/ip_ranges.rb', line 63

def initialize(client:)
  @client = client
end

Instance Method Details

#list(direction: nil, service: nil, request_options: {}) ⇒ HubSpotSDK::Models::Meta::CollectionResponseIPRangeNoPaging

Retrieve a collection of IP ranges associated with specific services and directions, such as ‘EMAIL`, `API`, `DNS`, or `WEB_SCRAPING`. The response includes details like CIDR notation, description, and the direction of IP traffic.

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
32
 
# File 'lib/hubspot_sdk/resources/meta/origins/ip_ranges.rb', line 22

def list(params = {})
  parsed, options = HubSpotSDK::Meta::Origins::IPRangeListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "meta/network-origins/2026-03/ip-ranges",
    query: query,
    model: HubSpotSDK::Meta::CollectionResponseIPRangeNoPaging,
    options: options
  )
end

#list_simple(direction: nil, service: nil, request_options: {}) ⇒ String

Retrieve a simplified list of IP ranges for specified services and directions in plain text format. This endpoint provides a straightforward representation of IP ranges without additional metadata.

Parameters:

Returns:

  • (String)

See Also:



47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/hubspot_sdk/resources/meta/origins/ip_ranges.rb', line 47

def list_simple(params = {})
  parsed, options = HubSpotSDK::Meta::Origins::IPRangeListSimpleParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "meta/network-origins/2026-03/ip-ranges/simple",
    query: query,
    headers: {"accept" => "text/plain"},
    model: String,
    options: options
  )
end