seatschart 0.2.0 → 0.3.0

data/lib/seatschart/api/public_api.rb

@@ -19,6 +19,356 @@ module SeatsChart
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Map-only embed policy of a chart
+    # Used by the Next.js map-only viewer (`/viewer/chart/{chart}?workspaceKey=…`) to build CSP frame-ancestors and validate `parent_origin`, like the event embed policy: `{ origins, chart: { id, name }, rendererDefaults }`. No tenant id. A deactivated workspace returns 403 `workspace_deactivated`; an unknown key or chart, a chart that was never published or is archived: 404 `not_found` (errors are `no-store`). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (`pub_…`).
+    # @param chart [String] Chart id or chart key.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_api_public_by_public_key_charts_by_chart_embed_policy(public_key, chart, opts = {})
+      get_api_public_by_public_key_charts_by_chart_embed_policy_with_http_info(public_key, chart, opts)
+      nil
+    end
+
+    # Map-only embed policy of a chart
+    # Used by the Next.js map-only viewer (`/viewer/chart/{chart}?workspaceKey=…`) to build CSP frame-ancestors and validate `parent_origin`, like the event embed policy: `{ origins, chart: { id, name }, rendererDefaults }`. No tenant id. A deactivated workspace returns 403 `workspace_deactivated`; an unknown key or chart, a chart that was never published or is archived: 404 `not_found` (errors are `no-store`). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (`pub_…`).
+    # @param chart [String] Chart id or chart key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_public_by_public_key_charts_by_chart_embed_policy_with_http_info(public_key, chart, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy ...'
+      end
+      # verify the required parameter 'public_key' is set
+      if @api_client.config.client_side_validation && public_key.nil?
+        fail ArgumentError, "Missing the required parameter 'public_key' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy"
+      end
+      if @api_client.config.client_side_validation && public_key.to_s.length > 64
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && public_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy, the character length must be great than or equal to 1.'
+      end
+
+      # verify the required parameter 'chart' is set
+      if @api_client.config.client_side_validation && chart.nil?
+        fail ArgumentError, "Missing the required parameter 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy"
+      end
+      if @api_client.config.client_side_validation && chart.to_s.length > 100
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy, the character length must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && chart.to_s.length < 1
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9][A-Za-z0-9_.~-]{0,99}$/)
+      if @api_client.config.client_side_validation && chart !~ pattern
+        fail ArgumentError, "invalid value for 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/public/{publicKey}/charts/{chart}/embed-policy'.sub('{' + 'publicKey' + '}', CGI.escape(public_key.to_s)).sub('{' + 'chart' + '}', CGI.escape(chart.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"PublicApi.get_api_public_by_public_key_charts_by_chart_embed_policy",
+        :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: PublicApi#get_api_public_by_public_key_charts_by_chart_embed_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Map-only chart geometry (immutable, CDN-cacheable)
+    # Content-addressed published geometry of the chart (sha256 of the canonical JSON; clients verify it), the same document as the chart preview geometry. `Cache-Control: public, max-age=31536000, immutable`. Unknown hash: 404. A deactivated workspace returns 403 `workspace_deactivated`; an unknown key or chart, a chart that was never published or is archived: 404 `not_found` (errors are `no-store`). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param chart [String] Chart id or chart key.
+    # @param hash [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_api_public_by_public_key_charts_by_chart_geometry_by_hash(public_key, chart, hash, opts = {})
+      get_api_public_by_public_key_charts_by_chart_geometry_by_hash_with_http_info(public_key, chart, hash, opts)
+      nil
+    end
+
+    # Map-only chart geometry (immutable, CDN-cacheable)
+    # Content-addressed published geometry of the chart (sha256 of the canonical JSON; clients verify it), the same document as the chart preview geometry. &#x60;Cache-Control: public, max-age&#x3D;31536000, immutable&#x60;. Unknown hash: 404. A deactivated workspace returns 403 &#x60;workspace_deactivated&#x60;; an unknown key or chart, a chart that was never published or is archived: 404 &#x60;not_found&#x60; (errors are &#x60;no-store&#x60;). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param chart [String] Chart id or chart key.
+    # @param hash [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_public_by_public_key_charts_by_chart_geometry_by_hash_with_http_info(public_key, chart, hash, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash ...'
+      end
+      # verify the required parameter 'public_key' is set
+      if @api_client.config.client_side_validation && public_key.nil?
+        fail ArgumentError, "Missing the required parameter 'public_key' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash"
+      end
+      if @api_client.config.client_side_validation && public_key.to_s.length > 64
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && public_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, the character length must be great than or equal to 1.'
+      end
+
+      # verify the required parameter 'chart' is set
+      if @api_client.config.client_side_validation && chart.nil?
+        fail ArgumentError, "Missing the required parameter 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash"
+      end
+      if @api_client.config.client_side_validation && chart.to_s.length > 100
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, the character length must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && chart.to_s.length < 1
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9][A-Za-z0-9_.~-]{0,99}$/)
+      if @api_client.config.client_side_validation && chart !~ pattern
+        fail ArgumentError, "invalid value for 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'hash' is set
+      if @api_client.config.client_side_validation && hash.nil?
+        fail ArgumentError, "Missing the required parameter 'hash' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash"
+      end
+      pattern = Regexp.new(/^[a-f0-9]{64}$/)
+      if @api_client.config.client_side_validation && hash !~ pattern
+        fail ArgumentError, "invalid value for 'hash' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/public/{publicKey}/charts/{chart}/geometry/{hash}'.sub('{' + 'publicKey' + '}', CGI.escape(public_key.to_s)).sub('{' + 'chart' + '}', CGI.escape(chart.to_s)).sub('{' + 'hash' + '}', CGI.escape(hash.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"PublicApi.get_api_public_by_public_key_charts_by_chart_geometry_by_hash",
+        :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: PublicApi#get_api_public_by_public_key_charts_by_chart_geometry_by_hash\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Map-only chart manifest (CDN-cacheable)
+    # Published chart for a map-only render (seats.io `bringYourOwnBackend`): `{ chartId, name, eventId (= chartId), mapRevision, geometryHash, geometrySchema, seatCount, gaCount, geometryUrl, state }`. `state` is the compact state with every object free (catalog prices, GA capacities, category prices / ticket types, booking rules); the renderer overlays the statuses the host passes. No inventory, holds or event data. Every object of the chart (seats + general admission areas) counts as a used object once per chart and UTC month (see the map-only guide). ETag; `If-None-Match` returns 304. `Cache-Control: public, max-age=30, stale-while-revalidate=60`. `chart` accepts the chart id or key. A deactivated workspace returns 403 `workspace_deactivated`; an unknown key or chart, a chart that was never published or is archived: 404 `not_found` (errors are `no-store`). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param chart [String] Chart id or chart key.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_api_public_by_public_key_charts_by_chart_manifest(public_key, chart, opts = {})
+      get_api_public_by_public_key_charts_by_chart_manifest_with_http_info(public_key, chart, opts)
+      nil
+    end
+
+    # Map-only chart manifest (CDN-cacheable)
+    # Published chart for a map-only render (seats.io &#x60;bringYourOwnBackend&#x60;): &#x60;{ chartId, name, eventId (&#x3D; chartId), mapRevision, geometryHash, geometrySchema, seatCount, gaCount, geometryUrl, state }&#x60;. &#x60;state&#x60; is the compact state with every object free (catalog prices, GA capacities, category prices / ticket types, booking rules); the renderer overlays the statuses the host passes. No inventory, holds or event data. Every object of the chart (seats + general admission areas) counts as a used object once per chart and UTC month (see the map-only guide). ETag; &#x60;If-None-Match&#x60; returns 304. &#x60;Cache-Control: public, max-age&#x3D;30, stale-while-revalidate&#x3D;60&#x60;. &#x60;chart&#x60; accepts the chart id or key. A deactivated workspace returns 403 &#x60;workspace_deactivated&#x60;; an unknown key or chart, a chart that was never published or is archived: 404 &#x60;not_found&#x60; (errors are &#x60;no-store&#x60;). CDN cache key: path + Origin + normalized Accept-Encoding.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param chart [String] Chart id or chart key.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_public_by_public_key_charts_by_chart_manifest_with_http_info(public_key, chart, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicApi.get_api_public_by_public_key_charts_by_chart_manifest ...'
+      end
+      # verify the required parameter 'public_key' is set
+      if @api_client.config.client_side_validation && public_key.nil?
+        fail ArgumentError, "Missing the required parameter 'public_key' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest"
+      end
+      if @api_client.config.client_side_validation && public_key.to_s.length > 64
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && public_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest, the character length must be great than or equal to 1.'
+      end
+
+      # verify the required parameter 'chart' is set
+      if @api_client.config.client_side_validation && chart.nil?
+        fail ArgumentError, "Missing the required parameter 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest"
+      end
+      if @api_client.config.client_side_validation && chart.to_s.length > 100
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest, the character length must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && chart.to_s.length < 1
+        fail ArgumentError, 'invalid value for "chart" when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest, the character length must be great than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^[A-Za-z0-9][A-Za-z0-9_.~-]{0,99}$/)
+      if @api_client.config.client_side_validation && chart !~ pattern
+        fail ArgumentError, "invalid value for 'chart' when calling PublicApi.get_api_public_by_public_key_charts_by_chart_manifest, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/public/{publicKey}/charts/{chart}/manifest'.sub('{' + 'publicKey' + '}', CGI.escape(public_key.to_s)).sub('{' + 'chart' + '}', CGI.escape(chart.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"PublicApi.get_api_public_by_public_key_charts_by_chart_manifest",
+        :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: PublicApi#get_api_public_by_public_key_charts_by_chart_manifest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Published buyer extraData of an event (workspace opt-in, CDN-cacheable)
+    # Object `extraData` is private by default. When a workspace admin enables buyer publication (`PUT /api/workspace/buyer-extra-data`) with an allow-list of keys, this read returns, for the workspace's events, `{ keys, objects: { [objectId]: { key: value } } }` with only those keys and scalar values (strings up to 256 characters, numbers, booleans, null; objects, arrays and longer strings are never published). The renderer reads it once after the map for declarative rules (`match.extraData`), templates (`{extraData.key}`) and host objects. Built from one indexed query on a miss, then served from a per-event cache dropped whenever the seat map cache is invalidated (overlay writes, extraData updates) and rebuilt when the key list changes. Never part of the compact state. Not published (setting off or no keys): 404 `extra_data_not_published`. ETag; `If-None-Match` returns 304. `Cache-Control: public, max-age=5, stale-while-revalidate=10`. `eventId` also accepts the event key.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_api_public_by_public_key_events_by_event_id_extra_data(public_key, event_id, opts = {})
+      get_api_public_by_public_key_events_by_event_id_extra_data_with_http_info(public_key, event_id, opts)
+      nil
+    end
+
+    # Published buyer extraData of an event (workspace opt-in, CDN-cacheable)
+    # Object &#x60;extraData&#x60; is private by default. When a workspace admin enables buyer publication (&#x60;PUT /api/workspace/buyer-extra-data&#x60;) with an allow-list of keys, this read returns, for the workspace&#39;s events, &#x60;{ keys, objects: { [objectId]: { key: value } } }&#x60; with only those keys and scalar values (strings up to 256 characters, numbers, booleans, null; objects, arrays and longer strings are never published). The renderer reads it once after the map for declarative rules (&#x60;match.extraData&#x60;), templates (&#x60;{extraData.key}&#x60;) and host objects. Built from one indexed query on a miss, then served from a per-event cache dropped whenever the seat map cache is invalidated (overlay writes, extraData updates) and rebuilt when the key list changes. Never part of the compact state. Not published (setting off or no keys): 404 &#x60;extra_data_not_published&#x60;. ETag; &#x60;If-None-Match&#x60; returns 304. &#x60;Cache-Control: public, max-age&#x3D;5, stale-while-revalidate&#x3D;10&#x60;. &#x60;eventId&#x60; also accepts the event key.
+    # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).
+    # @param event_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_api_public_by_public_key_events_by_event_id_extra_data_with_http_info(public_key, event_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data ...'
+      end
+      # verify the required parameter 'public_key' is set
+      if @api_client.config.client_side_validation && public_key.nil?
+        fail ArgumentError, "Missing the required parameter 'public_key' when calling PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data"
+      end
+      if @api_client.config.client_side_validation && public_key.to_s.length > 64
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data, the character length must be smaller than or equal to 64.'
+      end
+
+      if @api_client.config.client_side_validation && public_key.to_s.length < 1
+        fail ArgumentError, 'invalid value for "public_key" when calling PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data, the character length must be great than or equal to 1.'
+      end
+
+      # verify the required parameter 'event_id' is set
+      if @api_client.config.client_side_validation && event_id.nil?
+        fail ArgumentError, "Missing the required parameter 'event_id' when calling PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data"
+      end
+      # resource path
+      local_var_path = '/api/public/{publicKey}/events/{eventId}/extra-data'.sub('{' + 'publicKey' + '}', CGI.escape(public_key.to_s)).sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # 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] || []
+
+      new_options = opts.merge(
+        :operation => :"PublicApi.get_api_public_by_public_key_events_by_event_id_extra_data",
+        :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: PublicApi#get_api_public_by_public_key_events_by_event_id_extra_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Public immutable geometry (CDN-cacheable)
     # Content-addressed geometry (sha256 of the canonical JSON). br/gzip negotiated from Accept-Encoding. `Cache-Control: public, max-age=31536000, immutable`. Clients must verify the hash. Unknown key, event or hash: 404 no-store. `eventId` also accepts the event key. A deactivated workspace returns 403 `workspace_deactivated` (no-store). CDN cache key: path + Origin + normalized Accept-Encoding. Never forward or key on cookies, Authorization, x-api-key, x-channel-key or the query string.
     # @param public_key [String] Workspace public key (&#x60;pub_…&#x60;).