class Hubspot::Crm::Quotes::BasicApi
Attributes
Public Class Methods
# File lib/hubspot/codegen/crm/quotes/api/basic_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Read Read an Object identified by `{quoteId}`. `{quoteId}` 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. @param quote_id [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false) @option opts [String] :id_property The name of a property whose values are unique for this object type @return [SimplePublicObjectWithAssociations]
# File lib/hubspot/codegen/crm/quotes/api/basic_api.rb, line 35 def get_by_id(quote_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(quote_id, opts) data end
Read Read an Object identified by `{quoteId}`. `{quoteId}` 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. @param quote_id [String] @param [Hash] opts the optional parameters @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. @option opts [Boolean] :archived Whether to return only results that have been archived. @option opts [String] :id_property The name of a property whose values are unique for this object type @return [Array<(SimplePublicObjectWithAssociations
, Integer, Hash)>] SimplePublicObjectWithAssociations
data, response status code and response headers
# File lib/hubspot/codegen/crm/quotes/api/basic_api.rb, line 49 def get_by_id_with_http_info(quote_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.get_by_id ...' end # verify the required parameter 'quote_id' is set if @api_client.config.client_side_validation && quote_id.nil? fail ArgumentError, "Missing the required parameter 'quote_id' when calling BasicApi.get_by_id" end # resource path local_var_path = '/crm/v3/objects/quotes/{quoteId}'.sub('{' + 'quoteId' + '}', CGI.escape(quote_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil? query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil? query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil? query_params[:'idProperty'] = opts[:'id_property'] if !opts[:'id_property'].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[:body] # return_type return_type = opts[:return_type] || 'SimplePublicObjectWithAssociations' # auth_names auth_names = opts[:auth_names] || ['hapikey'] new_options = opts.merge( :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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Read a page of quotes. Control what is returned via the `properties` query param. @param [Hash] opts the optional parameters @option opts [Integer] :limit The maximum number of results to display per page. (default to 10) @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. @option opts [Boolean] :archived Whether to return only results that have been archived. (default to false) @return [CollectionResponseSimplePublicObjectWithAssociationsForwardPaging]
# File lib/hubspot/codegen/crm/quotes/api/basic_api.rb, line 109 def get_page(opts = {}) data, _status_code, _headers = get_page_with_http_info(opts) data end
List Read a page of quotes. Control what is returned via the `properties` query param. @param [Hash] opts the optional parameters @option opts [Integer] :limit The maximum number of results to display per page. @option opts [String] :after The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results. @option opts [Array<String>] :properties A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored. @option opts [Array<String>] :associations A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored. @option opts [Boolean] :archived Whether to return only results that have been archived. @return [Array<(CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
, Integer, Hash)>] CollectionResponseSimplePublicObjectWithAssociationsForwardPaging
data, response status code and response headers
# File lib/hubspot/codegen/crm/quotes/api/basic_api.rb, line 123 def get_page_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: BasicApi.get_page ...' end # resource path local_var_path = '/crm/v3/objects/quotes' # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil? query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil? query_params[:'associations'] = @api_client.build_collection_param(opts[:'associations'], :multi) if !opts[:'associations'].nil? query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].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[:body] # return_type return_type = opts[:return_type] || 'CollectionResponseSimplePublicObjectWithAssociationsForwardPaging' # auth_names auth_names = opts[:auth_names] || ['hapikey'] new_options = opts.merge( :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, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: BasicApi#get_page\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end