Class: Hubspot::Cms::Blogs::BlogPosts::BatchApi

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ BatchApi 



22
23
24
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 22

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Delete a batch of blog posts Delete a blog post by ID. Note: This is not the same as the in-app ‘archive` function. To perform a dashboard `archive` send an normal update with the `archivedInDashboard` field set to `true`.



30
31
32
33
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 30

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

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

Delete a batch of blog posts Delete a blog post by ID. Note: This is not the same as the in-app &#x60;archive&#x60; function. To perform a dashboard &#x60;archive&#x60; send an normal update with the &#x60;archivedInDashboard&#x60; field set to &#x60;true&#x60;.



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
89
90
91
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 40

def archive_with_http_info(batch_input_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.archive ...'
  end
  # verify the required parameter 'batch_input_string' is set
  if @api_client.config.client_side_validation && batch_input_string.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling BatchApi.archive"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/posts/batch/archive'

  # 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(['*/*'])
  # 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(batch_input_string)

  # return_type
  return_type = opts[:debug_return_type]

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

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

#create(batch_input_blog_post, opts = {}) ⇒ BatchResponseBlogPost

Create a batch of blog posts Create a batch of blog posts, specifying their content in the request body.



98
99
100
101
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 98

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

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

Create a batch of blog posts Create a batch of blog posts, specifying their content in the request body.



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
152
153
154
155
156
157
158
159
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 108

def create_with_http_info(batch_input_blog_post, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.create ...'
  end
  # verify the required parameter 'batch_input_blog_post' is set
  if @api_client.config.client_side_validation && batch_input_blog_post.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_blog_post' when calling BatchApi.create"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/posts/batch/create'

  # 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'
  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(batch_input_blog_post)

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

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

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

#read(batch_input_string, opts = {}) ⇒ BatchResponseBlogPost

Retrieve a batch of Blog Posts Retrieve a batch of blog posts by ID. identified in the request body.

Options Hash (opts):

  • :archived (Boolean) —

    Specifies whether to return deleted blog posts Defaults to &#x60;false&#x60;.



167
168
169
170
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 167

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

#read_with_http_info(batch_input_string, opts = {}) ⇒ Array<(BatchResponseBlogPost, Integer, Hash)>

Retrieve a batch of Blog Posts Retrieve a batch of blog posts by ID. identified in the request body.

Options Hash (opts):

  • :archived (Boolean) —

    Specifies whether to return deleted blog posts Defaults to &#x60;false&#x60;.



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
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 178

def read_with_http_info(batch_input_string, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.read ...'
  end
  # verify the required parameter 'batch_input_string' is set
  if @api_client.config.client_side_validation && batch_input_string.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_string' when calling BatchApi.read"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/posts/batch/read'

  # 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', '*/*'])
  # 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(batch_input_string)

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

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

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

#update(batch_input_json_node, opts = {}) ⇒ BatchResponseBlogPost

Update a batch of Blog Posts Update a batch of blog posts.

Options Hash (opts):

  • :archived (Boolean) —

    Specifies whether to update deleted Blog Posts. Defaults to &#x60;false&#x60;.



238
239
240
241
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 238

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

#update_with_http_info(batch_input_json_node, opts = {}) ⇒ Array<(BatchResponseBlogPost, Integer, Hash)>

Update a batch of Blog Posts Update a batch of blog posts.

Options Hash (opts):

  • :archived (Boolean) —

    Specifies whether to update deleted Blog Posts. Defaults to &#x60;false&#x60;.



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
299
300
301
 
# File 'lib/hubspot/codegen/cms/blogs/blog_posts/api/batch_api.rb', line 249

def update_with_http_info(batch_input_json_node, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: BatchApi.update ...'
  end
  # verify the required parameter 'batch_input_json_node' is set
  if @api_client.config.client_side_validation && batch_input_json_node.nil?
    fail ArgumentError, "Missing the required parameter 'batch_input_json_node' when calling BatchApi.update"
  end
  # resource path
  local_var_path = '/cms/v3/blogs/posts/batch/update'

  # 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', '*/*'])
  # 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(batch_input_json_node)

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

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

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