Class: HubSpotSDK::Resources::Automation::Sequences

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/automation/sequences.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Sequences

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

Parameters:



126
127
128
 
# File 'lib/hubspot_sdk/resources/automation/sequences.rb', line 126

def initialize(client:)
  @client = client
end

Instance Method Details

#create_enrollment(user_id:, contact_id:, sender_email:, sequence_id:, sender_alias_address: nil, request_options: {}) ⇒ HubSpotSDK::Models::Automation::PublicSequenceEnrollmentLiteResponse

Some parameter documentations has been truncated, see Models::Automation::SequenceCreateEnrollmentParams for more details.

Enroll a contact into a sequence using the specified user ID and sequence details.

Parameters:

  • user_id (String) —

    Query param

  • contact_id (String) —

    Body param: The unique identifier of the contact to be enrolled in the sequence.

  • sender_email (String) —

    Body param: The email address of the sender enrolling the contact in the sequenc

  • sequence_id (String) —

    Body param: The unique identifier of the sequence in which the contact will be e

  • sender_alias_address (String) —

    Body param: The alias email address used by the sender when enrolling the contac

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

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/hubspot_sdk/resources/automation/sequences.rb', line 67

def create_enrollment(params)
  query_params = [:user_id]
  parsed, options = HubSpotSDK::Automation::SequenceCreateEnrollmentParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :post,
    path: "automation/sequences/2026-03/enrollments",
    query: query.transform_keys(user_id: "userId"),
    body: parsed.except(*query_params),
    model: HubSpotSDK::Automation::PublicSequenceEnrollmentLiteResponse,
    options: options
  )
end

#get(sequence_id, user_id:, request_options: {}) ⇒ HubSpotSDK::Models::Automation::PublicSequenceResponse

Retrieve details of a specific sequence by its ID.

Parameters:

Returns:

See Also:



92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/hubspot_sdk/resources/automation/sequences.rb', line 92

def get(sequence_id, params)
  parsed, options = HubSpotSDK::Automation::SequenceGetParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["automation/sequences/2026-03/%1$s", sequence_id],
    query: query.transform_keys(user_id: "userId"),
    model: HubSpotSDK::Automation::PublicSequenceResponse,
    options: options
  )
end

#get_enrollment_by_contact_id(contact_id, request_options: {}) ⇒ HubSpotSDK::Models::Automation::PublicSequenceEnrollmentResponse

Get the enrollment status of a contact in sequences by their contact ID.

Parameters:

Returns:

See Also:



114
115
116
117
118
119
120
121
 
# File 'lib/hubspot_sdk/resources/automation/sequences.rb', line 114

def get_enrollment_by_contact_id(contact_id, params = {})
  @client.request(
    method: :get,
    path: ["automation/sequences/2026-03/enrollments/contact/%1$s", contact_id],
    model: HubSpotSDK::Automation::PublicSequenceEnrollmentResponse,
    options: params[:request_options]
  )
end

#list(user_id:, after: nil, limit: nil, name: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Automation::PublicSequenceLiteResponse>

Some parameter documentations has been truncated, see Models::Automation::SequenceListParams for more details.

Retrieve a list of sequences available in your HubSpot account. This endpoint allows you to filter sequences by user ID and name, and supports pagination for large result sets. Use this endpoint to manage and review your sequences effectively.

Parameters:

  • user_id (String)
  • after (String) —

    The paging cursor token of the last successfully read resource will be returned

  • limit (Integer) —

    The maximum number of results to display per page.

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

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/hubspot_sdk/resources/automation/sequences.rb', line 30

def list(params)
  parsed, options = HubSpotSDK::Automation::SequenceListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "automation/sequences/2026-03",
    query: query.transform_keys(user_id: "userId"),
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Automation::PublicSequenceLiteResponse,
    options: options
  )
end