Class: Hubspot::Crm::Objects::FeedbackSubmissions::AssociationsApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Objects::FeedbackSubmissions::AssociationsApi
- Defined in:
- lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#archive(feedback_submission_id, to_object_type, to_object_id, opts = {}) ⇒ nil
Delete deletes all associations between two records.
-
#archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete deletes all associations between two records.
-
#create(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) ⇒ LabelsBetweenObjectPair
Create Set association labels between two records.
-
#create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) ⇒ Array<(LabelsBetweenObjectPair, Integer, Hash)>
Create Set association labels between two records.
-
#get_page(feedback_submission_id, to_object_type, opts = {}) ⇒ CollectionResponseMultiAssociatedObjectWithLabelForwardPaging
List List all associations of a feedback submission by object type.
-
#get_page_with_http_info(feedback_submission_id, to_object_type, opts = {}) ⇒ Array<(CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, Integer, Hash)>
List List all associations of a feedback submission by object type.
-
#initialize(api_client = ApiClient.default) ⇒ AssociationsApi
constructor
A new instance of AssociationsApi.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ AssociationsApi
Returns a new instance of AssociationsApi.
22 23 24 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 22 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
20 21 22 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#archive(feedback_submission_id, to_object_type, to_object_id, opts = {}) ⇒ nil
Delete deletes all associations between two records.
32 33 34 35 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 32 def archive(feedback_submission_id, to_object_type, to_object_id, opts = {}) archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, opts) nil end |
#archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Delete deletes all associations between two records.
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 44 def archive_with_http_info(feedback_submission_id, to_object_type, to_object_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.archive ...' end # verify the required parameter 'feedback_submission_id' is set if @api_client.config.client_side_validation && feedback_submission_id.nil? fail ArgumentError, "Missing the required parameter 'feedback_submission_id' when calling AssociationsApi.archive" end # verify the required parameter 'to_object_type' is set if @api_client.config.client_side_validation && to_object_type.nil? fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.archive" end # verify the required parameter 'to_object_id' is set if @api_client.config.client_side_validation && to_object_id.nil? fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.archive" end # resource path local_var_path = '/crm/v4/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"AssociationsApi.archive", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#archive\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) ⇒ LabelsBetweenObjectPair
Create Set association labels between two records.
108 109 110 111 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 108 def create(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) data, _status_code, _headers = create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_spec, opts) data end |
#create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) ⇒ Array<(LabelsBetweenObjectPair, Integer, Hash)>
Create Set association labels between two records.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 121 def create_with_http_info(feedback_submission_id, to_object_type, to_object_id, association_spec, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.create ...' end # verify the required parameter 'feedback_submission_id' is set if @api_client.config.client_side_validation && feedback_submission_id.nil? fail ArgumentError, "Missing the required parameter 'feedback_submission_id' when calling AssociationsApi.create" end # verify the required parameter 'to_object_type' is set if @api_client.config.client_side_validation && to_object_type.nil? fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.create" end # verify the required parameter 'to_object_id' is set if @api_client.config.client_side_validation && to_object_id.nil? fail ArgumentError, "Missing the required parameter 'to_object_id' when calling AssociationsApi.create" end # verify the required parameter 'association_spec' is set if @api_client.config.client_side_validation && association_spec.nil? fail ArgumentError, "Missing the required parameter 'association_spec' when calling AssociationsApi.create" end # resource path local_var_path = '/crm/v4/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}/{toObjectId}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)).sub('{' + 'toObjectId' + '}', CGI.escape(to_object_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(association_spec) # return_type return_type = opts[:debug_return_type] || 'LabelsBetweenObjectPair' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"AssociationsApi.create", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_page(feedback_submission_id, to_object_type, opts = {}) ⇒ CollectionResponseMultiAssociatedObjectWithLabelForwardPaging
List List all associations of a feedback submission by object type. Limit 1000 per call.
194 195 196 197 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 194 def get_page(feedback_submission_id, to_object_type, opts = {}) data, _status_code, _headers = get_page_with_http_info(feedback_submission_id, to_object_type, opts) data end |
#get_page_with_http_info(feedback_submission_id, to_object_type, opts = {}) ⇒ Array<(CollectionResponseMultiAssociatedObjectWithLabelForwardPaging, Integer, Hash)>
List List all associations of a feedback submission by object type. Limit 1000 per call.
207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/hubspot/codegen/crm/objects/feedback_submissions/api/associations_api.rb', line 207 def get_page_with_http_info(feedback_submission_id, to_object_type, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AssociationsApi.get_page ...' end # verify the required parameter 'feedback_submission_id' is set if @api_client.config.client_side_validation && feedback_submission_id.nil? fail ArgumentError, "Missing the required parameter 'feedback_submission_id' when calling AssociationsApi.get_page" end # verify the required parameter 'to_object_type' is set if @api_client.config.client_side_validation && to_object_type.nil? fail ArgumentError, "Missing the required parameter 'to_object_type' when calling AssociationsApi.get_page" end # resource path local_var_path = '/crm/v4/objects/feedback_submissions/{feedbackSubmissionId}/associations/{toObjectType}'.sub('{' + 'feedbackSubmissionId' + '}', CGI.escape(feedback_submission_id.to_s)).sub('{' + 'toObjectType' + '}', CGI.escape(to_object_type.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'CollectionResponseMultiAssociatedObjectWithLabelForwardPaging' # auth_names auth_names = opts[:debug_auth_names] || ['hapikey', 'oauth2'] = opts.merge( :operation => :"AssociationsApi.get_page", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: AssociationsApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |