Class: Hubspot::Cms::Domains::DomainsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/domains/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.



21
22
23
 
# File 'lib/hubspot/codegen/cms/domains/api/domains_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/cms/domains/api/domains_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#get_by_id(domain_id, opts = {}) ⇒ Domain

Get a single domain Returns a single domains with the id specified.

Parameters:

  • domain_id (String) —

    The unique ID of the domain.

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



30
31
32
33
 
# File 'lib/hubspot/codegen/cms/domains/api/domains_api.rb', line 30

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

#get_by_id_with_http_info(domain_id, opts = {}) ⇒ Array<(Domain, Integer, Hash)>

Get a single domain Returns a single domains with the id specified.

Parameters:

  • domain_id (String) —

    The unique ID of the domain.

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

    the optional parameters

Options Hash (opts):

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:

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

    Domain data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/cms/domains/api/domains_api.rb', line 41

def get_by_id_with_http_info(domain_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DomainsApi.get_by_id ...'
  end
  # verify the required parameter 'domain_id' is set
  if @api_client.config.client_side_validation && domain_id.nil?
    fail ArgumentError, "Missing the required parameter 'domain_id' when calling DomainsApi.get_by_id"
  end
  # resource path
  local_var_path = '/cms/v3/domains/{domainId}'.sub('{' + 'domainId' + '}', CGI.escape(domain_id.to_s))

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

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

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

#get_page(opts = {}) ⇒ CollectionResponseWithTotalDomain

Get current domains Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_at (Integer) —

    Only return domains created at this date.

  • :created_after (Integer) —

    Only return domains created after this date.

  • :created_before (Integer) —

    Only return domains created before this date.

  • :updated_at (Integer) —

    Only return domains updated at this date.

  • :updated_after (Integer) —

    Only return domains updated after this date.

  • :updated_before (Integer) —

    Only return domains updated before this date.

  • :sort (Array<String>)
  • :properties (Array<String>)
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :before (String)
  • :limit (Integer) —

    Maximum number of results per page.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



105
106
107
108
 
# File 'lib/hubspot/codegen/cms/domains/api/domains_api.rb', line 105

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

#get_page_with_http_info(opts = {}) ⇒ Array<(CollectionResponseWithTotalDomain, Integer, Hash)>

Get current domains Returns all existing domains that have been created. Results can be limited and filtered by creation or updated date.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_at (Integer) —

    Only return domains created at this date.

  • :created_after (Integer) —

    Only return domains created after this date.

  • :created_before (Integer) —

    Only return domains created before this date.

  • :updated_at (Integer) —

    Only return domains updated at this date.

  • :updated_after (Integer) —

    Only return domains updated after this date.

  • :updated_before (Integer) —

    Only return domains updated before this date.

  • :sort (Array<String>)
  • :properties (Array<String>)
  • :after (String) —

    The paging cursor token of the last successfully read resource will be returned as the &#x60;paging.next.after&#x60; JSON property of a paged response containing more results.

  • :before (String)
  • :limit (Integer) —

    Maximum number of results per page.

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/hubspot/codegen/cms/domains/api/domains_api.rb', line 126

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

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'createdAt'] = opts[:'created_at'] if !opts[:'created_at'].nil?
  query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
  query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
  query_params[:'updatedAt'] = opts[:'updated_at'] if !opts[:'updated_at'].nil?
  query_params[:'updatedAfter'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
  query_params[:'updatedBefore'] = opts[:'updated_before'] if !opts[:'updated_before'].nil?
  query_params[:'sort'] = @api_client.build_collection_param(opts[:'sort'], :multi) if !opts[:'sort'].nil?
  query_params[:'properties'] = @api_client.build_collection_param(opts[:'properties'], :multi) if !opts[:'properties'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'archived'] = opts[:'archived'] if !opts[:'archived'].nil?

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

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