api-sdk-rb 1.11.66

data/lib/api-sdk-rb/api/canvases_api.rb

@@ -0,0 +1,390 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'cgi'
+
+module ApiSdkRb
+  class CanvasesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Canvas
+    # Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user's canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session's managed user. 
+    # @param create_canvas_request [CreateCanvasRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CanvasResponse]
+    def create_canvas_0(create_canvas_request, opts = {})
+      data, _status_code, _headers = create_canvas_0_with_http_info(create_canvas_request, opts)
+      data
+    end
+
+    # Create Canvas
+    # Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user's canvases with `getAllCanvases`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards. Called with an editor session, the canvas is always made for the session's managed user. 
+    # @param create_canvas_request [CreateCanvasRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CanvasResponse, Integer, Hash)>] CanvasResponse data, response status code and response headers
+    def create_canvas_0_with_http_info(create_canvas_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CanvasesApi.create_canvas_0 ...'
+      end
+      # verify the required parameter 'create_canvas_request' is set
+      if @api_client.config.client_side_validation && create_canvas_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_canvas_request' when calling CanvasesApi.create_canvas_0"
+      end
+      # resource path
+      local_var_path = '/canvases'
+
+      # 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(create_canvas_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CanvasResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CanvasesApi.create_canvas_0",
+        :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: CanvasesApi#create_canvas_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete Canvas
+    # Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session's managed user can be deleted; one that also holds somebody else's widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key. 
+    # @param id [String] ID of the canvas
+    # @param [Hash] opts the optional parameters
+    # @return [CanvasResponse]
+    def delete_canvas_0(id, opts = {})
+      data, _status_code, _headers = delete_canvas_0_with_http_info(id, opts)
+      data
+    end
+
+    # Delete Canvas
+    # Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session&#39;s managed user can be deleted; one that also holds somebody else&#39;s widgets is refused with 409 and &#x60;CANVAS_HAS_OTHER_WIDGETS&#x60;, and nothing is deleted. Delete such a canvas with your API key. 
+    # @param id [String] ID of the canvas
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CanvasResponse, Integer, Hash)>] CanvasResponse data, response status code and response headers
+    def delete_canvas_0_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CanvasesApi.delete_canvas_0 ...'
+      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 CanvasesApi.delete_canvas_0"
+      end
+      # resource path
+      local_var_path = '/canvases/{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] || 'CanvasResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CanvasesApi.delete_canvas_0",
+        :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: CanvasesApi#delete_canvas_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get All Canvases
+    # Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic's id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session's managed user's. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Integer] :size Number of items per page (default to 20)
+    # @option opts [String] :sort Sort field and direction (e.g., \&quot;created_at:desc\&quot;) (default to 'created_at:desc')
+    # @option opts [Time] :created_after Filter canvases created after the specified date (ISO 8601 format)
+    # @option opts [Time] :created_before Filter canvases created before the specified date (ISO 8601 format)
+    # @option opts [Time] :updated_after Filter canvases updated after the specified date (ISO 8601 format)
+    # @option opts [Time] :updated_before Filter canvases updated before the specified date (ISO 8601 format)
+    # @option opts [String] :managed_user_id List only the canvases made for this managed user (Widgetic&#39;s id for the user). Send this or &#x60;managedUserExternalId&#x60;, not both.
+    # @option opts [String] :managed_user_external_id List only the canvases made for the managed user you registered with this &#x60;externalId&#x60; (your own identifier for the user). Send this or &#x60;managedUserId&#x60;, not both.
+    # @return [GetAllCanvasesResponse]
+    def get_all_canvases_0(opts = {})
+      data, _status_code, _headers = get_all_canvases_0_with_http_info(opts)
+      data
+    end
+
+    # Get All Canvases
+    # Retrieves all canvases with pagination support and filtering options.  Pass &#x60;managedUserId&#x60; (Widgetic&#39;s id for one of your managed users) or &#x60;managedUserExternalId&#x60; (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and &#x60;MANAGED_USER_NOT_FOUND&#x60;. Called with an editor session, the list is always the session&#39;s managed user&#39;s. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page number for pagination (default to 1)
+    # @option opts [Integer] :size Number of items per page (default to 20)
+    # @option opts [String] :sort Sort field and direction (e.g., \&quot;created_at:desc\&quot;) (default to 'created_at:desc')
+    # @option opts [Time] :created_after Filter canvases created after the specified date (ISO 8601 format)
+    # @option opts [Time] :created_before Filter canvases created before the specified date (ISO 8601 format)
+    # @option opts [Time] :updated_after Filter canvases updated after the specified date (ISO 8601 format)
+    # @option opts [Time] :updated_before Filter canvases updated before the specified date (ISO 8601 format)
+    # @option opts [String] :managed_user_id List only the canvases made for this managed user (Widgetic&#39;s id for the user). Send this or &#x60;managedUserExternalId&#x60;, not both.
+    # @option opts [String] :managed_user_external_id List only the canvases made for the managed user you registered with this &#x60;externalId&#x60; (your own identifier for the user). Send this or &#x60;managedUserId&#x60;, not both.
+    # @return [Array<(GetAllCanvasesResponse, Integer, Hash)>] GetAllCanvasesResponse data, response status code and response headers
+    def get_all_canvases_0_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CanvasesApi.get_all_canvases_0 ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CanvasesApi.get_all_canvases_0, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CanvasesApi.get_all_canvases_0, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"size"]" when calling CanvasesApi.get_all_canvases_0, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'managed_user_external_id'].nil? && opts[:'managed_user_external_id'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"managed_user_external_id"]" when calling CanvasesApi.get_all_canvases_0, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/canvases'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'createdAfter'] = opts[:'created_after'] if !opts[:'created_after'].nil?
+      query_params[:'createdBefore'] = opts[:'created_before'] if !opts[:'created_before'].nil?
+      query_params[:'updatedAfter'] = opts[:'updated_after'] if !opts[:'updated_after'].nil?
+      query_params[:'updatedBefore'] = opts[:'updated_before'] if !opts[:'updated_before'].nil?
+      query_params[:'managedUserId'] = opts[:'managed_user_id'] if !opts[:'managed_user_id'].nil?
+      query_params[:'managedUserExternalId'] = opts[:'managed_user_external_id'] if !opts[:'managed_user_external_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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetAllCanvasesResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CanvasesApi.get_all_canvases_0",
+        :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: CanvasesApi#get_all_canvases_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Canvas
+    # Retrieves a specific canvas by ID.
+    # @param id [String] ID of the canvas
+    # @param [Hash] opts the optional parameters
+    # @return [CanvasResponse]
+    def get_canvas_0(id, opts = {})
+      data, _status_code, _headers = get_canvas_0_with_http_info(id, opts)
+      data
+    end
+
+    # Get Canvas
+    # Retrieves a specific canvas by ID.
+    # @param id [String] ID of the canvas
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CanvasResponse, Integer, Hash)>] CanvasResponse data, response status code and response headers
+    def get_canvas_0_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CanvasesApi.get_canvas_0 ...'
+      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 CanvasesApi.get_canvas_0"
+      end
+      # resource path
+      local_var_path = '/canvases/{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] || 'CanvasResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CanvasesApi.get_canvas_0",
+        :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: CanvasesApi#get_canvas_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Canvas
+    # Updates an existing canvas with the specified properties.
+    # @param id [String] ID of the canvas to update
+    # @param update_canvas_request [UpdateCanvasRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CanvasResponse]
+    def update_canvas_0(id, update_canvas_request, opts = {})
+      data, _status_code, _headers = update_canvas_0_with_http_info(id, update_canvas_request, opts)
+      data
+    end
+
+    # Update Canvas
+    # Updates an existing canvas with the specified properties.
+    # @param id [String] ID of the canvas to update
+    # @param update_canvas_request [UpdateCanvasRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CanvasResponse, Integer, Hash)>] CanvasResponse data, response status code and response headers
+    def update_canvas_0_with_http_info(id, update_canvas_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CanvasesApi.update_canvas_0 ...'
+      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 CanvasesApi.update_canvas_0"
+      end
+      # verify the required parameter 'update_canvas_request' is set
+      if @api_client.config.client_side_validation && update_canvas_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_canvas_request' when calling CanvasesApi.update_canvas_0"
+      end
+      # resource path
+      local_var_path = '/canvases/{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(update_canvas_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CanvasResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"CanvasesApi.update_canvas_0",
+        :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: CanvasesApi#update_canvas_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end