Class: Hubspot::Cms::UrlRedirects::RedirectsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RedirectsApi

Returns a new instance of RedirectsApi.



21
22
23
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_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/url-redirects/api/redirects_api.rb', line 19

def api_client
  @api_client
end

Instance Method Details

#archive(url_redirect_id, opts = {}) ⇒ nil

Delete a redirect Delete one existing redirect, so it is no longer mapped.

Parameters:

  • url_redirect_id (String) —

    The ID of the target redirect.

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

    the optional parameters

Returns:

  • (nil) 


29
30
31
32
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 29

def archive(url_redirect_id, opts = {})
  archive_with_http_info(url_redirect_id, opts)
  nil
end

#archive_with_http_info(url_redirect_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a redirect Delete one existing redirect, so it is no longer mapped.

Parameters:

  • url_redirect_id (String) —

    The ID of the target redirect.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 39

def archive_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.archive ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.archive"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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(['*/*'])

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

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

  # return_type
  return_type = opts[:return_type] 

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

#create(opts = {}) ⇒ UrlMapping

Create a redirect Creates and configures a new URL redirect.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



91
92
93
94
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 91

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

#create_with_http_info(opts = {}) ⇒ Array<(UrlMapping, Integer, Hash)>

Create a redirect Creates and configures a new URL redirect.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UrlMapping data, response status code and response headers



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
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 101

def create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.create ...'
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/'

  # 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(opts[:'url_mapping_create_request_body']) 

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

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

#get_by_id(url_redirect_id, opts = {}) ⇒ UrlMapping

Get details for a redirect Returns the details for a single existing URL redirect by ID.

Parameters:

  • url_redirect_id (String) —

    The ID of the target redirect.

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

    the optional parameters

Returns:



151
152
153
154
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 151

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

#get_by_id_with_http_info(url_redirect_id, opts = {}) ⇒ Array<(UrlMapping, Integer, Hash)>

Get details for a redirect Returns the details for a single existing URL redirect by ID.

Parameters:

  • url_redirect_id (String) —

    The ID of the target redirect.

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

    the optional parameters

Returns:

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

    UrlMapping data, response status code and response headers



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
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 161

def get_by_id_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.get_by_id ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.get_by_id"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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', '*/*'])

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

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

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

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

#get_page(opts = {}) ⇒ CollectionResponseWithTotalUrlMapping

Get current redirects Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_at (DateTime) —

    Only return redirects created on exactly this date.

  • :created_after (DateTime) —

    Only return redirects created after this date.

  • :created_before (DateTime) —

    Only return redirects created before this date.

  • :updated_at (DateTime) —

    Only return redirects last updated on exactly this date.

  • :updated_after (DateTime) —

    Only return redirects last updated after this date.

  • :updated_before (DateTime) —

    Only return redirects last 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 result per page

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



224
225
226
227
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 224

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

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

Get current redirects Returns all existing URL redirects. Results can be limited and filtered by creation or updated date.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :created_at (DateTime) —

    Only return redirects created on exactly this date.

  • :created_after (DateTime) —

    Only return redirects created after this date.

  • :created_before (DateTime) —

    Only return redirects created before this date.

  • :updated_at (DateTime) —

    Only return redirects last updated on exactly this date.

  • :updated_after (DateTime) —

    Only return redirects last updated after this date.

  • :updated_before (DateTime) —

    Only return redirects last 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 result per page

  • :archived (Boolean) —

    Whether to return only results that have been archived.

Returns:



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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 245

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

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

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

#update(url_redirect_id, opts = {}) ⇒ UrlMapping

Update a redirect Updates the settings for an existing URL redirect.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:



306
307
308
309
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 306

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

#update_with_http_info(url_redirect_id, opts = {}) ⇒ Array<(UrlMapping, Integer, Hash)>

Update a redirect Updates the settings for an existing URL redirect.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    UrlMapping data, response status code and response headers



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
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/hubspot/codegen/cms/url-redirects/api/redirects_api.rb', line 317

def update_with_http_info(url_redirect_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RedirectsApi.update ...'
  end
  # verify the required parameter 'url_redirect_id' is set
  if @api_client.config.client_side_validation && url_redirect_id.nil?
    fail ArgumentError, "Missing the required parameter 'url_redirect_id' when calling RedirectsApi.update"
  end
  # resource path
  local_var_path = '/cms/v3/url-redirects/{urlRedirectId}'.sub('{' + 'urlRedirectId' + '}', CGI.escape(url_redirect_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', '*/*'])
  # 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(opts[:'url_mapping']) 

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

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