Class: Hubspot::CommunicationPreferences::StatusApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/communication_preferences/api/status_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ StatusApi

Returns a new instance of StatusApi.



20
21
22
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 20

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



18
19
20
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 18

def api_client
  @api_client
end

Instance Method Details

#get_email_status(email_address, opts = {}) ⇒ PublicSubscriptionStatusesResponse

Get subscription statuses for a contact Returns a list of subscriptions and their status for a given contact.

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 28

def get_email_status(email_address, opts = {})
  data, _status_code, _headers = get_email_status_with_http_info(email_address, opts)
  data
end

#get_email_status_with_http_info(email_address, opts = {}) ⇒ Array<(PublicSubscriptionStatusesResponse, Integer, Hash)>

Get subscription statuses for a contact Returns a list of subscriptions and their status for a given contact.

Parameters:

  • email_address (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



38
39
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
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 38

def get_email_status_with_http_info(email_address, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusApi.get_email_status ...'
  end
  # verify the required parameter 'email_address' is set
  if @api_client.config.client_side_validation && email_address.nil?
    fail ArgumentError, "Missing the required parameter 'email_address' when calling StatusApi.get_email_status"
  end
  # resource path
  local_var_path = '/communication-preferences/v3/status/email/{emailAddress}'.sub('{' + 'emailAddress' + '}', CGI.escape(email_address.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] || 'PublicSubscriptionStatusesResponse' 

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

#subscribe(public_update_subscription_status_request, opts = {}) ⇒ PublicSubscriptionStatus

Subscribe a contact Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.

Parameters:

Returns:



90
91
92
93
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 90

def subscribe(public_update_subscription_status_request, opts = {})
  data, _status_code, _headers = subscribe_with_http_info(public_update_subscription_status_request, opts)
  data
end

#subscribe_with_http_info(public_update_subscription_status_request, opts = {}) ⇒ Array<(PublicSubscriptionStatus, Integer, Hash)>

Subscribe a contact Subscribes a contact to the given subscription type. This API is not valid to use for subscribing a contact at a brand or portal level and will return an error.

Parameters:

Returns:

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

    PublicSubscriptionStatus data, response status code and response headers



100
101
102
103
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
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 100

def subscribe_with_http_info(public_update_subscription_status_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusApi.subscribe ...'
  end
  # verify the required parameter 'public_update_subscription_status_request' is set
  if @api_client.config.client_side_validation && public_update_subscription_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'public_update_subscription_status_request' when calling StatusApi.subscribe"
  end
  # resource path
  local_var_path = '/communication-preferences/v3/subscribe'

  # 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(public_update_subscription_status_request) 

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

  # 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: StatusApi#subscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unsubscribe(public_update_subscription_status_request, opts = {}) ⇒ PublicSubscriptionStatus

Unsubscribe a contact Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.

Parameters:

Returns:



154
155
156
157
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 154

def unsubscribe(public_update_subscription_status_request, opts = {})
  data, _status_code, _headers = unsubscribe_with_http_info(public_update_subscription_status_request, opts)
  data
end

#unsubscribe_with_http_info(public_update_subscription_status_request, opts = {}) ⇒ Array<(PublicSubscriptionStatus, Integer, Hash)>

Unsubscribe a contact Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.

Parameters:

Returns:

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

    PublicSubscriptionStatus data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/hubspot/codegen/communication_preferences/api/status_api.rb', line 164

def unsubscribe_with_http_info(public_update_subscription_status_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatusApi.unsubscribe ...'
  end
  # verify the required parameter 'public_update_subscription_status_request' is set
  if @api_client.config.client_side_validation && public_update_subscription_status_request.nil?
    fail ArgumentError, "Missing the required parameter 'public_update_subscription_status_request' when calling StatusApi.unsubscribe"
  end
  # resource path
  local_var_path = '/communication-preferences/v3/unsubscribe'

  # 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(public_update_subscription_status_request) 

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

  # 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: StatusApi#unsubscribe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end