seatschart 0.1.0

data/lib/seatschart/api/embed_api.rb

@@ -0,0 +1,407 @@
+=begin
+#SeatsChart API
+
+#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.11.0
+
+=end
+
+require 'cgi'
+
+module SeatsChart
+  class EmbedApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List registered ticket buyer ids
+    # Ordered by id; page with `cursor` = the previous `nextCursor`. API key (`holds` scope) or a dashboard session that manages integrations.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @option opts [String] :cursor `nextCursor` of the previous page.
+    # @return [nil]
+    def get_api_ticket_buyers(opts = {})
+      get_api_ticket_buyers_with_http_info(opts)
+      nil
+    end
+
+    # List registered ticket buyer ids
+    # Ordered by id; page with `cursor` = the previous `nextCursor`. API key (`holds` scope) or a dashboard session that manages integrations.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :limit 
+    # @option opts [String] :cursor `nextCursor` of the previous page.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_ticket_buyers_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmbedApi.get_api_ticket_buyers ...'
+      end
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 1000
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmbedApi.get_api_ticket_buyers, must be smaller than or equal to 1000.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling EmbedApi.get_api_ticket_buyers, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length > 256
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling EmbedApi.get_api_ticket_buyers, the character length must be smaller than or equal to 256.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'cursor'].nil? && opts[:'cursor'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"cursor"]" when calling EmbedApi.get_api_ticket_buyers, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/ticket-buyers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # 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] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmbedApi.get_api_ticket_buyers",
+        :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: EmbedApi#get_api_ticket_buyers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mint a short-lived designer/manager embed token
+    # HS256 audience `embed`, max TTL 30 minutes. Never put the workspace API secret in the browser. See docs/SEATSIO_PARITY.md.
+    # @param post_api_embed_tokens_request [PostApiEmbedTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_embed_tokens(post_api_embed_tokens_request, opts = {})
+      post_api_embed_tokens_with_http_info(post_api_embed_tokens_request, opts)
+      nil
+    end
+
+    # Mint a short-lived designer/manager embed token
+    # HS256 audience &#x60;embed&#x60;, max TTL 30 minutes. Never put the workspace API secret in the browser. See docs/SEATSIO_PARITY.md.
+    # @param post_api_embed_tokens_request [PostApiEmbedTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_embed_tokens_with_http_info(post_api_embed_tokens_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmbedApi.post_api_embed_tokens ...'
+      end
+      # verify the required parameter 'post_api_embed_tokens_request' is set
+      if @api_client.config.client_side_validation && post_api_embed_tokens_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_embed_tokens_request' when calling EmbedApi.post_api_embed_tokens"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_embed_tokens, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_embed_tokens, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/embed-tokens'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_embed_tokens_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmbedApi.post_api_embed_tokens",
+        :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: EmbedApi#post_api_embed_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Register ticket buyer ids
+    # Adds ids to the workspace allow-list (idempotent). With ticket buyer validation on (`PATCH /workspace/settings`), `POST /viewer-tokens` mints a buyer token only for a registered `ticketBuyerId` and binds it (`tbid` claim): the buyer's holds carry that id, and a different `ticketBuyerId` is refused. Holds never query this list.
+    # @param post_api_ticket_buyers_request [PostApiTicketBuyersRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_ticket_buyers(post_api_ticket_buyers_request, opts = {})
+      post_api_ticket_buyers_with_http_info(post_api_ticket_buyers_request, opts)
+      nil
+    end
+
+    # Register ticket buyer ids
+    # Adds ids to the workspace allow-list (idempotent). With ticket buyer validation on (&#x60;PATCH /workspace/settings&#x60;), &#x60;POST /viewer-tokens&#x60; mints a buyer token only for a registered &#x60;ticketBuyerId&#x60; and binds it (&#x60;tbid&#x60; claim): the buyer&#39;s holds carry that id, and a different &#x60;ticketBuyerId&#x60; is refused. Holds never query this list.
+    # @param post_api_ticket_buyers_request [PostApiTicketBuyersRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_ticket_buyers_with_http_info(post_api_ticket_buyers_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmbedApi.post_api_ticket_buyers ...'
+      end
+      # verify the required parameter 'post_api_ticket_buyers_request' is set
+      if @api_client.config.client_side_validation && post_api_ticket_buyers_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_ticket_buyers_request' when calling EmbedApi.post_api_ticket_buyers"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_ticket_buyers, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_ticket_buyers, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/ticket-buyers'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_ticket_buyers_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmbedApi.post_api_ticket_buyers",
+        :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: EmbedApi#post_api_ticket_buyers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Remove ticket buyer ids
+    # Removes ids from the allow-list. Buyer tokens already minted keep their binding until they expire (at most one hour).
+    # @param post_api_ticket_buyers_request [PostApiTicketBuyersRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_ticket_buyers_actions_remove(post_api_ticket_buyers_request, opts = {})
+      post_api_ticket_buyers_actions_remove_with_http_info(post_api_ticket_buyers_request, opts)
+      nil
+    end
+
+    # Remove ticket buyer ids
+    # Removes ids from the allow-list. Buyer tokens already minted keep their binding until they expire (at most one hour).
+    # @param post_api_ticket_buyers_request [PostApiTicketBuyersRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_ticket_buyers_actions_remove_with_http_info(post_api_ticket_buyers_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmbedApi.post_api_ticket_buyers_actions_remove ...'
+      end
+      # verify the required parameter 'post_api_ticket_buyers_request' is set
+      if @api_client.config.client_side_validation && post_api_ticket_buyers_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_ticket_buyers_request' when calling EmbedApi.post_api_ticket_buyers_actions_remove"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_ticket_buyers_actions_remove, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_ticket_buyers_actions_remove, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/ticket-buyers/actions/remove'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_ticket_buyers_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmbedApi.post_api_ticket_buyers_actions_remove",
+        :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: EmbedApi#post_api_ticket_buyers_actions_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Mint a short-lived buyer (viewer) token with the partner API key
+    # Server-to-server only (`x-api-key`, `holds` scope). Returns an HS256 buyer JWT bound to the API key's workspace (`tenant_id` claim) for the viewer `?token=` / `token` prop or `Authorization: Bearer` on consumer routes. Partners never need the platform `JWT_SECRET`. Mint one per buyer session from your server; never expose the API key in the browser. Lifetime 60-3600 seconds (default 900). Buyer tokens cannot mint tokens (403). Optional `ticketBuyerId` binds the token to a ticket buyer: holds made with it carry that id. With the workspace setting **ticket buyer validation** on, `ticketBuyerId` is required (400 `ticket_buyer_id_required`) and must be registered (`POST /ticket-buyers`; 403 `ticket_buyer_not_registered`); buyer holds then refuse a different id (403 `ticket_buyer_mismatch`) and tokens without one (403 `ticket_buyer_required`). Response: `{ token, tokenType: \"Bearer\", expiresInSeconds, expiresAt, ticketBuyerId? }`.
+    # @param post_api_viewer_tokens_request [PostApiViewerTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_viewer_tokens(post_api_viewer_tokens_request, opts = {})
+      post_api_viewer_tokens_with_http_info(post_api_viewer_tokens_request, opts)
+      nil
+    end
+
+    # Mint a short-lived buyer (viewer) token with the partner API key
+    # Server-to-server only (&#x60;x-api-key&#x60;, &#x60;holds&#x60; scope). Returns an HS256 buyer JWT bound to the API key&#39;s workspace (&#x60;tenant_id&#x60; claim) for the viewer &#x60;?token&#x3D;&#x60; / &#x60;token&#x60; prop or &#x60;Authorization: Bearer&#x60; on consumer routes. Partners never need the platform &#x60;JWT_SECRET&#x60;. Mint one per buyer session from your server; never expose the API key in the browser. Lifetime 60-3600 seconds (default 900). Buyer tokens cannot mint tokens (403). Optional &#x60;ticketBuyerId&#x60; binds the token to a ticket buyer: holds made with it carry that id. With the workspace setting **ticket buyer validation** on, &#x60;ticketBuyerId&#x60; is required (400 &#x60;ticket_buyer_id_required&#x60;) and must be registered (&#x60;POST /ticket-buyers&#x60;; 403 &#x60;ticket_buyer_not_registered&#x60;); buyer holds then refuse a different id (403 &#x60;ticket_buyer_mismatch&#x60;) and tokens without one (403 &#x60;ticket_buyer_required&#x60;). Response: &#x60;{ token, tokenType: \&quot;Bearer\&quot;, expiresInSeconds, expiresAt, ticketBuyerId? }&#x60;.
+    # @param post_api_viewer_tokens_request [PostApiViewerTokensRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_viewer_tokens_with_http_info(post_api_viewer_tokens_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmbedApi.post_api_viewer_tokens ...'
+      end
+      # verify the required parameter 'post_api_viewer_tokens_request' is set
+      if @api_client.config.client_side_validation && post_api_viewer_tokens_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_viewer_tokens_request' when calling EmbedApi.post_api_viewer_tokens"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_viewer_tokens, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling EmbedApi.post_api_viewer_tokens, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/viewer-tokens'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_viewer_tokens_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"EmbedApi.post_api_viewer_tokens",
+        :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: EmbedApi#post_api_viewer_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end