Class: Hubspot::Crm::Extensions::Accounting::SettingsApi
- Inherits:
-
Object
- Object
- Hubspot::Crm::Extensions::Accounting::SettingsApi
- Defined in:
- lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#get_by_id(app_id, opts = {}) ⇒ AccountingAppSettings
Get URL settings Returns the URL settings for an accounting app with the specified ID.
-
#get_by_id_with_http_info(app_id, opts = {}) ⇒ Array<(AccountingAppSettings, Integer, Hash)>
Get URL settings Returns the URL settings for an accounting app with the specified ID.
-
#initialize(api_client = ApiClient.default) ⇒ SettingsApi
constructor
A new instance of SettingsApi.
-
#replace(app_id, accounting_app_settings, opts = {}) ⇒ nil
Add/Update URL Settings Add/Update the URL settings for an accounting app with the specified ID.
-
#replace_with_http_info(app_id, accounting_app_settings, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add/Update URL Settings Add/Update the URL settings for an accounting app with the specified ID.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ SettingsApi
Returns a new instance of SettingsApi.
22 23 24 |
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/settings_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/extensions/accounting/api/settings_api.rb', line 20 def api_client @api_client end |
Instance Method Details
#get_by_id(app_id, opts = {}) ⇒ AccountingAppSettings
Get URL settings Returns the URL settings for an accounting app with the specified ID.
30 31 32 33 |
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb', line 30 def get_by_id(app_id, opts = {}) data, _status_code, _headers = get_by_id_with_http_info(app_id, opts) data end |
#get_by_id_with_http_info(app_id, opts = {}) ⇒ Array<(AccountingAppSettings, Integer, Hash)>
Get URL settings Returns the URL settings for an accounting app with the specified ID.
40 41 42 43 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 |
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb', line 40 def get_by_id_with_http_info(app_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.get_by_id ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.get_by_id" end # resource path local_var_path = '/crm/v3/extensions/accounting/settings/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_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', '*/*']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'AccountingAppSettings' # auth_names auth_names = opts[:auth_names] || ['hapikey'] = 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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#replace(app_id, accounting_app_settings, opts = {}) ⇒ nil
Add/Update URL Settings Add/Update the URL settings for an accounting app with the specified ID. All URLs must use the ‘https` protocol.
93 94 95 96 |
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb', line 93 def replace(app_id, accounting_app_settings, opts = {}) replace_with_http_info(app_id, accounting_app_settings, opts) nil end |
#replace_with_http_info(app_id, accounting_app_settings, opts = {}) ⇒ Array<(nil, Integer, Hash)>
Add/Update URL Settings Add/Update the URL settings for an accounting app with the specified ID. All URLs must use the `https` protocol.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 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 |
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/settings_api.rb', line 104 def replace_with_http_info(app_id, accounting_app_settings, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SettingsApi.replace ...' end # verify the required parameter 'app_id' is set if @api_client.config.client_side_validation && app_id.nil? fail ArgumentError, "Missing the required parameter 'app_id' when calling SettingsApi.replace" end # verify the required parameter 'accounting_app_settings' is set if @api_client.config.client_side_validation && accounting_app_settings.nil? fail ArgumentError, "Missing the required parameter 'accounting_app_settings' when calling SettingsApi.replace" end # resource path local_var_path = '/crm/v3/extensions/accounting/settings/{appId}'.sub('{' + 'appId' + '}', CGI.escape(app_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(['*/*']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(accounting_app_settings) # return_type return_type = opts[:return_type] # auth_names auth_names = opts[:auth_names] || ['hapikey'] = 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(:PUT, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: SettingsApi#replace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |