seatschart 0.2.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +199 -19
- data/lib/seatschart/api/audit_api.rb +2 -2
- data/lib/seatschart/api/auth_api.rb +81 -4
- data/lib/seatschart/api/billing_api.rb +4 -0
- data/lib/seatschart/api/charts_api.rb +810 -77
- data/lib/seatschart/api/embed_api.rb +5 -5
- data/lib/seatschart/api/embed_origins_api.rb +63 -2
- data/lib/seatschart/api/event_log_api.rb +2 -2
- data/lib/seatschart/api/events_api.rb +1491 -175
- data/lib/seatschart/api/health_api.rb +244 -0
- data/lib/seatschart/api/map_designer_api.rb +11 -9
- data/lib/seatschart/api/public_api.rb +356 -6
- data/lib/seatschart/api/sandboxes_api.rb +672 -0
- data/lib/seatschart/api/seasons_api.rb +344 -36
- data/lib/seatschart/api/seats_api.rb +10 -10
- data/lib/seatschart/api/usage_api.rb +18 -15
- data/lib/seatschart/api/webhooks_api.rb +2 -2
- data/lib/seatschart/api/workspace_api.rb +1815 -363
- data/lib/seatschart/models/api_error.rb +4 -4
- data/lib/seatschart/models/delete_api_sandboxes_by_sandbox_id200_response.rb +255 -0
- data/lib/seatschart/models/delete_api_workspaces_by_workspace_id_keys_by_key_id200_response.rb +237 -0
- data/lib/seatschart/models/get_api_monitoring_requests200_response.rb +62 -4
- data/lib/seatschart/models/get_api_monitoring_requests200_response_points_inner.rb +21 -4
- data/lib/seatschart/models/get_api_sandboxes200_response.rb +239 -0
- data/lib/seatschart/models/get_api_sandboxes200_response_items_inner.rb +431 -0
- data/lib/seatschart/models/get_api_sandboxes200_response_items_inner_rate_limits.rb +270 -0
- data/lib/seatschart/models/get_api_sandboxes200_response_items_inner_usage.rb +287 -0
- data/lib/seatschart/models/get_api_status200_response.rb +387 -0
- data/lib/seatschart/models/get_api_status200_response_components_inner.rb +330 -0
- data/lib/seatschart/models/get_api_status200_response_components_inner_days_inner.rb +301 -0
- data/lib/seatschart/models/get_api_status200_response_incidents_inner.rb +374 -0
- data/lib/seatschart/models/get_api_status200_response_maintenance_inner.rb +350 -0
- data/lib/seatschart/models/get_api_status503_response.rb +271 -0
- data/lib/seatschart/models/get_api_workspace_buyer_extra_data200_response.rb +241 -0
- data/lib/seatschart/models/get_api_workspace_defaults200_response.rb +254 -0
- data/lib/seatschart/models/get_api_workspace_defaults200_response_renderer.rb +246 -0
- data/lib/seatschart/models/get_api_workspace_defaults200_response_renderer_built_in.rb +270 -0
- data/lib/seatschart/models/get_api_workspaces200_response_items_inner.rb +80 -5
- data/lib/seatschart/models/get_api_workspaces_by_workspace_id_keys200_response.rb +239 -0
- data/lib/seatschart/models/get_api_workspaces_by_workspace_id_keys200_response_api_keys_inner.rb +321 -0
- data/lib/seatschart/models/get_api_workspaces_created_by_api_parameter.rb +103 -0
- data/lib/seatschart/models/get_api_workspaces_overview_created_by_api_parameter.rb +103 -0
- data/lib/seatschart/models/patch_api_events_by_event_id_request.rb +12 -2
- data/lib/seatschart/models/patch_api_seasons_by_season_id_request.rb +15 -5
- data/lib/seatschart/models/patch_api_workspace_chart_validation_request_severities.rb +25 -4
- data/lib/seatschart/models/patch_api_workspace_defaults_request.rb +224 -0
- data/lib/seatschart/models/patch_api_workspace_defaults_request_renderer.rb +249 -0
- data/lib/seatschart/models/patch_api_workspace_settings_request.rb +6 -6
- data/lib/seatschart/models/patch_api_workspaces_by_workspace_id_keys_by_key_id200_response.rb +221 -0
- data/lib/seatschart/models/patch_api_workspaces_by_workspace_id_keys_by_key_id_request.rb +292 -0
- data/lib/seatschart/models/patch_api_workspaces_by_workspace_id_request.rb +288 -0
- data/lib/seatschart/models/post_api_auth_new_workspace_request.rb +294 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_copy_to_workspace_request.rb +39 -1
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_validate_request.rb +1 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_map_publish422_response_issues_inner.rb +64 -6
- data/lib/seatschart/models/post_api_charts_by_chart_id_map_publish_request.rb +1 -1
- data/lib/seatschart/models/post_api_embed_tokens_request.rb +18 -15
- data/lib/seatschart/models/post_api_embed_tokens_request_safe_mode_options.rb +226 -0
- data/lib/seatschart/models/post_api_events_actions_edit_for_sale_config_request.rb +251 -0
- data/lib/seatschart/models/post_api_events_actions_edit_for_sale_config_request_events_inner.rb +322 -0
- data/lib/seatschart/models/post_api_events_bulk_request_events_inner.rb +42 -1
- data/lib/seatschart/models/post_api_events_by_event_id_actions_edit_for_sale_config_request.rb +277 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_edit_for_sale_config_request_for_sale_inner.rb +319 -0
- data/lib/seatschart/models/post_api_events_by_event_id_map_publish_request.rb +215 -0
- data/lib/seatschart/models/post_api_events_request.rb +42 -1
- data/lib/seatschart/models/{patch_api_events_by_event_id_request_categories_inner.rb → post_api_events_request_categories_inner.rb} +3 -3
- data/lib/seatschart/models/post_api_extract_seats200_response.rb +459 -0
- data/lib/seatschart/models/post_api_extract_seats200_response_seats_inner.rb +323 -0
- data/lib/seatschart/models/post_api_extract_seats200_response_suggested_inner.rb +320 -0
- data/lib/seatschart/models/post_api_extract_seats_request.rb +124 -4
- data/lib/seatschart/models/post_api_extract_seats_request_examples.rb +105 -0
- data/lib/seatschart/models/post_api_extract_seats_request_examples_any_of_inner.rb +293 -0
- data/lib/seatschart/models/post_api_extract_seats_request_negatives.rb +105 -0
- data/lib/seatschart/models/post_api_extract_seats_request_region.rb +105 -0
- data/lib/seatschart/models/{put_api_charts_by_chart_id_map_draft_request.rb → post_api_extract_seats_request_region_any_of.rb} +111 -96
- data/lib/seatschart/models/post_api_sandboxes201_response.rb +245 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_admin_key.rb +286 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied.rb +313 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied_charts_inner.rb +281 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied_events_inner.rb +281 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied_events_with_own_map_inner.rb +265 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied_key_conflicts_inner.rb +287 -0
- data/lib/seatschart/models/post_api_sandboxes201_response_copied_seasons_inner.rb +312 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_actions_copy_from_production200_response.rb +313 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_actions_copy_from_production_request.rb +255 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_actions_join200_response.rb +271 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_actions_reset200_response.rb +268 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_actions_reset_request.rb +225 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_admin_key201_response.rb +253 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_admin_key201_response_api_key.rb +286 -0
- data/lib/seatschart/models/post_api_sandboxes_by_sandbox_id_admin_key_request.rb +252 -0
- data/lib/seatschart/models/post_api_sandboxes_request.rb +319 -0
- data/lib/seatschart/models/post_api_seasons_request.rb +14 -4
- data/lib/seatschart/models/post_api_seats_confirm_request.rb +5 -5
- data/lib/seatschart/models/post_api_seats_release_request.rb +5 -5
- data/lib/seatschart/models/post_api_seats_reserve_request.rb +5 -5
- data/lib/seatschart/models/post_api_workspaces200_response.rb +468 -0
- data/lib/seatschart/models/post_api_workspaces200_response_api_key.rb +332 -0
- data/lib/seatschart/models/post_api_workspaces200_response_template.rb +260 -0
- data/lib/seatschart/models/post_api_workspaces200_response_template_webhooks_inner.rb +284 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_actions_delete200_response.rb +319 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_actions_delete_request.rb +281 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_invitations_request.rb +300 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_keys201_response.rb +237 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_keys201_response_api_key.rb +338 -0
- data/lib/seatschart/models/post_api_workspaces_by_workspace_id_keys_request.rb +299 -0
- data/lib/seatschart/models/post_api_workspaces_request.rb +101 -5
- data/lib/seatschart/models/post_api_workspaces_request_issue_key.rb +294 -0
- data/lib/seatschart/models/put_api_workspace_buyer_extra_data_request.rb +260 -0
- data/lib/seatschart/models/put_internal_status_notices_request.rb +242 -0
- data/lib/seatschart/models/put_internal_status_notices_request_notices_inner.rb +445 -0
- data/lib/seatschart/retry.rb +106 -7
- data/lib/seatschart/version.rb +1 -1
- data/lib/seatschart.rb +73 -3
- metadata +75 -5
- data/lib/seatschart/api/default_api.rb +0 -763
|
@@ -99,6 +99,108 @@ module SeatsChart
|
|
|
99
99
|
return data, status_code, headers
|
|
100
100
|
end
|
|
101
101
|
|
|
102
|
+
# Delete a category from the chart draft
|
|
103
|
+
# Removes a category from the chart draft. When draft seats or GA areas still use it, pass `?reassignTo=<categoryId>` to move them to another category first (`reassignedSeats`, `reassignedGaAreas`); without it the call answers 409 `category_in_use` with the counts. 404 `not_found` when the category is not in the draft. Requires chart write access.
|
|
104
|
+
# @param chart_id [String]
|
|
105
|
+
# @param category_id [String]
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @option opts [String] :reassign_to Category id that receives the seats/GA areas of the deleted category.
|
|
108
|
+
# @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.
|
|
109
|
+
# @return [nil]
|
|
110
|
+
def delete_api_charts_by_chart_id_categories_by_category_id(chart_id, category_id, opts = {})
|
|
111
|
+
delete_api_charts_by_chart_id_categories_by_category_id_with_http_info(chart_id, category_id, opts)
|
|
112
|
+
nil
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
# Delete a category from the chart draft
|
|
116
|
+
# Removes a category from the chart draft. When draft seats or GA areas still use it, pass `?reassignTo=<categoryId>` to move them to another category first (`reassignedSeats`, `reassignedGaAreas`); without it the call answers 409 `category_in_use` with the counts. 404 `not_found` when the category is not in the draft. Requires chart write access.
|
|
117
|
+
# @param chart_id [String]
|
|
118
|
+
# @param category_id [String]
|
|
119
|
+
# @param [Hash] opts the optional parameters
|
|
120
|
+
# @option opts [String] :reassign_to Category id that receives the seats/GA areas of the deleted category.
|
|
121
|
+
# @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.
|
|
122
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
123
|
+
def delete_api_charts_by_chart_id_categories_by_category_id_with_http_info(chart_id, category_id, opts = {})
|
|
124
|
+
if @api_client.config.debugging
|
|
125
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id ...'
|
|
126
|
+
end
|
|
127
|
+
# verify the required parameter 'chart_id' is set
|
|
128
|
+
if @api_client.config.client_side_validation && chart_id.nil?
|
|
129
|
+
fail ArgumentError, "Missing the required parameter 'chart_id' when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id"
|
|
130
|
+
end
|
|
131
|
+
pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
|
|
132
|
+
if @api_client.config.client_side_validation && chart_id !~ pattern
|
|
133
|
+
fail ArgumentError, "invalid value for 'chart_id' when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, must conform to the pattern #{pattern}."
|
|
134
|
+
end
|
|
135
|
+
|
|
136
|
+
# verify the required parameter 'category_id' is set
|
|
137
|
+
if @api_client.config.client_side_validation && category_id.nil?
|
|
138
|
+
fail ArgumentError, "Missing the required parameter 'category_id' when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id"
|
|
139
|
+
end
|
|
140
|
+
if @api_client.config.client_side_validation && category_id.to_s.length > 64
|
|
141
|
+
fail ArgumentError, 'invalid value for "category_id" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be smaller than or equal to 64.'
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
if @api_client.config.client_side_validation && category_id.to_s.length < 1
|
|
145
|
+
fail ArgumentError, 'invalid value for "category_id" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be great than or equal to 1.'
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
if @api_client.config.client_side_validation && !opts[:'reassign_to'].nil? && opts[:'reassign_to'].to_s.length > 64
|
|
149
|
+
fail ArgumentError, 'invalid value for "opts[:"reassign_to"]" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be smaller than or equal to 64.'
|
|
150
|
+
end
|
|
151
|
+
|
|
152
|
+
if @api_client.config.client_side_validation && !opts[:'reassign_to'].nil? && opts[:'reassign_to'].to_s.length < 1
|
|
153
|
+
fail ArgumentError, 'invalid value for "opts[:"reassign_to"]" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be great than or equal to 1.'
|
|
154
|
+
end
|
|
155
|
+
|
|
156
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
157
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be smaller than or equal to 255.'
|
|
158
|
+
end
|
|
159
|
+
|
|
160
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
161
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id, the character length must be great than or equal to 1.'
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# resource path
|
|
165
|
+
local_var_path = '/api/charts/{chartId}/categories/{categoryId}'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s)).sub('{' + 'categoryId' + '}', CGI.escape(category_id.to_s))
|
|
166
|
+
|
|
167
|
+
# query parameters
|
|
168
|
+
query_params = opts[:query_params] || {}
|
|
169
|
+
query_params[:'reassignTo'] = opts[:'reassign_to'] if !opts[:'reassign_to'].nil?
|
|
170
|
+
|
|
171
|
+
# header parameters
|
|
172
|
+
header_params = opts[:header_params] || {}
|
|
173
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
174
|
+
|
|
175
|
+
# form parameters
|
|
176
|
+
form_params = opts[:form_params] || {}
|
|
177
|
+
|
|
178
|
+
# http body (model)
|
|
179
|
+
post_body = opts[:debug_body]
|
|
180
|
+
|
|
181
|
+
# return_type
|
|
182
|
+
return_type = opts[:debug_return_type]
|
|
183
|
+
|
|
184
|
+
# auth_names
|
|
185
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
186
|
+
|
|
187
|
+
new_options = opts.merge(
|
|
188
|
+
:operation => :"ChartsApi.delete_api_charts_by_chart_id_categories_by_category_id",
|
|
189
|
+
:header_params => header_params,
|
|
190
|
+
:query_params => query_params,
|
|
191
|
+
:form_params => form_params,
|
|
192
|
+
:body => post_body,
|
|
193
|
+
:auth_names => auth_names,
|
|
194
|
+
:return_type => return_type
|
|
195
|
+
)
|
|
196
|
+
|
|
197
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
198
|
+
if @api_client.config.debugging
|
|
199
|
+
@api_client.config.logger.debug "API called: ChartsApi#delete_api_charts_by_chart_id_categories_by_category_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
200
|
+
end
|
|
201
|
+
return data, status_code, headers
|
|
202
|
+
end
|
|
203
|
+
|
|
102
204
|
# Revoke every public preview link of a chart
|
|
103
205
|
# Rotates the chart's preview secret: all links issued before stop working (within ~15 s on every API instance).
|
|
104
206
|
# @param chart_id [String]
|
|
@@ -185,7 +287,8 @@ module SeatsChart
|
|
|
185
287
|
# @option opts [String] :archived `false` (default) hides archived charts, `true` returns only archived charts, `all` returns both.
|
|
186
288
|
# @option opts [String] :tag Comma-separated tags (case-insensitive, at most 5); a chart must carry all of them.
|
|
187
289
|
# @option opts [String] :sort `name` (default): name A→Z. `recent`: last draft save / publish first, then creation time.
|
|
188
|
-
# @option opts [String] :expand Comma-separated. `events` adds `events[]` (`{ id, key, name, date, isInThePast }`, soonest first, at most 100 per chart; `eventCount` has the total). `validation` is accepted for seats.io compatibility (`validation` is always part of paginated items).
|
|
290
|
+
# @option opts [String] :expand Comma-separated. `events` adds `events[]` (`{ id, key, name, date, isInThePast }`, soonest first, at most 100 per chart unless `eventsLimit` says otherwise; `eventCount` has the total). `venueType` adds `venueType` (`simple` | `sections` | `zones`: the designer template of the published chart, else of its draft). `zones` adds `zones[]` of the published chart, else of its draft (same items as GET /charts/{chartId}/zones; no seat geometry is read). `validation` is accepted for seats.io compatibility (`validation` is always part of paginated items).
|
|
291
|
+
# @option opts [Float] :events_limit With `expand=events`: events listed per chart (1–1000, default 100).
|
|
189
292
|
# @return [nil]
|
|
190
293
|
def get_api_charts(opts = {})
|
|
191
294
|
get_api_charts_with_http_info(opts)
|
|
@@ -201,7 +304,8 @@ module SeatsChart
|
|
|
201
304
|
# @option opts [String] :archived `false` (default) hides archived charts, `true` returns only archived charts, `all` returns both.
|
|
202
305
|
# @option opts [String] :tag Comma-separated tags (case-insensitive, at most 5); a chart must carry all of them.
|
|
203
306
|
# @option opts [String] :sort `name` (default): name A→Z. `recent`: last draft save / publish first, then creation time.
|
|
204
|
-
# @option opts [String] :expand Comma-separated. `events` adds `events[]` (`{ id, key, name, date, isInThePast }`, soonest first, at most 100 per chart; `eventCount` has the total). `validation` is accepted for seats.io compatibility (`validation` is always part of paginated items).
|
|
307
|
+
# @option opts [String] :expand Comma-separated. `events` adds `events[]` (`{ id, key, name, date, isInThePast }`, soonest first, at most 100 per chart unless `eventsLimit` says otherwise; `eventCount` has the total). `venueType` adds `venueType` (`simple` | `sections` | `zones`: the designer template of the published chart, else of its draft). `zones` adds `zones[]` of the published chart, else of its draft (same items as GET /charts/{chartId}/zones; no seat geometry is read). `validation` is accepted for seats.io compatibility (`validation` is always part of paginated items).
|
|
308
|
+
# @option opts [Float] :events_limit With `expand=events`: events listed per chart (1–1000, default 100).
|
|
205
309
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
206
310
|
def get_api_charts_with_http_info(opts = {})
|
|
207
311
|
if @api_client.config.debugging
|
|
@@ -260,6 +364,14 @@ module SeatsChart
|
|
|
260
364
|
fail ArgumentError, 'invalid value for "opts[:"expand"]" when calling ChartsApi.get_api_charts, the character length must be great than or equal to 1.'
|
|
261
365
|
end
|
|
262
366
|
|
|
367
|
+
if @api_client.config.client_side_validation && !opts[:'events_limit'].nil? && opts[:'events_limit'] > 1000
|
|
368
|
+
fail ArgumentError, 'invalid value for "opts[:"events_limit"]" when calling ChartsApi.get_api_charts, must be smaller than or equal to 1000.'
|
|
369
|
+
end
|
|
370
|
+
|
|
371
|
+
if @api_client.config.client_side_validation && !opts[:'events_limit'].nil? && opts[:'events_limit'] < 1
|
|
372
|
+
fail ArgumentError, 'invalid value for "opts[:"events_limit"]" when calling ChartsApi.get_api_charts, must be greater than or equal to 1.'
|
|
373
|
+
end
|
|
374
|
+
|
|
263
375
|
# resource path
|
|
264
376
|
local_var_path = '/api/charts'
|
|
265
377
|
|
|
@@ -272,6 +384,7 @@ module SeatsChart
|
|
|
272
384
|
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
|
273
385
|
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
274
386
|
query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
|
|
387
|
+
query_params[:'eventsLimit'] = opts[:'events_limit'] if !opts[:'events_limit'].nil?
|
|
275
388
|
|
|
276
389
|
# header parameters
|
|
277
390
|
header_params = opts[:header_params] || {}
|
|
@@ -306,10 +419,10 @@ module SeatsChart
|
|
|
306
419
|
end
|
|
307
420
|
|
|
308
421
|
# Retrieve one chart
|
|
309
|
-
# Returns chart `key`, name and publication metadata: `publishedAt`, `draftUpdatedAt`, `isPublished`, `hasUnpublishedDraft`, `hasDraft`, published seat / GA template counts and the number of events using it, plus `archivedAt`, `createdAt`, `tags`, `latestVersion`, `hasThumbnail` and `thumbnailUrl`. Archived charts are still returned. Geometry blobs are never returned — use the map / draft endpoints. `?expand=zones` adds the zones of the published chart (`&version=draft`: of the draft; empty when that version does not exist). The path accepts the chart key. 404 when the chart belongs to another tenant.
|
|
422
|
+
# Returns chart `key`, name and publication metadata: `publishedAt`, `draftUpdatedAt`, `isPublished`, `hasUnpublishedDraft`, `hasDraft`, published seat / GA template counts and the number of events using it, plus `archivedAt`, `createdAt`, `tags`, `latestVersion`, `hasThumbnail` and `thumbnailUrl`. Archived charts are still returned. Geometry blobs are never returned — use the map / draft endpoints. `?expand=zones` adds the zones of the published chart (`&version=draft`: of the draft; empty when that version does not exist). `?expand=events` adds the 10,000 most recently created events of the chart (`events`, newest first) and `numTotalEvents` (seats.io retrieveWithEvents). The path accepts the chart key. 404 when the chart belongs to another tenant.
|
|
310
423
|
# @param chart_id [String] Chart id (UUID) or chart key.
|
|
311
424
|
# @param [Hash] opts the optional parameters
|
|
312
|
-
# @option opts [String] :expand `zones` adds `zones[]` (same items as GET /charts/{chartId}/zones) of the version selected by `version`.
|
|
425
|
+
# @option opts [String] :expand Comma-separated. `zones` adds `zones[]` (same items as GET /charts/{chartId}/zones) of the version selected by `version`. `events` adds `events[]` (the 10,000 most recently created events, newest first: `{ id, key, name, date, isInThePast, createdAt }`) and `numTotalEvents` (all events of the chart).
|
|
313
426
|
# @option opts [String] :version `published` or `draft` (the unpublished designer draft).
|
|
314
427
|
# @return [nil]
|
|
315
428
|
def get_api_charts_by_chart_id(chart_id, opts = {})
|
|
@@ -318,10 +431,10 @@ module SeatsChart
|
|
|
318
431
|
end
|
|
319
432
|
|
|
320
433
|
# Retrieve one chart
|
|
321
|
-
# Returns chart `key`, name and publication metadata: `publishedAt`, `draftUpdatedAt`, `isPublished`, `hasUnpublishedDraft`, `hasDraft`, published seat / GA template counts and the number of events using it, plus `archivedAt`, `createdAt`, `tags`, `latestVersion`, `hasThumbnail` and `thumbnailUrl`. Archived charts are still returned. Geometry blobs are never returned — use the map / draft endpoints. `?expand=zones` adds the zones of the published chart (`&version=draft`: of the draft; empty when that version does not exist). The path accepts the chart key. 404 when the chart belongs to another tenant.
|
|
434
|
+
# Returns chart `key`, name and publication metadata: `publishedAt`, `draftUpdatedAt`, `isPublished`, `hasUnpublishedDraft`, `hasDraft`, published seat / GA template counts and the number of events using it, plus `archivedAt`, `createdAt`, `tags`, `latestVersion`, `hasThumbnail` and `thumbnailUrl`. Archived charts are still returned. Geometry blobs are never returned — use the map / draft endpoints. `?expand=zones` adds the zones of the published chart (`&version=draft`: of the draft; empty when that version does not exist). `?expand=events` adds the 10,000 most recently created events of the chart (`events`, newest first) and `numTotalEvents` (seats.io retrieveWithEvents). The path accepts the chart key. 404 when the chart belongs to another tenant.
|
|
322
435
|
# @param chart_id [String] Chart id (UUID) or chart key.
|
|
323
436
|
# @param [Hash] opts the optional parameters
|
|
324
|
-
# @option opts [String] :expand `zones` adds `zones[]` (same items as GET /charts/{chartId}/zones) of the version selected by `version`.
|
|
437
|
+
# @option opts [String] :expand Comma-separated. `zones` adds `zones[]` (same items as GET /charts/{chartId}/zones) of the version selected by `version`. `events` adds `events[]` (the 10,000 most recently created events, newest first: `{ id, key, name, date, isInThePast, createdAt }`) and `numTotalEvents` (all events of the chart).
|
|
325
438
|
# @option opts [String] :version `published` or `draft` (the unpublished designer draft).
|
|
326
439
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
327
440
|
def get_api_charts_by_chart_id_with_http_info(chart_id, opts = {})
|
|
@@ -537,6 +650,7 @@ module SeatsChart
|
|
|
537
650
|
end
|
|
538
651
|
|
|
539
652
|
# Load chart map draft for designer
|
|
653
|
+
# The draft (else the published map) the designer edits, plus `draftChartDrawingsEnabled` (workspace setting, default true; false: the designer publishes every save directly, see `GET /api/workspace/defaults`).
|
|
540
654
|
# @param chart_id [String]
|
|
541
655
|
# @param [Hash] opts the optional parameters
|
|
542
656
|
# @return [nil]
|
|
@@ -546,6 +660,7 @@ module SeatsChart
|
|
|
546
660
|
end
|
|
547
661
|
|
|
548
662
|
# Load chart map draft for designer
|
|
663
|
+
# The draft (else the published map) the designer edits, plus `draftChartDrawingsEnabled` (workspace setting, default true; false: the designer publishes every save directly, see `GET /api/workspace/defaults`).
|
|
549
664
|
# @param chart_id [String]
|
|
550
665
|
# @param [Hash] opts the optional parameters
|
|
551
666
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
@@ -604,11 +719,12 @@ module SeatsChart
|
|
|
604
719
|
end
|
|
605
720
|
|
|
606
721
|
# Chart report by category (CSV)
|
|
607
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
722
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
608
723
|
# @param chart_id [String]
|
|
609
724
|
# @param [Hash] opts the optional parameters
|
|
610
725
|
# @option opts [String] :category Only this category bucket.
|
|
611
726
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
727
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
612
728
|
# @return [nil]
|
|
613
729
|
def get_api_charts_by_chart_id_reports_by_category_csv(chart_id, opts = {})
|
|
614
730
|
get_api_charts_by_chart_id_reports_by_category_csv_with_http_info(chart_id, opts)
|
|
@@ -616,11 +732,12 @@ module SeatsChart
|
|
|
616
732
|
end
|
|
617
733
|
|
|
618
734
|
# Chart report by category (CSV)
|
|
619
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
735
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
620
736
|
# @param chart_id [String]
|
|
621
737
|
# @param [Hash] opts the optional parameters
|
|
622
738
|
# @option opts [String] :category Only this category bucket.
|
|
623
739
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
740
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
624
741
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
625
742
|
def get_api_charts_by_chart_id_reports_by_category_csv_with_http_info(chart_id, opts = {})
|
|
626
743
|
if @api_client.config.debugging
|
|
@@ -647,6 +764,10 @@ module SeatsChart
|
|
|
647
764
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
648
765
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
649
766
|
end
|
|
767
|
+
allowable_values = ["true", "false", "chart"]
|
|
768
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
769
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
770
|
+
end
|
|
650
771
|
# resource path
|
|
651
772
|
local_var_path = '/api/charts/{chartId}/reports/by-category.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
652
773
|
|
|
@@ -654,6 +775,7 @@ module SeatsChart
|
|
|
654
775
|
query_params = opts[:query_params] || {}
|
|
655
776
|
query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
|
|
656
777
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
778
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
657
779
|
|
|
658
780
|
# header parameters
|
|
659
781
|
header_params = opts[:header_params] || {}
|
|
@@ -688,11 +810,12 @@ module SeatsChart
|
|
|
688
810
|
end
|
|
689
811
|
|
|
690
812
|
# Chart report by category
|
|
691
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
813
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
692
814
|
# @param chart_id [String]
|
|
693
815
|
# @param [Hash] opts the optional parameters
|
|
694
816
|
# @option opts [String] :category Only this category bucket.
|
|
695
817
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
818
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
696
819
|
# @return [nil]
|
|
697
820
|
def get_api_charts_by_chart_id_reports_by_category_json(chart_id, opts = {})
|
|
698
821
|
get_api_charts_by_chart_id_reports_by_category_json_with_http_info(chart_id, opts)
|
|
@@ -700,11 +823,12 @@ module SeatsChart
|
|
|
700
823
|
end
|
|
701
824
|
|
|
702
825
|
# Chart report by category
|
|
703
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
826
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
704
827
|
# @param chart_id [String]
|
|
705
828
|
# @param [Hash] opts the optional parameters
|
|
706
829
|
# @option opts [String] :category Only this category bucket.
|
|
707
830
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
831
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
708
832
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
709
833
|
def get_api_charts_by_chart_id_reports_by_category_json_with_http_info(chart_id, opts = {})
|
|
710
834
|
if @api_client.config.debugging
|
|
@@ -731,6 +855,10 @@ module SeatsChart
|
|
|
731
855
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
732
856
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
733
857
|
end
|
|
858
|
+
allowable_values = ["true", "false", "chart"]
|
|
859
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
860
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
861
|
+
end
|
|
734
862
|
# resource path
|
|
735
863
|
local_var_path = '/api/charts/{chartId}/reports/by-category.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
736
864
|
|
|
@@ -738,6 +866,7 @@ module SeatsChart
|
|
|
738
866
|
query_params = opts[:query_params] || {}
|
|
739
867
|
query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
|
|
740
868
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
869
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
741
870
|
|
|
742
871
|
# header parameters
|
|
743
872
|
header_params = opts[:header_params] || {}
|
|
@@ -772,11 +901,12 @@ module SeatsChart
|
|
|
772
901
|
end
|
|
773
902
|
|
|
774
903
|
# Chart report by category key (CSV)
|
|
775
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
904
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
776
905
|
# @param chart_id [String]
|
|
777
906
|
# @param [Hash] opts the optional parameters
|
|
778
907
|
# @option opts [String] :category_key Only this categoryKey bucket.
|
|
779
908
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
909
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
780
910
|
# @return [nil]
|
|
781
911
|
def get_api_charts_by_chart_id_reports_by_category_key_csv(chart_id, opts = {})
|
|
782
912
|
get_api_charts_by_chart_id_reports_by_category_key_csv_with_http_info(chart_id, opts)
|
|
@@ -784,11 +914,12 @@ module SeatsChart
|
|
|
784
914
|
end
|
|
785
915
|
|
|
786
916
|
# Chart report by category key (CSV)
|
|
787
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
917
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
788
918
|
# @param chart_id [String]
|
|
789
919
|
# @param [Hash] opts the optional parameters
|
|
790
920
|
# @option opts [String] :category_key Only this categoryKey bucket.
|
|
791
921
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
922
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
792
923
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
793
924
|
def get_api_charts_by_chart_id_reports_by_category_key_csv_with_http_info(chart_id, opts = {})
|
|
794
925
|
if @api_client.config.debugging
|
|
@@ -815,6 +946,10 @@ module SeatsChart
|
|
|
815
946
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
816
947
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
817
948
|
end
|
|
949
|
+
allowable_values = ["true", "false", "chart"]
|
|
950
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
951
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
952
|
+
end
|
|
818
953
|
# resource path
|
|
819
954
|
local_var_path = '/api/charts/{chartId}/reports/by-category-key.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
820
955
|
|
|
@@ -822,6 +957,7 @@ module SeatsChart
|
|
|
822
957
|
query_params = opts[:query_params] || {}
|
|
823
958
|
query_params[:'categoryKey'] = opts[:'category_key'] if !opts[:'category_key'].nil?
|
|
824
959
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
960
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
825
961
|
|
|
826
962
|
# header parameters
|
|
827
963
|
header_params = opts[:header_params] || {}
|
|
@@ -856,11 +992,12 @@ module SeatsChart
|
|
|
856
992
|
end
|
|
857
993
|
|
|
858
994
|
# Chart report by category key
|
|
859
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
995
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
860
996
|
# @param chart_id [String]
|
|
861
997
|
# @param [Hash] opts the optional parameters
|
|
862
998
|
# @option opts [String] :category_key Only this categoryKey bucket.
|
|
863
999
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1000
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
864
1001
|
# @return [nil]
|
|
865
1002
|
def get_api_charts_by_chart_id_reports_by_category_key_json(chart_id, opts = {})
|
|
866
1003
|
get_api_charts_by_chart_id_reports_by_category_key_json_with_http_info(chart_id, opts)
|
|
@@ -868,11 +1005,12 @@ module SeatsChart
|
|
|
868
1005
|
end
|
|
869
1006
|
|
|
870
1007
|
# Chart report by category key
|
|
871
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1008
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
872
1009
|
# @param chart_id [String]
|
|
873
1010
|
# @param [Hash] opts the optional parameters
|
|
874
1011
|
# @option opts [String] :category_key Only this categoryKey bucket.
|
|
875
1012
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1013
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
876
1014
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
877
1015
|
def get_api_charts_by_chart_id_reports_by_category_key_json_with_http_info(chart_id, opts = {})
|
|
878
1016
|
if @api_client.config.debugging
|
|
@@ -899,6 +1037,10 @@ module SeatsChart
|
|
|
899
1037
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
900
1038
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
901
1039
|
end
|
|
1040
|
+
allowable_values = ["true", "false", "chart"]
|
|
1041
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1042
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1043
|
+
end
|
|
902
1044
|
# resource path
|
|
903
1045
|
local_var_path = '/api/charts/{chartId}/reports/by-category-key.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
904
1046
|
|
|
@@ -906,6 +1048,7 @@ module SeatsChart
|
|
|
906
1048
|
query_params = opts[:query_params] || {}
|
|
907
1049
|
query_params[:'categoryKey'] = opts[:'category_key'] if !opts[:'category_key'].nil?
|
|
908
1050
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1051
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
909
1052
|
|
|
910
1053
|
# header parameters
|
|
911
1054
|
header_params = opts[:header_params] || {}
|
|
@@ -940,11 +1083,12 @@ module SeatsChart
|
|
|
940
1083
|
end
|
|
941
1084
|
|
|
942
1085
|
# Chart report by category label (CSV)
|
|
943
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1086
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
944
1087
|
# @param chart_id [String]
|
|
945
1088
|
# @param [Hash] opts the optional parameters
|
|
946
1089
|
# @option opts [String] :category_label Only this categoryLabel bucket.
|
|
947
1090
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1091
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
948
1092
|
# @return [nil]
|
|
949
1093
|
def get_api_charts_by_chart_id_reports_by_category_label_csv(chart_id, opts = {})
|
|
950
1094
|
get_api_charts_by_chart_id_reports_by_category_label_csv_with_http_info(chart_id, opts)
|
|
@@ -952,11 +1096,12 @@ module SeatsChart
|
|
|
952
1096
|
end
|
|
953
1097
|
|
|
954
1098
|
# Chart report by category label (CSV)
|
|
955
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1099
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
956
1100
|
# @param chart_id [String]
|
|
957
1101
|
# @param [Hash] opts the optional parameters
|
|
958
1102
|
# @option opts [String] :category_label Only this categoryLabel bucket.
|
|
959
1103
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1104
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
960
1105
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
961
1106
|
def get_api_charts_by_chart_id_reports_by_category_label_csv_with_http_info(chart_id, opts = {})
|
|
962
1107
|
if @api_client.config.debugging
|
|
@@ -983,6 +1128,10 @@ module SeatsChart
|
|
|
983
1128
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
984
1129
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
985
1130
|
end
|
|
1131
|
+
allowable_values = ["true", "false", "chart"]
|
|
1132
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1133
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1134
|
+
end
|
|
986
1135
|
# resource path
|
|
987
1136
|
local_var_path = '/api/charts/{chartId}/reports/by-category-label.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
988
1137
|
|
|
@@ -990,6 +1139,7 @@ module SeatsChart
|
|
|
990
1139
|
query_params = opts[:query_params] || {}
|
|
991
1140
|
query_params[:'categoryLabel'] = opts[:'category_label'] if !opts[:'category_label'].nil?
|
|
992
1141
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1142
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
993
1143
|
|
|
994
1144
|
# header parameters
|
|
995
1145
|
header_params = opts[:header_params] || {}
|
|
@@ -1024,11 +1174,12 @@ module SeatsChart
|
|
|
1024
1174
|
end
|
|
1025
1175
|
|
|
1026
1176
|
# Chart report by category label
|
|
1027
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1177
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1028
1178
|
# @param chart_id [String]
|
|
1029
1179
|
# @param [Hash] opts the optional parameters
|
|
1030
1180
|
# @option opts [String] :category_label Only this categoryLabel bucket.
|
|
1031
1181
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1182
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1032
1183
|
# @return [nil]
|
|
1033
1184
|
def get_api_charts_by_chart_id_reports_by_category_label_json(chart_id, opts = {})
|
|
1034
1185
|
get_api_charts_by_chart_id_reports_by_category_label_json_with_http_info(chart_id, opts)
|
|
@@ -1036,11 +1187,12 @@ module SeatsChart
|
|
|
1036
1187
|
end
|
|
1037
1188
|
|
|
1038
1189
|
# Chart report by category label
|
|
1039
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1190
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1040
1191
|
# @param chart_id [String]
|
|
1041
1192
|
# @param [Hash] opts the optional parameters
|
|
1042
1193
|
# @option opts [String] :category_label Only this categoryLabel bucket.
|
|
1043
1194
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1195
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1044
1196
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1045
1197
|
def get_api_charts_by_chart_id_reports_by_category_label_json_with_http_info(chart_id, opts = {})
|
|
1046
1198
|
if @api_client.config.debugging
|
|
@@ -1067,6 +1219,10 @@ module SeatsChart
|
|
|
1067
1219
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1068
1220
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1069
1221
|
end
|
|
1222
|
+
allowable_values = ["true", "false", "chart"]
|
|
1223
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1224
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1225
|
+
end
|
|
1070
1226
|
# resource path
|
|
1071
1227
|
local_var_path = '/api/charts/{chartId}/reports/by-category-label.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1072
1228
|
|
|
@@ -1074,6 +1230,7 @@ module SeatsChart
|
|
|
1074
1230
|
query_params = opts[:query_params] || {}
|
|
1075
1231
|
query_params[:'categoryLabel'] = opts[:'category_label'] if !opts[:'category_label'].nil?
|
|
1076
1232
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1233
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1077
1234
|
|
|
1078
1235
|
# header parameters
|
|
1079
1236
|
header_params = opts[:header_params] || {}
|
|
@@ -1108,11 +1265,12 @@ module SeatsChart
|
|
|
1108
1265
|
end
|
|
1109
1266
|
|
|
1110
1267
|
# Chart report by label (CSV)
|
|
1111
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1268
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1112
1269
|
# @param chart_id [String]
|
|
1113
1270
|
# @param [Hash] opts the optional parameters
|
|
1114
1271
|
# @option opts [String] :label Only this label bucket.
|
|
1115
1272
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1273
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1116
1274
|
# @return [nil]
|
|
1117
1275
|
def get_api_charts_by_chart_id_reports_by_label_csv(chart_id, opts = {})
|
|
1118
1276
|
get_api_charts_by_chart_id_reports_by_label_csv_with_http_info(chart_id, opts)
|
|
@@ -1120,11 +1278,12 @@ module SeatsChart
|
|
|
1120
1278
|
end
|
|
1121
1279
|
|
|
1122
1280
|
# Chart report by label (CSV)
|
|
1123
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1281
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1124
1282
|
# @param chart_id [String]
|
|
1125
1283
|
# @param [Hash] opts the optional parameters
|
|
1126
1284
|
# @option opts [String] :label Only this label bucket.
|
|
1127
1285
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1286
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1128
1287
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1129
1288
|
def get_api_charts_by_chart_id_reports_by_label_csv_with_http_info(chart_id, opts = {})
|
|
1130
1289
|
if @api_client.config.debugging
|
|
@@ -1151,6 +1310,10 @@ module SeatsChart
|
|
|
1151
1310
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1152
1311
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1153
1312
|
end
|
|
1313
|
+
allowable_values = ["true", "false", "chart"]
|
|
1314
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1315
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1316
|
+
end
|
|
1154
1317
|
# resource path
|
|
1155
1318
|
local_var_path = '/api/charts/{chartId}/reports/by-label.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1156
1319
|
|
|
@@ -1158,6 +1321,7 @@ module SeatsChart
|
|
|
1158
1321
|
query_params = opts[:query_params] || {}
|
|
1159
1322
|
query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?
|
|
1160
1323
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1324
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1161
1325
|
|
|
1162
1326
|
# header parameters
|
|
1163
1327
|
header_params = opts[:header_params] || {}
|
|
@@ -1192,11 +1356,12 @@ module SeatsChart
|
|
|
1192
1356
|
end
|
|
1193
1357
|
|
|
1194
1358
|
# Chart report by label
|
|
1195
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1359
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1196
1360
|
# @param chart_id [String]
|
|
1197
1361
|
# @param [Hash] opts the optional parameters
|
|
1198
1362
|
# @option opts [String] :label Only this label bucket.
|
|
1199
1363
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1364
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1200
1365
|
# @return [nil]
|
|
1201
1366
|
def get_api_charts_by_chart_id_reports_by_label_json(chart_id, opts = {})
|
|
1202
1367
|
get_api_charts_by_chart_id_reports_by_label_json_with_http_info(chart_id, opts)
|
|
@@ -1204,11 +1369,12 @@ module SeatsChart
|
|
|
1204
1369
|
end
|
|
1205
1370
|
|
|
1206
1371
|
# Chart report by label
|
|
1207
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1372
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1208
1373
|
# @param chart_id [String]
|
|
1209
1374
|
# @param [Hash] opts the optional parameters
|
|
1210
1375
|
# @option opts [String] :label Only this label bucket.
|
|
1211
1376
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1377
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1212
1378
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1213
1379
|
def get_api_charts_by_chart_id_reports_by_label_json_with_http_info(chart_id, opts = {})
|
|
1214
1380
|
if @api_client.config.debugging
|
|
@@ -1235,6 +1401,10 @@ module SeatsChart
|
|
|
1235
1401
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1236
1402
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1237
1403
|
end
|
|
1404
|
+
allowable_values = ["true", "false", "chart"]
|
|
1405
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1406
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1407
|
+
end
|
|
1238
1408
|
# resource path
|
|
1239
1409
|
local_var_path = '/api/charts/{chartId}/reports/by-label.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1240
1410
|
|
|
@@ -1242,6 +1412,7 @@ module SeatsChart
|
|
|
1242
1412
|
query_params = opts[:query_params] || {}
|
|
1243
1413
|
query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?
|
|
1244
1414
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1415
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1245
1416
|
|
|
1246
1417
|
# header parameters
|
|
1247
1418
|
header_params = opts[:header_params] || {}
|
|
@@ -1276,11 +1447,12 @@ module SeatsChart
|
|
|
1276
1447
|
end
|
|
1277
1448
|
|
|
1278
1449
|
# Chart report by object type (CSV)
|
|
1279
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1450
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1280
1451
|
# @param chart_id [String]
|
|
1281
1452
|
# @param [Hash] opts the optional parameters
|
|
1282
1453
|
# @option opts [String] :object_type Only this objectType bucket.
|
|
1283
1454
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1455
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1284
1456
|
# @return [nil]
|
|
1285
1457
|
def get_api_charts_by_chart_id_reports_by_object_type_csv(chart_id, opts = {})
|
|
1286
1458
|
get_api_charts_by_chart_id_reports_by_object_type_csv_with_http_info(chart_id, opts)
|
|
@@ -1288,11 +1460,12 @@ module SeatsChart
|
|
|
1288
1460
|
end
|
|
1289
1461
|
|
|
1290
1462
|
# Chart report by object type (CSV)
|
|
1291
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1463
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1292
1464
|
# @param chart_id [String]
|
|
1293
1465
|
# @param [Hash] opts the optional parameters
|
|
1294
1466
|
# @option opts [String] :object_type Only this objectType bucket.
|
|
1295
1467
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1468
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1296
1469
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1297
1470
|
def get_api_charts_by_chart_id_reports_by_object_type_csv_with_http_info(chart_id, opts = {})
|
|
1298
1471
|
if @api_client.config.debugging
|
|
@@ -1319,6 +1492,10 @@ module SeatsChart
|
|
|
1319
1492
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1320
1493
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1321
1494
|
end
|
|
1495
|
+
allowable_values = ["true", "false", "chart"]
|
|
1496
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1497
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1498
|
+
end
|
|
1322
1499
|
# resource path
|
|
1323
1500
|
local_var_path = '/api/charts/{chartId}/reports/by-object-type.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1324
1501
|
|
|
@@ -1326,6 +1503,7 @@ module SeatsChart
|
|
|
1326
1503
|
query_params = opts[:query_params] || {}
|
|
1327
1504
|
query_params[:'objectType'] = opts[:'object_type'] if !opts[:'object_type'].nil?
|
|
1328
1505
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1506
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1329
1507
|
|
|
1330
1508
|
# header parameters
|
|
1331
1509
|
header_params = opts[:header_params] || {}
|
|
@@ -1360,11 +1538,12 @@ module SeatsChart
|
|
|
1360
1538
|
end
|
|
1361
1539
|
|
|
1362
1540
|
# Chart report by object type
|
|
1363
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1541
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1364
1542
|
# @param chart_id [String]
|
|
1365
1543
|
# @param [Hash] opts the optional parameters
|
|
1366
1544
|
# @option opts [String] :object_type Only this objectType bucket.
|
|
1367
1545
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1546
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1368
1547
|
# @return [nil]
|
|
1369
1548
|
def get_api_charts_by_chart_id_reports_by_object_type_json(chart_id, opts = {})
|
|
1370
1549
|
get_api_charts_by_chart_id_reports_by_object_type_json_with_http_info(chart_id, opts)
|
|
@@ -1372,11 +1551,12 @@ module SeatsChart
|
|
|
1372
1551
|
end
|
|
1373
1552
|
|
|
1374
1553
|
# Chart report by object type
|
|
1375
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1554
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1376
1555
|
# @param chart_id [String]
|
|
1377
1556
|
# @param [Hash] opts the optional parameters
|
|
1378
1557
|
# @option opts [String] :object_type Only this objectType bucket.
|
|
1379
1558
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1559
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1380
1560
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1381
1561
|
def get_api_charts_by_chart_id_reports_by_object_type_json_with_http_info(chart_id, opts = {})
|
|
1382
1562
|
if @api_client.config.debugging
|
|
@@ -1403,6 +1583,10 @@ module SeatsChart
|
|
|
1403
1583
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1404
1584
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1405
1585
|
end
|
|
1586
|
+
allowable_values = ["true", "false", "chart"]
|
|
1587
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1588
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1589
|
+
end
|
|
1406
1590
|
# resource path
|
|
1407
1591
|
local_var_path = '/api/charts/{chartId}/reports/by-object-type.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1408
1592
|
|
|
@@ -1410,6 +1594,7 @@ module SeatsChart
|
|
|
1410
1594
|
query_params = opts[:query_params] || {}
|
|
1411
1595
|
query_params[:'objectType'] = opts[:'object_type'] if !opts[:'object_type'].nil?
|
|
1412
1596
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1597
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1413
1598
|
|
|
1414
1599
|
# header parameters
|
|
1415
1600
|
header_params = opts[:header_params] || {}
|
|
@@ -1444,11 +1629,12 @@ module SeatsChart
|
|
|
1444
1629
|
end
|
|
1445
1630
|
|
|
1446
1631
|
# Chart report by section (CSV)
|
|
1447
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1632
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1448
1633
|
# @param chart_id [String]
|
|
1449
1634
|
# @param [Hash] opts the optional parameters
|
|
1450
1635
|
# @option opts [String] :section Only this section bucket.
|
|
1451
1636
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1637
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1452
1638
|
# @return [nil]
|
|
1453
1639
|
def get_api_charts_by_chart_id_reports_by_section_csv(chart_id, opts = {})
|
|
1454
1640
|
get_api_charts_by_chart_id_reports_by_section_csv_with_http_info(chart_id, opts)
|
|
@@ -1456,11 +1642,12 @@ module SeatsChart
|
|
|
1456
1642
|
end
|
|
1457
1643
|
|
|
1458
1644
|
# Chart report by section (CSV)
|
|
1459
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1645
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1460
1646
|
# @param chart_id [String]
|
|
1461
1647
|
# @param [Hash] opts the optional parameters
|
|
1462
1648
|
# @option opts [String] :section Only this section bucket.
|
|
1463
1649
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1650
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1464
1651
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1465
1652
|
def get_api_charts_by_chart_id_reports_by_section_csv_with_http_info(chart_id, opts = {})
|
|
1466
1653
|
if @api_client.config.debugging
|
|
@@ -1487,6 +1674,10 @@ module SeatsChart
|
|
|
1487
1674
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1488
1675
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1489
1676
|
end
|
|
1677
|
+
allowable_values = ["true", "false", "chart"]
|
|
1678
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1679
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1680
|
+
end
|
|
1490
1681
|
# resource path
|
|
1491
1682
|
local_var_path = '/api/charts/{chartId}/reports/by-section.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1492
1683
|
|
|
@@ -1494,6 +1685,7 @@ module SeatsChart
|
|
|
1494
1685
|
query_params = opts[:query_params] || {}
|
|
1495
1686
|
query_params[:'section'] = opts[:'section'] if !opts[:'section'].nil?
|
|
1496
1687
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1688
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1497
1689
|
|
|
1498
1690
|
# header parameters
|
|
1499
1691
|
header_params = opts[:header_params] || {}
|
|
@@ -1528,11 +1720,12 @@ module SeatsChart
|
|
|
1528
1720
|
end
|
|
1529
1721
|
|
|
1530
1722
|
# Chart report by section
|
|
1531
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1723
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1532
1724
|
# @param chart_id [String]
|
|
1533
1725
|
# @param [Hash] opts the optional parameters
|
|
1534
1726
|
# @option opts [String] :section Only this section bucket.
|
|
1535
1727
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1728
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1536
1729
|
# @return [nil]
|
|
1537
1730
|
def get_api_charts_by_chart_id_reports_by_section_json(chart_id, opts = {})
|
|
1538
1731
|
get_api_charts_by_chart_id_reports_by_section_json_with_http_info(chart_id, opts)
|
|
@@ -1540,11 +1733,12 @@ module SeatsChart
|
|
|
1540
1733
|
end
|
|
1541
1734
|
|
|
1542
1735
|
# Chart report by section
|
|
1543
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1736
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1544
1737
|
# @param chart_id [String]
|
|
1545
1738
|
# @param [Hash] opts the optional parameters
|
|
1546
1739
|
# @option opts [String] :section Only this section bucket.
|
|
1547
1740
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1741
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1548
1742
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1549
1743
|
def get_api_charts_by_chart_id_reports_by_section_json_with_http_info(chart_id, opts = {})
|
|
1550
1744
|
if @api_client.config.debugging
|
|
@@ -1571,6 +1765,10 @@ module SeatsChart
|
|
|
1571
1765
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1572
1766
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1573
1767
|
end
|
|
1768
|
+
allowable_values = ["true", "false", "chart"]
|
|
1769
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1770
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1771
|
+
end
|
|
1574
1772
|
# resource path
|
|
1575
1773
|
local_var_path = '/api/charts/{chartId}/reports/by-section.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1576
1774
|
|
|
@@ -1578,6 +1776,7 @@ module SeatsChart
|
|
|
1578
1776
|
query_params = opts[:query_params] || {}
|
|
1579
1777
|
query_params[:'section'] = opts[:'section'] if !opts[:'section'].nil?
|
|
1580
1778
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1779
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1581
1780
|
|
|
1582
1781
|
# header parameters
|
|
1583
1782
|
header_params = opts[:header_params] || {}
|
|
@@ -1612,11 +1811,12 @@ module SeatsChart
|
|
|
1612
1811
|
end
|
|
1613
1812
|
|
|
1614
1813
|
# Chart report by zone (CSV)
|
|
1615
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1814
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1616
1815
|
# @param chart_id [String]
|
|
1617
1816
|
# @param [Hash] opts the optional parameters
|
|
1618
1817
|
# @option opts [String] :zone Only this zone bucket.
|
|
1619
1818
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1819
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1620
1820
|
# @return [nil]
|
|
1621
1821
|
def get_api_charts_by_chart_id_reports_by_zone_csv(chart_id, opts = {})
|
|
1622
1822
|
get_api_charts_by_chart_id_reports_by_zone_csv_with_http_info(chart_id, opts)
|
|
@@ -1624,11 +1824,12 @@ module SeatsChart
|
|
|
1624
1824
|
end
|
|
1625
1825
|
|
|
1626
1826
|
# Chart report by zone (CSV)
|
|
1627
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1827
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1628
1828
|
# @param chart_id [String]
|
|
1629
1829
|
# @param [Hash] opts the optional parameters
|
|
1630
1830
|
# @option opts [String] :zone Only this zone bucket.
|
|
1631
1831
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1832
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1632
1833
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1633
1834
|
def get_api_charts_by_chart_id_reports_by_zone_csv_with_http_info(chart_id, opts = {})
|
|
1634
1835
|
if @api_client.config.debugging
|
|
@@ -1655,6 +1856,10 @@ module SeatsChart
|
|
|
1655
1856
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1656
1857
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1657
1858
|
end
|
|
1859
|
+
allowable_values = ["true", "false", "chart"]
|
|
1860
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1861
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1862
|
+
end
|
|
1658
1863
|
# resource path
|
|
1659
1864
|
local_var_path = '/api/charts/{chartId}/reports/by-zone.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1660
1865
|
|
|
@@ -1662,6 +1867,7 @@ module SeatsChart
|
|
|
1662
1867
|
query_params = opts[:query_params] || {}
|
|
1663
1868
|
query_params[:'zone'] = opts[:'zone'] if !opts[:'zone'].nil?
|
|
1664
1869
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1870
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1665
1871
|
|
|
1666
1872
|
# header parameters
|
|
1667
1873
|
header_params = opts[:header_params] || {}
|
|
@@ -1696,11 +1902,12 @@ module SeatsChart
|
|
|
1696
1902
|
end
|
|
1697
1903
|
|
|
1698
1904
|
# Chart report by zone
|
|
1699
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1905
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1700
1906
|
# @param chart_id [String]
|
|
1701
1907
|
# @param [Hash] opts the optional parameters
|
|
1702
1908
|
# @option opts [String] :zone Only this zone bucket.
|
|
1703
1909
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1910
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1704
1911
|
# @return [nil]
|
|
1705
1912
|
def get_api_charts_by_chart_id_reports_by_zone_json(chart_id, opts = {})
|
|
1706
1913
|
get_api_charts_by_chart_id_reports_by_zone_json_with_http_info(chart_id, opts)
|
|
@@ -1708,11 +1915,12 @@ module SeatsChart
|
|
|
1708
1915
|
end
|
|
1709
1916
|
|
|
1710
1917
|
# Chart report by zone
|
|
1711
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1918
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1712
1919
|
# @param chart_id [String]
|
|
1713
1920
|
# @param [Hash] opts the optional parameters
|
|
1714
1921
|
# @option opts [String] :zone Only this zone bucket.
|
|
1715
1922
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
1923
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1716
1924
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1717
1925
|
def get_api_charts_by_chart_id_reports_by_zone_json_with_http_info(chart_id, opts = {})
|
|
1718
1926
|
if @api_client.config.debugging
|
|
@@ -1739,6 +1947,10 @@ module SeatsChart
|
|
|
1739
1947
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1740
1948
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1741
1949
|
end
|
|
1950
|
+
allowable_values = ["true", "false", "chart"]
|
|
1951
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
1952
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
1953
|
+
end
|
|
1742
1954
|
# resource path
|
|
1743
1955
|
local_var_path = '/api/charts/{chartId}/reports/by-zone.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1744
1956
|
|
|
@@ -1746,6 +1958,7 @@ module SeatsChart
|
|
|
1746
1958
|
query_params = opts[:query_params] || {}
|
|
1747
1959
|
query_params[:'zone'] = opts[:'zone'] if !opts[:'zone'].nil?
|
|
1748
1960
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
1961
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1749
1962
|
|
|
1750
1963
|
# header parameters
|
|
1751
1964
|
header_params = opts[:header_params] || {}
|
|
@@ -1780,10 +1993,11 @@ module SeatsChart
|
|
|
1780
1993
|
end
|
|
1781
1994
|
|
|
1782
1995
|
# Chart summary by category (CSV)
|
|
1783
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1996
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1784
1997
|
# @param chart_id [String]
|
|
1785
1998
|
# @param [Hash] opts the optional parameters
|
|
1786
1999
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2000
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1787
2001
|
# @return [nil]
|
|
1788
2002
|
def get_api_charts_by_chart_id_reports_summary_by_category_csv(chart_id, opts = {})
|
|
1789
2003
|
get_api_charts_by_chart_id_reports_summary_by_category_csv_with_http_info(chart_id, opts)
|
|
@@ -1791,10 +2005,11 @@ module SeatsChart
|
|
|
1791
2005
|
end
|
|
1792
2006
|
|
|
1793
2007
|
# Chart summary by category (CSV)
|
|
1794
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2008
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1795
2009
|
# @param chart_id [String]
|
|
1796
2010
|
# @param [Hash] opts the optional parameters
|
|
1797
2011
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2012
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1798
2013
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1799
2014
|
def get_api_charts_by_chart_id_reports_summary_by_category_csv_with_http_info(chart_id, opts = {})
|
|
1800
2015
|
if @api_client.config.debugging
|
|
@@ -1813,12 +2028,17 @@ module SeatsChart
|
|
|
1813
2028
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1814
2029
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1815
2030
|
end
|
|
2031
|
+
allowable_values = ["true", "false", "chart"]
|
|
2032
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2033
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2034
|
+
end
|
|
1816
2035
|
# resource path
|
|
1817
2036
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1818
2037
|
|
|
1819
2038
|
# query parameters
|
|
1820
2039
|
query_params = opts[:query_params] || {}
|
|
1821
2040
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2041
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1822
2042
|
|
|
1823
2043
|
# header parameters
|
|
1824
2044
|
header_params = opts[:header_params] || {}
|
|
@@ -1853,10 +2073,11 @@ module SeatsChart
|
|
|
1853
2073
|
end
|
|
1854
2074
|
|
|
1855
2075
|
# Chart summary by category
|
|
1856
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2076
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1857
2077
|
# @param chart_id [String]
|
|
1858
2078
|
# @param [Hash] opts the optional parameters
|
|
1859
2079
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2080
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1860
2081
|
# @return [nil]
|
|
1861
2082
|
def get_api_charts_by_chart_id_reports_summary_by_category_json(chart_id, opts = {})
|
|
1862
2083
|
get_api_charts_by_chart_id_reports_summary_by_category_json_with_http_info(chart_id, opts)
|
|
@@ -1864,10 +2085,11 @@ module SeatsChart
|
|
|
1864
2085
|
end
|
|
1865
2086
|
|
|
1866
2087
|
# Chart summary by category
|
|
1867
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2088
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1868
2089
|
# @param chart_id [String]
|
|
1869
2090
|
# @param [Hash] opts the optional parameters
|
|
1870
2091
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2092
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1871
2093
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1872
2094
|
def get_api_charts_by_chart_id_reports_summary_by_category_json_with_http_info(chart_id, opts = {})
|
|
1873
2095
|
if @api_client.config.debugging
|
|
@@ -1886,12 +2108,17 @@ module SeatsChart
|
|
|
1886
2108
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1887
2109
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1888
2110
|
end
|
|
2111
|
+
allowable_values = ["true", "false", "chart"]
|
|
2112
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2113
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2114
|
+
end
|
|
1889
2115
|
# resource path
|
|
1890
2116
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1891
2117
|
|
|
1892
2118
|
# query parameters
|
|
1893
2119
|
query_params = opts[:query_params] || {}
|
|
1894
2120
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2121
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1895
2122
|
|
|
1896
2123
|
# header parameters
|
|
1897
2124
|
header_params = opts[:header_params] || {}
|
|
@@ -1926,10 +2153,11 @@ module SeatsChart
|
|
|
1926
2153
|
end
|
|
1927
2154
|
|
|
1928
2155
|
# Chart summary by category key (CSV)
|
|
1929
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2156
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1930
2157
|
# @param chart_id [String]
|
|
1931
2158
|
# @param [Hash] opts the optional parameters
|
|
1932
2159
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2160
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1933
2161
|
# @return [nil]
|
|
1934
2162
|
def get_api_charts_by_chart_id_reports_summary_by_category_key_csv(chart_id, opts = {})
|
|
1935
2163
|
get_api_charts_by_chart_id_reports_summary_by_category_key_csv_with_http_info(chart_id, opts)
|
|
@@ -1937,10 +2165,11 @@ module SeatsChart
|
|
|
1937
2165
|
end
|
|
1938
2166
|
|
|
1939
2167
|
# Chart summary by category key (CSV)
|
|
1940
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2168
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
1941
2169
|
# @param chart_id [String]
|
|
1942
2170
|
# @param [Hash] opts the optional parameters
|
|
1943
2171
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2172
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
1944
2173
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
1945
2174
|
def get_api_charts_by_chart_id_reports_summary_by_category_key_csv_with_http_info(chart_id, opts = {})
|
|
1946
2175
|
if @api_client.config.debugging
|
|
@@ -1959,12 +2188,17 @@ module SeatsChart
|
|
|
1959
2188
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
1960
2189
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
1961
2190
|
end
|
|
2191
|
+
allowable_values = ["true", "false", "chart"]
|
|
2192
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2193
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2194
|
+
end
|
|
1962
2195
|
# resource path
|
|
1963
2196
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category-key.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
1964
2197
|
|
|
1965
2198
|
# query parameters
|
|
1966
2199
|
query_params = opts[:query_params] || {}
|
|
1967
2200
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2201
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
1968
2202
|
|
|
1969
2203
|
# header parameters
|
|
1970
2204
|
header_params = opts[:header_params] || {}
|
|
@@ -1999,10 +2233,11 @@ module SeatsChart
|
|
|
1999
2233
|
end
|
|
2000
2234
|
|
|
2001
2235
|
# Chart summary by category key
|
|
2002
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2236
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2003
2237
|
# @param chart_id [String]
|
|
2004
2238
|
# @param [Hash] opts the optional parameters
|
|
2005
2239
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2240
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2006
2241
|
# @return [nil]
|
|
2007
2242
|
def get_api_charts_by_chart_id_reports_summary_by_category_key_json(chart_id, opts = {})
|
|
2008
2243
|
get_api_charts_by_chart_id_reports_summary_by_category_key_json_with_http_info(chart_id, opts)
|
|
@@ -2010,10 +2245,11 @@ module SeatsChart
|
|
|
2010
2245
|
end
|
|
2011
2246
|
|
|
2012
2247
|
# Chart summary by category key
|
|
2013
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2248
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2014
2249
|
# @param chart_id [String]
|
|
2015
2250
|
# @param [Hash] opts the optional parameters
|
|
2016
2251
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2252
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2017
2253
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2018
2254
|
def get_api_charts_by_chart_id_reports_summary_by_category_key_json_with_http_info(chart_id, opts = {})
|
|
2019
2255
|
if @api_client.config.debugging
|
|
@@ -2032,12 +2268,17 @@ module SeatsChart
|
|
|
2032
2268
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2033
2269
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2034
2270
|
end
|
|
2271
|
+
allowable_values = ["true", "false", "chart"]
|
|
2272
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2273
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2274
|
+
end
|
|
2035
2275
|
# resource path
|
|
2036
2276
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category-key.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2037
2277
|
|
|
2038
2278
|
# query parameters
|
|
2039
2279
|
query_params = opts[:query_params] || {}
|
|
2040
2280
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2281
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2041
2282
|
|
|
2042
2283
|
# header parameters
|
|
2043
2284
|
header_params = opts[:header_params] || {}
|
|
@@ -2072,10 +2313,11 @@ module SeatsChart
|
|
|
2072
2313
|
end
|
|
2073
2314
|
|
|
2074
2315
|
# Chart summary by category label (CSV)
|
|
2075
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2316
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2076
2317
|
# @param chart_id [String]
|
|
2077
2318
|
# @param [Hash] opts the optional parameters
|
|
2078
2319
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2320
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2079
2321
|
# @return [nil]
|
|
2080
2322
|
def get_api_charts_by_chart_id_reports_summary_by_category_label_csv(chart_id, opts = {})
|
|
2081
2323
|
get_api_charts_by_chart_id_reports_summary_by_category_label_csv_with_http_info(chart_id, opts)
|
|
@@ -2083,10 +2325,11 @@ module SeatsChart
|
|
|
2083
2325
|
end
|
|
2084
2326
|
|
|
2085
2327
|
# Chart summary by category label (CSV)
|
|
2086
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2328
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2087
2329
|
# @param chart_id [String]
|
|
2088
2330
|
# @param [Hash] opts the optional parameters
|
|
2089
2331
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2332
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2090
2333
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2091
2334
|
def get_api_charts_by_chart_id_reports_summary_by_category_label_csv_with_http_info(chart_id, opts = {})
|
|
2092
2335
|
if @api_client.config.debugging
|
|
@@ -2105,12 +2348,17 @@ module SeatsChart
|
|
|
2105
2348
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2106
2349
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2107
2350
|
end
|
|
2351
|
+
allowable_values = ["true", "false", "chart"]
|
|
2352
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2353
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2354
|
+
end
|
|
2108
2355
|
# resource path
|
|
2109
2356
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category-label.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2110
2357
|
|
|
2111
2358
|
# query parameters
|
|
2112
2359
|
query_params = opts[:query_params] || {}
|
|
2113
2360
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2361
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2114
2362
|
|
|
2115
2363
|
# header parameters
|
|
2116
2364
|
header_params = opts[:header_params] || {}
|
|
@@ -2145,10 +2393,11 @@ module SeatsChart
|
|
|
2145
2393
|
end
|
|
2146
2394
|
|
|
2147
2395
|
# Chart summary by category label
|
|
2148
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2396
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2149
2397
|
# @param chart_id [String]
|
|
2150
2398
|
# @param [Hash] opts the optional parameters
|
|
2151
2399
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2400
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2152
2401
|
# @return [nil]
|
|
2153
2402
|
def get_api_charts_by_chart_id_reports_summary_by_category_label_json(chart_id, opts = {})
|
|
2154
2403
|
get_api_charts_by_chart_id_reports_summary_by_category_label_json_with_http_info(chart_id, opts)
|
|
@@ -2156,10 +2405,11 @@ module SeatsChart
|
|
|
2156
2405
|
end
|
|
2157
2406
|
|
|
2158
2407
|
# Chart summary by category label
|
|
2159
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2408
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2160
2409
|
# @param chart_id [String]
|
|
2161
2410
|
# @param [Hash] opts the optional parameters
|
|
2162
2411
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2412
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2163
2413
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2164
2414
|
def get_api_charts_by_chart_id_reports_summary_by_category_label_json_with_http_info(chart_id, opts = {})
|
|
2165
2415
|
if @api_client.config.debugging
|
|
@@ -2178,12 +2428,17 @@ module SeatsChart
|
|
|
2178
2428
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2179
2429
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2180
2430
|
end
|
|
2431
|
+
allowable_values = ["true", "false", "chart"]
|
|
2432
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2433
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2434
|
+
end
|
|
2181
2435
|
# resource path
|
|
2182
2436
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-category-label.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2183
2437
|
|
|
2184
2438
|
# query parameters
|
|
2185
2439
|
query_params = opts[:query_params] || {}
|
|
2186
2440
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2441
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2187
2442
|
|
|
2188
2443
|
# header parameters
|
|
2189
2444
|
header_params = opts[:header_params] || {}
|
|
@@ -2218,10 +2473,11 @@ module SeatsChart
|
|
|
2218
2473
|
end
|
|
2219
2474
|
|
|
2220
2475
|
# Chart summary by object type (CSV)
|
|
2221
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2476
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2222
2477
|
# @param chart_id [String]
|
|
2223
2478
|
# @param [Hash] opts the optional parameters
|
|
2224
2479
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2480
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2225
2481
|
# @return [nil]
|
|
2226
2482
|
def get_api_charts_by_chart_id_reports_summary_by_object_type_csv(chart_id, opts = {})
|
|
2227
2483
|
get_api_charts_by_chart_id_reports_summary_by_object_type_csv_with_http_info(chart_id, opts)
|
|
@@ -2229,10 +2485,11 @@ module SeatsChart
|
|
|
2229
2485
|
end
|
|
2230
2486
|
|
|
2231
2487
|
# Chart summary by object type (CSV)
|
|
2232
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2488
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2233
2489
|
# @param chart_id [String]
|
|
2234
2490
|
# @param [Hash] opts the optional parameters
|
|
2235
2491
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2492
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2236
2493
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2237
2494
|
def get_api_charts_by_chart_id_reports_summary_by_object_type_csv_with_http_info(chart_id, opts = {})
|
|
2238
2495
|
if @api_client.config.debugging
|
|
@@ -2251,12 +2508,17 @@ module SeatsChart
|
|
|
2251
2508
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2252
2509
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2253
2510
|
end
|
|
2511
|
+
allowable_values = ["true", "false", "chart"]
|
|
2512
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2513
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2514
|
+
end
|
|
2254
2515
|
# resource path
|
|
2255
2516
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-object-type.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2256
2517
|
|
|
2257
2518
|
# query parameters
|
|
2258
2519
|
query_params = opts[:query_params] || {}
|
|
2259
2520
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2521
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2260
2522
|
|
|
2261
2523
|
# header parameters
|
|
2262
2524
|
header_params = opts[:header_params] || {}
|
|
@@ -2291,10 +2553,11 @@ module SeatsChart
|
|
|
2291
2553
|
end
|
|
2292
2554
|
|
|
2293
2555
|
# Chart summary by object type
|
|
2294
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2556
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2295
2557
|
# @param chart_id [String]
|
|
2296
2558
|
# @param [Hash] opts the optional parameters
|
|
2297
2559
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2560
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2298
2561
|
# @return [nil]
|
|
2299
2562
|
def get_api_charts_by_chart_id_reports_summary_by_object_type_json(chart_id, opts = {})
|
|
2300
2563
|
get_api_charts_by_chart_id_reports_summary_by_object_type_json_with_http_info(chart_id, opts)
|
|
@@ -2302,10 +2565,11 @@ module SeatsChart
|
|
|
2302
2565
|
end
|
|
2303
2566
|
|
|
2304
2567
|
# Chart summary by object type
|
|
2305
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2568
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2306
2569
|
# @param chart_id [String]
|
|
2307
2570
|
# @param [Hash] opts the optional parameters
|
|
2308
2571
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2572
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2309
2573
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2310
2574
|
def get_api_charts_by_chart_id_reports_summary_by_object_type_json_with_http_info(chart_id, opts = {})
|
|
2311
2575
|
if @api_client.config.debugging
|
|
@@ -2324,12 +2588,17 @@ module SeatsChart
|
|
|
2324
2588
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2325
2589
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2326
2590
|
end
|
|
2591
|
+
allowable_values = ["true", "false", "chart"]
|
|
2592
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2593
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2594
|
+
end
|
|
2327
2595
|
# resource path
|
|
2328
2596
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-object-type.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2329
2597
|
|
|
2330
2598
|
# query parameters
|
|
2331
2599
|
query_params = opts[:query_params] || {}
|
|
2332
2600
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2601
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2333
2602
|
|
|
2334
2603
|
# header parameters
|
|
2335
2604
|
header_params = opts[:header_params] || {}
|
|
@@ -2364,10 +2633,11 @@ module SeatsChart
|
|
|
2364
2633
|
end
|
|
2365
2634
|
|
|
2366
2635
|
# Chart summary by section (CSV)
|
|
2367
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2636
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2368
2637
|
# @param chart_id [String]
|
|
2369
2638
|
# @param [Hash] opts the optional parameters
|
|
2370
2639
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2640
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2371
2641
|
# @return [nil]
|
|
2372
2642
|
def get_api_charts_by_chart_id_reports_summary_by_section_csv(chart_id, opts = {})
|
|
2373
2643
|
get_api_charts_by_chart_id_reports_summary_by_section_csv_with_http_info(chart_id, opts)
|
|
@@ -2375,10 +2645,11 @@ module SeatsChart
|
|
|
2375
2645
|
end
|
|
2376
2646
|
|
|
2377
2647
|
# Chart summary by section (CSV)
|
|
2378
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2648
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2379
2649
|
# @param chart_id [String]
|
|
2380
2650
|
# @param [Hash] opts the optional parameters
|
|
2381
2651
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2652
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2382
2653
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2383
2654
|
def get_api_charts_by_chart_id_reports_summary_by_section_csv_with_http_info(chart_id, opts = {})
|
|
2384
2655
|
if @api_client.config.debugging
|
|
@@ -2397,12 +2668,17 @@ module SeatsChart
|
|
|
2397
2668
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2398
2669
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2399
2670
|
end
|
|
2671
|
+
allowable_values = ["true", "false", "chart"]
|
|
2672
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2673
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2674
|
+
end
|
|
2400
2675
|
# resource path
|
|
2401
2676
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-section.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2402
2677
|
|
|
2403
2678
|
# query parameters
|
|
2404
2679
|
query_params = opts[:query_params] || {}
|
|
2405
2680
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2681
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2406
2682
|
|
|
2407
2683
|
# header parameters
|
|
2408
2684
|
header_params = opts[:header_params] || {}
|
|
@@ -2437,10 +2713,11 @@ module SeatsChart
|
|
|
2437
2713
|
end
|
|
2438
2714
|
|
|
2439
2715
|
# Chart summary by section
|
|
2440
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2716
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2441
2717
|
# @param chart_id [String]
|
|
2442
2718
|
# @param [Hash] opts the optional parameters
|
|
2443
2719
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2720
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2444
2721
|
# @return [nil]
|
|
2445
2722
|
def get_api_charts_by_chart_id_reports_summary_by_section_json(chart_id, opts = {})
|
|
2446
2723
|
get_api_charts_by_chart_id_reports_summary_by_section_json_with_http_info(chart_id, opts)
|
|
@@ -2448,10 +2725,11 @@ module SeatsChart
|
|
|
2448
2725
|
end
|
|
2449
2726
|
|
|
2450
2727
|
# Chart summary by section
|
|
2451
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2728
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2452
2729
|
# @param chart_id [String]
|
|
2453
2730
|
# @param [Hash] opts the optional parameters
|
|
2454
2731
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2732
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2455
2733
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2456
2734
|
def get_api_charts_by_chart_id_reports_summary_by_section_json_with_http_info(chart_id, opts = {})
|
|
2457
2735
|
if @api_client.config.debugging
|
|
@@ -2470,12 +2748,17 @@ module SeatsChart
|
|
|
2470
2748
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2471
2749
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2472
2750
|
end
|
|
2751
|
+
allowable_values = ["true", "false", "chart"]
|
|
2752
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2753
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2754
|
+
end
|
|
2473
2755
|
# resource path
|
|
2474
2756
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-section.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2475
2757
|
|
|
2476
2758
|
# query parameters
|
|
2477
2759
|
query_params = opts[:query_params] || {}
|
|
2478
2760
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2761
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2479
2762
|
|
|
2480
2763
|
# header parameters
|
|
2481
2764
|
header_params = opts[:header_params] || {}
|
|
@@ -2510,10 +2793,11 @@ module SeatsChart
|
|
|
2510
2793
|
end
|
|
2511
2794
|
|
|
2512
2795
|
# Chart summary by zone (CSV)
|
|
2513
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2796
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2514
2797
|
# @param chart_id [String]
|
|
2515
2798
|
# @param [Hash] opts the optional parameters
|
|
2516
2799
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2800
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2517
2801
|
# @return [nil]
|
|
2518
2802
|
def get_api_charts_by_chart_id_reports_summary_by_zone_csv(chart_id, opts = {})
|
|
2519
2803
|
get_api_charts_by_chart_id_reports_summary_by_zone_csv_with_http_info(chart_id, opts)
|
|
@@ -2521,10 +2805,11 @@ module SeatsChart
|
|
|
2521
2805
|
end
|
|
2522
2806
|
|
|
2523
2807
|
# Chart summary by zone (CSV)
|
|
2524
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2808
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2525
2809
|
# @param chart_id [String]
|
|
2526
2810
|
# @param [Hash] opts the optional parameters
|
|
2527
2811
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2812
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2528
2813
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2529
2814
|
def get_api_charts_by_chart_id_reports_summary_by_zone_csv_with_http_info(chart_id, opts = {})
|
|
2530
2815
|
if @api_client.config.debugging
|
|
@@ -2543,12 +2828,17 @@ module SeatsChart
|
|
|
2543
2828
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2544
2829
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2545
2830
|
end
|
|
2831
|
+
allowable_values = ["true", "false", "chart"]
|
|
2832
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2833
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2834
|
+
end
|
|
2546
2835
|
# resource path
|
|
2547
2836
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-zone.csv'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2548
2837
|
|
|
2549
2838
|
# query parameters
|
|
2550
2839
|
query_params = opts[:query_params] || {}
|
|
2551
2840
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2841
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2552
2842
|
|
|
2553
2843
|
# header parameters
|
|
2554
2844
|
header_params = opts[:header_params] || {}
|
|
@@ -2583,10 +2873,11 @@ module SeatsChart
|
|
|
2583
2873
|
end
|
|
2584
2874
|
|
|
2585
2875
|
# Chart summary by zone
|
|
2586
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2876
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2587
2877
|
# @param chart_id [String]
|
|
2588
2878
|
# @param [Hash] opts the optional parameters
|
|
2589
2879
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2880
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2590
2881
|
# @return [nil]
|
|
2591
2882
|
def get_api_charts_by_chart_id_reports_summary_by_zone_json(chart_id, opts = {})
|
|
2592
2883
|
get_api_charts_by_chart_id_reports_summary_by_zone_json_with_http_info(chart_id, opts)
|
|
@@ -2594,10 +2885,11 @@ module SeatsChart
|
|
|
2594
2885
|
end
|
|
2595
2886
|
|
|
2596
2887
|
# Chart summary by zone
|
|
2597
|
-
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2888
|
+
# Reads the published chart (seat and GA templates plus the published chart layout) — no event, no live state. Rows: `objectId`, `label`, `objectType`, `category`, `section`, `zone`, `capacity` (1 per seat, places per GA area), `price` (catalog cents; null for GA), `categoryKey` (chart category id of `category`; the value itself when no category defines it). `published` is false when the chart has never been published (no rows). `?version=draft` reports the unpublished designer draft instead (404 `draft_not_found` when the chart has none): it reads only the draft row, never the published geometry or its caches; `version` echoes the reported version. GA areas sold as a whole add `areaType`, `bookAsAWhole` and (variable occupancy) `minOccupancy` / `maxOccupancy`. Buckets: `count` (places), `objects`, `seats`, `gaPlaces`, `byCategory`, `bySection`, `byZone`, `byObjectType`; `totals` sums every bucket. The `.csv` variant returns the same data as RFC 4180 CSV (one line per object, or per group for summaries). Requires content_write (or a partner API key with the reports scope).
|
|
2598
2889
|
# @param chart_id [String]
|
|
2599
2890
|
# @param [Hash] opts the optional parameters
|
|
2600
2891
|
# @option opts [String] :version `published` (default) or `draft` (the unpublished designer draft).
|
|
2892
|
+
# @option opts [String] :book_whole_tables seats.io `bookWholeTables`: `false` (default) lists every seat; `true` lists every table as one object (`objectType: table`, `capacity` = its seats, `seats` = their labels, `price` = their sum) instead of its seats; `chart` does so for the tables the chart books as a whole (table booking `all_by_table`, or `custom` tables set to `by_table`). Echoed as `bookWholeTables`.
|
|
2601
2893
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
2602
2894
|
def get_api_charts_by_chart_id_reports_summary_by_zone_json_with_http_info(chart_id, opts = {})
|
|
2603
2895
|
if @api_client.config.debugging
|
|
@@ -2616,12 +2908,17 @@ module SeatsChart
|
|
|
2616
2908
|
if @api_client.config.client_side_validation && opts[:'version'] && !allowable_values.include?(opts[:'version'])
|
|
2617
2909
|
fail ArgumentError, "invalid value for \"version\", must be one of #{allowable_values}"
|
|
2618
2910
|
end
|
|
2911
|
+
allowable_values = ["true", "false", "chart"]
|
|
2912
|
+
if @api_client.config.client_side_validation && opts[:'book_whole_tables'] && !allowable_values.include?(opts[:'book_whole_tables'])
|
|
2913
|
+
fail ArgumentError, "invalid value for \"book_whole_tables\", must be one of #{allowable_values}"
|
|
2914
|
+
end
|
|
2619
2915
|
# resource path
|
|
2620
2916
|
local_var_path = '/api/charts/{chartId}/reports/summary/by-zone.json'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
2621
2917
|
|
|
2622
2918
|
# query parameters
|
|
2623
2919
|
query_params = opts[:query_params] || {}
|
|
2624
2920
|
query_params[:'version'] = opts[:'version'] if !opts[:'version'].nil?
|
|
2921
|
+
query_params[:'bookWholeTables'] = opts[:'book_whole_tables'] if !opts[:'book_whole_tables'].nil?
|
|
2625
2922
|
|
|
2626
2923
|
# header parameters
|
|
2627
2924
|
header_params = opts[:header_params] || {}
|
|
@@ -2963,7 +3260,7 @@ module SeatsChart
|
|
|
2963
3260
|
end
|
|
2964
3261
|
|
|
2965
3262
|
# Update chart name or key
|
|
2966
|
-
# Updates the display name and/or the partner `key` of a reusable seating chart (at least one of them). Keys are unique per workspace, URL-safe and never UUID-shaped; after a rename the old key stops resolving
|
|
3263
|
+
# Updates the display name and/or the partner `key` of a reusable seating chart (at least one of them). Keys are unique per workspace, URL-safe and never UUID-shaped; after a rename the old key stops resolving at once on every API instance (Redis invalidation message; 5 s at most if it is lost).
|
|
2967
3264
|
# @param chart_id [String] Chart id (UUID) or chart key.
|
|
2968
3265
|
# @param patch_api_charts_by_chart_id_request [PatchApiChartsByChartIdRequest]
|
|
2969
3266
|
# @param [Hash] opts the optional parameters
|
|
@@ -2975,7 +3272,7 @@ module SeatsChart
|
|
|
2975
3272
|
end
|
|
2976
3273
|
|
|
2977
3274
|
# Update chart name or key
|
|
2978
|
-
# Updates the display name and/or the partner `key` of a reusable seating chart (at least one of them). Keys are unique per workspace, URL-safe and never UUID-shaped; after a rename the old key stops resolving
|
|
3275
|
+
# Updates the display name and/or the partner `key` of a reusable seating chart (at least one of them). Keys are unique per workspace, URL-safe and never UUID-shaped; after a rename the old key stops resolving at once on every API instance (Redis invalidation message; 5 s at most if it is lost).
|
|
2979
3276
|
# @param chart_id [String] Chart id (UUID) or chart key.
|
|
2980
3277
|
# @param patch_api_charts_by_chart_id_request [PatchApiChartsByChartIdRequest]
|
|
2981
3278
|
# @param [Hash] opts the optional parameters
|
|
@@ -3053,8 +3350,110 @@ module SeatsChart
|
|
|
3053
3350
|
return data, status_code, headers
|
|
3054
3351
|
end
|
|
3055
3352
|
|
|
3353
|
+
# Update a category in the chart draft
|
|
3354
|
+
# Renames a draft category, changes its `color` or replaces its `ticketTypes`. A rename relabels every draft seat and GA area of the category (`renamedSeats`, `renamedGaAreas`). 404 `not_found` when the category is not in the draft, 409 `category_exists` when another category uses the name. Requires chart write access.
|
|
3355
|
+
# @param chart_id [String]
|
|
3356
|
+
# @param category_id [String]
|
|
3357
|
+
# @param patch_api_charts_by_chart_id_categories_by_category_id_request [PatchApiChartsByChartIdCategoriesByCategoryIdRequest]
|
|
3358
|
+
# @param [Hash] opts the optional parameters
|
|
3359
|
+
# @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.
|
|
3360
|
+
# @return [nil]
|
|
3361
|
+
def patch_api_charts_by_chart_id_categories_by_category_id(chart_id, category_id, patch_api_charts_by_chart_id_categories_by_category_id_request, opts = {})
|
|
3362
|
+
patch_api_charts_by_chart_id_categories_by_category_id_with_http_info(chart_id, category_id, patch_api_charts_by_chart_id_categories_by_category_id_request, opts)
|
|
3363
|
+
nil
|
|
3364
|
+
end
|
|
3365
|
+
|
|
3366
|
+
# Update a category in the chart draft
|
|
3367
|
+
# Renames a draft category, changes its `color` or replaces its `ticketTypes`. A rename relabels every draft seat and GA area of the category (`renamedSeats`, `renamedGaAreas`). 404 `not_found` when the category is not in the draft, 409 `category_exists` when another category uses the name. Requires chart write access.
|
|
3368
|
+
# @param chart_id [String]
|
|
3369
|
+
# @param category_id [String]
|
|
3370
|
+
# @param patch_api_charts_by_chart_id_categories_by_category_id_request [PatchApiChartsByChartIdCategoriesByCategoryIdRequest]
|
|
3371
|
+
# @param [Hash] opts the optional parameters
|
|
3372
|
+
# @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.
|
|
3373
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
3374
|
+
def patch_api_charts_by_chart_id_categories_by_category_id_with_http_info(chart_id, category_id, patch_api_charts_by_chart_id_categories_by_category_id_request, opts = {})
|
|
3375
|
+
if @api_client.config.debugging
|
|
3376
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id ...'
|
|
3377
|
+
end
|
|
3378
|
+
# verify the required parameter 'chart_id' is set
|
|
3379
|
+
if @api_client.config.client_side_validation && chart_id.nil?
|
|
3380
|
+
fail ArgumentError, "Missing the required parameter 'chart_id' when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id"
|
|
3381
|
+
end
|
|
3382
|
+
pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
|
|
3383
|
+
if @api_client.config.client_side_validation && chart_id !~ pattern
|
|
3384
|
+
fail ArgumentError, "invalid value for 'chart_id' when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id, must conform to the pattern #{pattern}."
|
|
3385
|
+
end
|
|
3386
|
+
|
|
3387
|
+
# verify the required parameter 'category_id' is set
|
|
3388
|
+
if @api_client.config.client_side_validation && category_id.nil?
|
|
3389
|
+
fail ArgumentError, "Missing the required parameter 'category_id' when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id"
|
|
3390
|
+
end
|
|
3391
|
+
if @api_client.config.client_side_validation && category_id.to_s.length > 64
|
|
3392
|
+
fail ArgumentError, 'invalid value for "category_id" when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id, the character length must be smaller than or equal to 64.'
|
|
3393
|
+
end
|
|
3394
|
+
|
|
3395
|
+
if @api_client.config.client_side_validation && category_id.to_s.length < 1
|
|
3396
|
+
fail ArgumentError, 'invalid value for "category_id" when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id, the character length must be great than or equal to 1.'
|
|
3397
|
+
end
|
|
3398
|
+
|
|
3399
|
+
# verify the required parameter 'patch_api_charts_by_chart_id_categories_by_category_id_request' is set
|
|
3400
|
+
if @api_client.config.client_side_validation && patch_api_charts_by_chart_id_categories_by_category_id_request.nil?
|
|
3401
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_charts_by_chart_id_categories_by_category_id_request' when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id"
|
|
3402
|
+
end
|
|
3403
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
3404
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id, the character length must be smaller than or equal to 255.'
|
|
3405
|
+
end
|
|
3406
|
+
|
|
3407
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
3408
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id, the character length must be great than or equal to 1.'
|
|
3409
|
+
end
|
|
3410
|
+
|
|
3411
|
+
# resource path
|
|
3412
|
+
local_var_path = '/api/charts/{chartId}/categories/{categoryId}'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s)).sub('{' + 'categoryId' + '}', CGI.escape(category_id.to_s))
|
|
3413
|
+
|
|
3414
|
+
# query parameters
|
|
3415
|
+
query_params = opts[:query_params] || {}
|
|
3416
|
+
|
|
3417
|
+
# header parameters
|
|
3418
|
+
header_params = opts[:header_params] || {}
|
|
3419
|
+
# HTTP header 'Content-Type'
|
|
3420
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
3421
|
+
if !content_type.nil?
|
|
3422
|
+
header_params['Content-Type'] = content_type
|
|
3423
|
+
end
|
|
3424
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
3425
|
+
|
|
3426
|
+
# form parameters
|
|
3427
|
+
form_params = opts[:form_params] || {}
|
|
3428
|
+
|
|
3429
|
+
# http body (model)
|
|
3430
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_charts_by_chart_id_categories_by_category_id_request)
|
|
3431
|
+
|
|
3432
|
+
# return_type
|
|
3433
|
+
return_type = opts[:debug_return_type]
|
|
3434
|
+
|
|
3435
|
+
# auth_names
|
|
3436
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
3437
|
+
|
|
3438
|
+
new_options = opts.merge(
|
|
3439
|
+
:operation => :"ChartsApi.patch_api_charts_by_chart_id_categories_by_category_id",
|
|
3440
|
+
:header_params => header_params,
|
|
3441
|
+
:query_params => query_params,
|
|
3442
|
+
:form_params => form_params,
|
|
3443
|
+
:body => post_body,
|
|
3444
|
+
:auth_names => auth_names,
|
|
3445
|
+
:return_type => return_type
|
|
3446
|
+
)
|
|
3447
|
+
|
|
3448
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
3449
|
+
if @api_client.config.debugging
|
|
3450
|
+
@api_client.config.logger.debug "API called: ChartsApi#patch_api_charts_by_chart_id_categories_by_category_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3451
|
+
end
|
|
3452
|
+
return data, status_code, headers
|
|
3453
|
+
end
|
|
3454
|
+
|
|
3056
3455
|
# Create chart
|
|
3057
|
-
# Creates a reusable seating chart. Optional in the same call: `key` (partner key, unique per workspace, usable wherever a chart id is accepted; 409 `chart_key_taken`), `venueType` (`simple` | `sections` | `zones`, the designer template) and `categories` (up to 128 `{ key?, label, color, accessible? }`; keys and labels unique, case-insensitive). With `venueType` or `categories` an initial draft holding them is written in the same transaction (`hasDraft: true`). Author geometry via `PUT /api/charts/:chartId/map/draft` and publish before attaching to events.
|
|
3456
|
+
# Creates a reusable seating chart. Optional in the same call: `key` (partner key, unique per workspace, usable wherever a chart id is accepted; 409 `chart_key_taken`), `venueType` (`simple` | `sections` | `zones`, the designer template) and `categories` (up to 128 `{ key?, label, color, accessible? }`; keys and labels unique, case-insensitive). With `venueType` or `categories` an initial draft holding them is written in the same transaction (`hasDraft: true`). Author geometry via `PUT /api/charts/:chartId/map/draft` and publish before attaching to events. Besides a partner key or a dashboard session with `content_write`, a designer embed token minted without `chartId` and `eventId` may create charts (the embedded designer opened without a chart); other embed tokens get 403 `ERR_EMBED_SCOPE`.
|
|
3058
3457
|
# @param post_api_charts_request [PostApiChartsRequest]
|
|
3059
3458
|
# @param [Hash] opts the optional parameters
|
|
3060
3459
|
# @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.
|
|
@@ -3065,7 +3464,7 @@ module SeatsChart
|
|
|
3065
3464
|
end
|
|
3066
3465
|
|
|
3067
3466
|
# Create chart
|
|
3068
|
-
# Creates a reusable seating chart. Optional in the same call: `key` (partner key, unique per workspace, usable wherever a chart id is accepted; 409 `chart_key_taken`), `venueType` (`simple` | `sections` | `zones`, the designer template) and `categories` (up to 128 `{ key?, label, color, accessible? }`; keys and labels unique, case-insensitive). With `venueType` or `categories` an initial draft holding them is written in the same transaction (`hasDraft: true`). Author geometry via `PUT /api/charts/:chartId/map/draft` and publish before attaching to events.
|
|
3467
|
+
# Creates a reusable seating chart. Optional in the same call: `key` (partner key, unique per workspace, usable wherever a chart id is accepted; 409 `chart_key_taken`), `venueType` (`simple` | `sections` | `zones`, the designer template) and `categories` (up to 128 `{ key?, label, color, accessible? }`; keys and labels unique, case-insensitive). With `venueType` or `categories` an initial draft holding them is written in the same transaction (`hasDraft: true`). Author geometry via `PUT /api/charts/:chartId/map/draft` and publish before attaching to events. Besides a partner key or a dashboard session with `content_write`, a designer embed token minted without `chartId` and `eventId` may create charts (the embedded designer opened without a chart); other embed tokens get 403 `ERR_EMBED_SCOPE`.
|
|
3069
3468
|
# @param post_api_charts_request [PostApiChartsRequest]
|
|
3070
3469
|
# @param [Hash] opts the optional parameters
|
|
3071
3470
|
# @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.
|
|
@@ -3210,7 +3609,7 @@ module SeatsChart
|
|
|
3210
3609
|
end
|
|
3211
3610
|
|
|
3212
3611
|
# Copy a chart to another workspace
|
|
3213
|
-
# Copies the chart (its draft, else the published map) into another workspace as a new **unpublished** chart with fresh object ids. Callers: a dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; a scoped key also needs `charts_write`) — other API keys get 403 `ERR_PARTNER_SCOPE`. The user (for a key: the admin it is bound to, re-checked on every call) must be an **admin of both workspaces** (403 `ERR_FORBIDDEN_ROLE`). The target must be active (409 `workspace_deactivated`) and within its plan's chart limit. Both workspaces get a `chart.copy_to_workspace` audit entry; the target also gets `chart.created`. Same workspace: use `POST /charts/{chartId}/duplicate` (400).
|
|
3612
|
+
# Copies the chart (its draft, else the published map) into another workspace as a new **unpublished** chart with fresh object ids. Callers: a dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; a scoped key also needs `charts_write`) — other API keys get 403 `ERR_PARTNER_SCOPE`. The user (for a key: the admin it is bound to, re-checked on every call) must be an **admin of both workspaces** (403 `ERR_FORBIDDEN_ROLE`). The target must be active (409 `workspace_deactivated`) and within its plan's chart limit. Both workspaces get a `chart.copy_to_workspace` audit entry; the target also gets `chart.created`. Same workspace: use `POST /charts/{chartId}/duplicate` (400). **From another workspace** (seats.io `copyFromWorkspaceTo`): `fromWorkspaceId` names the source workspace, so one company admin key copies a chart from workspace X to workspace Y without a key of X. The admin must administer both X and Y (403 `ERR_FORBIDDEN_ROLE`, also when X is not one of its workspaces); 404 `ERR_CHART_NOT_FOUND` when the chart is not in X. X and Y get `chart.copy_to_workspace` and, when the calling workspace is neither, it gets `chart.copy_between_workspaces`.
|
|
3214
3613
|
# @param chart_id [String]
|
|
3215
3614
|
# @param post_api_charts_by_chart_id_actions_copy_to_workspace_request [PostApiChartsByChartIdActionsCopyToWorkspaceRequest]
|
|
3216
3615
|
# @param [Hash] opts the optional parameters
|
|
@@ -3222,7 +3621,7 @@ module SeatsChart
|
|
|
3222
3621
|
end
|
|
3223
3622
|
|
|
3224
3623
|
# Copy a chart to another workspace
|
|
3225
|
-
# Copies the chart (its draft, else the published map) into another workspace as a new **unpublished** chart with fresh object ids. Callers: a dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; a scoped key also needs `charts_write`) — other API keys get 403 `ERR_PARTNER_SCOPE`. The user (for a key: the admin it is bound to, re-checked on every call) must be an **admin of both workspaces** (403 `ERR_FORBIDDEN_ROLE`). The target must be active (409 `workspace_deactivated`) and within its plan's chart limit. Both workspaces get a `chart.copy_to_workspace` audit entry; the target also gets `chart.created`. Same workspace: use `POST /charts/{chartId}/duplicate` (400).
|
|
3624
|
+
# Copies the chart (its draft, else the published map) into another workspace as a new **unpublished** chart with fresh object ids. Callers: a dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; a scoped key also needs `charts_write`) — other API keys get 403 `ERR_PARTNER_SCOPE`. The user (for a key: the admin it is bound to, re-checked on every call) must be an **admin of both workspaces** (403 `ERR_FORBIDDEN_ROLE`). The target must be active (409 `workspace_deactivated`) and within its plan's chart limit. Both workspaces get a `chart.copy_to_workspace` audit entry; the target also gets `chart.created`. Same workspace: use `POST /charts/{chartId}/duplicate` (400). **From another workspace** (seats.io `copyFromWorkspaceTo`): `fromWorkspaceId` names the source workspace, so one company admin key copies a chart from workspace X to workspace Y without a key of X. The admin must administer both X and Y (403 `ERR_FORBIDDEN_ROLE`, also when X is not one of its workspaces); 404 `ERR_CHART_NOT_FOUND` when the chart is not in X. X and Y get `chart.copy_to_workspace` and, when the calling workspace is neither, it gets `chart.copy_between_workspaces`.
|
|
3226
3625
|
# @param chart_id [String]
|
|
3227
3626
|
# @param post_api_charts_by_chart_id_actions_copy_to_workspace_request [PostApiChartsByChartIdActionsCopyToWorkspaceRequest]
|
|
3228
3627
|
# @param [Hash] opts the optional parameters
|
|
@@ -3297,6 +3696,78 @@ module SeatsChart
|
|
|
3297
3696
|
return data, status_code, headers
|
|
3298
3697
|
end
|
|
3299
3698
|
|
|
3699
|
+
# Retired: scan a chart image (410)
|
|
3700
|
+
# Retired legacy AI scan route: always answers 410 `scan_route_retired` without calling any AI provider. Use `POST /api/extract-seats` with a multipart image.
|
|
3701
|
+
# @param chart_id [String]
|
|
3702
|
+
# @param [Hash] opts the optional parameters
|
|
3703
|
+
# @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.
|
|
3704
|
+
# @return [nil]
|
|
3705
|
+
def post_api_charts_by_chart_id_actions_scan_chart(chart_id, opts = {})
|
|
3706
|
+
post_api_charts_by_chart_id_actions_scan_chart_with_http_info(chart_id, opts)
|
|
3707
|
+
nil
|
|
3708
|
+
end
|
|
3709
|
+
|
|
3710
|
+
# Retired: scan a chart image (410)
|
|
3711
|
+
# Retired legacy AI scan route: always answers 410 `scan_route_retired` without calling any AI provider. Use `POST /api/extract-seats` with a multipart image.
|
|
3712
|
+
# @param chart_id [String]
|
|
3713
|
+
# @param [Hash] opts the optional parameters
|
|
3714
|
+
# @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.
|
|
3715
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
3716
|
+
def post_api_charts_by_chart_id_actions_scan_chart_with_http_info(chart_id, opts = {})
|
|
3717
|
+
if @api_client.config.debugging
|
|
3718
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.post_api_charts_by_chart_id_actions_scan_chart ...'
|
|
3719
|
+
end
|
|
3720
|
+
# verify the required parameter 'chart_id' is set
|
|
3721
|
+
if @api_client.config.client_side_validation && chart_id.nil?
|
|
3722
|
+
fail ArgumentError, "Missing the required parameter 'chart_id' when calling ChartsApi.post_api_charts_by_chart_id_actions_scan_chart"
|
|
3723
|
+
end
|
|
3724
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
3725
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_actions_scan_chart, the character length must be smaller than or equal to 255.'
|
|
3726
|
+
end
|
|
3727
|
+
|
|
3728
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
3729
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_actions_scan_chart, the character length must be great than or equal to 1.'
|
|
3730
|
+
end
|
|
3731
|
+
|
|
3732
|
+
# resource path
|
|
3733
|
+
local_var_path = '/api/charts/{chartId}/actions/scan-chart'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
3734
|
+
|
|
3735
|
+
# query parameters
|
|
3736
|
+
query_params = opts[:query_params] || {}
|
|
3737
|
+
|
|
3738
|
+
# header parameters
|
|
3739
|
+
header_params = opts[:header_params] || {}
|
|
3740
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
3741
|
+
|
|
3742
|
+
# form parameters
|
|
3743
|
+
form_params = opts[:form_params] || {}
|
|
3744
|
+
|
|
3745
|
+
# http body (model)
|
|
3746
|
+
post_body = opts[:debug_body]
|
|
3747
|
+
|
|
3748
|
+
# return_type
|
|
3749
|
+
return_type = opts[:debug_return_type]
|
|
3750
|
+
|
|
3751
|
+
# auth_names
|
|
3752
|
+
auth_names = opts[:debug_auth_names] || []
|
|
3753
|
+
|
|
3754
|
+
new_options = opts.merge(
|
|
3755
|
+
:operation => :"ChartsApi.post_api_charts_by_chart_id_actions_scan_chart",
|
|
3756
|
+
:header_params => header_params,
|
|
3757
|
+
:query_params => query_params,
|
|
3758
|
+
:form_params => form_params,
|
|
3759
|
+
:body => post_body,
|
|
3760
|
+
:auth_names => auth_names,
|
|
3761
|
+
:return_type => return_type
|
|
3762
|
+
)
|
|
3763
|
+
|
|
3764
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
3765
|
+
if @api_client.config.debugging
|
|
3766
|
+
@api_client.config.logger.debug "API called: ChartsApi#post_api_charts_by_chart_id_actions_scan_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
3767
|
+
end
|
|
3768
|
+
return data, status_code, headers
|
|
3769
|
+
end
|
|
3770
|
+
|
|
3300
3771
|
# Unarchive chart
|
|
3301
3772
|
# Returns an archived chart to the default chart lists. Idempotent for charts that are not archived.
|
|
3302
3773
|
# @param chart_id [String]
|
|
@@ -3471,8 +3942,96 @@ module SeatsChart
|
|
|
3471
3942
|
return data, status_code, headers
|
|
3472
3943
|
end
|
|
3473
3944
|
|
|
3945
|
+
# Add a category to the chart draft
|
|
3946
|
+
# Adds a category (`name`, optional `id`, `color` and `ticketTypes`) to the chart draft (created from the published map when there is none) and answers 201 `{ category }`. Names are unique per chart (case-insensitive): 409 `category_exists`. Publish the draft to make the category live. Requires chart write access.
|
|
3947
|
+
# @param chart_id [String]
|
|
3948
|
+
# @param post_api_charts_by_chart_id_categories_request [PostApiChartsByChartIdCategoriesRequest]
|
|
3949
|
+
# @param [Hash] opts the optional parameters
|
|
3950
|
+
# @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.
|
|
3951
|
+
# @return [nil]
|
|
3952
|
+
def post_api_charts_by_chart_id_categories(chart_id, post_api_charts_by_chart_id_categories_request, opts = {})
|
|
3953
|
+
post_api_charts_by_chart_id_categories_with_http_info(chart_id, post_api_charts_by_chart_id_categories_request, opts)
|
|
3954
|
+
nil
|
|
3955
|
+
end
|
|
3956
|
+
|
|
3957
|
+
# Add a category to the chart draft
|
|
3958
|
+
# Adds a category (`name`, optional `id`, `color` and `ticketTypes`) to the chart draft (created from the published map when there is none) and answers 201 `{ category }`. Names are unique per chart (case-insensitive): 409 `category_exists`. Publish the draft to make the category live. Requires chart write access.
|
|
3959
|
+
# @param chart_id [String]
|
|
3960
|
+
# @param post_api_charts_by_chart_id_categories_request [PostApiChartsByChartIdCategoriesRequest]
|
|
3961
|
+
# @param [Hash] opts the optional parameters
|
|
3962
|
+
# @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.
|
|
3963
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
3964
|
+
def post_api_charts_by_chart_id_categories_with_http_info(chart_id, post_api_charts_by_chart_id_categories_request, opts = {})
|
|
3965
|
+
if @api_client.config.debugging
|
|
3966
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.post_api_charts_by_chart_id_categories ...'
|
|
3967
|
+
end
|
|
3968
|
+
# verify the required parameter 'chart_id' is set
|
|
3969
|
+
if @api_client.config.client_side_validation && chart_id.nil?
|
|
3970
|
+
fail ArgumentError, "Missing the required parameter 'chart_id' when calling ChartsApi.post_api_charts_by_chart_id_categories"
|
|
3971
|
+
end
|
|
3972
|
+
pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
|
|
3973
|
+
if @api_client.config.client_side_validation && chart_id !~ pattern
|
|
3974
|
+
fail ArgumentError, "invalid value for 'chart_id' when calling ChartsApi.post_api_charts_by_chart_id_categories, must conform to the pattern #{pattern}."
|
|
3975
|
+
end
|
|
3976
|
+
|
|
3977
|
+
# verify the required parameter 'post_api_charts_by_chart_id_categories_request' is set
|
|
3978
|
+
if @api_client.config.client_side_validation && post_api_charts_by_chart_id_categories_request.nil?
|
|
3979
|
+
fail ArgumentError, "Missing the required parameter 'post_api_charts_by_chart_id_categories_request' when calling ChartsApi.post_api_charts_by_chart_id_categories"
|
|
3980
|
+
end
|
|
3981
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
3982
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_categories, the character length must be smaller than or equal to 255.'
|
|
3983
|
+
end
|
|
3984
|
+
|
|
3985
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
3986
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_categories, the character length must be great than or equal to 1.'
|
|
3987
|
+
end
|
|
3988
|
+
|
|
3989
|
+
# resource path
|
|
3990
|
+
local_var_path = '/api/charts/{chartId}/categories'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s))
|
|
3991
|
+
|
|
3992
|
+
# query parameters
|
|
3993
|
+
query_params = opts[:query_params] || {}
|
|
3994
|
+
|
|
3995
|
+
# header parameters
|
|
3996
|
+
header_params = opts[:header_params] || {}
|
|
3997
|
+
# HTTP header 'Content-Type'
|
|
3998
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
3999
|
+
if !content_type.nil?
|
|
4000
|
+
header_params['Content-Type'] = content_type
|
|
4001
|
+
end
|
|
4002
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
4003
|
+
|
|
4004
|
+
# form parameters
|
|
4005
|
+
form_params = opts[:form_params] || {}
|
|
4006
|
+
|
|
4007
|
+
# http body (model)
|
|
4008
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_charts_by_chart_id_categories_request)
|
|
4009
|
+
|
|
4010
|
+
# return_type
|
|
4011
|
+
return_type = opts[:debug_return_type]
|
|
4012
|
+
|
|
4013
|
+
# auth_names
|
|
4014
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
4015
|
+
|
|
4016
|
+
new_options = opts.merge(
|
|
4017
|
+
:operation => :"ChartsApi.post_api_charts_by_chart_id_categories",
|
|
4018
|
+
:header_params => header_params,
|
|
4019
|
+
:query_params => query_params,
|
|
4020
|
+
:form_params => form_params,
|
|
4021
|
+
:body => post_body,
|
|
4022
|
+
:auth_names => auth_names,
|
|
4023
|
+
:return_type => return_type
|
|
4024
|
+
)
|
|
4025
|
+
|
|
4026
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4027
|
+
if @api_client.config.debugging
|
|
4028
|
+
@api_client.config.logger.debug "API called: ChartsApi#post_api_charts_by_chart_id_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4029
|
+
end
|
|
4030
|
+
return data, status_code, headers
|
|
4031
|
+
end
|
|
4032
|
+
|
|
3474
4033
|
# Duplicate chart
|
|
3475
|
-
# Creates a new unpublished chart draft copied from the source chart (seats, GA areas, shapes, images).
|
|
4034
|
+
# Creates a new unpublished chart draft copied from the source chart (seats, GA areas, shapes, images). Counts against the plan chart limit (402 `plan_limit_exceeded`).
|
|
3476
4035
|
# @param chart_id [String]
|
|
3477
4036
|
# @param post_api_charts_by_chart_id_duplicate_request [PostApiChartsByChartIdDuplicateRequest]
|
|
3478
4037
|
# @param [Hash] opts the optional parameters
|
|
@@ -3484,7 +4043,7 @@ module SeatsChart
|
|
|
3484
4043
|
end
|
|
3485
4044
|
|
|
3486
4045
|
# Duplicate chart
|
|
3487
|
-
# Creates a new unpublished chart draft copied from the source chart (seats, GA areas, shapes, images).
|
|
4046
|
+
# Creates a new unpublished chart draft copied from the source chart (seats, GA areas, shapes, images). Counts against the plan chart limit (402 `plan_limit_exceeded`).
|
|
3488
4047
|
# @param chart_id [String]
|
|
3489
4048
|
# @param post_api_charts_by_chart_id_duplicate_request [PostApiChartsByChartIdDuplicateRequest]
|
|
3490
4049
|
# @param [Hash] opts the optional parameters
|
|
@@ -3640,7 +4199,7 @@ module SeatsChart
|
|
|
3640
4199
|
end
|
|
3641
4200
|
|
|
3642
4201
|
# Publish chart map template
|
|
3643
|
-
# Promotes draft → `chart_seat_templates` + `chart_layouts`. Events clone templates on create. The draft is validated with the same rules the designer runs, at the **workspace severity** (`GET /api/workspace/chart-validation`; rules set to `off` are skipped). Error-level issues return `422 { error: \"validation_failed\", issues: [{ code, severity, objectIds, message, count, scope? }] }` (warnings included); warning-level issues do not block and are returned in `warnings`. Per-rule counts are stored with the version, so `GET /api/charts` (`validation`) and event creation (409 `chart_invalid`) never re-run the rules. Every successful publish appends an immutable version (`version`, `geometryHash`; `sameAsVersion` names an earlier version with identical content, e.g. after a restore). An optional JSON body `{ \"note\": \"...\" }` (≤ 280 chars) is stored on the version. See `GET /api/charts/:chartId/versions`. Emits the `chart.published` webhook. Use `POST /api/charts/:chartId/actions/validate` for a dry run. With `{ \"autoPublish\": true }` (designer auto-publish, off by default) the publish only runs while no event uses the chart; otherwise 409 `{ code: \"ERR_AUTO_PUBLISH_CHART_HAS_EVENTS\", params: { eventCount } }`.
|
|
4202
|
+
# Promotes draft → `chart_seat_templates` + `chart_layouts`. Events clone templates on create. The draft is validated with the same rules the designer runs, at the **workspace severity** (`GET /api/workspace/chart-validation`; rules set to `off` are skipped). Error-level issues return `422 { error: \"validation_failed\", issues: [{ code, severity, objectIds, message, count, scope? }] }` (warnings included); warning-level issues do not block and are returned in `warnings`. Per-rule counts are stored with the version, so `GET /api/charts` (`validation`) and event creation (409 `chart_invalid`) never re-run the rules. Every successful publish appends an immutable version (`version`, `geometryHash`; `sameAsVersion` names an earlier version with identical content, e.g. after a restore). An optional JSON body `{ \"note\": \"...\" }` (≤ 280 chars) is stored on the version. See `GET /api/charts/:chartId/versions`. Emits the `chart.published` webhook. Use `POST /api/charts/:chartId/actions/validate` for a dry run. With `{ \"autoPublish\": true }` (designer auto-publish, off by default) the publish only runs while no event uses the chart; otherwise 409 `{ code: \"ERR_AUTO_PUBLISH_CHART_HAS_EVENTS\", params: { eventCount } }`. Workspaces that publish designer changes directly (`draftChartDrawingsEnabled: false`) skip that check: every designer save is published. GA areas sold as a whole: a change of how an area is sold (regular / `fixedOccupancy` / `variableOccupancy`, and the capacity, `minOccupancy` or per-area pricing of a whole area) also reaches the events of the chart. It is refused with 409 `{ error: \"ga_area_occupancy_locked\", objects: [{ eventId, objectId, label, soldCount, heldCount }] }` while any of those event areas has sold or held places (nothing is published).
|
|
3644
4203
|
# @param chart_id [String]
|
|
3645
4204
|
# @param post_api_charts_by_chart_id_map_publish_request [PostApiChartsByChartIdMapPublishRequest]
|
|
3646
4205
|
# @param [Hash] opts the optional parameters
|
|
@@ -3652,7 +4211,7 @@ module SeatsChart
|
|
|
3652
4211
|
end
|
|
3653
4212
|
|
|
3654
4213
|
# Publish chart map template
|
|
3655
|
-
# Promotes draft → `chart_seat_templates` + `chart_layouts`. Events clone templates on create. The draft is validated with the same rules the designer runs, at the **workspace severity** (`GET /api/workspace/chart-validation`; rules set to `off` are skipped). Error-level issues return `422 { error: \"validation_failed\", issues: [{ code, severity, objectIds, message, count, scope? }] }` (warnings included); warning-level issues do not block and are returned in `warnings`. Per-rule counts are stored with the version, so `GET /api/charts` (`validation`) and event creation (409 `chart_invalid`) never re-run the rules. Every successful publish appends an immutable version (`version`, `geometryHash`; `sameAsVersion` names an earlier version with identical content, e.g. after a restore). An optional JSON body `{ \"note\": \"...\" }` (≤ 280 chars) is stored on the version. See `GET /api/charts/:chartId/versions`. Emits the `chart.published` webhook. Use `POST /api/charts/:chartId/actions/validate` for a dry run. With `{ \"autoPublish\": true }` (designer auto-publish, off by default) the publish only runs while no event uses the chart; otherwise 409 `{ code: \"ERR_AUTO_PUBLISH_CHART_HAS_EVENTS\", params: { eventCount } }`.
|
|
4214
|
+
# Promotes draft → `chart_seat_templates` + `chart_layouts`. Events clone templates on create. The draft is validated with the same rules the designer runs, at the **workspace severity** (`GET /api/workspace/chart-validation`; rules set to `off` are skipped). Error-level issues return `422 { error: \"validation_failed\", issues: [{ code, severity, objectIds, message, count, scope? }] }` (warnings included); warning-level issues do not block and are returned in `warnings`. Per-rule counts are stored with the version, so `GET /api/charts` (`validation`) and event creation (409 `chart_invalid`) never re-run the rules. Every successful publish appends an immutable version (`version`, `geometryHash`; `sameAsVersion` names an earlier version with identical content, e.g. after a restore). An optional JSON body `{ \"note\": \"...\" }` (≤ 280 chars) is stored on the version. See `GET /api/charts/:chartId/versions`. Emits the `chart.published` webhook. Use `POST /api/charts/:chartId/actions/validate` for a dry run. With `{ \"autoPublish\": true }` (designer auto-publish, off by default) the publish only runs while no event uses the chart; otherwise 409 `{ code: \"ERR_AUTO_PUBLISH_CHART_HAS_EVENTS\", params: { eventCount } }`. Workspaces that publish designer changes directly (`draftChartDrawingsEnabled: false`) skip that check: every designer save is published. GA areas sold as a whole: a change of how an area is sold (regular / `fixedOccupancy` / `variableOccupancy`, and the capacity, `minOccupancy` or per-area pricing of a whole area) also reaches the events of the chart. It is refused with 409 `{ error: \"ga_area_occupancy_locked\", objects: [{ eventId, objectId, label, soldCount, heldCount }] }` while any of those event areas has sold or held places (nothing is published).
|
|
3656
4215
|
# @param chart_id [String]
|
|
3657
4216
|
# @param post_api_charts_by_chart_id_map_publish_request [PostApiChartsByChartIdMapPublishRequest]
|
|
3658
4217
|
# @param [Hash] opts the optional parameters
|
|
@@ -3820,6 +4379,108 @@ module SeatsChart
|
|
|
3820
4379
|
return data, status_code, headers
|
|
3821
4380
|
end
|
|
3822
4381
|
|
|
4382
|
+
# Copy a chart version into a new chart
|
|
4383
|
+
# Creates a new chart in the same workspace from one published version of this chart (see `GET /charts/{chartId}/versions`), with the chart tags. `name` defaults to \"<chart name> (v<version> copy)\". Answers `{ chart: { id, name, sourceChartId, sourceVersion } }`; 404 `ERR_CHART_VERSION_NOT_FOUND` for an unknown version. Counts against the plan chart limit. Requires chart write access.
|
|
4384
|
+
# @param chart_id [String]
|
|
4385
|
+
# @param version [Float]
|
|
4386
|
+
# @param post_api_charts_by_chart_id_versions_by_version_actions_copy_request [PostApiChartsByChartIdVersionsByVersionActionsCopyRequest]
|
|
4387
|
+
# @param [Hash] opts the optional parameters
|
|
4388
|
+
# @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.
|
|
4389
|
+
# @return [nil]
|
|
4390
|
+
def post_api_charts_by_chart_id_versions_by_version_actions_copy(chart_id, version, post_api_charts_by_chart_id_versions_by_version_actions_copy_request, opts = {})
|
|
4391
|
+
post_api_charts_by_chart_id_versions_by_version_actions_copy_with_http_info(chart_id, version, post_api_charts_by_chart_id_versions_by_version_actions_copy_request, opts)
|
|
4392
|
+
nil
|
|
4393
|
+
end
|
|
4394
|
+
|
|
4395
|
+
# Copy a chart version into a new chart
|
|
4396
|
+
# Creates a new chart in the same workspace from one published version of this chart (see `GET /charts/{chartId}/versions`), with the chart tags. `name` defaults to \"<chart name> (v<version> copy)\". Answers `{ chart: { id, name, sourceChartId, sourceVersion } }`; 404 `ERR_CHART_VERSION_NOT_FOUND` for an unknown version. Counts against the plan chart limit. Requires chart write access.
|
|
4397
|
+
# @param chart_id [String]
|
|
4398
|
+
# @param version [Float]
|
|
4399
|
+
# @param post_api_charts_by_chart_id_versions_by_version_actions_copy_request [PostApiChartsByChartIdVersionsByVersionActionsCopyRequest]
|
|
4400
|
+
# @param [Hash] opts the optional parameters
|
|
4401
|
+
# @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.
|
|
4402
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
4403
|
+
def post_api_charts_by_chart_id_versions_by_version_actions_copy_with_http_info(chart_id, version, post_api_charts_by_chart_id_versions_by_version_actions_copy_request, opts = {})
|
|
4404
|
+
if @api_client.config.debugging
|
|
4405
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy ...'
|
|
4406
|
+
end
|
|
4407
|
+
# verify the required parameter 'chart_id' is set
|
|
4408
|
+
if @api_client.config.client_side_validation && chart_id.nil?
|
|
4409
|
+
fail ArgumentError, "Missing the required parameter 'chart_id' when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy"
|
|
4410
|
+
end
|
|
4411
|
+
pattern = Regexp.new(/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/)
|
|
4412
|
+
if @api_client.config.client_side_validation && chart_id !~ pattern
|
|
4413
|
+
fail ArgumentError, "invalid value for 'chart_id' when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy, must conform to the pattern #{pattern}."
|
|
4414
|
+
end
|
|
4415
|
+
|
|
4416
|
+
# verify the required parameter 'version' is set
|
|
4417
|
+
if @api_client.config.client_side_validation && version.nil?
|
|
4418
|
+
fail ArgumentError, "Missing the required parameter 'version' when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy"
|
|
4419
|
+
end
|
|
4420
|
+
if @api_client.config.client_side_validation && version > 2147483647
|
|
4421
|
+
fail ArgumentError, 'invalid value for "version" when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy, must be smaller than or equal to 2147483647.'
|
|
4422
|
+
end
|
|
4423
|
+
|
|
4424
|
+
if @api_client.config.client_side_validation && version < 1
|
|
4425
|
+
fail ArgumentError, 'invalid value for "version" when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy, must be greater than or equal to 1.'
|
|
4426
|
+
end
|
|
4427
|
+
|
|
4428
|
+
# verify the required parameter 'post_api_charts_by_chart_id_versions_by_version_actions_copy_request' is set
|
|
4429
|
+
if @api_client.config.client_side_validation && post_api_charts_by_chart_id_versions_by_version_actions_copy_request.nil?
|
|
4430
|
+
fail ArgumentError, "Missing the required parameter 'post_api_charts_by_chart_id_versions_by_version_actions_copy_request' when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy"
|
|
4431
|
+
end
|
|
4432
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
4433
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy, the character length must be smaller than or equal to 255.'
|
|
4434
|
+
end
|
|
4435
|
+
|
|
4436
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
4437
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy, the character length must be great than or equal to 1.'
|
|
4438
|
+
end
|
|
4439
|
+
|
|
4440
|
+
# resource path
|
|
4441
|
+
local_var_path = '/api/charts/{chartId}/versions/{version}/actions/copy'.sub('{' + 'chartId' + '}', CGI.escape(chart_id.to_s)).sub('{' + 'version' + '}', CGI.escape(version.to_s))
|
|
4442
|
+
|
|
4443
|
+
# query parameters
|
|
4444
|
+
query_params = opts[:query_params] || {}
|
|
4445
|
+
|
|
4446
|
+
# header parameters
|
|
4447
|
+
header_params = opts[:header_params] || {}
|
|
4448
|
+
# HTTP header 'Content-Type'
|
|
4449
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
4450
|
+
if !content_type.nil?
|
|
4451
|
+
header_params['Content-Type'] = content_type
|
|
4452
|
+
end
|
|
4453
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
4454
|
+
|
|
4455
|
+
# form parameters
|
|
4456
|
+
form_params = opts[:form_params] || {}
|
|
4457
|
+
|
|
4458
|
+
# http body (model)
|
|
4459
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_charts_by_chart_id_versions_by_version_actions_copy_request)
|
|
4460
|
+
|
|
4461
|
+
# return_type
|
|
4462
|
+
return_type = opts[:debug_return_type]
|
|
4463
|
+
|
|
4464
|
+
# auth_names
|
|
4465
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
4466
|
+
|
|
4467
|
+
new_options = opts.merge(
|
|
4468
|
+
:operation => :"ChartsApi.post_api_charts_by_chart_id_versions_by_version_actions_copy",
|
|
4469
|
+
:header_params => header_params,
|
|
4470
|
+
:query_params => query_params,
|
|
4471
|
+
:form_params => form_params,
|
|
4472
|
+
:body => post_body,
|
|
4473
|
+
:auth_names => auth_names,
|
|
4474
|
+
:return_type => return_type
|
|
4475
|
+
)
|
|
4476
|
+
|
|
4477
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4478
|
+
if @api_client.config.debugging
|
|
4479
|
+
@api_client.config.logger.debug "API called: ChartsApi#post_api_charts_by_chart_id_versions_by_version_actions_copy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4480
|
+
end
|
|
4481
|
+
return data, status_code, headers
|
|
4482
|
+
end
|
|
4483
|
+
|
|
3823
4484
|
# Restore a version into the draft
|
|
3824
4485
|
# Overwrites the chart draft with the content of a published version (seats, shapes, categories, images). It never publishes: the live map and linked events are untouched until `POST /api/charts/:chartId/map/publish`, which runs the normal validation and records a new version. Any unpublished draft changes are replaced. Requires map authoring rights (admin / map editor dashboard role or `x-api-key`).
|
|
3825
4486
|
# @param chart_id [String]
|
|
@@ -3911,26 +4572,98 @@ module SeatsChart
|
|
|
3911
4572
|
return data, status_code, headers
|
|
3912
4573
|
end
|
|
3913
4574
|
|
|
4575
|
+
# Retired: scan an event chart image (410)
|
|
4576
|
+
# Retired legacy AI scan route: always answers 410 `scan_route_retired` without calling any AI provider. Use `POST /api/extract-seats` with a multipart image.
|
|
4577
|
+
# @param event_id [String]
|
|
4578
|
+
# @param [Hash] opts the optional parameters
|
|
4579
|
+
# @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.
|
|
4580
|
+
# @return [nil]
|
|
4581
|
+
def post_api_events_by_event_id_actions_scan_chart(event_id, opts = {})
|
|
4582
|
+
post_api_events_by_event_id_actions_scan_chart_with_http_info(event_id, opts)
|
|
4583
|
+
nil
|
|
4584
|
+
end
|
|
4585
|
+
|
|
4586
|
+
# Retired: scan an event chart image (410)
|
|
4587
|
+
# Retired legacy AI scan route: always answers 410 `scan_route_retired` without calling any AI provider. Use `POST /api/extract-seats` with a multipart image.
|
|
4588
|
+
# @param event_id [String]
|
|
4589
|
+
# @param [Hash] opts the optional parameters
|
|
4590
|
+
# @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.
|
|
4591
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
4592
|
+
def post_api_events_by_event_id_actions_scan_chart_with_http_info(event_id, opts = {})
|
|
4593
|
+
if @api_client.config.debugging
|
|
4594
|
+
@api_client.config.logger.debug 'Calling API: ChartsApi.post_api_events_by_event_id_actions_scan_chart ...'
|
|
4595
|
+
end
|
|
4596
|
+
# verify the required parameter 'event_id' is set
|
|
4597
|
+
if @api_client.config.client_side_validation && event_id.nil?
|
|
4598
|
+
fail ArgumentError, "Missing the required parameter 'event_id' when calling ChartsApi.post_api_events_by_event_id_actions_scan_chart"
|
|
4599
|
+
end
|
|
4600
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
4601
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_events_by_event_id_actions_scan_chart, the character length must be smaller than or equal to 255.'
|
|
4602
|
+
end
|
|
4603
|
+
|
|
4604
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
4605
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.post_api_events_by_event_id_actions_scan_chart, the character length must be great than or equal to 1.'
|
|
4606
|
+
end
|
|
4607
|
+
|
|
4608
|
+
# resource path
|
|
4609
|
+
local_var_path = '/api/events/{eventId}/actions/scan-chart'.sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))
|
|
4610
|
+
|
|
4611
|
+
# query parameters
|
|
4612
|
+
query_params = opts[:query_params] || {}
|
|
4613
|
+
|
|
4614
|
+
# header parameters
|
|
4615
|
+
header_params = opts[:header_params] || {}
|
|
4616
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
4617
|
+
|
|
4618
|
+
# form parameters
|
|
4619
|
+
form_params = opts[:form_params] || {}
|
|
4620
|
+
|
|
4621
|
+
# http body (model)
|
|
4622
|
+
post_body = opts[:debug_body]
|
|
4623
|
+
|
|
4624
|
+
# return_type
|
|
4625
|
+
return_type = opts[:debug_return_type]
|
|
4626
|
+
|
|
4627
|
+
# auth_names
|
|
4628
|
+
auth_names = opts[:debug_auth_names] || []
|
|
4629
|
+
|
|
4630
|
+
new_options = opts.merge(
|
|
4631
|
+
:operation => :"ChartsApi.post_api_events_by_event_id_actions_scan_chart",
|
|
4632
|
+
:header_params => header_params,
|
|
4633
|
+
:query_params => query_params,
|
|
4634
|
+
:form_params => form_params,
|
|
4635
|
+
:body => post_body,
|
|
4636
|
+
:auth_names => auth_names,
|
|
4637
|
+
:return_type => return_type
|
|
4638
|
+
)
|
|
4639
|
+
|
|
4640
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
4641
|
+
if @api_client.config.debugging
|
|
4642
|
+
@api_client.config.logger.debug "API called: ChartsApi#post_api_events_by_event_id_actions_scan_chart\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
4643
|
+
end
|
|
4644
|
+
return data, status_code, headers
|
|
4645
|
+
end
|
|
4646
|
+
|
|
3914
4647
|
# Save chart map draft
|
|
3915
4648
|
# Saves the designer draft (`draftUpdatedAt` in the response). With `baseDraftUpdatedAt` the save is conflict-safe: 409 `draft_conflict` (with the current `draftUpdatedAt`) when the draft changed since that version — used by the designer autosave.
|
|
3916
4649
|
# @param chart_id [String]
|
|
3917
|
-
# @param
|
|
4650
|
+
# @param post_api_charts_by_chart_id_actions_validate_request [PostApiChartsByChartIdActionsValidateRequest]
|
|
3918
4651
|
# @param [Hash] opts the optional parameters
|
|
3919
4652
|
# @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.
|
|
3920
4653
|
# @return [nil]
|
|
3921
|
-
def put_api_charts_by_chart_id_map_draft(chart_id,
|
|
3922
|
-
put_api_charts_by_chart_id_map_draft_with_http_info(chart_id,
|
|
4654
|
+
def put_api_charts_by_chart_id_map_draft(chart_id, post_api_charts_by_chart_id_actions_validate_request, opts = {})
|
|
4655
|
+
put_api_charts_by_chart_id_map_draft_with_http_info(chart_id, post_api_charts_by_chart_id_actions_validate_request, opts)
|
|
3923
4656
|
nil
|
|
3924
4657
|
end
|
|
3925
4658
|
|
|
3926
4659
|
# Save chart map draft
|
|
3927
4660
|
# Saves the designer draft (`draftUpdatedAt` in the response). With `baseDraftUpdatedAt` the save is conflict-safe: 409 `draft_conflict` (with the current `draftUpdatedAt`) when the draft changed since that version — used by the designer autosave.
|
|
3928
4661
|
# @param chart_id [String]
|
|
3929
|
-
# @param
|
|
4662
|
+
# @param post_api_charts_by_chart_id_actions_validate_request [PostApiChartsByChartIdActionsValidateRequest]
|
|
3930
4663
|
# @param [Hash] opts the optional parameters
|
|
3931
4664
|
# @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.
|
|
3932
4665
|
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
3933
|
-
def put_api_charts_by_chart_id_map_draft_with_http_info(chart_id,
|
|
4666
|
+
def put_api_charts_by_chart_id_map_draft_with_http_info(chart_id, post_api_charts_by_chart_id_actions_validate_request, opts = {})
|
|
3934
4667
|
if @api_client.config.debugging
|
|
3935
4668
|
@api_client.config.logger.debug 'Calling API: ChartsApi.put_api_charts_by_chart_id_map_draft ...'
|
|
3936
4669
|
end
|
|
@@ -3946,9 +4679,9 @@ module SeatsChart
|
|
|
3946
4679
|
fail ArgumentError, 'invalid value for "chart_id" when calling ChartsApi.put_api_charts_by_chart_id_map_draft, the character length must be great than or equal to 36.'
|
|
3947
4680
|
end
|
|
3948
4681
|
|
|
3949
|
-
# verify the required parameter '
|
|
3950
|
-
if @api_client.config.client_side_validation &&
|
|
3951
|
-
fail ArgumentError, "Missing the required parameter '
|
|
4682
|
+
# verify the required parameter 'post_api_charts_by_chart_id_actions_validate_request' is set
|
|
4683
|
+
if @api_client.config.client_side_validation && post_api_charts_by_chart_id_actions_validate_request.nil?
|
|
4684
|
+
fail ArgumentError, "Missing the required parameter 'post_api_charts_by_chart_id_actions_validate_request' when calling ChartsApi.put_api_charts_by_chart_id_map_draft"
|
|
3952
4685
|
end
|
|
3953
4686
|
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
3954
4687
|
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling ChartsApi.put_api_charts_by_chart_id_map_draft, the character length must be smaller than or equal to 255.'
|
|
@@ -3977,7 +4710,7 @@ module SeatsChart
|
|
|
3977
4710
|
form_params = opts[:form_params] || {}
|
|
3978
4711
|
|
|
3979
4712
|
# http body (model)
|
|
3980
|
-
post_body = opts[:debug_body] || @api_client.object_to_http_body(
|
|
4713
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_charts_by_chart_id_actions_validate_request)
|
|
3981
4714
|
|
|
3982
4715
|
# return_type
|
|
3983
4716
|
return_type = opts[:debug_return_type]
|