Class: Sendpost::SubAccountApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/api/sub_account_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SubAccountApi

Returns a new instance of SubAccountApi.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_sub_account(new_sub_account, opts = {}) ⇒ SubAccount

Create Sub-Account Create a new sub-account to segment your email sending. Each sub-account gets its own API key, suppression list, and statistics. What You Get: - Unique X-SubAccount-ApiKey for authentication - Isolated email statistics - Separate suppression management - Independent domain configuration - Optional SMTP credentials Naming Best Practices: - Use descriptive names: Transactional_Orders, Marketing_Newsletter - Include environment: Production_Alerts, Staging_Tests - For multi-tenant: Client_CompanyName Use Cases: - New application or microservice needing email - Onboarding a new client in multi-tenant setup - Creating isolated testing environment - Separating email streams for analytics

Parameters:

  • new_sub_account (NewSubAccount)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 27

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

#create_sub_account_with_http_info(new_sub_account, opts = {}) ⇒ Array<(SubAccount, Integer, Hash)>

Create Sub-Account Create a new sub-account to segment your email sending. Each sub-account gets its own API key, suppression list, and statistics. What You Get: - Unique `X-SubAccount-ApiKey` for authentication - Isolated email statistics - Separate suppression management - Independent domain configuration - Optional SMTP credentials Naming Best Practices: - Use descriptive names: `Transactional_Orders`, `Marketing_Newsletter` - Include environment: `Production_Alerts`, `Staging_Tests` - For multi-tenant: `Client_CompanyName` Use Cases: - New application or microservice needing email - Onboarding a new client in multi-tenant setup - Creating isolated testing environment - Separating email streams for analytics

Parameters:

  • new_sub_account (NewSubAccount)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

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

    SubAccount data, response status code and response headers



37
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
84
85
86
87
88
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 37

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountApi.create_sub_account ...'
  end
  # verify the required parameter 'new_sub_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'new_sub_account' when calling SubAccountApi.create_sub_account"
  end
  # resource path
  local_var_path = '/account/subaccount/'

  # 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']) unless header_params['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()

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

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

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

#delete_sub_account(subaccount_id, opts = {}) ⇒ DeleteSubAccountResponse

Delete Sub-Account Remove a sub-account from your organization. This action is irreversible. ⚠️ Before Deleting: - Export any needed statistics or suppression lists - Update applications using this sub-account's API key - Ensure no active email sending relies on this sub-account What Gets Deleted: - All sub-account configuration - Associated API keys (will stop working) - Statistics are retained for your account records Note: The default sub-account (type 0) cannot be deleted.

Parameters:

  • subaccount_id (Integer) —

    The unique ID of the sub-account to delete.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 95

def (subaccount_id, opts = {})
  data, _status_code, _headers = (subaccount_id, opts)
  data
end

#delete_sub_account_with_http_info(subaccount_id, opts = {}) ⇒ Array<(DeleteSubAccountResponse, Integer, Hash)>

Delete Sub-Account Remove a sub-account from your organization. This action is irreversible. ⚠️ Before Deleting: - Export any needed statistics or suppression lists - Update applications using this sub-account's API key - Ensure no active email sending relies on this sub-account What Gets Deleted: - All sub-account configuration - Associated API keys (will stop working) - Statistics are retained for your account records Note: The default sub-account (type `0`) cannot be deleted.

Parameters:

  • subaccount_id (Integer) —

    The unique ID of the sub-account to delete.

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

    the optional parameters

Returns:

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

    DeleteSubAccountResponse data, response status code and response headers



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
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 105

def (subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountApi.delete_sub_account ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubAccountApi.delete_sub_account"
  end
  # resource path
  local_var_path = '/account/subaccount/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', CGI.escape(subaccount_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

  new_options = opts.merge(
    :operation => :"SubAccountApi.delete_sub_account",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountApi#delete_sub_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_sub_accounts(opts = {}) ⇒ Array<SubAccount>

List Sub-Accounts Retrieve all sub-accounts under your main account. Sub-accounts allow you to segment email sending for different applications, brands, or use cases. Sub-Account Types: | Type | Value | Description | |------|-------|-------------| | Default | 0 | Primary sub-account created with your account (cannot be deleted) | | Custom | 1 | Additional sub-accounts you create | Each Sub-Account Has: - Unique X-SubAccount-ApiKey for API authentication - Independent suppression list - Isolated email statistics - Own domain configurations - SMTP credentials (if enabled) Use Cases: - Separate transactional and marketing emails - Multi-tenant SaaS applications (one sub-account per customer) - Different brands or product lines - Development/staging/production environments Note: isPlus indicates SendX Plus customers with premium features.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case-insensitive search against sub-account names.

Returns:



160
161
162
163
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 160

def get_all_sub_accounts(opts = {})
  data, _status_code, _headers = get_all_sub_accounts_with_http_info(opts)
  data
end

#get_all_sub_accounts_with_http_info(opts = {}) ⇒ Array<(Array<SubAccount>, Integer, Hash)>

List Sub-Accounts Retrieve all sub-accounts under your main account. Sub-accounts allow you to segment email sending for different applications, brands, or use cases. Sub-Account Types: | Type | Value | Description | |------|-------|-------------| | Default | `0` | Primary sub-account created with your account (cannot be deleted) | | Custom | `1` | Additional sub-accounts you create | Each Sub-Account Has: - Unique `X-SubAccount-ApiKey` for API authentication - Independent suppression list - Isolated email statistics - Own domain configurations - SMTP credentials (if enabled) Use Cases: - Separate transactional and marketing emails - Multi-tenant SaaS applications (one sub-account per customer) - Different brands or product lines - Development/staging/production environments Note: `isPlus` indicates SendX Plus customers with premium features.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case-insensitive search against sub-account names.

Returns:

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

    Array data, response status code and response headers



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
212
213
214
215
216
217
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 172

def get_all_sub_accounts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountApi.get_all_sub_accounts ...'
  end
  # resource path
  local_var_path = '/account/subaccount/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<SubAccount>'

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

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

#get_sub_account(subaccount_id, opts = {}) ⇒ SubAccount

Get Sub-Account Retrieve detailed information about a specific sub-account, including API keys, SMTP credentials, and configuration. Response Includes: - Sub-account name and ID - API key for sub-account authentication - SMTP credentials (if enabled) - Team members with access - Labels/tags for categorization - Creation timestamp

Parameters:

  • subaccount_id (Integer) —

    The unique ID of the sub-account to retrieve.

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

    the optional parameters

Returns:



224
225
226
227
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 224

def (subaccount_id, opts = {})
  data, _status_code, _headers = (subaccount_id, opts)
  data
end

#get_sub_account_with_http_info(subaccount_id, opts = {}) ⇒ Array<(SubAccount, Integer, Hash)>

Get Sub-Account Retrieve detailed information about a specific sub-account, including API keys, SMTP credentials, and configuration. Response Includes: - Sub-account name and ID - API key for sub-account authentication - SMTP credentials (if enabled) - Team members with access - Labels/tags for categorization - Creation timestamp

Parameters:

  • subaccount_id (Integer) —

    The unique ID of the sub-account to retrieve.

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

    the optional parameters

Returns:

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

    SubAccount data, response status code and response headers



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 234

def (subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountApi.get_sub_account ...'
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubAccountApi.get_sub_account"
  end
  # resource path
  local_var_path = '/account/subaccount/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', CGI.escape(subaccount_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']) unless header_params['Accept']

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

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

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

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

#update_sub_account(update_sub_account, subaccount_id, opts = {}) ⇒ SubAccount

Update Sub-Account Modify settings for an existing sub-account. Use this to rename sub-accounts, update labels, or modify configuration. What Can Be Updated: - Sub-account name - Labels/tags for categorization - Other configuration settings Use Cases: - Rename sub-account for clarity - Update labels for organizational changes - Modify settings after initial setup

Parameters:

  • update_sub_account (UpdateSubAccount)
  • subaccount_id (Integer) —

    The unique ID of the sub-account to update.

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

    the optional parameters

Returns:



288
289
290
291
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 288

def (, subaccount_id, opts = {})
  data, _status_code, _headers = (, subaccount_id, opts)
  data
end

#update_sub_account_with_http_info(update_sub_account, subaccount_id, opts = {}) ⇒ Array<(SubAccount, Integer, Hash)>

Update Sub-Account Modify settings for an existing sub-account. Use this to rename sub-accounts, update labels, or modify configuration. What Can Be Updated: - Sub-account name - Labels/tags for categorization - Other configuration settings Use Cases: - Rename sub-account for clarity - Update labels for organizational changes - Modify settings after initial setup

Parameters:

  • update_sub_account (UpdateSubAccount)
  • subaccount_id (Integer) —

    The unique ID of the sub-account to update.

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

    the optional parameters

Returns:

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

    SubAccount data, response status code and response headers



299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/sendpost_ruby_sdk/api/sub_account_api.rb', line 299

def (, subaccount_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SubAccountApi.update_sub_account ...'
  end
  # verify the required parameter 'update_sub_account' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'update_sub_account' when calling SubAccountApi.update_sub_account"
  end
  # verify the required parameter 'subaccount_id' is set
  if @api_client.config.client_side_validation && subaccount_id.nil?
    fail ArgumentError, "Missing the required parameter 'subaccount_id' when calling SubAccountApi.update_sub_account"
  end
  # resource path
  local_var_path = '/account/subaccount/{subaccount_id}'.sub('{' + 'subaccount_id' + '}', CGI.escape(subaccount_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']) unless header_params['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()

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

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

  new_options = opts.merge(
    :operation => :"SubAccountApi.update_sub_account",
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SubAccountApi#update_sub_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end