Class: Spatio::SlidesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/spatio-sdk/api/slides_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SlidesApi

Returns a new instance of SlidesApi.



19
20
21
 
# File 'lib/spatio-sdk/api/slides_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/spatio-sdk/api/slides_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_presentation(create_presentation_request, opts = {}) ⇒ Presentation

Create a presentation. Creates a new deck under the target account. Target resolution mirrors ‘POST /v1/notes` and `/v1/sheets`: body `accountId` → `?accountId=` → body `provider` → `?provider=` → caller’s single connected account (errors with ‘ambiguous_account` otherwise). The new deck is auto-seeded with one blank slide so the renderer has something to display immediately.

Parameters:

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with `provider`. If omitted on a list endpoint the call fans out across every connected account.

  • :provider (String) —

    Provider id (e.g. `native-notes`, `notion`). Selects every connected account for the provider. Mutually exclusive with `accountId`.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



30
31
32
33
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 30

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

#create_presentation_with_http_info(create_presentation_request, opts = {}) ⇒ Array<(Presentation, Integer, Hash)>

Create a presentation. Creates a new deck under the target account. Target resolution mirrors &#x60;POST /v1/notes&#x60; and &#x60;/v1/sheets&#x60;: body &#x60;accountId&#x60; → &#x60;?accountId&#x3D;&#x60; → body &#x60;provider&#x60; → &#x60;?provider&#x3D;&#x60; → caller&#39;s single connected account (errors with &#x60;ambiguous_account&#x60; otherwise). The new deck is auto-seeded with one blank slide so the renderer has something to display immediately.

Parameters:

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :provider (String) —

    Provider id (e.g. &#x60;native-notes&#x60;, &#x60;notion&#x60;). Selects every connected account for the provider. Mutually exclusive with &#x60;accountId&#x60;.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Presentation data, response status code and response headers



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
92
93
94
95
96
97
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 43

def create_presentation_with_http_info(create_presentation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_presentation ...'
  end
  # verify the required parameter 'create_presentation_request' is set
  if @api_client.config.client_side_validation && create_presentation_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_presentation_request' when calling SlidesApi.create_presentation"
  end
  # resource path
  local_var_path = '/v1/slides'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_presentation_request)

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

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

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

#create_slide(id, create_slide_request, opts = {}) ⇒ Slide

Insert a slide.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



106
107
108
109
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 106

def create_slide(id, create_slide_request, opts = {})
  data, _status_code, _headers = create_slide_with_http_info(id, create_slide_request, opts)
  data
end

#create_slide_element(id, slide_id, create_slide_element_request, opts = {}) ⇒ SlideElement

Add a canvas element (text/shape/image) to a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



185
186
187
188
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 185

def create_slide_element(id, slide_id, create_slide_element_request, opts = {})
  data, _status_code, _headers = create_slide_element_with_http_info(id, slide_id, create_slide_element_request, opts)
  data
end

#create_slide_element_with_http_info(id, slide_id, create_slide_element_request, opts = {}) ⇒ Array<(SlideElement, Integer, Hash)>

Add a canvas element (text/shape/image) to a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SlideElement data, response status code and response headers



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
231
232
233
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
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 198

def create_slide_element_with_http_info(id, slide_id, create_slide_element_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_slide_element ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.create_slide_element"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.create_slide_element"
  end
  # verify the required parameter 'create_slide_element_request' is set
  if @api_client.config.client_side_validation && create_slide_element_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_slide_element_request' when calling SlidesApi.create_slide_element"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}/elements'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_slide_element_request)

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

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

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

#create_slide_with_http_info(id, create_slide_request, opts = {}) ⇒ Array<(Slide, Integer, Hash)>

Insert a slide.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Slide data, response status code and response headers



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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 118

def create_slide_with_http_info(id, create_slide_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.create_slide ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.create_slide"
  end
  # verify the required parameter 'create_slide_request' is set
  if @api_client.config.client_side_validation && create_slide_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_slide_request' when calling SlidesApi.create_slide"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(create_slide_request)

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

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

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

#delete_presentation(id, opts = {}) ⇒ SuccessFlag

Delete a presentation.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



267
268
269
270
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 267

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

#delete_presentation_with_http_info(id, opts = {}) ⇒ Array<(SuccessFlag, Integer, Hash)>

Delete a presentation.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SuccessFlag data, response status code and response headers



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
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
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 278

def delete_presentation_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_presentation ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.delete_presentation"
  end
  # resource path
  local_var_path = '/v1/slides/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#delete_slide(id, slide_id, opts = {}) ⇒ SuccessFlag

Delete a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



335
336
337
338
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 335

def delete_slide(id, slide_id, opts = {})
  data, _status_code, _headers = delete_slide_with_http_info(id, slide_id, opts)
  data
end

#delete_slide_element(id, slide_id, element_id, opts = {}) ⇒ SuccessFlag

Delete a slide element.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



409
410
411
412
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 409

def delete_slide_element(id, slide_id, element_id, opts = {})
  data, _status_code, _headers = delete_slide_element_with_http_info(id, slide_id, element_id, opts)
  data
end

#delete_slide_element_with_http_info(id, slide_id, element_id, opts = {}) ⇒ Array<(SuccessFlag, Integer, Hash)>

Delete a slide element.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SuccessFlag data, response status code and response headers



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 422

def delete_slide_element_with_http_info(id, slide_id, element_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slide_element ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.delete_slide_element"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.delete_slide_element"
  end
  # verify the required parameter 'element_id' is set
  if @api_client.config.client_side_validation && element_id.nil?
    fail ArgumentError, "Missing the required parameter 'element_id' when calling SlidesApi.delete_slide_element"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}/elements/{elementId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s)).sub('{elementId}', CGI.escape(element_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#delete_slide_with_http_info(id, slide_id, opts = {}) ⇒ Array<(SuccessFlag, Integer, Hash)>

Delete a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SuccessFlag data, response status code and response headers



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 347

def delete_slide_with_http_info(id, slide_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.delete_slide ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.delete_slide"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.delete_slide"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#disable_presentation_share(id, opts = {}) ⇒ nil

Disable public sharing. Owner-only. Subsequent public viewer requests 404.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

  • (nil) 


487
488
489
490
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 487

def disable_presentation_share(id, opts = {})
  disable_presentation_share_with_http_info(id, opts)
  nil
end

#disable_presentation_share_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Disable public sharing. Owner-only. Subsequent public viewer requests 404.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    nil, response status code and response headers



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 499

def disable_presentation_share_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.disable_presentation_share ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.disable_presentation_share"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/share'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

  # return_type
  return_type = opts[:debug_return_type]

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

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

#enable_presentation_share(id, opts = {}) ⇒ ShareSettings

Enable (or update password on) public sharing. Owner-only. With ‘setPassword: false` (or empty body), flips the deck public without changing the password. With `setPassword: true`, applies `password` (empty clears).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :enable_share_request (EnableShareRequest)

Returns:



557
558
559
560
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 557

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

#enable_presentation_share_with_http_info(id, opts = {}) ⇒ Array<(ShareSettings, Integer, Hash)>

Enable (or update password on) public sharing. Owner-only. With &#x60;setPassword: false&#x60; (or empty body), flips the deck public without changing the password. With &#x60;setPassword: true&#x60;, applies &#x60;password&#x60; (empty clears).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :enable_share_request (EnableShareRequest)

Returns:

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

    ShareSettings data, response status code and response headers



570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 570

def enable_presentation_share_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.enable_presentation_share ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.enable_presentation_share"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/share'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'enable_share_request'])

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

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

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

#export_presentation_pdf(id, opts = {}) ⇒ File

Render the presentation as a PDF. Proxies to the Spatio export sidecar (Playwright). Two response modes selected via ‘?storage=`: - `stream` (default) — response body is the PDF binary (`application/pdf`). - `r2` — uploads the rendered PDF to R2 storage and returns a JSON envelope with a 24-hour signed URL. Returns `503 Service Unavailable` when the export sidecar is not configured (dev fallback to the client-side exporter).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :storage (String) — default: default to 'stream'
  • :filename (String) —

    Sanitized base name for the downloaded PDF.

  • :export_pdf_request (ExportPDFRequest)

Returns:

  • (File) 


635
636
637
638
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 635

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

#export_presentation_pdf_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Render the presentation as a PDF. Proxies to the Spatio export sidecar (Playwright). Two response modes selected via &#x60;?storage&#x3D;&#x60;: - &#x60;stream&#x60; (default) — response body is the PDF binary (&#x60;application/pdf&#x60;). - &#x60;r2&#x60; — uploads the rendered PDF to R2 storage and returns a JSON envelope with a 24-hour signed URL. Returns &#x60;503 Service Unavailable&#x60; when the export sidecar is not configured (dev fallback to the client-side exporter).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :storage (String) — default: default to 'stream'
  • :filename (String) —

    Sanitized base name for the downloaded PDF.

  • :export_pdf_request (ExportPDFRequest)

Returns:

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

    File data, response status code and response headers



650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 650

def export_presentation_pdf_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.export_presentation_pdf ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.export_presentation_pdf"
  end
  allowable_values = ["stream", "r2"]
  if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
    fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/export/pdf'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/pdf', '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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'export_pdf_request'])

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

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

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

#export_presentation_pptx(id, opts = {}) ⇒ File

Render the presentation as a PowerPoint (.pptx) file. Proxies to the Spatio export sidecar (Playwright + pptxgenjs). Each slide is screenshotted at 2× device-pixel ratio and wrapped into a PowerPoint .pptx as a full-bleed image. Visual fidelity is preserved exactly — what renders in Spatio renders identically in PowerPoint, Keynote, Google Slides — at the cost of in-PowerPoint editability of slide content. Users edit slide content back in Spatio (the source of truth), not inside PowerPoint. Two response modes selected via ‘?storage=`: - `stream` (default) — response body is the PPTX binary (`application/vnd.openxmlformats-officedocument.presentationml.presentation`). - `r2` — uploads the rendered PPTX to R2 storage and returns a JSON envelope with a 24-hour signed URL. Returns `503 Service Unavailable` when the export sidecar is not configured.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :storage (String) — default: default to 'stream'
  • :filename (String) —

    Sanitized base name for the downloaded PPTX.

  • :export_pdf_request (ExportPDFRequest)

Returns:

  • (File) 


721
722
723
724
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 721

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

#export_presentation_pptx_with_http_info(id, opts = {}) ⇒ Array<(File, Integer, Hash)>

Render the presentation as a PowerPoint (.pptx) file. Proxies to the Spatio export sidecar (Playwright + pptxgenjs). Each slide is screenshotted at 2× device-pixel ratio and wrapped into a PowerPoint .pptx as a full-bleed image. Visual fidelity is preserved exactly — what renders in Spatio renders identically in PowerPoint, Keynote, Google Slides — at the cost of in-PowerPoint editability of slide content. Users edit slide content back in Spatio (the source of truth), not inside PowerPoint. Two response modes selected via &#x60;?storage&#x3D;&#x60;: - &#x60;stream&#x60; (default) — response body is the PPTX binary (&#x60;application/vnd.openxmlformats-officedocument.presentationml.presentation&#x60;). - &#x60;r2&#x60; — uploads the rendered PPTX to R2 storage and returns a JSON envelope with a 24-hour signed URL. Returns &#x60;503 Service Unavailable&#x60; when the export sidecar is not configured.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :storage (String) — default: default to 'stream'
  • :filename (String) —

    Sanitized base name for the downloaded PPTX.

  • :export_pdf_request (ExportPDFRequest)

Returns:

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

    File data, response status code and response headers



736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 736

def export_presentation_pptx_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.export_presentation_pptx ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.export_presentation_pptx"
  end
  allowable_values = ["stream", "r2"]
  if @api_client.config.client_side_validation && opts[:'storage'] && !allowable_values.include?(opts[:'storage'])
    fail ArgumentError, "invalid value for \"storage\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/export/pptx'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'storage'] = opts[:'storage'] if !opts[:'storage'].nil?
  query_params[:'filename'] = opts[:'filename'] if !opts[:'filename'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.openxmlformats-officedocument.presentationml.presentation', '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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'export_pdf_request'])

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

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

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

#get_presentation(id, opts = {}) ⇒ Presentation

Fetch one presentation.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



803
804
805
806
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 803

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

#get_presentation_share_settings(id, opts = {}) ⇒ ShareSettings

Fetch share settings for a presentation. Owner-only. Mirror of ‘GET /v1/notes/id/share` — same shape, same fields. Returns the current public-share configuration, including the share token and computed public viewer URL when the deck is currently public.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



871
872
873
874
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 871

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

#get_presentation_share_settings_with_http_info(id, opts = {}) ⇒ Array<(ShareSettings, Integer, Hash)>

Fetch share settings for a presentation. Owner-only. Mirror of &#x60;GET /v1/notes/id/share&#x60; — same shape, same fields. Returns the current public-share configuration, including the share token and computed public viewer URL when the deck is currently public.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    ShareSettings data, response status code and response headers



883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 883

def get_presentation_share_settings_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_presentation_share_settings ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.get_presentation_share_settings"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/share'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#get_presentation_with_http_info(id, opts = {}) ⇒ Array<(Presentation, Integer, Hash)>

Fetch one presentation.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Presentation data, response status code and response headers



814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 814

def get_presentation_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_presentation ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.get_presentation"
  end
  # resource path
  local_var_path = '/v1/slides/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#get_public_presentation(token, opts = {}) ⇒ Hash<String, Object>

Fetch a publicly shared presentation. Unauthenticated. Mirror of ‘GET /public/notes/token`. The share token is the credential. For password-protected decks the password is supplied via `?password=`; the response distinguishes "no password supplied" from "wrong password" so the viewer can render the right prompt. Unknown tokens and disabled-share decks both return `404` to prevent enumeration.

Parameters:

  • token (String) —

    Opaque public-share token.

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

    the optional parameters

Options Hash (opts):

  • :password (String) —

    Optional viewer password.

Returns:

  • (Hash<String, Object>) 


939
940
941
942
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 939

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

#get_public_presentation_with_http_info(token, opts = {}) ⇒ Array<(Hash<String, Object>, Integer, Hash)>

Fetch a publicly shared presentation. Unauthenticated. Mirror of &#x60;GET /public/notes/token&#x60;. The share token is the credential. For password-protected decks the password is supplied via &#x60;?password&#x3D;&#x60;; the response distinguishes &quot;no password supplied&quot; from &quot;wrong password&quot; so the viewer can render the right prompt. Unknown tokens and disabled-share decks both return &#x60;404&#x60; to prevent enumeration.

Parameters:

  • token (String) —

    Opaque public-share token.

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

    the optional parameters

Options Hash (opts):

  • :password (String) —

    Optional viewer password.

Returns:

  • (Array<(Hash<String, Object>, Integer, Hash)>) —

    Hash<String, Object> data, response status code and response headers



950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 950

def get_public_presentation_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_public_presentation ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling SlidesApi.get_public_presentation"
  end
  # resource path
  local_var_path = '/public/slides/{token}'.sub('{token}', CGI.escape(token.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'password'] = opts[:'password'] if !opts[:'password'].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] || 'Hash<String, Object>'

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

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

#get_slide(id, slide_id, opts = {}) ⇒ Slide

Fetch one slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1006
1007
1008
1009
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1006

def get_slide(id, slide_id, opts = {})
  data, _status_code, _headers = get_slide_with_http_info(id, slide_id, opts)
  data
end

#get_slide_element(id, slide_id, element_id, opts = {}) ⇒ SlideElement

Fetch one slide element.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1080
1081
1082
1083
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1080

def get_slide_element(id, slide_id, element_id, opts = {})
  data, _status_code, _headers = get_slide_element_with_http_info(id, slide_id, element_id, opts)
  data
end

#get_slide_element_with_http_info(id, slide_id, element_id, opts = {}) ⇒ Array<(SlideElement, Integer, Hash)>

Fetch one slide element.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SlideElement data, response status code and response headers



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1093

def get_slide_element_with_http_info(id, slide_id, element_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide_element ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.get_slide_element"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.get_slide_element"
  end
  # verify the required parameter 'element_id' is set
  if @api_client.config.client_side_validation && element_id.nil?
    fail ArgumentError, "Missing the required parameter 'element_id' when calling SlidesApi.get_slide_element"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}/elements/{elementId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s)).sub('{elementId}', CGI.escape(element_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#get_slide_with_http_info(id, slide_id, opts = {}) ⇒ Array<(Slide, Integer, Hash)>

Fetch one slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Slide data, response status code and response headers



1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1018

def get_slide_with_http_info(id, slide_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.get_slide ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.get_slide"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.get_slide"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#list_presentations(opts = {}) ⇒ PresentationListEnvelope

List presentations across connected accounts. Fan-out list. Returns every presentation visible to the caller across every connected slides provider. Pass ‘?accountId=` or `?provider=` to scope to a single source.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :provider (String) —

    Provider id (e.g. &#x60;native-notes&#x60;, &#x60;notion&#x60;). Selects every connected account for the provider. Mutually exclusive with &#x60;accountId&#x60;.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :limit (Integer) — default: default to 50
  • :offset (Integer) — default: default to 0

Returns:



1160
1161
1162
1163
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1160

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

#list_presentations_with_http_info(opts = {}) ⇒ Array<(PresentationListEnvelope, Integer, Hash)>

List presentations across connected accounts. Fan-out list. Returns every presentation visible to the caller across every connected slides provider. Pass &#x60;?accountId&#x3D;&#x60; or &#x60;?provider&#x3D;&#x60; to scope to a single source.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :provider (String) —

    Provider id (e.g. &#x60;native-notes&#x60;, &#x60;notion&#x60;). Selects every connected account for the provider. Mutually exclusive with &#x60;accountId&#x60;.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

  • :limit (Integer) — default: default to 50
  • :offset (Integer) — default: default to 0

Returns:

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

    PresentationListEnvelope data, response status code and response headers



1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1174

def list_presentations_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.list_presentations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SlidesApi.list_presentations, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling SlidesApi.list_presentations, must be greater than or equal to 0.'
  end

  # resource path
  local_var_path = '/v1/slides'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].nil?
  query_params[:'provider'] = opts[:'provider'] if !opts[:'provider'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#list_slide_elements(id, slide_id, opts = {}) ⇒ SlideElementList

List the canvas elements on a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1238
1239
1240
1241
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1238

def list_slide_elements(id, slide_id, opts = {})
  data, _status_code, _headers = list_slide_elements_with_http_info(id, slide_id, opts)
  data
end

#list_slide_elements_with_http_info(id, slide_id, opts = {}) ⇒ Array<(SlideElementList, Integer, Hash)>

List the canvas elements on a slide.

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SlideElementList data, response status code and response headers



1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1250

def list_slide_elements_with_http_info(id, slide_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.list_slide_elements ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.list_slide_elements"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.list_slide_elements"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}/elements'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#list_slides_in_presentation(id, opts = {}) ⇒ SlideList

List slides in a presentation. Single-account list. Returns slides in the order set by their ‘position` field.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1311
1312
1313
1314
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1311

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

#list_slides_in_presentation_with_http_info(id, opts = {}) ⇒ Array<(SlideList, Integer, Hash)>

List slides in a presentation. Single-account list. Returns slides in the order set by their &#x60;position&#x60; field.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SlideList data, response status code and response headers



1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1323

def list_slides_in_presentation_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.list_slides_in_presentation ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.list_slides_in_presentation"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#rotate_presentation_share_token(id, opts = {}) ⇒ ShareSettings

Rotate the share token, invalidating outstanding URLs.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1379
1380
1381
1382
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1379

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

#rotate_presentation_share_token_with_http_info(id, opts = {}) ⇒ Array<(ShareSettings, Integer, Hash)>

Rotate the share token, invalidating outstanding URLs.

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    ShareSettings data, response status code and response headers



1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1390

def rotate_presentation_share_token_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.rotate_presentation_share_token ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.rotate_presentation_share_token"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/share/rotate'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

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

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

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

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

#update_presentation(id, update_presentation_request, opts = {}) ⇒ Presentation

Update presentation metadata (partial).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1447
1448
1449
1450
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1447

def update_presentation(id, update_presentation_request, opts = {})
  data, _status_code, _headers = update_presentation_with_http_info(id, update_presentation_request, opts)
  data
end

#update_presentation_with_http_info(id, update_presentation_request, opts = {}) ⇒ Array<(Presentation, Integer, Hash)>

Update presentation metadata (partial).

Parameters:

  • id (String) —

    Presentation id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Presentation data, response status code and response headers



1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1459

def update_presentation_with_http_info(id, update_presentation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_presentation ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.update_presentation"
  end
  # verify the required parameter 'update_presentation_request' is set
  if @api_client.config.client_side_validation && update_presentation_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_presentation_request' when calling SlidesApi.update_presentation"
  end
  # resource path
  local_var_path = '/v1/slides/{id}'.sub('{id}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_presentation_request)

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

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

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

#update_slide(id, slide_id, update_slide_request, opts = {}) ⇒ Slide

Update a slide (partial).

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1526
1527
1528
1529
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1526

def update_slide(id, slide_id, update_slide_request, opts = {})
  data, _status_code, _headers = update_slide_with_http_info(id, slide_id, update_slide_request, opts)
  data
end

#update_slide_element(id, slide_id, element_id, update_slide_element_request, opts = {}) ⇒ SlideElement

Update a slide element (partial).

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:



1611
1612
1613
1614
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1611

def update_slide_element(id, slide_id, element_id, update_slide_element_request, opts = {})
  data, _status_code, _headers = update_slide_element_with_http_info(id, slide_id, element_id, update_slide_element_request, opts)
  data
end

#update_slide_element_with_http_info(id, slide_id, element_id, update_slide_element_request, opts = {}) ⇒ Array<(SlideElement, Integer, Hash)>

Update a slide element (partial).

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

  • element_id (String) —

    Slide-element id.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    SlideElement data, response status code and response headers



1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1625

def update_slide_element_with_http_info(id, slide_id, element_id, update_slide_element_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_slide_element ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.update_slide_element"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.update_slide_element"
  end
  # verify the required parameter 'element_id' is set
  if @api_client.config.client_side_validation && element_id.nil?
    fail ArgumentError, "Missing the required parameter 'element_id' when calling SlidesApi.update_slide_element"
  end
  # verify the required parameter 'update_slide_element_request' is set
  if @api_client.config.client_side_validation && update_slide_element_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_slide_element_request' when calling SlidesApi.update_slide_element"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}/elements/{elementId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s)).sub('{elementId}', CGI.escape(element_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_slide_element_request)

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

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

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

#update_slide_with_http_info(id, slide_id, update_slide_request, opts = {}) ⇒ Array<(Slide, Integer, Hash)>

Update a slide (partial).

Parameters:

  • id (String) —

    Presentation id.

  • slide_id (String) —

    Slide id within the presentation.

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

    the optional parameters

Options Hash (opts):

  • :account_id (String) —

    Connected-account row id. Selects which provider account this request targets when more than one is connected. Mutually exclusive with &#x60;provider&#x60;. If omitted on a list endpoint the call fans out across every connected account.

  • :x_workspace_id (String) —

    Workspace scope for unscoped tokens. Workspace-scoped PATs and OAuth tokens carry this implicitly; for session/JWT auth without a scoped PAT, pass it explicitly.

Returns:

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

    Slide data, response status code and response headers



1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/spatio-sdk/api/slides_api.rb', line 1539

def update_slide_with_http_info(id, slide_id, update_slide_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SlidesApi.update_slide ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling SlidesApi.update_slide"
  end
  # verify the required parameter 'slide_id' is set
  if @api_client.config.client_side_validation && slide_id.nil?
    fail ArgumentError, "Missing the required parameter 'slide_id' when calling SlidesApi.update_slide"
  end
  # verify the required parameter 'update_slide_request' is set
  if @api_client.config.client_side_validation && update_slide_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_slide_request' when calling SlidesApi.update_slide"
  end
  # resource path
  local_var_path = '/v1/slides/{id}/slides/{slideId}'.sub('{id}', CGI.escape(id.to_s)).sub('{slideId}', CGI.escape(slide_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'accountId'] = opts[:'account_id'] if !opts[:'account_id'].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']
  # 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
  header_params[:'X-Workspace-ID'] = opts[:'x_workspace_id'] if !opts[:'x_workspace_id'].nil?

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

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(update_slide_request)

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

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

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