def archive_with_http_info(self, account_id, **kwargs): # noqa: E501 """Delete user account # noqa: E501 Deletes a user account from HubSpot, meaning that HubSpot will no longer send requests to the external accounting system for this user. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.archive_with_http_info(account_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str account_id: The ID of the user account to delete. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['account_id'] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method archive" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'account_id' is set if self.api_client.client_side_validation and ( 'account_id' not in local_var_params or # noqa: E501 local_var_params['account_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `account_id` when calling `archive`" ) # noqa: E501 collection_formats = {} path_params = {} if 'account_id' in local_var_params: path_params['accountId'] = local_var_params[ 'account_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/extensions/accounting/user-accounts/{accountId}', 'DELETE', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def get_by_id_with_http_info(self, app_id, **kwargs): # noqa: E501 """Get URL settings # noqa: E501 Returns the URL settings for an accounting app with the specified ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.get_by_id_with_http_info(app_id, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int app_id: The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(AccountingAppSettings, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ 'app_id' ] all_params.extend( [ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ] ) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError( "Got an unexpected keyword argument '%s'" " to method get_by_id" % key ) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'app_id' is set if self.api_client.client_side_validation and ('app_id' not in local_var_params or # noqa: E501 local_var_params['app_id'] is None): # noqa: E501 raise ApiValueError("Missing the required parameter `app_id` when calling `get_by_id`") # noqa: E501 collection_formats = {} path_params = {} if 'app_id' in local_var_params: path_params['appId'] = local_var_params['app_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json', '*/*']) # noqa: E501 # Authentication setting auth_settings = ['hapikey'] # noqa: E501 return self.api_client.call_api( '/crm/v3/extensions/accounting/settings/{appId}', 'GET', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='AccountingAppSettings', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get('_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def replace_with_http_info(self, create_user_account_request_external, **kwargs): # noqa: E501 """Create a user account # noqa: E501 Creates an account which contains the information about the account in the external accounting system. This *must* be called after a user connects their HubSpot account to the external accounting system, as there is no other way for HubSpot to obtain the external account details. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_with_http_info(create_user_account_request_external, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param CreateUserAccountRequestExternal create_user_account_request_external: The external accounting system user account information. (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['create_user_account_request_external'] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method replace" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'create_user_account_request_external' is set if self.api_client.client_side_validation and ( 'create_user_account_request_external' not in local_var_params or # noqa: E501 local_var_params['create_user_account_request_external'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `create_user_account_request_external` when calling `replace`" ) # noqa: E501 collection_formats = {} path_params = {} query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'create_user_account_request_external' in local_var_params: body_params = local_var_params[ 'create_user_account_request_external'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['*/*']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/extensions/accounting/user-accounts', 'PUT', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def create_contact_with_http_info(self, app_id, sync_contacts_request, **kwargs): # noqa: E501 """Import contacts # noqa: E501 Imports contacts' properties from an external accounting system to HubSpot. Import details, including property mappings, must be configured previously in HubSpot infrastructure. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_contact_with_http_info(app_id, sync_contacts_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int app_id: The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal. (required) :param SyncContactsRequest sync_contacts_request: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(ActionResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['app_id', 'sync_contacts_request'] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method create_contact" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'app_id' is set if self.api_client.client_side_validation and ( 'app_id' not in local_var_params or # noqa: E501 local_var_params['app_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `app_id` when calling `create_contact`" ) # noqa: E501 # verify the required parameter 'sync_contacts_request' is set if self.api_client.client_side_validation and ( 'sync_contacts_request' not in local_var_params or # noqa: E501 local_var_params['sync_contacts_request'] is None ): # noqa: E501 raise ApiValueError( "Missing the required parameter `sync_contacts_request` when calling `create_contact`" ) # noqa: E501 collection_formats = {} path_params = {} if 'app_id' in local_var_params: path_params['appId'] = local_var_params['app_id'] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if 'sync_contacts_request' in local_var_params: body_params = local_var_params['sync_contacts_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json', '*/*']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/extensions/accounting/sync/{appId}/contacts', 'POST', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='ActionResponse', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def create_payment_with_http_info(self, invoice_id, invoice_create_payment_request, **kwargs): # noqa: E501 """Records an invoice payment # noqa: E501 Records an payment against an invoice. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.create_payment_with_http_info(invoice_id, invoice_create_payment_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str invoice_id: The ID of the invoice. This is the invoice ID from the external accounting system. (required) :param InvoiceCreatePaymentRequest invoice_create_payment_request: The payment information (required) :param str account_id: The ID of the account that the invoice belongs to. This is the account ID from the external accounting system. :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InvoiceUpdateResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = [ "invoice_id", "invoice_create_payment_request", "account_id" ] all_params.extend([ "async_req", "_return_http_data_only", "_preload_content", "_request_timeout", ]) for key, val in six.iteritems(local_var_params["kwargs"]): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method create_payment" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'invoice_id' is set if self.api_client.client_side_validation and ( "invoice_id" not in local_var_params or local_var_params["invoice_id"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `invoice_id` when calling `create_payment`" ) # noqa: E501 # verify the required parameter 'invoice_create_payment_request' is set if self.api_client.client_side_validation and ( "invoice_create_payment_request" not in local_var_params or local_var_params["invoice_create_payment_request"] is None # noqa: E501 ): # noqa: E501 raise ApiValueError( "Missing the required parameter `invoice_create_payment_request` when calling `create_payment`" ) # noqa: E501 collection_formats = {} path_params = {} if "invoice_id" in local_var_params: path_params["invoiceId"] = local_var_params[ "invoice_id"] # noqa: E501 query_params = [] if ("account_id" in local_var_params and local_var_params["account_id"] is not None): # noqa: E501 query_params.append( ("accountId", local_var_params["account_id"])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if "invoice_create_payment_request" in local_var_params: body_params = local_var_params["invoice_create_payment_request"] # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept( ["application/json", "*/*"]) # noqa: E501 # HTTP header `Content-Type` header_params[ "Content-Type"] = self.api_client.select_header_content_type( # noqa: E501 ["application/json"]) # noqa: E501 # Authentication setting auth_settings = ["hapikey", "oauth2"] # noqa: E501 return self.api_client.call_api( "/crm/v3/extensions/accounting/invoice/{invoiceId}/payment", "POST", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type="InvoiceUpdateResponse", # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get("async_req"), _return_http_data_only=local_var_params.get( "_return_http_data_only"), # noqa: E501 _preload_content=local_var_params.get("_preload_content", True), _request_timeout=local_var_params.get("_request_timeout"), collection_formats=collection_formats, )
def update_with_http_info(self, invoice_id, account_id, invoice_update_request, **kwargs): # noqa: E501 """Update an invoice # noqa: E501 Updates an Invoice by the given ID. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.update_with_http_info(invoice_id, account_id, invoice_update_request, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param str invoice_id: The ID of the invoice. This is the invoice ID from the external accounting system. (required) :param str account_id: The ID of the account that the invoice belongs to. This is the account ID from the external accounting system. (required) :param InvoiceUpdateRequest invoice_update_request: The invoice data to update (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: tuple(InvoiceUpdateResponse, status_code(int), headers(HTTPHeaderDict)) If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ['invoice_id', 'account_id', 'invoice_update_request'] all_params.extend([ 'async_req', '_return_http_data_only', '_preload_content', '_request_timeout' ]) for key, val in six.iteritems(local_var_params['kwargs']): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method update" % key) local_var_params[key] = val del local_var_params['kwargs'] # verify the required parameter 'invoice_id' is set if self.api_client.client_side_validation and ( 'invoice_id' not in local_var_params or # noqa: E501 local_var_params['invoice_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `invoice_id` when calling `update`" ) # noqa: E501 # verify the required parameter 'account_id' is set if self.api_client.client_side_validation and ( 'account_id' not in local_var_params or # noqa: E501 local_var_params['account_id'] is None): # noqa: E501 raise ApiValueError( "Missing the required parameter `account_id` when calling `update`" ) # noqa: E501 # verify the required parameter 'invoice_update_request' is set if self.api_client.client_side_validation and ( 'invoice_update_request' not in local_var_params or # noqa: E501 local_var_params['invoice_update_request'] is None ): # noqa: E501 raise ApiValueError( "Missing the required parameter `invoice_update_request` when calling `update`" ) # noqa: E501 collection_formats = {} path_params = {} if 'invoice_id' in local_var_params: path_params['invoiceId'] = local_var_params[ 'invoice_id'] # noqa: E501 query_params = [] if 'account_id' in local_var_params and local_var_params[ 'account_id'] is not None: # noqa: E501 query_params.append( ('accountId', local_var_params['account_id'])) # noqa: E501 header_params = {} form_params = [] local_var_files = {} body_params = None if 'invoice_update_request' in local_var_params: body_params = local_var_params['invoice_update_request'] # HTTP header `Accept` header_params['Accept'] = self.api_client.select_header_accept( ['application/json', '*/*']) # noqa: E501 # HTTP header `Content-Type` header_params[ 'Content-Type'] = self.api_client.select_header_content_type( # noqa: E501 ['application/json']) # noqa: E501 # Authentication setting auth_settings = ['hapikey', 'oauth2'] # noqa: E501 return self.api_client.call_api( '/crm/v3/extensions/accounting/invoice/{invoiceId}', 'PATCH', path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type='InvoiceUpdateResponse', # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get('async_req'), _return_http_data_only=local_var_params.get( '_return_http_data_only'), # noqa: E501 _preload_content=local_var_params.get('_preload_content', True), _request_timeout=local_var_params.get('_request_timeout'), collection_formats=collection_formats)
def replace_with_http_info(self, app_id, accounting_app_settings, **kwargs): # noqa: E501 """Add/Update URL Settings # noqa: E501 Add/Update the URL settings for an accounting app with the specified ID. All URLs must use the `https` protocol. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True >>> thread = api.replace_with_http_info(app_id, accounting_app_settings, async_req=True) >>> result = thread.get() :param async_req bool: execute request asynchronously :param int app_id: The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal. (required) :param AccountingAppSettings accounting_app_settings: (required) :param _return_http_data_only: response data without head status code and headers :param _preload_content: if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True. :param _request_timeout: timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts. :return: None If the method is called asynchronously, returns the request thread. """ local_var_params = locals() all_params = ["app_id", "accounting_app_settings"] # noqa: E501 all_params.append("async_req") all_params.append("_return_http_data_only") all_params.append("_preload_content") all_params.append("_request_timeout") for key, val in six.iteritems(local_var_params["kwargs"]): if key not in all_params: raise ApiTypeError("Got an unexpected keyword argument '%s'" " to method replace" % key) local_var_params[key] = val del local_var_params["kwargs"] # verify the required parameter 'app_id' is set if self.api_client.client_side_validation and ("app_id" not in local_var_params or local_var_params["app_id"] is None): # noqa: E501 # noqa: E501 raise ApiValueError("Missing the required parameter `app_id` when calling `replace`") # noqa: E501 # verify the required parameter 'accounting_app_settings' is set if self.api_client.client_side_validation and ("accounting_app_settings" not in local_var_params or local_var_params["accounting_app_settings"] is None): # noqa: E501 # noqa: E501 raise ApiValueError("Missing the required parameter `accounting_app_settings` when calling `replace`") # noqa: E501 collection_formats = {} path_params = {} if "app_id" in local_var_params: path_params["appId"] = local_var_params["app_id"] # noqa: E501 query_params = [] header_params = {} form_params = [] local_var_files = {} body_params = None if "accounting_app_settings" in local_var_params: body_params = local_var_params["accounting_app_settings"] # HTTP header `Accept` header_params["Accept"] = self.api_client.select_header_accept(["*/*"]) # noqa: E501 # HTTP header `Content-Type` header_params["Content-Type"] = self.api_client.select_header_content_type(["application/json"]) # noqa: E501 # noqa: E501 # Authentication setting auth_settings = ["hapikey"] # noqa: E501 return self.api_client.call_api( "/crm/v3/extensions/accounting/settings/{appId}", "PUT", path_params, query_params, header_params, body=body_params, post_params=form_params, files=local_var_files, response_type=None, # noqa: E501 auth_settings=auth_settings, async_req=local_var_params.get("async_req"), _return_http_data_only=local_var_params.get("_return_http_data_only"), # noqa: E501 _preload_content=local_var_params.get("_preload_content", True), _request_timeout=local_var_params.get("_request_timeout"), collection_formats=collection_formats, )