Class: DyspatchClient::DraftsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/dyspatch_client/api/drafts_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DraftsApi

Returns a new instance of DraftsApi.



19
20
21
 
# File 'lib/dyspatch_client/api/drafts_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/dyspatch_client/api/drafts_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#drafts_draft_id_get(draft_id, target_language, opts = {}) ⇒ DraftRead

Get Draft by ID Gets a draft object with the matching ID. The “compiled” field will contain the unlocalized default template object.

Parameters:

  • draft_id —

    A draft ID

  • target_language —

    The type of templating language to compile as. Should only be used for visual templates.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 28

def drafts_draft_id_get(draft_id, target_language, opts = {})
  data, _status_code, _headers = drafts_draft_id_get_with_http_info(draft_id, target_language, opts)
  data
end

#drafts_draft_id_get_with_http_info(draft_id, target_language, opts = {}) ⇒ Array<(DraftRead, Fixnum, Hash)>

Get Draft by ID Gets a draft object with the matching ID. The “compiled” field will contain the unlocalized default template object.

Parameters:

  • draft_id —

    A draft ID

  • target_language —

    The type of templating language to compile as. Should only be used for visual templates.

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

    the optional parameters

Returns:

  • (Array<(DraftRead, Fixnum, Hash)>) —

    DraftRead data, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 39

def drafts_draft_id_get_with_http_info(draft_id, target_language, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_get ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_get"
  end
  # verify the required parameter 'target_language' is set
  if @api_client.config.client_side_validation && target_language.nil?
    fail ArgumentError, "Missing the required parameter 'target_language' when calling DraftsApi.drafts_draft_id_get"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['html', 'jinja', 'handlebars', 'ampscript', 'freemarker', 'cheetah'].include?(target_language)
    fail ArgumentError, "invalid value for 'target_language', must be one of html, jinja, handlebars, ampscript, freemarker, cheetah"
  end
  # resource path
  local_var_path = '/drafts/{draftId}'.sub('{' + 'draftId' + '}', draft_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'targetLanguage'] = target_language

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DraftRead')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_localization_keys_get(draft_id, opts = {}) ⇒ Array<LocalizationKeyRead>

Get Localization Keys Returns the list of values that need to be translated for the draft. Set the Accept header to ‘application/vnd.dyspatch.2019.10+json` to get a JSON object, or `text/vnd.dyspatch.2019.10+x-gettext-translation` to get the POT file.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    A version of the API that should be used for the request. For example, to use version “2019.10”, set the value to “application/vnd.dyspatch.2019.10+json”.

Returns:



91
92
93
94
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 91

def drafts_draft_id_localization_keys_get(draft_id, opts = {})
  data, _status_code, _headers = drafts_draft_id_localization_keys_get_with_http_info(draft_id, opts)
  data
end

#drafts_draft_id_localization_keys_get_with_http_info(draft_id, opts = {}) ⇒ Array<(Array<LocalizationKeyRead>, Fixnum, Hash)>

Get Localization Keys Returns the list of values that need to be translated for the draft. Set the Accept header to ‘application/vnd.dyspatch.2019.10+json` to get a JSON object, or `text/vnd.dyspatch.2019.10+x-gettext-translation` to get the POT file.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Options Hash (opts):

  • :accept (String) —

    A version of the API that should be used for the request. For example, to use version “2019.10”, set the value to “application/vnd.dyspatch.2019.10+json”.

Returns:

  • (Array<(Array<LocalizationKeyRead>, Fixnum, Hash)>) —

    Array<LocalizationKeyRead> data, response status code and response headers



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 102

def drafts_draft_id_localization_keys_get_with_http_info(draft_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_localization_keys_get ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_localization_keys_get"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/localizationKeys'.sub('{' + 'draftId' + '}', draft_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json', 'text/vnd.dyspatch.2019.10+x-gettext-translation'])
  header_params[:'Accept'] = opts[:'accept'] if !opts[:'accept'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<LocalizationKeyRead>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_localization_keys_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_localizations_get(draft_id, opts = {}) ⇒ Array<LocalizationMetaRead>

Get Localizations on a Draft Returns localization metadata object for a template draft.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 145

def drafts_draft_id_localizations_get(draft_id, opts = {})
  data, _status_code, _headers = drafts_draft_id_localizations_get_with_http_info(draft_id, opts)
  data
end

#drafts_draft_id_localizations_get_with_http_info(draft_id, opts = {}) ⇒ Array<(Array<LocalizationMetaRead>, Fixnum, Hash)>

Get Localizations on a Draft Returns localization metadata object for a template draft.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Returns:

  • (Array<(Array<LocalizationMetaRead>, Fixnum, Hash)>) —

    Array<LocalizationMetaRead> data, response status code and response headers



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 155

def drafts_draft_id_localizations_get_with_http_info(draft_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_localizations_get ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_localizations_get"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/localizations'.sub('{' + 'draftId' + '}', draft_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<LocalizationMetaRead>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_localizations_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_localizations_language_id_delete(draft_id, language_id, opts = {}) ⇒ nil

Remove a Localization Deletes the localization with the given languageId if it exists.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

  • (nil) 


198
199
200
201
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 198

def drafts_draft_id_localizations_language_id_delete(draft_id, language_id, opts = {})
  drafts_draft_id_localizations_language_id_delete_with_http_info(draft_id, language_id, opts)
  nil
end

#drafts_draft_id_localizations_language_id_delete_with_http_info(draft_id, language_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Remove a Localization Deletes the localization with the given languageId if it exists.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 209

def drafts_draft_id_localizations_language_id_delete_with_http_info(draft_id, language_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_localizations_language_id_delete ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_delete"
  end
  # verify the required parameter 'language_id' is set
  if @api_client.config.client_side_validation && language_id.nil?
    fail ArgumentError, "Missing the required parameter 'language_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_delete"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/localizations/{languageId}'.sub('{' + 'draftId' + '}', draft_id.to_s).sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_localizations_language_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_localizations_language_id_put(draft_id, language_id, body, opts = {}) ⇒ nil

Create or Update a Localization Inserts a localization or sets the name on an existing localization that already uses the languageId.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

  • (nil) 


256
257
258
259
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 256

def drafts_draft_id_localizations_language_id_put(draft_id, language_id, body, opts = {})
  drafts_draft_id_localizations_language_id_put_with_http_info(draft_id, language_id, body, opts)
  nil
end

#drafts_draft_id_localizations_language_id_put_with_http_info(draft_id, language_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create or Update a Localization Inserts a localization or sets the name on an existing localization that already uses the languageId.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 268

def drafts_draft_id_localizations_language_id_put_with_http_info(draft_id, language_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_localizations_language_id_put ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_put"
  end
  # verify the required parameter 'language_id' is set
  if @api_client.config.client_side_validation && language_id.nil?
    fail ArgumentError, "Missing the required parameter 'language_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DraftsApi.drafts_draft_id_localizations_language_id_put"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/localizations/{languageId}'.sub('{' + 'draftId' + '}', draft_id.to_s).sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_localizations_language_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_localizations_language_id_translations_put(draft_id, language_id, body, opts = {}) ⇒ nil

Set Translations for Language Completely replaces any existing translations for the given language with those provided in request body. Variables embedded in keys or values are expected to be in the format ‘%(my_variable)s` and will automatically convert to the correct Dyspatch format depending on the type of template. Accepts key/value pairs in JSON format or in gettext PO file format. For JSON set Content-Type header to application/json. For gettext PO format set Content-Type header to text/x-gettext-translation.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

  • (nil) 


319
320
321
322
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 319

def drafts_draft_id_localizations_language_id_translations_put(draft_id, language_id, body, opts = {})
  drafts_draft_id_localizations_language_id_translations_put_with_http_info(draft_id, language_id, body, opts)
  nil
end

#drafts_draft_id_localizations_language_id_translations_put_with_http_info(draft_id, language_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Set Translations for Language Completely replaces any existing translations for the given language with those provided in request body. Variables embedded in keys or values are expected to be in the format ‘%(my_variable)s` and will automatically convert to the correct Dyspatch format depending on the type of template. Accepts key/value pairs in JSON format or in gettext PO file format. For JSON set Content-Type header to application/json. For gettext PO format set Content-Type header to text/x-gettext-translation.

Parameters:

  • draft_id —

    A draft ID

  • language_id —

    A language ID (eg: en-US)

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 331

def drafts_draft_id_localizations_language_id_translations_put_with_http_info(draft_id, language_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_localizations_language_id_translations_put ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_translations_put"
  end
  # verify the required parameter 'language_id' is set
  if @api_client.config.client_side_validation && language_id.nil?
    fail ArgumentError, "Missing the required parameter 'language_id' when calling DraftsApi.drafts_draft_id_localizations_language_id_translations_put"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling DraftsApi.drafts_draft_id_localizations_language_id_translations_put"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/localizations/{languageId}/translations'.sub('{' + 'draftId' + '}', draft_id.to_s).sub('{' + 'languageId' + '}', language_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_localizations_language_id_translations_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_draft_id_publish_request_post(draft_id, opts = {}) ⇒ nil

Submit the Draft for Approval Moves the draft into [submitted and locked state](docs.dyspatch.io/templates/submitting_a_template/#awaiting-approval). This will allow your email stakeholders to review the template draft and provide feedback.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Returns:

  • (nil) 


380
381
382
383
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 380

def drafts_draft_id_publish_request_post(draft_id, opts = {})
  drafts_draft_id_publish_request_post_with_http_info(draft_id, opts)
  nil
end

#drafts_draft_id_publish_request_post_with_http_info(draft_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Submit the Draft for Approval Moves the draft into [submitted and locked state](docs.dyspatch.io/templates/submitting_a_template/#awaiting-approval). This will allow your email stakeholders to review the template draft and provide feedback.

Parameters:

  • draft_id —

    A draft ID

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 390

def drafts_draft_id_publish_request_post_with_http_info(draft_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_draft_id_publish_request_post ...'
  end
  # verify the required parameter 'draft_id' is set
  if @api_client.config.client_side_validation && draft_id.nil?
    fail ArgumentError, "Missing the required parameter 'draft_id' when calling DraftsApi.drafts_draft_id_publish_request_post"
  end
  # resource path
  local_var_path = '/drafts/{draftId}/publishRequest'.sub('{' + 'draftId' + '}', draft_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_draft_id_publish_request_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#drafts_get(opts = {}) ⇒ DraftsRead

List Drafts Gets a list of all drafts for your oranization. Up to 25 results returned before results are paginated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    A cursor value used to retrieve a specific page from a paginated result set.

  • :status (String) —

    Filter the list of drafts by a particular status

Returns:



432
433
434
435
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 432

def drafts_get(opts = {})
  data, _status_code, _headers = drafts_get_with_http_info(opts)
  data
end

#drafts_get_with_http_info(opts = {}) ⇒ Array<(DraftsRead, Fixnum, Hash)>

List Drafts Gets a list of all drafts for your oranization. Up to 25 results returned before results are paginated.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String) —

    A cursor value used to retrieve a specific page from a paginated result set.

  • :status (String) —

    Filter the list of drafts by a particular status

Returns:

  • (Array<(DraftsRead, Fixnum, Hash)>) —

    DraftsRead data, response status code and response headers



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
479
480
 
# File 'lib/dyspatch_client/api/drafts_api.rb', line 443

def drafts_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: DraftsApi.drafts_get ...'
  end
  if @api_client.config.client_side_validation && opts[:'status'] && !['awaitingTranslation'].include?(opts[:'status'])
    fail ArgumentError, 'invalid value for "status", must be one of awaitingTranslation'
  end
  # resource path
  local_var_path = '/drafts'

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

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2019.10+json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['Bearer']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'DraftsRead')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DraftsApi#drafts_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end