class DyspatchClient::LocalizationsApi
Attributes
Public Class Methods
# File lib/dyspatch_client/api/localizations_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Draft Localization Object by ID Returns a specific localization object of the matching draft with a matching localization ID @param draft_id [String] A draft ID @param localization_id [String] A localization ID @param target_language [String] The type of templating language to compile as. Should only be used for visual templates. @param accept [String] A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" @param [Hash] opts the optional parameters @return [LocalizationRead]
# File lib/dyspatch_client/api/localizations_api.rb, line 30 def get_draft_localization_by_id(draft_id, localization_id, target_language, accept, opts = {}) data, _status_code, _headers = get_draft_localization_by_id_with_http_info(draft_id, localization_id, target_language, accept, opts) data end
Get Draft Localization Object by ID Returns a specific localization object of the matching draft with a matching localization ID @param draft_id [String] A draft ID @param localization_id [String] A localization ID @param target_language [String] The type of templating language to compile as. Should only be used for visual templates. @param accept [String] A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" @param [Hash] opts the optional parameters @return [Array<(LocalizationRead
, Integer, Hash)>] LocalizationRead
data, response status code and response headers
# File lib/dyspatch_client/api/localizations_api.rb, line 43 def get_draft_localization_by_id_with_http_info(draft_id, localization_id, target_language, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalizationsApi.get_draft_localization_by_id ...' 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 LocalizationsApi.get_draft_localization_by_id" end # verify the required parameter 'localization_id' is set if @api_client.config.client_side_validation && localization_id.nil? fail ArgumentError, "Missing the required parameter 'localization_id' when calling LocalizationsApi.get_draft_localization_by_id" 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 LocalizationsApi.get_draft_localization_by_id" end # verify enum value allowable_values = ["html", "handlebars", "ampscript", "freemarker", "cheetah", "jinja", "liquid"] if @api_client.config.client_side_validation && !allowable_values.include?(target_language) fail ArgumentError, "invalid value for \"target_language\", must be one of #{allowable_values}" end # verify the required parameter 'accept' is set if @api_client.config.client_side_validation && accept.nil? fail ArgumentError, "Missing the required parameter 'accept' when calling LocalizationsApi.get_draft_localization_by_id" end # resource path local_var_path = '/localizations/{localizationId}/drafts/{draftId}'.sub('{' + 'draftId' + '}', CGI.escape(draft_id.to_s)).sub('{' + 'localizationId' + '}', CGI.escape(localization_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'targetLanguage'] = target_language # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2020.11+json', '*/*']) header_params[:'Accept'] = accept # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'LocalizationRead' # auth_names auth_names = opts[:auth_names] || ['Bearer'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalizationsApi#get_draft_localization_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Localization Object by ID Returns the published content associated with the localization of the matching ID @param localization_id [String] A localization ID @param target_language [String] The type of templating language to compile as. Should only be used for visual templates. @param accept [String] A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" @param [Hash] opts the optional parameters @return [LocalizationRead]
# File lib/dyspatch_client/api/localizations_api.rb, line 116 def get_published_localization_by_id(localization_id, target_language, accept, opts = {}) data, _status_code, _headers = get_published_localization_by_id_with_http_info(localization_id, target_language, accept, opts) data end
Get Localization Object by ID Returns the published content associated with the localization of the matching ID @param localization_id [String] A localization ID @param target_language [String] The type of templating language to compile as. Should only be used for visual templates. @param accept [String] A version of the API that should be used for the request. For example, to use version "2020.11", set the value to "application/vnd.dyspatch.2020.11+json" @param [Hash] opts the optional parameters @return [Array<(LocalizationRead
, Integer, Hash)>] LocalizationRead
data, response status code and response headers
# File lib/dyspatch_client/api/localizations_api.rb, line 128 def get_published_localization_by_id_with_http_info(localization_id, target_language, accept, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: LocalizationsApi.get_published_localization_by_id ...' end # verify the required parameter 'localization_id' is set if @api_client.config.client_side_validation && localization_id.nil? fail ArgumentError, "Missing the required parameter 'localization_id' when calling LocalizationsApi.get_published_localization_by_id" 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 LocalizationsApi.get_published_localization_by_id" end # verify enum value allowable_values = ["html", "handlebars", "ampscript", "freemarker", "cheetah", "jinja", "liquid"] if @api_client.config.client_side_validation && !allowable_values.include?(target_language) fail ArgumentError, "invalid value for \"target_language\", must be one of #{allowable_values}" end # verify the required parameter 'accept' is set if @api_client.config.client_side_validation && accept.nil? fail ArgumentError, "Missing the required parameter 'accept' when calling LocalizationsApi.get_published_localization_by_id" end # resource path local_var_path = '/localizations/{localizationId}'.sub('{' + 'localizationId' + '}', CGI.escape(localization_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'targetLanguage'] = target_language # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/vnd.dyspatch.2020.11+json', '*/*']) header_params[:'Accept'] = accept # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'LocalizationRead' # auth_names auth_names = opts[:auth_names] || ['Bearer'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: LocalizationsApi#get_published_localization_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end