Class: HubSpotSDK::Resources::Crm::Objects::FeedbackSubmissions

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb,
lib/hubspot_sdk/resources/crm/objects/feedback_submissions/batch.rb

Defined Under Namespace

Classes: Batch

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ FeedbackSubmissions

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

Parameters:



129
130
131
132
 
# File 'lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb', line 129

def initialize(client:)
  @client = client
  @batch = HubSpotSDK::Resources::Crm::Objects::FeedbackSubmissions::Batch.new(client: client)
end

Instance Attribute Details

#batch ⇒ HubSpotSDK::Resources::Crm::Objects::FeedbackSubmissions::Batch (readonly)

Returns:



9
10
11
 
# File 'lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb', line 9

def batch
  @batch
end

Instance Method Details

#get(feedback_submission_id, archived: nil, associations: nil, id_property: nil, properties: nil, properties_with_history: nil, request_options: {}) ⇒ HubSpotSDK::Models::Crm::SimplePublicObjectWithAssociations

Some parameter documentations has been truncated, see Models::Crm::Objects::FeedbackSubmissionGetParams for more details.

Read an Object identified by ‘feedbackSubmissionId`. `feedbackSubmissionId` refers to the internal object ID by default, or optionally any unique property value as specified by the `idProperty` query param. Control what is returned via the `properties` query param.

Parameters:

  • feedback_submission_id (String)
  • archived (Boolean) —

    Whether to return only results that have been archived.

  • associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of

  • id_property (String) —

    The name of a property whose values are unique for this object type

  • properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any

  • properties_with_history (Array<String>) —

    A comma separated list of the properties to be returned along with their history

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

Returns:

See Also:



78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb', line 78

def get(feedback_submission_id, params = {})
  parsed, options = HubSpotSDK::Crm::Objects::FeedbackSubmissionGetParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["crm/objects/2026-03/feedback_submissions/%1$s", feedback_submission_id],
    query: query.transform_keys(
      id_property: "idProperty",
      properties_with_history: "propertiesWithHistory"
    ),
    model: HubSpotSDK::Crm::SimplePublicObjectWithAssociations,
    options: options
  )
end

#list(after: nil, archived: nil, associations: nil, limit: nil, properties: nil, properties_with_history: nil, request_options: {}) ⇒ HubSpotSDK::Internal::Page<HubSpotSDK::Models::Crm::SimplePublicObjectWithAssociations>

Some parameter documentations has been truncated, see Models::Crm::Objects::FeedbackSubmissionListParams for more details.

Read a page of feedback submissions. Control what is returned via the ‘properties` query param.

Parameters:

  • after (String) —

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

  • archived (Boolean) —

    Whether to return only results that have been archived.

  • associations (Array<String>) —

    A comma separated list of object types to retrieve associated IDs for. If any of

  • limit (Integer) —

    The maximum number of results to display per page.

  • properties (Array<String>) —

    A comma separated list of the properties to be returned in the response. If any

  • properties_with_history (Array<String>) —

    A comma separated list of the properties to be returned along with their history

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

Returns:

See Also:



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb', line 37

def list(params = {})
  parsed, options = HubSpotSDK::Crm::Objects::FeedbackSubmissionListParams.dump_request(params)
  query = HubSpotSDK::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "crm/objects/2026-03/feedback_submissions",
    query: query.transform_keys(properties_with_history: "propertiesWithHistory"),
    page: HubSpotSDK::Internal::Page,
    model: HubSpotSDK::Crm::SimplePublicObjectWithAssociations,
    options: options
  )
end

#search(after:, filter_groups:, limit:, properties:, sorts:, query: nil, request_options: {}) ⇒ HubSpotSDK::Models::Crm::CollectionResponseWithTotalSimplePublicObject

Execute a search to retrieve feedback submissions based on defined filters, properties, and sorting options.

Parameters:

  • after (String) —

    A paging cursor token for retrieving subsequent pages.

  • filter_groups (Array<HubSpotSDK::Models::Crm::FilterGroup>) —

    Up to 6 groups of filters defining additional query criteria.

  • limit (Integer) —

    The maximum results to return, up to 200 objects.

  • properties (Array<String>) —

    A list of property names to include in the response.

  • sorts (Array<String>) —

    Specifies sorting order based on object properties.

  • query (String) —

    The search query string, up to 3000 characters.

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

Returns:

See Also:



115
116
117
118
119
120
121
122
123
124
 
# File 'lib/hubspot_sdk/resources/crm/objects/feedback_submissions.rb', line 115

def search(params)
  parsed, options = HubSpotSDK::Crm::Objects::FeedbackSubmissionSearchParams.dump_request(params)
  @client.request(
    method: :post,
    path: "crm/objects/2026-03/feedback_submissions/search",
    body: parsed,
    model: HubSpotSDK::Crm::CollectionResponseWithTotalSimplePublicObject,
    options: options
  )
end