Class: Hubspot::Crm::Extensions::Accounting::SyncApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SyncApi

Returns a new instance of SyncApi.



22
23
24
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/sync_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/sync_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_contact(app_id, sync_contacts_request, opts = {}) ⇒ ActionResponse

Import contacts Imports contacts’ properties from an external accounting system to HubSpot. Import details, including property mappings, must be configured previously in HubSpot infrastructure.

Parameters:

  • app_id (Integer) —

    The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal.

  • sync_contacts_request (SyncContactsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



31
32
33
34
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb', line 31

def create_contact(app_id, sync_contacts_request, opts = {})
  data, _status_code, _headers = create_contact_with_http_info(app_id, sync_contacts_request, opts)
  data
end

#create_contact_with_http_info(app_id, sync_contacts_request, opts = {}) ⇒ Array<(ActionResponse, Integer, Hash)>

Import contacts Imports contacts&#39; properties from an external accounting system to HubSpot. Import details, including property mappings, must be configured previously in HubSpot infrastructure.

Parameters:

  • app_id (Integer) —

    The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal.

  • sync_contacts_request (SyncContactsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActionResponse, Integer, Hash)>) —

    ActionResponse data, response status code and response headers



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
86
87
88
89
90
91
92
93
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb', line 42

def create_contact_with_http_info(app_id, sync_contacts_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyncApi.create_contact ...'
  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 SyncApi.create_contact"
  end
  # verify the required parameter 'sync_contacts_request' is set
  if @api_client.config.client_side_validation && sync_contacts_request.nil?
    fail ArgumentError, "Missing the required parameter 'sync_contacts_request' when calling SyncApi.create_contact"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/accounting/sync/{appId}/contacts'.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', '*/*'])
  # 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(sync_contacts_request) 

  # return_type
  return_type = opts[:return_type] || 'ActionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SyncApi#create_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_product(app_id, sync_products_request, opts = {}) ⇒ ActionResponse

Import products Imports products’ properties from an external accounting system to HubSpot. Import details, including property mappings, must be configured previously in HubSpot infrastructure.

Parameters:

  • app_id (Integer) —

    The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal.

  • sync_products_request (SyncProductsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



101
102
103
104
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb', line 101

def create_product(app_id, sync_products_request, opts = {})
  data, _status_code, _headers = create_product_with_http_info(app_id, sync_products_request, opts)
  data
end

#create_product_with_http_info(app_id, sync_products_request, opts = {}) ⇒ Array<(ActionResponse, Integer, Hash)>

Import products Imports products&#39; properties from an external accounting system to HubSpot. Import details, including property mappings, must be configured previously in HubSpot infrastructure.

Parameters:

  • app_id (Integer) —

    The ID of the accounting app. This is the identifier of the application created in your HubSpot developer portal.

  • sync_products_request (SyncProductsRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ActionResponse, Integer, Hash)>) —

    ActionResponse data, response status code and response headers



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
156
157
158
159
160
161
162
163
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/api/sync_api.rb', line 112

def create_product_with_http_info(app_id, sync_products_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SyncApi.create_product ...'
  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 SyncApi.create_product"
  end
  # verify the required parameter 'sync_products_request' is set
  if @api_client.config.client_side_validation && sync_products_request.nil?
    fail ArgumentError, "Missing the required parameter 'sync_products_request' when calling SyncApi.create_product"
  end
  # resource path
  local_var_path = '/crm/v3/extensions/accounting/sync/{appId}/products'.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', '*/*'])
  # 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(sync_products_request) 

  # return_type
  return_type = opts[:return_type] || 'ActionResponse' 

  # auth_names
  auth_names = opts[:auth_names] || ['hapikey', 'oauth2']

  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(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SyncApi#create_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end