api-sdk-rb 1.11.66

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

@@ -0,0 +1,347 @@
+=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 WidgetsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a composition for a widget in one call
+    # After a managed user publishes a widget from the creator, call this with the widget id, the customer's managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition.  When the widget is already tagged with a managed user, you may omit `managedUserId`. When you send it, it must match that tag.  A widget that keeps what visitors send (a form, a vote, a rating) declares its tables in its own source (`src/lib/meta/database.json`); they are made for the composition here, in a schema of its own, as the widget was when it was last published. A widget that keeps nothing leaves the composition without tables. If the tables cannot be made just now, or the widget's file cannot be used, the composition is still created (`201`) and `meta.warnings` says why; the tables are made the next time the widget is generated.  The widget must be published. The `Idempotency-Key` header is required. 
+    # @param id [String] The widget id
+    # @param idempotency_key [String] Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
+    # @param create_composition_from_widget_request [CreateCompositionFromWidgetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateCompositionFromWidget201Response]
+    def create_composition_from_widget_0(id, idempotency_key, create_composition_from_widget_request, opts = {})
+      data, _status_code, _headers = create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request, opts)
+      data
+    end
+
+    # Create a composition for a widget in one call
+    # After a managed user publishes a widget from the creator, call this with the widget id, the customer's managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition.  When the widget is already tagged with a managed user, you may omit `managedUserId`. When you send it, it must match that tag.  A widget that keeps what visitors send (a form, a vote, a rating) declares its tables in its own source (`src/lib/meta/database.json`); they are made for the composition here, in a schema of its own, as the widget was when it was last published. A widget that keeps nothing leaves the composition without tables. If the tables cannot be made just now, or the widget's file cannot be used, the composition is still created (`201`) and `meta.warnings` says why; the tables are made the next time the widget is generated.  The widget must be published. The `Idempotency-Key` header is required. 
+    # @param id [String] The widget id
+    # @param idempotency_key [String] Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
+    # @param create_composition_from_widget_request [CreateCompositionFromWidgetRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateCompositionFromWidget201Response, Integer, Hash)>] CreateCompositionFromWidget201Response data, response status code and response headers
+    def create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WidgetsApi.create_composition_from_widget_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 WidgetsApi.create_composition_from_widget_0"
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling WidgetsApi.create_composition_from_widget_0"
+      end
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length > 50
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling WidgetsApi.create_composition_from_widget_0, the character length must be smaller than or equal to 50.'
+      end
+
+      if @api_client.config.client_side_validation && idempotency_key.to_s.length < 8
+        fail ArgumentError, 'invalid value for "idempotency_key" when calling WidgetsApi.create_composition_from_widget_0, the character length must be great than or equal to 8.'
+      end
+
+      pattern = Regexp.new(/^[a-zA-Z0-9_-]{8,50}$/)
+      if @api_client.config.client_side_validation && idempotency_key !~ pattern
+        fail ArgumentError, "invalid value for 'idempotency_key' when calling WidgetsApi.create_composition_from_widget_0, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'create_composition_from_widget_request' is set
+      if @api_client.config.client_side_validation && create_composition_from_widget_request.nil?
+        fail ArgumentError, "Missing the required parameter 'create_composition_from_widget_request' when calling WidgetsApi.create_composition_from_widget_0"
+      end
+      # resource path
+      local_var_path = '/widgets/{id}/composition'.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
+      header_params[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_composition_from_widget_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateCompositionFromWidget201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WidgetsApi.create_composition_from_widget_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: WidgetsApi#create_composition_from_widget_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create Widget
+    # Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name). It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with `getWidgets`. A widget is a draft until you say otherwise (`isDraft: false`).  If a step after the widget was saved does not go through, the widget is still created, and `data.warnings` says what did not. Read it before relying on the widget.  A widget can be placed on one of your canvases (`canvasId`), in a project you can edit (`projectId`) or in an organization where you may create widgets (`organizationId`). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not.  To make the widget for one of your managed users, send `managedUserId` or `managedUserExternalId`. The widget stays in your account and is yours to edit; the tag lets you list one user's widgets with `getWidgets`. 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.  This call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a `Retry-After`. A widget has no database of its own: what the visitors of a composition leave is kept in the tables of that composition, made when the composition is. The `Idempotency-Key` header is required; send the same key when you retry, so one widget is created, not two. 
+    # @param idempotency_key [String] A unique value (a UUID is fine) that makes a retry of this request safe.
+    # @param new_widget [NewWidget] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreateWidget201Response]
+    def create_widget_0(idempotency_key, new_widget, opts = {})
+      data, _status_code, _headers = create_widget_0_with_http_info(idempotency_key, new_widget, opts)
+      data
+    end
+
+    # Create Widget
+    # Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name). It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with &#x60;getWidgets&#x60;. A widget is a draft until you say otherwise (&#x60;isDraft: false&#x60;).  If a step after the widget was saved does not go through, the widget is still created, and &#x60;data.warnings&#x60; says what did not. Read it before relying on the widget.  A widget can be placed on one of your canvases (&#x60;canvasId&#x60;), in a project you can edit (&#x60;projectId&#x60;) or in an organization where you may create widgets (&#x60;organizationId&#x60;). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not.  To make the widget for one of your managed users, send &#x60;managedUserId&#x60; or &#x60;managedUserExternalId&#x60;. The widget stays in your account and is yours to edit; the tag lets you list one user&#39;s widgets with &#x60;getWidgets&#x60;. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and &#x60;MANAGED_USER_NOT_FOUND&#x60;, and one that is switched off with 409 and &#x60;MANAGED_USER_INACTIVE&#x60;. The tag is set here and does not change afterwards.  This call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a &#x60;Retry-After&#x60;. A widget has no database of its own: what the visitors of a composition leave is kept in the tables of that composition, made when the composition is. The &#x60;Idempotency-Key&#x60; header is required; send the same key when you retry, so one widget is created, not two. 
+    # @param idempotency_key [String] A unique value (a UUID is fine) that makes a retry of this request safe.
+    # @param new_widget [NewWidget] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreateWidget201Response, Integer, Hash)>] CreateWidget201Response data, response status code and response headers
+    def create_widget_0_with_http_info(idempotency_key, new_widget, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WidgetsApi.create_widget_0 ...'
+      end
+      # verify the required parameter 'idempotency_key' is set
+      if @api_client.config.client_side_validation && idempotency_key.nil?
+        fail ArgumentError, "Missing the required parameter 'idempotency_key' when calling WidgetsApi.create_widget_0"
+      end
+      # verify the required parameter 'new_widget' is set
+      if @api_client.config.client_side_validation && new_widget.nil?
+        fail ArgumentError, "Missing the required parameter 'new_widget' when calling WidgetsApi.create_widget_0"
+      end
+      # resource path
+      local_var_path = '/widgets'
+
+      # 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
+      header_params[:'Idempotency-Key'] = idempotency_key
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(new_widget)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreateWidget201Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WidgetsApi.create_widget_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: WidgetsApi#create_widget_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Widgets
+    # Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic's widgets.  Pass `page` (counting from 1) and `size` (1 to 100, 20 when left out) to read the list one page at a time. `meta` then carries `total`, `hasNextPage` and `hasPreviousPage`, so a client can walk the list to its end. A page past the end is an empty list. Without `page` and `size` the call returns the whole list in one response, which only suits an account with a few widgets.  Pass `canvasId` to list only the widgets on one of your canvases. That list is always returned whole, whatever `page` and `size` say.  Pass `managedUserId` (Widgetic's id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with `page`, `size` and `canvasId`. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page to return, counting from 1. Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on.
+    # @option opts [Integer] :size How many widgets a page holds (20 when &#x60;page&#x60; is given without it). Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on.
+    # @option opts [String] :canvas_id List only the widgets on this canvas. The list is returned whole.
+    # @option opts [String] :managed_user_id List only the widgets 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 widgets 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 [GetWidgets200Response]
+    def get_widgets_0(opts = {})
+      data, _status_code, _headers = get_widgets_0_with_http_info(opts)
+      data
+    end
+
+    # List Widgets
+    # Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic&#39;s widgets.  Pass &#x60;page&#x60; (counting from 1) and &#x60;size&#x60; (1 to 100, 20 when left out) to read the list one page at a time. &#x60;meta&#x60; then carries &#x60;total&#x60;, &#x60;hasNextPage&#x60; and &#x60;hasPreviousPage&#x60;, so a client can walk the list to its end. A page past the end is an empty list. Without &#x60;page&#x60; and &#x60;size&#x60; the call returns the whole list in one response, which only suits an account with a few widgets.  Pass &#x60;canvasId&#x60; to list only the widgets on one of your canvases. That list is always returned whole, whatever &#x60;page&#x60; and &#x60;size&#x60; say.  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 widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with &#x60;page&#x60;, &#x60;size&#x60; and &#x60;canvasId&#x60;. A managed user that is not yours, or does not exist, is answered with 404 and &#x60;MANAGED_USER_NOT_FOUND&#x60;. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page to return, counting from 1. Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on.
+    # @option opts [Integer] :size How many widgets a page holds (20 when &#x60;page&#x60; is given without it). Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on.
+    # @option opts [String] :canvas_id List only the widgets on this canvas. The list is returned whole.
+    # @option opts [String] :managed_user_id List only the widgets 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 widgets 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<(GetWidgets200Response, Integer, Hash)>] GetWidgets200Response data, response status code and response headers
+    def get_widgets_0_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WidgetsApi.get_widgets_0 ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling WidgetsApi.get_widgets_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 WidgetsApi.get_widgets_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 WidgetsApi.get_widgets_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 WidgetsApi.get_widgets_0, the character length must be smaller than or equal to 255.'
+      end
+
+      # resource path
+      local_var_path = '/widgets'
+
+      # 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[:'canvasId'] = opts[:'canvas_id'] if !opts[:'canvas_id'].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] || 'GetWidgets200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WidgetsApi.get_widgets_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: WidgetsApi#get_widgets_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Widgets Batch
+    # Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session's managed user are returned.
+    # @param get_widgets_batch_request [GetWidgetsBatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetWidgetsBatchResponse]
+    def get_widgets_batch_0(get_widgets_batch_request, opts = {})
+      data, _status_code, _headers = get_widgets_batch_0_with_http_info(get_widgets_batch_request, opts)
+      data
+    end
+
+    # Get Widgets Batch
+    # Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in &#x60;errors&#x60; exactly like one that does not exist. Called with an editor session, only the widgets made for the session&#39;s managed user are returned.
+    # @param get_widgets_batch_request [GetWidgetsBatchRequest] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetWidgetsBatchResponse, Integer, Hash)>] GetWidgetsBatchResponse data, response status code and response headers
+    def get_widgets_batch_0_with_http_info(get_widgets_batch_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WidgetsApi.get_widgets_batch_0 ...'
+      end
+      # verify the required parameter 'get_widgets_batch_request' is set
+      if @api_client.config.client_side_validation && get_widgets_batch_request.nil?
+        fail ArgumentError, "Missing the required parameter 'get_widgets_batch_request' when calling WidgetsApi.get_widgets_batch_0"
+      end
+      # resource path
+      local_var_path = '/widgets/batch'
+
+      # 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(get_widgets_batch_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetWidgetsBatchResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"WidgetsApi.get_widgets_batch_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: WidgetsApi#get_widgets_batch_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end