doorflow 1.0.0 → 1.1.0

data/lib/doorflow-api/api/card_templates_api.rb

@@ -0,0 +1,811 @@
+=begin
+#DoorFlow API
+
+#Access control and door management API for DoorFlow
+
+The version of the OpenAPI document: 3.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'cgi'
+
+module DoorFlow
+  class CardTemplatesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create card template
+    # Creates a new card template. The client should submit a locally generated uuid. The server preserves this and returns the server-assigned id. 
+    # @param card_template_input [CardTemplateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CardTemplate]
+    def create_card_template(card_template_input, opts = {})
+      data, _status_code, _headers = create_card_template_with_http_info(card_template_input, opts)
+      data
+    end
+
+    # Create card template
+    # Creates a new card template. The client should submit a locally generated uuid. The server preserves this and returns the server-assigned id. 
+    # @param card_template_input [CardTemplateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CardTemplate, Integer, Hash)>] CardTemplate data, response status code and response headers
+    def create_card_template_with_http_info(card_template_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.create_card_template ...'
+      end
+      # verify the required parameter 'card_template_input' is set
+      if @api_client.config.client_side_validation && card_template_input.nil?
+        fail ArgumentError, "Missing the required parameter 'card_template_input' when calling CardTemplatesApi.create_card_template"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(card_template_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CardTemplate'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.create_card_template",
+        :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: CardTemplatesApi#create_card_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete card template (hard-delete)
+    # Permanently deletes a card template and all associated template elements and background images. The record is removed from the database and cannot be restored. Permitted for any admin in the account.  For a recoverable delete, PATCH `deleted_at` instead. 
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_card_template(id, opts = {})
+      delete_card_template_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete card template (hard-delete)
+    # Permanently deletes a card template and all associated template elements and background images. The record is removed from the database and cannot be restored. Permitted for any admin in the account.  For a recoverable delete, PATCH &#x60;deleted_at&#x60; instead. 
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_card_template_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.delete_card_template ...'
+      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 CardTemplatesApi.delete_card_template"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.delete_card_template",
+        :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: CardTemplatesApi#delete_card_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete background image
+    # Removes the background image for the specified side.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_card_template_background_image(id, side, opts = {})
+      delete_card_template_background_image_with_http_info(id, side, opts)
+      nil
+    end
+
+    # Delete background image
+    # Removes the background image for the specified side.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_card_template_background_image_with_http_info(id, side, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.delete_card_template_background_image ...'
+      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 CardTemplatesApi.delete_card_template_background_image"
+      end
+      # verify the required parameter 'side' is set
+      if @api_client.config.client_side_validation && side.nil?
+        fail ArgumentError, "Missing the required parameter 'side' when calling CardTemplatesApi.delete_card_template_background_image"
+      end
+      # verify enum value
+      allowable_values = ["front", "back"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(side)
+        fail ArgumentError, "invalid value for \"side\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/background_image/{side}'.sub('{id}', CGI.escape(id.to_s)).sub('{side}', CGI.escape(side.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.delete_card_template_background_image",
+        :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: CardTemplatesApi#delete_card_template_background_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete linked file
+    # Removes a linked file from a card template.
+    # @param id [Integer] Card template ID
+    # @param file_uuid [String] UUID of the linked file
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_card_template_file(id, file_uuid, opts = {})
+      delete_card_template_file_with_http_info(id, file_uuid, opts)
+      nil
+    end
+
+    # Delete linked file
+    # Removes a linked file from a card template.
+    # @param id [Integer] Card template ID
+    # @param file_uuid [String] UUID of the linked file
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_card_template_file_with_http_info(id, file_uuid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.delete_card_template_file ...'
+      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 CardTemplatesApi.delete_card_template_file"
+      end
+      # verify the required parameter 'file_uuid' is set
+      if @api_client.config.client_side_validation && file_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'file_uuid' when calling CardTemplatesApi.delete_card_template_file"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/files/{file_uuid}'.sub('{id}', CGI.escape(id.to_s)).sub('{file_uuid}', CGI.escape(file_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.delete_card_template_file",
+        :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: CardTemplatesApi#delete_card_template_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get card template
+    # Returns a single card template by ID including all template elements.
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [CardTemplate]
+    def get_card_template(id, opts = {})
+      data, _status_code, _headers = get_card_template_with_http_info(id, opts)
+      data
+    end
+
+    # Get card template
+    # Returns a single card template by ID including all template elements.
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CardTemplate, Integer, Hash)>] CardTemplate data, response status code and response headers
+    def get_card_template_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.get_card_template ...'
+      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 CardTemplatesApi.get_card_template"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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] || 'CardTemplate'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.get_card_template",
+        :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: CardTemplatesApi#get_card_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get background image
+    # Returns the background image for the specified side. Redirects to the image URL.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_card_template_background_image(id, side, opts = {})
+      get_card_template_background_image_with_http_info(id, side, opts)
+      nil
+    end
+
+    # Get background image
+    # Returns the background image for the specified side. Redirects to the image URL.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_card_template_background_image_with_http_info(id, side, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.get_card_template_background_image ...'
+      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 CardTemplatesApi.get_card_template_background_image"
+      end
+      # verify the required parameter 'side' is set
+      if @api_client.config.client_side_validation && side.nil?
+        fail ArgumentError, "Missing the required parameter 'side' when calling CardTemplatesApi.get_card_template_background_image"
+      end
+      # verify enum value
+      allowable_values = ["front", "back"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(side)
+        fail ArgumentError, "invalid value for \"side\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/background_image/{side}'.sub('{id}', CGI.escape(id.to_s)).sub('{side}', CGI.escape(side.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.get_card_template_background_image",
+        :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: CardTemplatesApi#get_card_template_background_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List linked files
+    # Returns all files linked to a card template.
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<LinkedFile>]
+    def list_card_template_files(id, opts = {})
+      data, _status_code, _headers = list_card_template_files_with_http_info(id, opts)
+      data
+    end
+
+    # List linked files
+    # Returns all files linked to a card template.
+    # @param id [Integer] Card template ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<LinkedFile>, Integer, Hash)>] Array<LinkedFile> data, response status code and response headers
+    def list_card_template_files_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.list_card_template_files ...'
+      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 CardTemplatesApi.list_card_template_files"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/files'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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] || 'Array<LinkedFile>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.list_card_template_files",
+        :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: CardTemplatesApi#list_card_template_files\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List card templates
+    # Returns a paginated list of card templates for the authenticated account. Soft-deleted templates (deleted_at is not null) are excluded by default; pass include_deleted=true to include them. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Results per page (default to 50)
+    # @option opts [Time] :updated_since ISO 8601 timestamp. Returns only records updated after this time
+    # @option opts [Boolean] :include_deleted When true, soft-deleted templates are included in the response. Defaults to false.  (default to false)
+    # @return [Array<CardTemplate>]
+    def list_card_templates(opts = {})
+      data, _status_code, _headers = list_card_templates_with_http_info(opts)
+      data
+    end
+
+    # List card templates
+    # Returns a paginated list of card templates for the authenticated account. Soft-deleted templates (deleted_at is not null) are excluded by default; pass include_deleted&#x3D;true to include them. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number (default to 1)
+    # @option opts [Integer] :per_page Results per page (default to 50)
+    # @option opts [Time] :updated_since ISO 8601 timestamp. Returns only records updated after this time
+    # @option opts [Boolean] :include_deleted When true, soft-deleted templates are included in the response. Defaults to false.  (default to false)
+    # @return [Array<(Array<CardTemplate>, Integer, Hash)>] Array<CardTemplate> data, response status code and response headers
+    def list_card_templates_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.list_card_templates ...'
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'updated_since'] = opts[:'updated_since'] if !opts[:'updated_since'].nil?
+      query_params[:'include_deleted'] = opts[:'include_deleted'] if !opts[:'include_deleted'].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] || 'Array<CardTemplate>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.list_card_templates",
+        :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: CardTemplatesApi#list_card_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update card template
+    # Updates an existing card template. Submitting template_objects replaces the entire objects array.  Three special update modes are recognised: - **Soft-delete**: PATCH `deleted_at` to a non-null timestamp to   soft-delete (or null to restore). The server records `deleted_by_id`   from the authenticated user. Soft-delete is permitted for any admin   in the account, regardless of `editable_by` or `owner_id`. - **Owner transfer**: PATCH `owner_id` to reassign ownership. Permitted   for the current owner or any admin in the account. The new value must   be the ID of an admin in the same account. - **Content edits** (any other writable field): respect the existing   `editable_by` rule; if `editable_by` is `owner_only`, only the   current owner may edit. 
+    # @param id [Integer] Card template ID
+    # @param card_template_input [CardTemplateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [CardTemplate]
+    def update_card_template(id, card_template_input, opts = {})
+      data, _status_code, _headers = update_card_template_with_http_info(id, card_template_input, opts)
+      data
+    end
+
+    # Update card template
+    # Updates an existing card template. Submitting template_objects replaces the entire objects array.  Three special update modes are recognised: - **Soft-delete**: PATCH &#x60;deleted_at&#x60; to a non-null timestamp to   soft-delete (or null to restore). The server records &#x60;deleted_by_id&#x60;   from the authenticated user. Soft-delete is permitted for any admin   in the account, regardless of &#x60;editable_by&#x60; or &#x60;owner_id&#x60;. - **Owner transfer**: PATCH &#x60;owner_id&#x60; to reassign ownership. Permitted   for the current owner or any admin in the account. The new value must   be the ID of an admin in the same account. - **Content edits** (any other writable field): respect the existing   &#x60;editable_by&#x60; rule; if &#x60;editable_by&#x60; is &#x60;owner_only&#x60;, only the   current owner may edit. 
+    # @param id [Integer] Card template ID
+    # @param card_template_input [CardTemplateInput] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CardTemplate, Integer, Hash)>] CardTemplate data, response status code and response headers
+    def update_card_template_with_http_info(id, card_template_input, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.update_card_template ...'
+      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 CardTemplatesApi.update_card_template"
+      end
+      # verify the required parameter 'card_template_input' is set
+      if @api_client.config.client_side_validation && card_template_input.nil?
+        fail ArgumentError, "Missing the required parameter 'card_template_input' when calling CardTemplatesApi.update_card_template"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) 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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(card_template_input)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CardTemplate'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.update_card_template",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CardTemplatesApi#update_card_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload background image
+    # Uploads or replaces the background image for the specified side.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param body [File] 
+    # @param [Hash] opts the optional parameters
+    # @return [CardTemplate]
+    def update_card_template_background_image(id, side, body, opts = {})
+      data, _status_code, _headers = update_card_template_background_image_with_http_info(id, side, body, opts)
+      data
+    end
+
+    # Upload background image
+    # Uploads or replaces the background image for the specified side.
+    # @param id [Integer] Card template ID
+    # @param side [String] Which side of the card
+    # @param body [File] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CardTemplate, Integer, Hash)>] CardTemplate data, response status code and response headers
+    def update_card_template_background_image_with_http_info(id, side, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.update_card_template_background_image ...'
+      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 CardTemplatesApi.update_card_template_background_image"
+      end
+      # verify the required parameter 'side' is set
+      if @api_client.config.client_side_validation && side.nil?
+        fail ArgumentError, "Missing the required parameter 'side' when calling CardTemplatesApi.update_card_template_background_image"
+      end
+      # verify enum value
+      allowable_values = ["front", "back"]
+      if @api_client.config.client_side_validation && !allowable_values.include?(side)
+        fail ArgumentError, "invalid value for \"side\", must be one of #{allowable_values}"
+      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 CardTemplatesApi.update_card_template_background_image"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/background_image/{side}'.sub('{id}', CGI.escape(id.to_s)).sub('{side}', CGI.escape(side.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['image/png', 'image/jpeg'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CardTemplate'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.update_card_template_background_image",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CardTemplatesApi#update_card_template_background_image\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload or replace linked file
+    # Uploads or replaces a linked file for a card template. The file_role query parameter is required.
+    # @param id [Integer] Card template ID
+    # @param file_uuid [String] UUID of the linked file
+    # @param file_role [String] Role of the file (e.g. background_front, background_back, logo)
+    # @param body [File] 
+    # @param [Hash] opts the optional parameters
+    # @return [LinkedFile]
+    def upload_card_template_file(id, file_uuid, file_role, body, opts = {})
+      data, _status_code, _headers = upload_card_template_file_with_http_info(id, file_uuid, file_role, body, opts)
+      data
+    end
+
+    # Upload or replace linked file
+    # Uploads or replaces a linked file for a card template. The file_role query parameter is required.
+    # @param id [Integer] Card template ID
+    # @param file_uuid [String] UUID of the linked file
+    # @param file_role [String] Role of the file (e.g. background_front, background_back, logo)
+    # @param body [File] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(LinkedFile, Integer, Hash)>] LinkedFile data, response status code and response headers
+    def upload_card_template_file_with_http_info(id, file_uuid, file_role, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CardTemplatesApi.upload_card_template_file ...'
+      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 CardTemplatesApi.upload_card_template_file"
+      end
+      # verify the required parameter 'file_uuid' is set
+      if @api_client.config.client_side_validation && file_uuid.nil?
+        fail ArgumentError, "Missing the required parameter 'file_uuid' when calling CardTemplatesApi.upload_card_template_file"
+      end
+      # verify the required parameter 'file_role' is set
+      if @api_client.config.client_side_validation && file_role.nil?
+        fail ArgumentError, "Missing the required parameter 'file_role' when calling CardTemplatesApi.upload_card_template_file"
+      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 CardTemplatesApi.upload_card_template_file"
+      end
+      # resource path
+      local_var_path = '/api/3/card_templates/{id}/files/{file_uuid}'.sub('{id}', CGI.escape(id.to_s)).sub('{file_uuid}', CGI.escape(file_uuid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'file_role'] = file_role
+
+      # 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/octet-stream'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'LinkedFile'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"CardTemplatesApi.upload_card_template_file",
+        :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(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CardTemplatesApi#upload_card_template_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end