Class: Zyphr::DomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zyphr/api/domains_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DomainsApi

Returns a new instance of DomainsApi.



19
20
21
 
# File 'lib/zyphr/api/domains_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/zyphr/api/domains_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_domain(add_domain_request, opts = {}) ⇒ AddDomain200Response

Add a sending domain Register a new sending domain on the account. Returns the full set of DNS records that must be published before email can send from this domain. Idempotent: calling this with a domain already registered on the current project returns the existing domain (200) instead of erroring, so re-runs from IaC tooling are safe.

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/zyphr/api/domains_api.rb', line 27

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

#add_domain_with_http_info(add_domain_request, opts = {}) ⇒ Array<(AddDomain200Response, Integer, Hash)>

Add a sending domain Register a new sending domain on the account. Returns the full set of DNS records that must be published before email can send from this domain. Idempotent: calling this with a domain already registered on the current project returns the existing domain (200) instead of erroring, so re-runs from IaC tooling are safe.

Parameters:

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

    the optional parameters

Returns:

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

    AddDomain200Response 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/zyphr/api/domains_api.rb', line 37

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

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

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

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

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

#list_domains(opts = {}) ⇒ DomainListResponse

List sending domains List sending domains on the current project, with verification status and DNS records.

Parameters:

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

    the optional parameters

Returns:



94
95
96
97
 
# File 'lib/zyphr/api/domains_api.rb', line 94

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

#list_domains_with_http_info(opts = {}) ⇒ Array<(DomainListResponse, Integer, Hash)>

List sending domains List sending domains on the current project, with verification status and DNS records.

Parameters:

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

    the optional parameters

Returns:

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

    DomainListResponse data, response status code and response headers



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
 
# File 'lib/zyphr/api/domains_api.rb', line 103

def list_domains_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.list_domains ...'
  end
  # resource path
  local_var_path = '/domains'

  # 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] || 'DomainListResponse'

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

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