Class: Hubspot::Marketing::Events::SubscriberStateChangesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubscriberStateChangesApi

Returns a new instance of SubscriberStateChangesApi.



21
22
23
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 21

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



19
20
21
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#upsert_by_contact_email(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ Error

Record a subscriber state by contact email Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: 'register', 'attend' or 'cancel'.

  • external_account_id (String) —

    The account ID associated with the marketing event

  • batch_input_marketing_event_email_subscriber (BatchInputMarketingEventEmailSubscriber)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 32

def upsert_by_contact_email(external_event_id, subscriber_state, , batch_input_marketing_event_email_subscriber, opts = {})
  data, _status_code, _headers = upsert_by_contact_email_with_http_info(external_event_id, subscriber_state, , batch_input_marketing_event_email_subscriber, opts)
  data
end

#upsert_by_contact_email_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_email_subscriber, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Record a subscriber state by contact email Record a subscriber state between multiple HubSpot contacts and a marketing event, using contact email addresses. Note that the contact must already exist in HubSpot; a contact will not be created. The contactProperties field is used only when creating a new contact. These properties will not update existing contacts.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

  • external_account_id (String) —

    The account ID associated with the marketing event

  • batch_input_marketing_event_email_subscriber (BatchInputMarketingEventEmailSubscriber)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Error data, response status code and response headers



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
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 45

def upsert_by_contact_email_with_http_info(external_event_id, subscriber_state, , batch_input_marketing_event_email_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.upsert_by_contact_email ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.upsert_by_contact_email"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.upsert_by_contact_email"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.upsert_by_contact_email"
  end
  # verify the required parameter 'batch_input_marketing_event_email_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_email_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_email_subscriber' when calling SubscriberStateChangesApi.upsert_by_contact_email"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'externalAccountId'] = 

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(batch_input_marketing_event_email_subscriber)

  # return_type
  return_type = opts[:debug_return_type] || 'Error'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SubscriberStateChangesApi.upsert_by_contact_email",
    :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: SubscriberStateChangesApi#upsert_by_contact_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#upsert_by_contact_id(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {}) ⇒ Error

Record a subscriber state by contact ID Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

  • external_account_id (String) —

    The account ID associated with the marketing event

  • batch_input_marketing_event_subscriber (BatchInputMarketingEventSubscriber)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



119
120
121
122
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 119

def upsert_by_contact_id(external_event_id, subscriber_state, , batch_input_marketing_event_subscriber, opts = {})
  data, _status_code, _headers = upsert_by_contact_id_with_http_info(external_event_id, subscriber_state, , batch_input_marketing_event_subscriber, opts)
  data
end

#upsert_by_contact_id_with_http_info(external_event_id, subscriber_state, external_account_id, batch_input_marketing_event_subscriber, opts = {}) ⇒ Array<(Error, Integer, Hash)>

Record a subscriber state by contact ID Record a subscriber state between multiple HubSpot contacts and a marketing event, using HubSpot contact IDs. Note that the contact must already exist in HubSpot; a contact will not be created.

Parameters:

  • external_event_id (String) —

    The ID of the marketing event

  • subscriber_state (String) —

    The new subscriber state for the HubSpot contacts and the specified marketing event. For example: &#39;register&#39;, &#39;attend&#39; or &#39;cancel&#39;.

  • external_account_id (String) —

    The account ID associated with the marketing event

  • batch_input_marketing_event_subscriber (BatchInputMarketingEventSubscriber)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    Error data, response status code and response headers



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
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/hubspot/codegen/marketing/events/api/subscriber_state_changes_api.rb', line 132

def upsert_by_contact_id_with_http_info(external_event_id, subscriber_state, , batch_input_marketing_event_subscriber, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubscriberStateChangesApi.upsert_by_contact_id ...'
  end
  # verify the required parameter 'external_event_id' is set
  if @api_client.config.client_side_validation && external_event_id.nil?
    fail ArgumentError, "Missing the required parameter 'external_event_id' when calling SubscriberStateChangesApi.upsert_by_contact_id"
  end
  # verify the required parameter 'subscriber_state' is set
  if @api_client.config.client_side_validation && subscriber_state.nil?
    fail ArgumentError, "Missing the required parameter 'subscriber_state' when calling SubscriberStateChangesApi.upsert_by_contact_id"
  end
  # verify the required parameter 'external_account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'external_account_id' when calling SubscriberStateChangesApi.upsert_by_contact_id"
  end
  # verify the required parameter 'batch_input_marketing_event_subscriber' is set
  if @api_client.config.client_side_validation && batch_input_marketing_event_subscriber.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_marketing_event_subscriber' when calling SubscriberStateChangesApi.upsert_by_contact_id"
  end
  # resource path
  local_var_path = '/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert'.sub('{' + 'externalEventId' + '}', CGI.escape(external_event_id.to_s)).sub('{' + 'subscriberState' + '}', CGI.escape(subscriber_state.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'externalAccountId'] = 

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['*/*'])
  # 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(batch_input_marketing_event_subscriber)

  # return_type
  return_type = opts[:debug_return_type] || 'Error'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['oauth2']

  new_options = opts.merge(
    :operation => :"SubscriberStateChangesApi.upsert_by_contact_id",
    :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: SubscriberStateChangesApi#upsert_by_contact_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end