seatschart 0.1.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 +7 -0
- data/LICENSE +21 -0
- data/README.md +552 -0
- data/lib/seatschart/api/api_keys_api.rb +364 -0
- data/lib/seatschart/api/assets_api.rb +95 -0
- data/lib/seatschart/api/audit_api.rb +88 -0
- data/lib/seatschart/api/auth_api.rb +1187 -0
- data/lib/seatschart/api/billing_api.rb +355 -0
- data/lib/seatschart/api/charts_api.rb +4195 -0
- data/lib/seatschart/api/default_api.rb +763 -0
- data/lib/seatschart/api/embed_api.rb +407 -0
- data/lib/seatschart/api/embed_origins_api.rb +281 -0
- data/lib/seatschart/api/event_log_api.rb +148 -0
- data/lib/seatschart/api/events_api.rb +6608 -0
- data/lib/seatschart/api/health_api.rb +77 -0
- data/lib/seatschart/api/map_designer_api.rb +135 -0
- data/lib/seatschart/api/object_status_api.rb +805 -0
- data/lib/seatschart/api/orders_api.rb +166 -0
- data/lib/seatschart/api/public_api.rb +455 -0
- data/lib/seatschart/api/quotes_api.rb +103 -0
- data/lib/seatschart/api/seasons_api.rb +5543 -0
- data/lib/seatschart/api/seats_api.rb +1103 -0
- data/lib/seatschart/api/sse_api.rb +83 -0
- data/lib/seatschart/api/team_api.rb +428 -0
- data/lib/seatschart/api/usage_api.rb +540 -0
- data/lib/seatschart/api/webhooks_api.rb +771 -0
- data/lib/seatschart/api/workspace_api.rb +1244 -0
- data/lib/seatschart/api_client.rb +394 -0
- data/lib/seatschart/api_error.rb +58 -0
- data/lib/seatschart/configuration.rb +316 -0
- data/lib/seatschart/models/delete_api_workspaces_by_workspace_id200_response.rb +283 -0
- data/lib/seatschart/models/get_api_charts_by_chart_id_versions200_response.rb +247 -0
- data/lib/seatschart/models/get_api_charts_by_chart_id_versions200_response_items_inner.rb +473 -0
- data/lib/seatschart/models/get_api_charts_by_chart_id_versions200_response_items_inner_published_by.rb +280 -0
- data/lib/seatschart/models/get_api_events_by_event_id_map_versions200_response.rb +247 -0
- data/lib/seatschart/models/get_api_events_by_event_id_map_versions200_response_items_inner.rb +444 -0
- data/lib/seatschart/models/get_api_events_by_event_id_seat_views200_response.rb +267 -0
- data/lib/seatschart/models/get_api_events_by_event_id_seat_views200_response_views_value.rb +273 -0
- data/lib/seatschart/models/get_api_events_by_event_id_seat_views404_response.rb +237 -0
- data/lib/seatschart/models/get_api_monitoring_requests200_response.rb +388 -0
- data/lib/seatschart/models/get_api_monitoring_requests200_response_lanes.rb +237 -0
- data/lib/seatschart/models/get_api_monitoring_requests200_response_lanes_sales.rb +256 -0
- data/lib/seatschart/models/get_api_monitoring_requests200_response_points_inner.rb +286 -0
- data/lib/seatschart/models/get_api_workspace_integration200_response.rb +287 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response.rb +329 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response_bounds.rb +237 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response_bounds_hold_period_minutes.rb +237 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response_effective.rb +269 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response_overrides.rb +241 -0
- data/lib/seatschart/models/get_api_workspace_settings200_response_sources.rb +339 -0
- data/lib/seatschart/models/get_api_workspaces200_response.rb +223 -0
- data/lib/seatschart/models/get_api_workspaces200_response_items_inner.rb +423 -0
- data/lib/seatschart/models/patch_api_charts_by_chart_id_categories_by_category_id_request.rb +304 -0
- data/lib/seatschart/models/patch_api_charts_by_chart_id_request.rb +288 -0
- data/lib/seatschart/models/patch_api_events_by_event_id_inventory_channels_by_channel_key_id_request.rb +272 -0
- data/lib/seatschart/models/patch_api_events_by_event_id_request.rb +448 -0
- data/lib/seatschart/models/patch_api_events_by_event_id_request_categories_inner.rb +343 -0
- data/lib/seatschart/models/patch_api_events_by_event_id_request_table_booking_config.rb +266 -0
- data/lib/seatschart/models/patch_api_keys_by_id_request.rb +292 -0
- data/lib/seatschart/models/patch_api_seasons_by_season_id_events_by_event_id_request.rb +221 -0
- data/lib/seatschart/models/patch_api_seasons_by_season_id_request.rb +276 -0
- data/lib/seatschart/models/patch_api_team_members_by_user_id_request.rb +255 -0
- data/lib/seatschart/models/patch_api_webhooks_by_id_request.rb +291 -0
- data/lib/seatschart/models/patch_api_workspace_chart_validation_request.rb +224 -0
- data/lib/seatschart/models/patch_api_workspace_chart_validation_request_severities.rb +543 -0
- data/lib/seatschart/models/patch_api_workspace_integration_request.rb +257 -0
- data/lib/seatschart/models/patch_api_workspace_request.rb +249 -0
- data/lib/seatschart/models/patch_api_workspace_settings_request.rb +307 -0
- data/lib/seatschart/models/post_api_auth2fa_disable_request.rb +281 -0
- data/lib/seatschart/models/post_api_auth2fa_enable_request.rb +250 -0
- data/lib/seatschart/models/post_api_auth2fa_enroll_confirm_request.rb +295 -0
- data/lib/seatschart/models/post_api_auth2fa_enroll_start_request.rb +250 -0
- data/lib/seatschart/models/post_api_auth2fa_verify_request.rb +326 -0
- data/lib/seatschart/models/post_api_auth_accept_invite_request.rb +293 -0
- data/lib/seatschart/models/post_api_auth_login_request.rb +293 -0
- data/lib/seatschart/models/post_api_auth_logout_request.rb +242 -0
- data/lib/seatschart/models/post_api_auth_refresh_request.rb +292 -0
- data/lib/seatschart/models/post_api_auth_signup_request.rb +321 -0
- data/lib/seatschart/models/post_api_auth_switch_workspace_request.rb +249 -0
- data/lib/seatschart/models/post_api_billing_checkout_session_request.rb +249 -0
- data/lib/seatschart/models/post_api_billing_confirm_checkout_request.rb +249 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_archive200_response.rb +221 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_archive200_response_chart.rb +249 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_copy_to_workspace_request.rb +287 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_validate_request.rb +348 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_validate_request_seats_inner.rb +555 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_actions_validate_request_seats_inner_accessibility.rb +356 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_categories_request.rb +361 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_categories_request_ticket_types_inner.rb +448 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_duplicate_request.rb +233 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_map_publish422_response.rb +289 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_map_publish422_response_issues_inner.rb +402 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_map_publish_request.rb +244 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_preview_link_request.rb +243 -0
- data/lib/seatschart/models/post_api_charts_by_chart_id_versions_by_version_actions_copy_request.rb +242 -0
- data/lib/seatschart/models/post_api_charts_request.rb +372 -0
- data/lib/seatschart/models/post_api_charts_request_categories_inner.rb +346 -0
- data/lib/seatschart/models/post_api_embed_origins_request.rb +249 -0
- data/lib/seatschart/models/post_api_embed_tokens_request.rb +394 -0
- data/lib/seatschart/models/post_api_events_actions_change_object_status_request.rb +251 -0
- data/lib/seatschart/models/post_api_events_actions_change_object_status_request_status_changes_inner.rb +737 -0
- data/lib/seatschart/models/post_api_events_actions_change_object_status_request_status_changes_inner_objects_inner.rb +104 -0
- data/lib/seatschart/models/post_api_events_actions_change_object_status_request_status_changes_inner_objects_inner_any_of.rb +335 -0
- data/lib/seatschart/models/post_api_events_bulk_request.rb +332 -0
- data/lib/seatschart/models/post_api_events_bulk_request_events_inner.rb +398 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_change_object_status_request.rb +824 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_override_season_status_request.rb +272 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_update_extra_data_request.rb +260 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_update_extra_data_request_objects_inner.rb +263 -0
- data/lib/seatschart/models/post_api_events_by_event_id_actions_use_season_status_request.rb +252 -0
- data/lib/seatschart/models/post_api_events_by_event_id_duplicate_request.rb +261 -0
- data/lib/seatschart/models/post_api_events_by_event_id_inventory_channels_assign_request.rb +321 -0
- data/lib/seatschart/models/post_api_events_by_event_id_inventory_channels_request.rb +323 -0
- data/lib/seatschart/models/post_api_events_by_event_id_inventory_for_sale_apply_request.rb +333 -0
- data/lib/seatschart/models/post_api_events_by_event_id_objects_actions_retrieve_request.rb +252 -0
- data/lib/seatschart/models/post_api_events_request.rb +502 -0
- data/lib/seatschart/models/post_api_events_request_category_overrides_value.rb +276 -0
- data/lib/seatschart/models/post_api_events_request_channels_inner.rb +360 -0
- data/lib/seatschart/models/post_api_events_request_for_sale_config.rb +295 -0
- data/lib/seatschart/models/post_api_events_request_table_booking_config.rb +267 -0
- data/lib/seatschart/models/post_api_extract_seats_request.rb +279 -0
- data/lib/seatschart/models/post_api_ga_confirm409_response.rb +271 -0
- data/lib/seatschart/models/post_api_ga_confirm_request.rb +687 -0
- data/lib/seatschart/models/post_api_ga_release_request.rb +385 -0
- data/lib/seatschart/models/post_api_ga_reserve_request.rb +527 -0
- data/lib/seatschart/models/post_api_hold_tokens_by_token_request.rb +249 -0
- data/lib/seatschart/models/post_api_hold_tokens_request.rb +391 -0
- data/lib/seatschart/models/post_api_keys_request.rb +299 -0
- data/lib/seatschart/models/post_api_orders_by_order_id_cancel_request.rb +249 -0
- data/lib/seatschart/models/post_api_quotes_request.rb +351 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_actions_add_events_request.rb +261 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_actions_create_events_request.rb +322 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_actions_create_events_request_events_inner.rb +289 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_actions_remove_events_request.rb +251 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_events_request.rb +267 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_inventory_sync_request.rb +235 -0
- data/lib/seatschart/models/post_api_seasons_by_season_id_partial_seasons_request.rb +279 -0
- data/lib/seatschart/models/post_api_seasons_request.rb +395 -0
- data/lib/seatschart/models/post_api_seats_best_available_request.rb +809 -0
- data/lib/seatschart/models/post_api_seats_confirm409_response.rb +271 -0
- data/lib/seatschart/models/post_api_seats_confirm_request.rb +711 -0
- data/lib/seatschart/models/post_api_seats_holds_renew_request.rb +249 -0
- data/lib/seatschart/models/post_api_seats_release_request.rb +387 -0
- data/lib/seatschart/models/post_api_seats_reserve_request.rb +561 -0
- data/lib/seatschart/models/post_api_team_invitations_request.rb +299 -0
- data/lib/seatschart/models/post_api_ticket_buyers_request.rb +252 -0
- data/lib/seatschart/models/post_api_viewer_tokens_request.rb +292 -0
- data/lib/seatschart/models/post_api_webhooks_request.rb +298 -0
- data/lib/seatschart/models/post_api_workspaces_request.rb +269 -0
- data/lib/seatschart/models/put_api_charts_by_chart_id_tags_request.rb +243 -0
- data/lib/seatschart/models/put_api_charts_by_chart_id_versions_by_version_thumbnail_request.rb +261 -0
- data/lib/seatschart/models/put_api_events_by_event_id_inventory_channels_definitions_request.rb +242 -0
- data/lib/seatschart/models/put_api_events_by_event_id_inventory_channels_definitions_request_channels_inner.rb +405 -0
- data/lib/seatschart/models/put_api_events_by_event_id_inventory_channels_request.rb +242 -0
- data/lib/seatschart/models/put_api_events_by_event_id_inventory_channels_request_assignments_inner.rb +320 -0
- data/lib/seatschart/models/put_api_events_by_event_id_inventory_for_sale_request.rb +333 -0
- data/lib/seatschart/models/put_api_events_by_event_id_pricing_request.rb +297 -0
- data/lib/seatschart/models/put_api_events_by_event_id_pricing_request_categories_inner.rb +295 -0
- data/lib/seatschart/models/put_api_events_by_event_id_pricing_request_categories_inner_ticket_types_inner.rb +425 -0
- data/lib/seatschart/models/put_api_events_by_event_id_sales_rules_request.rb +320 -0
- data/lib/seatschart/models/put_api_events_by_event_id_sales_rules_request_buyer_limit.rb +259 -0
- data/lib/seatschart/models/put_api_events_by_event_id_sales_rules_request_lot_plans_inner.rb +374 -0
- data/lib/seatschart/models/put_api_events_by_event_id_sales_rules_request_lot_plans_inner_lots_inner.rb +364 -0
- data/lib/seatschart/models/put_api_events_by_event_id_sales_rules_request_quotas_inner.rb +418 -0
- data/lib/seatschart/retry.rb +118 -0
- data/lib/seatschart/version.rb +15 -0
- data/lib/seatschart.rb +198 -0
- metadata +254 -0
|
@@ -0,0 +1,1244 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#SeatsChart API
|
|
3
|
+
|
|
4
|
+
#Seat inventory and locking API for B2B2C integrations. Authenticate using `x-api-key` (partners) or `Authorization: Bearer` with an HS256 JWT.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
|
7
|
+
|
|
8
|
+
Generated by: https://openapi-generator.tech
|
|
9
|
+
Generator version: 7.11.0
|
|
10
|
+
|
|
11
|
+
=end
|
|
12
|
+
|
|
13
|
+
require 'cgi'
|
|
14
|
+
|
|
15
|
+
module SeatsChart
|
|
16
|
+
class WorkspaceApi
|
|
17
|
+
attr_accessor :api_client
|
|
18
|
+
|
|
19
|
+
def initialize(api_client = ApiClient.default)
|
|
20
|
+
@api_client = api_client
|
|
21
|
+
end
|
|
22
|
+
# Delete (soft) a workspace
|
|
23
|
+
# Workspaces are never hard-deleted: their charts, events, orders and audit history are kept for accounting and reconciliation. DELETE is a **soft delete** — exactly POST /workspaces/{workspaceId}/actions/deactivate (reversible with …/actions/activate). Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`).
|
|
24
|
+
# @param workspace_id [String]
|
|
25
|
+
# @param [Hash] opts the optional parameters
|
|
26
|
+
# @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.
|
|
27
|
+
# @return [DeleteApiWorkspacesByWorkspaceId200Response]
|
|
28
|
+
def delete_api_workspaces_by_workspace_id(workspace_id, opts = {})
|
|
29
|
+
data, _status_code, _headers = delete_api_workspaces_by_workspace_id_with_http_info(workspace_id, opts)
|
|
30
|
+
data
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
# Delete (soft) a workspace
|
|
34
|
+
# Workspaces are never hard-deleted: their charts, events, orders and audit history are kept for accounting and reconciliation. DELETE is a **soft delete** — exactly POST /workspaces/{workspaceId}/actions/deactivate (reversible with …/actions/activate). Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`).
|
|
35
|
+
# @param workspace_id [String]
|
|
36
|
+
# @param [Hash] opts the optional parameters
|
|
37
|
+
# @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.
|
|
38
|
+
# @return [Array<(DeleteApiWorkspacesByWorkspaceId200Response, Integer, Hash)>] DeleteApiWorkspacesByWorkspaceId200Response data, response status code and response headers
|
|
39
|
+
def delete_api_workspaces_by_workspace_id_with_http_info(workspace_id, opts = {})
|
|
40
|
+
if @api_client.config.debugging
|
|
41
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.delete_api_workspaces_by_workspace_id ...'
|
|
42
|
+
end
|
|
43
|
+
# verify the required parameter 'workspace_id' is set
|
|
44
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
45
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.delete_api_workspaces_by_workspace_id"
|
|
46
|
+
end
|
|
47
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
48
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.delete_api_workspaces_by_workspace_id, the character length must be smaller than or equal to 128.'
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
52
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.delete_api_workspaces_by_workspace_id, the character length must be great than or equal to 1.'
|
|
53
|
+
end
|
|
54
|
+
|
|
55
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
56
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.delete_api_workspaces_by_workspace_id, the character length must be smaller than or equal to 255.'
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
60
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.delete_api_workspaces_by_workspace_id, the character length must be great than or equal to 1.'
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
# resource path
|
|
64
|
+
local_var_path = '/api/workspaces/{workspaceId}'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
65
|
+
|
|
66
|
+
# query parameters
|
|
67
|
+
query_params = opts[:query_params] || {}
|
|
68
|
+
|
|
69
|
+
# header parameters
|
|
70
|
+
header_params = opts[:header_params] || {}
|
|
71
|
+
# HTTP header 'Accept' (if needed)
|
|
72
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
73
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
74
|
+
|
|
75
|
+
# form parameters
|
|
76
|
+
form_params = opts[:form_params] || {}
|
|
77
|
+
|
|
78
|
+
# http body (model)
|
|
79
|
+
post_body = opts[:debug_body]
|
|
80
|
+
|
|
81
|
+
# return_type
|
|
82
|
+
return_type = opts[:debug_return_type] || 'DeleteApiWorkspacesByWorkspaceId200Response'
|
|
83
|
+
|
|
84
|
+
# auth_names
|
|
85
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
86
|
+
|
|
87
|
+
new_options = opts.merge(
|
|
88
|
+
:operation => :"WorkspaceApi.delete_api_workspaces_by_workspace_id",
|
|
89
|
+
:header_params => header_params,
|
|
90
|
+
:query_params => query_params,
|
|
91
|
+
:form_params => form_params,
|
|
92
|
+
:body => post_body,
|
|
93
|
+
:auth_names => auth_names,
|
|
94
|
+
:return_type => return_type
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
|
|
98
|
+
if @api_client.config.debugging
|
|
99
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#delete_api_workspaces_by_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
100
|
+
end
|
|
101
|
+
return data, status_code, headers
|
|
102
|
+
end
|
|
103
|
+
|
|
104
|
+
# Get workspace profile for the authenticated tenant
|
|
105
|
+
# Includes `publicKey` (`pub_…`) for `?workspaceKey=` on the viewer. The public key is not authentication — Bearer JWT or embed token is still required.
|
|
106
|
+
# @param [Hash] opts the optional parameters
|
|
107
|
+
# @return [nil]
|
|
108
|
+
def get_api_workspace(opts = {})
|
|
109
|
+
get_api_workspace_with_http_info(opts)
|
|
110
|
+
nil
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Get workspace profile for the authenticated tenant
|
|
114
|
+
# Includes `publicKey` (`pub_…`) for `?workspaceKey=` on the viewer. The public key is not authentication — Bearer JWT or embed token is still required.
|
|
115
|
+
# @param [Hash] opts the optional parameters
|
|
116
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
117
|
+
def get_api_workspace_with_http_info(opts = {})
|
|
118
|
+
if @api_client.config.debugging
|
|
119
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspace ...'
|
|
120
|
+
end
|
|
121
|
+
# resource path
|
|
122
|
+
local_var_path = '/api/workspace'
|
|
123
|
+
|
|
124
|
+
# query parameters
|
|
125
|
+
query_params = opts[:query_params] || {}
|
|
126
|
+
|
|
127
|
+
# header parameters
|
|
128
|
+
header_params = opts[:header_params] || {}
|
|
129
|
+
|
|
130
|
+
# form parameters
|
|
131
|
+
form_params = opts[:form_params] || {}
|
|
132
|
+
|
|
133
|
+
# http body (model)
|
|
134
|
+
post_body = opts[:debug_body]
|
|
135
|
+
|
|
136
|
+
# return_type
|
|
137
|
+
return_type = opts[:debug_return_type]
|
|
138
|
+
|
|
139
|
+
# auth_names
|
|
140
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
141
|
+
|
|
142
|
+
new_options = opts.merge(
|
|
143
|
+
:operation => :"WorkspaceApi.get_api_workspace",
|
|
144
|
+
:header_params => header_params,
|
|
145
|
+
:query_params => query_params,
|
|
146
|
+
:form_params => form_params,
|
|
147
|
+
:body => post_body,
|
|
148
|
+
:auth_names => auth_names,
|
|
149
|
+
:return_type => return_type
|
|
150
|
+
)
|
|
151
|
+
|
|
152
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
153
|
+
if @api_client.config.debugging
|
|
154
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
155
|
+
end
|
|
156
|
+
return data, status_code, headers
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
# Get chart validation severities
|
|
160
|
+
# Level of every chart validation rule for this workspace (`off`, `warning` or `error`) plus the product defaults. The designer, `POST /charts/{chartId}/map/publish`, `POST /charts/{chartId}/actions/validate` and event creation all apply these levels. Rules: `no_objects` (no seats or GA areas), `empty_label` (unlabeled seats / GA areas), `duplicate_label` (same label in a section), `uncategorized` (objects without a category once categories exist), `overlap`, `table_too_small` (< 2 seats), `ga_invalid_capacity` (GA capacity missing or outside 1–100000), `empty_floor` (multi-floor maps), `empty_section`, `outside_section` (seat outside its section outline), `multiple_object_types` (one category used by seats, table seats and GA areas), `missing_focal_point`, `zone_missing_focal_point`, `orphan_gap` (one-seat gap in a row), `ga_table_capacity` (GA tables in an area hold more places than its capacity).
|
|
161
|
+
# @param [Hash] opts the optional parameters
|
|
162
|
+
# @return [nil]
|
|
163
|
+
def get_api_workspace_chart_validation(opts = {})
|
|
164
|
+
get_api_workspace_chart_validation_with_http_info(opts)
|
|
165
|
+
nil
|
|
166
|
+
end
|
|
167
|
+
|
|
168
|
+
# Get chart validation severities
|
|
169
|
+
# Level of every chart validation rule for this workspace (`off`, `warning` or `error`) plus the product defaults. The designer, `POST /charts/{chartId}/map/publish`, `POST /charts/{chartId}/actions/validate` and event creation all apply these levels. Rules: `no_objects` (no seats or GA areas), `empty_label` (unlabeled seats / GA areas), `duplicate_label` (same label in a section), `uncategorized` (objects without a category once categories exist), `overlap`, `table_too_small` (< 2 seats), `ga_invalid_capacity` (GA capacity missing or outside 1–100000), `empty_floor` (multi-floor maps), `empty_section`, `outside_section` (seat outside its section outline), `multiple_object_types` (one category used by seats, table seats and GA areas), `missing_focal_point`, `zone_missing_focal_point`, `orphan_gap` (one-seat gap in a row), `ga_table_capacity` (GA tables in an area hold more places than its capacity).
|
|
170
|
+
# @param [Hash] opts the optional parameters
|
|
171
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
172
|
+
def get_api_workspace_chart_validation_with_http_info(opts = {})
|
|
173
|
+
if @api_client.config.debugging
|
|
174
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspace_chart_validation ...'
|
|
175
|
+
end
|
|
176
|
+
# resource path
|
|
177
|
+
local_var_path = '/api/workspace/chart-validation'
|
|
178
|
+
|
|
179
|
+
# query parameters
|
|
180
|
+
query_params = opts[:query_params] || {}
|
|
181
|
+
|
|
182
|
+
# header parameters
|
|
183
|
+
header_params = opts[:header_params] || {}
|
|
184
|
+
|
|
185
|
+
# form parameters
|
|
186
|
+
form_params = opts[:form_params] || {}
|
|
187
|
+
|
|
188
|
+
# http body (model)
|
|
189
|
+
post_body = opts[:debug_body]
|
|
190
|
+
|
|
191
|
+
# return_type
|
|
192
|
+
return_type = opts[:debug_return_type]
|
|
193
|
+
|
|
194
|
+
# auth_names
|
|
195
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
196
|
+
|
|
197
|
+
new_options = opts.merge(
|
|
198
|
+
:operation => :"WorkspaceApi.get_api_workspace_chart_validation",
|
|
199
|
+
:header_params => header_params,
|
|
200
|
+
:query_params => query_params,
|
|
201
|
+
:form_params => form_params,
|
|
202
|
+
:body => post_body,
|
|
203
|
+
:auth_names => auth_names,
|
|
204
|
+
:return_type => return_type
|
|
205
|
+
)
|
|
206
|
+
|
|
207
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
208
|
+
if @api_client.config.debugging
|
|
209
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspace_chart_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
210
|
+
end
|
|
211
|
+
return data, status_code, headers
|
|
212
|
+
end
|
|
213
|
+
|
|
214
|
+
# Get the workspace integration mode (pricing source)
|
|
215
|
+
# `pricingSource`: where prices come from for events without their own override — `partner` (the ticketing platform passes prices to the renderer and declares amounts at confirm; no quote required), `synced_catalog` (the platform pushes a price table with PUT /events/{eventId}/pricing; confirmations are validated against it) or `seatschart_catalog` (prices from the designer catalog; a quote is required before every confirm). New workspaces start with `partner`; workspaces created before pricing modes keep `seatschart_catalog`. `ownCatalog`: show the direct-selling tools (event prices, box office) in the dashboard although prices come from the platform.
|
|
216
|
+
# @param [Hash] opts the optional parameters
|
|
217
|
+
# @return [GetApiWorkspaceIntegration200Response]
|
|
218
|
+
def get_api_workspace_integration(opts = {})
|
|
219
|
+
data, _status_code, _headers = get_api_workspace_integration_with_http_info(opts)
|
|
220
|
+
data
|
|
221
|
+
end
|
|
222
|
+
|
|
223
|
+
# Get the workspace integration mode (pricing source)
|
|
224
|
+
# `pricingSource`: where prices come from for events without their own override — `partner` (the ticketing platform passes prices to the renderer and declares amounts at confirm; no quote required), `synced_catalog` (the platform pushes a price table with PUT /events/{eventId}/pricing; confirmations are validated against it) or `seatschart_catalog` (prices from the designer catalog; a quote is required before every confirm). New workspaces start with `partner`; workspaces created before pricing modes keep `seatschart_catalog`. `ownCatalog`: show the direct-selling tools (event prices, box office) in the dashboard although prices come from the platform.
|
|
225
|
+
# @param [Hash] opts the optional parameters
|
|
226
|
+
# @return [Array<(GetApiWorkspaceIntegration200Response, Integer, Hash)>] GetApiWorkspaceIntegration200Response data, response status code and response headers
|
|
227
|
+
def get_api_workspace_integration_with_http_info(opts = {})
|
|
228
|
+
if @api_client.config.debugging
|
|
229
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspace_integration ...'
|
|
230
|
+
end
|
|
231
|
+
# resource path
|
|
232
|
+
local_var_path = '/api/workspace/integration'
|
|
233
|
+
|
|
234
|
+
# query parameters
|
|
235
|
+
query_params = opts[:query_params] || {}
|
|
236
|
+
|
|
237
|
+
# header parameters
|
|
238
|
+
header_params = opts[:header_params] || {}
|
|
239
|
+
# HTTP header 'Accept' (if needed)
|
|
240
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
241
|
+
|
|
242
|
+
# form parameters
|
|
243
|
+
form_params = opts[:form_params] || {}
|
|
244
|
+
|
|
245
|
+
# http body (model)
|
|
246
|
+
post_body = opts[:debug_body]
|
|
247
|
+
|
|
248
|
+
# return_type
|
|
249
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaceIntegration200Response'
|
|
250
|
+
|
|
251
|
+
# auth_names
|
|
252
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
253
|
+
|
|
254
|
+
new_options = opts.merge(
|
|
255
|
+
:operation => :"WorkspaceApi.get_api_workspace_integration",
|
|
256
|
+
:header_params => header_params,
|
|
257
|
+
:query_params => query_params,
|
|
258
|
+
:form_params => form_params,
|
|
259
|
+
:body => post_body,
|
|
260
|
+
:auth_names => auth_names,
|
|
261
|
+
:return_type => return_type
|
|
262
|
+
)
|
|
263
|
+
|
|
264
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
265
|
+
if @api_client.config.debugging
|
|
266
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspace_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
267
|
+
end
|
|
268
|
+
return data, status_code, headers
|
|
269
|
+
end
|
|
270
|
+
|
|
271
|
+
# Get workspace settings (effective value and source)
|
|
272
|
+
# Effective value of every workspace setting, the default it inherits and whether it is overridden. Settings: `holdPeriodMinutes` (1–120; default `SEAT_HOLD_TTL_SEC`, 10 min) — TTL of new and renewed seat/GA holds; `maxSeatsPerHoldToken` (1–64; default 64) — seats one hold token may hold across appends; `ticketBuyerValidation` (default off) — buyer tokens are minted only for a registered ticket buyer id (`POST /ticket-buyers`) and bind it, buyer holds must carry it; `gaPlacesToChannels` (default on) — inventory channels may receive GA place quotas (`areaPlaces`). Each setting either uses the platform default or is overridden for this workspace; `sources` says which.
|
|
273
|
+
# @param [Hash] opts the optional parameters
|
|
274
|
+
# @return [GetApiWorkspaceSettings200Response]
|
|
275
|
+
def get_api_workspace_settings(opts = {})
|
|
276
|
+
data, _status_code, _headers = get_api_workspace_settings_with_http_info(opts)
|
|
277
|
+
data
|
|
278
|
+
end
|
|
279
|
+
|
|
280
|
+
# Get workspace settings (effective value and source)
|
|
281
|
+
# Effective value of every workspace setting, the default it inherits and whether it is overridden. Settings: `holdPeriodMinutes` (1–120; default `SEAT_HOLD_TTL_SEC`, 10 min) — TTL of new and renewed seat/GA holds; `maxSeatsPerHoldToken` (1–64; default 64) — seats one hold token may hold across appends; `ticketBuyerValidation` (default off) — buyer tokens are minted only for a registered ticket buyer id (`POST /ticket-buyers`) and bind it, buyer holds must carry it; `gaPlacesToChannels` (default on) — inventory channels may receive GA place quotas (`areaPlaces`). Each setting either uses the platform default or is overridden for this workspace; `sources` says which.
|
|
282
|
+
# @param [Hash] opts the optional parameters
|
|
283
|
+
# @return [Array<(GetApiWorkspaceSettings200Response, Integer, Hash)>] GetApiWorkspaceSettings200Response data, response status code and response headers
|
|
284
|
+
def get_api_workspace_settings_with_http_info(opts = {})
|
|
285
|
+
if @api_client.config.debugging
|
|
286
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspace_settings ...'
|
|
287
|
+
end
|
|
288
|
+
# resource path
|
|
289
|
+
local_var_path = '/api/workspace/settings'
|
|
290
|
+
|
|
291
|
+
# query parameters
|
|
292
|
+
query_params = opts[:query_params] || {}
|
|
293
|
+
|
|
294
|
+
# header parameters
|
|
295
|
+
header_params = opts[:header_params] || {}
|
|
296
|
+
# HTTP header 'Accept' (if needed)
|
|
297
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
298
|
+
|
|
299
|
+
# form parameters
|
|
300
|
+
form_params = opts[:form_params] || {}
|
|
301
|
+
|
|
302
|
+
# http body (model)
|
|
303
|
+
post_body = opts[:debug_body]
|
|
304
|
+
|
|
305
|
+
# return_type
|
|
306
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaceSettings200Response'
|
|
307
|
+
|
|
308
|
+
# auth_names
|
|
309
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
310
|
+
|
|
311
|
+
new_options = opts.merge(
|
|
312
|
+
:operation => :"WorkspaceApi.get_api_workspace_settings",
|
|
313
|
+
:header_params => header_params,
|
|
314
|
+
:query_params => query_params,
|
|
315
|
+
:form_params => form_params,
|
|
316
|
+
:body => post_body,
|
|
317
|
+
:auth_names => auth_names,
|
|
318
|
+
:return_type => return_type
|
|
319
|
+
)
|
|
320
|
+
|
|
321
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
322
|
+
if @api_client.config.debugging
|
|
323
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspace_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
324
|
+
end
|
|
325
|
+
return data, status_code, headers
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
# List my workspaces
|
|
329
|
+
# Every workspace the signed-in dashboard user belongs to, with role, effective plan, subscription status, activation status and `isCurrent`. Dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`): it lists the workspaces of the admin it is bound to. Other API keys: 403 `ERR_PARTNER_SCOPE`.
|
|
330
|
+
# @param [Hash] opts the optional parameters
|
|
331
|
+
# @return [GetApiWorkspaces200Response]
|
|
332
|
+
def get_api_workspaces(opts = {})
|
|
333
|
+
data, _status_code, _headers = get_api_workspaces_with_http_info(opts)
|
|
334
|
+
data
|
|
335
|
+
end
|
|
336
|
+
|
|
337
|
+
# List my workspaces
|
|
338
|
+
# Every workspace the signed-in dashboard user belongs to, with role, effective plan, subscription status, activation status and `isCurrent`. Dashboard session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`): it lists the workspaces of the admin it is bound to. Other API keys: 403 `ERR_PARTNER_SCOPE`.
|
|
339
|
+
# @param [Hash] opts the optional parameters
|
|
340
|
+
# @return [Array<(GetApiWorkspaces200Response, Integer, Hash)>] GetApiWorkspaces200Response data, response status code and response headers
|
|
341
|
+
def get_api_workspaces_with_http_info(opts = {})
|
|
342
|
+
if @api_client.config.debugging
|
|
343
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspaces ...'
|
|
344
|
+
end
|
|
345
|
+
# resource path
|
|
346
|
+
local_var_path = '/api/workspaces'
|
|
347
|
+
|
|
348
|
+
# query parameters
|
|
349
|
+
query_params = opts[:query_params] || {}
|
|
350
|
+
|
|
351
|
+
# header parameters
|
|
352
|
+
header_params = opts[:header_params] || {}
|
|
353
|
+
# HTTP header 'Accept' (if needed)
|
|
354
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
355
|
+
|
|
356
|
+
# form parameters
|
|
357
|
+
form_params = opts[:form_params] || {}
|
|
358
|
+
|
|
359
|
+
# http body (model)
|
|
360
|
+
post_body = opts[:debug_body]
|
|
361
|
+
|
|
362
|
+
# return_type
|
|
363
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaces200Response'
|
|
364
|
+
|
|
365
|
+
# auth_names
|
|
366
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
367
|
+
|
|
368
|
+
new_options = opts.merge(
|
|
369
|
+
:operation => :"WorkspaceApi.get_api_workspaces",
|
|
370
|
+
:header_params => header_params,
|
|
371
|
+
:query_params => query_params,
|
|
372
|
+
:form_params => form_params,
|
|
373
|
+
:body => post_body,
|
|
374
|
+
:auth_names => auth_names,
|
|
375
|
+
:return_type => return_type
|
|
376
|
+
)
|
|
377
|
+
|
|
378
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
379
|
+
if @api_client.config.debugging
|
|
380
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
381
|
+
end
|
|
382
|
+
return data, status_code, headers
|
|
383
|
+
end
|
|
384
|
+
|
|
385
|
+
# Get one of my workspaces
|
|
386
|
+
# Same item as GET /workspaces for one workspace the caller is a member of (404 otherwise). Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`).
|
|
387
|
+
# @param workspace_id [String]
|
|
388
|
+
# @param [Hash] opts the optional parameters
|
|
389
|
+
# @return [GetApiWorkspaces200ResponseItemsInner]
|
|
390
|
+
def get_api_workspaces_by_workspace_id(workspace_id, opts = {})
|
|
391
|
+
data, _status_code, _headers = get_api_workspaces_by_workspace_id_with_http_info(workspace_id, opts)
|
|
392
|
+
data
|
|
393
|
+
end
|
|
394
|
+
|
|
395
|
+
# Get one of my workspaces
|
|
396
|
+
# Same item as GET /workspaces for one workspace the caller is a member of (404 otherwise). Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`).
|
|
397
|
+
# @param workspace_id [String]
|
|
398
|
+
# @param [Hash] opts the optional parameters
|
|
399
|
+
# @return [Array<(GetApiWorkspaces200ResponseItemsInner, Integer, Hash)>] GetApiWorkspaces200ResponseItemsInner data, response status code and response headers
|
|
400
|
+
def get_api_workspaces_by_workspace_id_with_http_info(workspace_id, opts = {})
|
|
401
|
+
if @api_client.config.debugging
|
|
402
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.get_api_workspaces_by_workspace_id ...'
|
|
403
|
+
end
|
|
404
|
+
# verify the required parameter 'workspace_id' is set
|
|
405
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
406
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.get_api_workspaces_by_workspace_id"
|
|
407
|
+
end
|
|
408
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
409
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.get_api_workspaces_by_workspace_id, the character length must be smaller than or equal to 128.'
|
|
410
|
+
end
|
|
411
|
+
|
|
412
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
413
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.get_api_workspaces_by_workspace_id, the character length must be great than or equal to 1.'
|
|
414
|
+
end
|
|
415
|
+
|
|
416
|
+
# resource path
|
|
417
|
+
local_var_path = '/api/workspaces/{workspaceId}'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
418
|
+
|
|
419
|
+
# query parameters
|
|
420
|
+
query_params = opts[:query_params] || {}
|
|
421
|
+
|
|
422
|
+
# header parameters
|
|
423
|
+
header_params = opts[:header_params] || {}
|
|
424
|
+
# HTTP header 'Accept' (if needed)
|
|
425
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
426
|
+
|
|
427
|
+
# form parameters
|
|
428
|
+
form_params = opts[:form_params] || {}
|
|
429
|
+
|
|
430
|
+
# http body (model)
|
|
431
|
+
post_body = opts[:debug_body]
|
|
432
|
+
|
|
433
|
+
# return_type
|
|
434
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaces200ResponseItemsInner'
|
|
435
|
+
|
|
436
|
+
# auth_names
|
|
437
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
438
|
+
|
|
439
|
+
new_options = opts.merge(
|
|
440
|
+
:operation => :"WorkspaceApi.get_api_workspaces_by_workspace_id",
|
|
441
|
+
:header_params => header_params,
|
|
442
|
+
:query_params => query_params,
|
|
443
|
+
:form_params => form_params,
|
|
444
|
+
:body => post_body,
|
|
445
|
+
:auth_names => auth_names,
|
|
446
|
+
:return_type => return_type
|
|
447
|
+
)
|
|
448
|
+
|
|
449
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
450
|
+
if @api_client.config.debugging
|
|
451
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#get_api_workspaces_by_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
452
|
+
end
|
|
453
|
+
return data, status_code, headers
|
|
454
|
+
end
|
|
455
|
+
|
|
456
|
+
# Update workspace display name
|
|
457
|
+
# @param patch_api_workspace_request [PatchApiWorkspaceRequest]
|
|
458
|
+
# @param [Hash] opts the optional parameters
|
|
459
|
+
# @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.
|
|
460
|
+
# @return [nil]
|
|
461
|
+
def patch_api_workspace(patch_api_workspace_request, opts = {})
|
|
462
|
+
patch_api_workspace_with_http_info(patch_api_workspace_request, opts)
|
|
463
|
+
nil
|
|
464
|
+
end
|
|
465
|
+
|
|
466
|
+
# Update workspace display name
|
|
467
|
+
# @param patch_api_workspace_request [PatchApiWorkspaceRequest]
|
|
468
|
+
# @param [Hash] opts the optional parameters
|
|
469
|
+
# @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.
|
|
470
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
471
|
+
def patch_api_workspace_with_http_info(patch_api_workspace_request, opts = {})
|
|
472
|
+
if @api_client.config.debugging
|
|
473
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.patch_api_workspace ...'
|
|
474
|
+
end
|
|
475
|
+
# verify the required parameter 'patch_api_workspace_request' is set
|
|
476
|
+
if @api_client.config.client_side_validation && patch_api_workspace_request.nil?
|
|
477
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_workspace_request' when calling WorkspaceApi.patch_api_workspace"
|
|
478
|
+
end
|
|
479
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
480
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace, the character length must be smaller than or equal to 255.'
|
|
481
|
+
end
|
|
482
|
+
|
|
483
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
484
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace, the character length must be great than or equal to 1.'
|
|
485
|
+
end
|
|
486
|
+
|
|
487
|
+
# resource path
|
|
488
|
+
local_var_path = '/api/workspace'
|
|
489
|
+
|
|
490
|
+
# query parameters
|
|
491
|
+
query_params = opts[:query_params] || {}
|
|
492
|
+
|
|
493
|
+
# header parameters
|
|
494
|
+
header_params = opts[:header_params] || {}
|
|
495
|
+
# HTTP header 'Content-Type'
|
|
496
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
497
|
+
if !content_type.nil?
|
|
498
|
+
header_params['Content-Type'] = content_type
|
|
499
|
+
end
|
|
500
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
501
|
+
|
|
502
|
+
# form parameters
|
|
503
|
+
form_params = opts[:form_params] || {}
|
|
504
|
+
|
|
505
|
+
# http body (model)
|
|
506
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_workspace_request)
|
|
507
|
+
|
|
508
|
+
# return_type
|
|
509
|
+
return_type = opts[:debug_return_type]
|
|
510
|
+
|
|
511
|
+
# auth_names
|
|
512
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
513
|
+
|
|
514
|
+
new_options = opts.merge(
|
|
515
|
+
:operation => :"WorkspaceApi.patch_api_workspace",
|
|
516
|
+
:header_params => header_params,
|
|
517
|
+
:query_params => query_params,
|
|
518
|
+
:form_params => form_params,
|
|
519
|
+
:body => post_body,
|
|
520
|
+
:auth_names => auth_names,
|
|
521
|
+
:return_type => return_type
|
|
522
|
+
)
|
|
523
|
+
|
|
524
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
525
|
+
if @api_client.config.debugging
|
|
526
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#patch_api_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
527
|
+
end
|
|
528
|
+
return data, status_code, headers
|
|
529
|
+
end
|
|
530
|
+
|
|
531
|
+
# Update chart validation severities
|
|
532
|
+
# Workspace admins only. Merges `severities` into the stored levels (only differences from the defaults are kept); `reset: true` restores the defaults first. Takes effect immediately in the designer and the API (other API replicas within 5 seconds). Charts are not re-validated: stored per-rule counts are re-read under the new levels. Every change is written to the audit log (`workspace.chart_validation.update`). Rules: `no_objects` (no seats or GA areas), `empty_label` (unlabeled seats / GA areas), `duplicate_label` (same label in a section), `uncategorized` (objects without a category once categories exist), `overlap`, `table_too_small` (< 2 seats), `ga_invalid_capacity` (GA capacity missing or outside 1–100000), `empty_floor` (multi-floor maps), `empty_section`, `outside_section` (seat outside its section outline), `multiple_object_types` (one category used by seats, table seats and GA areas), `missing_focal_point`, `zone_missing_focal_point`, `orphan_gap` (one-seat gap in a row), `ga_table_capacity` (GA tables in an area hold more places than its capacity).
|
|
533
|
+
# @param patch_api_workspace_chart_validation_request [PatchApiWorkspaceChartValidationRequest]
|
|
534
|
+
# @param [Hash] opts the optional parameters
|
|
535
|
+
# @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.
|
|
536
|
+
# @return [nil]
|
|
537
|
+
def patch_api_workspace_chart_validation(patch_api_workspace_chart_validation_request, opts = {})
|
|
538
|
+
patch_api_workspace_chart_validation_with_http_info(patch_api_workspace_chart_validation_request, opts)
|
|
539
|
+
nil
|
|
540
|
+
end
|
|
541
|
+
|
|
542
|
+
# Update chart validation severities
|
|
543
|
+
# Workspace admins only. Merges `severities` into the stored levels (only differences from the defaults are kept); `reset: true` restores the defaults first. Takes effect immediately in the designer and the API (other API replicas within 5 seconds). Charts are not re-validated: stored per-rule counts are re-read under the new levels. Every change is written to the audit log (`workspace.chart_validation.update`). Rules: `no_objects` (no seats or GA areas), `empty_label` (unlabeled seats / GA areas), `duplicate_label` (same label in a section), `uncategorized` (objects without a category once categories exist), `overlap`, `table_too_small` (< 2 seats), `ga_invalid_capacity` (GA capacity missing or outside 1–100000), `empty_floor` (multi-floor maps), `empty_section`, `outside_section` (seat outside its section outline), `multiple_object_types` (one category used by seats, table seats and GA areas), `missing_focal_point`, `zone_missing_focal_point`, `orphan_gap` (one-seat gap in a row), `ga_table_capacity` (GA tables in an area hold more places than its capacity).
|
|
544
|
+
# @param patch_api_workspace_chart_validation_request [PatchApiWorkspaceChartValidationRequest]
|
|
545
|
+
# @param [Hash] opts the optional parameters
|
|
546
|
+
# @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.
|
|
547
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
548
|
+
def patch_api_workspace_chart_validation_with_http_info(patch_api_workspace_chart_validation_request, opts = {})
|
|
549
|
+
if @api_client.config.debugging
|
|
550
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.patch_api_workspace_chart_validation ...'
|
|
551
|
+
end
|
|
552
|
+
# verify the required parameter 'patch_api_workspace_chart_validation_request' is set
|
|
553
|
+
if @api_client.config.client_side_validation && patch_api_workspace_chart_validation_request.nil?
|
|
554
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_workspace_chart_validation_request' when calling WorkspaceApi.patch_api_workspace_chart_validation"
|
|
555
|
+
end
|
|
556
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
557
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_chart_validation, the character length must be smaller than or equal to 255.'
|
|
558
|
+
end
|
|
559
|
+
|
|
560
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
561
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_chart_validation, the character length must be great than or equal to 1.'
|
|
562
|
+
end
|
|
563
|
+
|
|
564
|
+
# resource path
|
|
565
|
+
local_var_path = '/api/workspace/chart-validation'
|
|
566
|
+
|
|
567
|
+
# query parameters
|
|
568
|
+
query_params = opts[:query_params] || {}
|
|
569
|
+
|
|
570
|
+
# header parameters
|
|
571
|
+
header_params = opts[:header_params] || {}
|
|
572
|
+
# HTTP header 'Content-Type'
|
|
573
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
574
|
+
if !content_type.nil?
|
|
575
|
+
header_params['Content-Type'] = content_type
|
|
576
|
+
end
|
|
577
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
578
|
+
|
|
579
|
+
# form parameters
|
|
580
|
+
form_params = opts[:form_params] || {}
|
|
581
|
+
|
|
582
|
+
# http body (model)
|
|
583
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_workspace_chart_validation_request)
|
|
584
|
+
|
|
585
|
+
# return_type
|
|
586
|
+
return_type = opts[:debug_return_type]
|
|
587
|
+
|
|
588
|
+
# auth_names
|
|
589
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
590
|
+
|
|
591
|
+
new_options = opts.merge(
|
|
592
|
+
:operation => :"WorkspaceApi.patch_api_workspace_chart_validation",
|
|
593
|
+
:header_params => header_params,
|
|
594
|
+
:query_params => query_params,
|
|
595
|
+
:form_params => form_params,
|
|
596
|
+
:body => post_body,
|
|
597
|
+
:auth_names => auth_names,
|
|
598
|
+
:return_type => return_type
|
|
599
|
+
)
|
|
600
|
+
|
|
601
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
602
|
+
if @api_client.config.debugging
|
|
603
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#patch_api_workspace_chart_validation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
604
|
+
end
|
|
605
|
+
return data, status_code, headers
|
|
606
|
+
end
|
|
607
|
+
|
|
608
|
+
# Change the workspace integration mode
|
|
609
|
+
# Workspace admins only (dashboard session). Takes effect within 5 seconds on every API instance. Audited (`workspace.integration.update`). `pricingSource`: where prices come from for events without their own override — `partner` (the ticketing platform passes prices to the renderer and declares amounts at confirm; no quote required), `synced_catalog` (the platform pushes a price table with PUT /events/{eventId}/pricing; confirmations are validated against it) or `seatschart_catalog` (prices from the designer catalog; a quote is required before every confirm). New workspaces start with `partner`; workspaces created before pricing modes keep `seatschart_catalog`. `ownCatalog`: show the direct-selling tools (event prices, box office) in the dashboard although prices come from the platform.
|
|
610
|
+
# @param patch_api_workspace_integration_request [PatchApiWorkspaceIntegrationRequest]
|
|
611
|
+
# @param [Hash] opts the optional parameters
|
|
612
|
+
# @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.
|
|
613
|
+
# @return [nil]
|
|
614
|
+
def patch_api_workspace_integration(patch_api_workspace_integration_request, opts = {})
|
|
615
|
+
patch_api_workspace_integration_with_http_info(patch_api_workspace_integration_request, opts)
|
|
616
|
+
nil
|
|
617
|
+
end
|
|
618
|
+
|
|
619
|
+
# Change the workspace integration mode
|
|
620
|
+
# Workspace admins only (dashboard session). Takes effect within 5 seconds on every API instance. Audited (`workspace.integration.update`). `pricingSource`: where prices come from for events without their own override — `partner` (the ticketing platform passes prices to the renderer and declares amounts at confirm; no quote required), `synced_catalog` (the platform pushes a price table with PUT /events/{eventId}/pricing; confirmations are validated against it) or `seatschart_catalog` (prices from the designer catalog; a quote is required before every confirm). New workspaces start with `partner`; workspaces created before pricing modes keep `seatschart_catalog`. `ownCatalog`: show the direct-selling tools (event prices, box office) in the dashboard although prices come from the platform.
|
|
621
|
+
# @param patch_api_workspace_integration_request [PatchApiWorkspaceIntegrationRequest]
|
|
622
|
+
# @param [Hash] opts the optional parameters
|
|
623
|
+
# @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.
|
|
624
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
625
|
+
def patch_api_workspace_integration_with_http_info(patch_api_workspace_integration_request, opts = {})
|
|
626
|
+
if @api_client.config.debugging
|
|
627
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.patch_api_workspace_integration ...'
|
|
628
|
+
end
|
|
629
|
+
# verify the required parameter 'patch_api_workspace_integration_request' is set
|
|
630
|
+
if @api_client.config.client_side_validation && patch_api_workspace_integration_request.nil?
|
|
631
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_workspace_integration_request' when calling WorkspaceApi.patch_api_workspace_integration"
|
|
632
|
+
end
|
|
633
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
634
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_integration, the character length must be smaller than or equal to 255.'
|
|
635
|
+
end
|
|
636
|
+
|
|
637
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
638
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_integration, the character length must be great than or equal to 1.'
|
|
639
|
+
end
|
|
640
|
+
|
|
641
|
+
# resource path
|
|
642
|
+
local_var_path = '/api/workspace/integration'
|
|
643
|
+
|
|
644
|
+
# query parameters
|
|
645
|
+
query_params = opts[:query_params] || {}
|
|
646
|
+
|
|
647
|
+
# header parameters
|
|
648
|
+
header_params = opts[:header_params] || {}
|
|
649
|
+
# HTTP header 'Content-Type'
|
|
650
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
651
|
+
if !content_type.nil?
|
|
652
|
+
header_params['Content-Type'] = content_type
|
|
653
|
+
end
|
|
654
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
655
|
+
|
|
656
|
+
# form parameters
|
|
657
|
+
form_params = opts[:form_params] || {}
|
|
658
|
+
|
|
659
|
+
# http body (model)
|
|
660
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_workspace_integration_request)
|
|
661
|
+
|
|
662
|
+
# return_type
|
|
663
|
+
return_type = opts[:debug_return_type]
|
|
664
|
+
|
|
665
|
+
# auth_names
|
|
666
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
667
|
+
|
|
668
|
+
new_options = opts.merge(
|
|
669
|
+
:operation => :"WorkspaceApi.patch_api_workspace_integration",
|
|
670
|
+
:header_params => header_params,
|
|
671
|
+
:query_params => query_params,
|
|
672
|
+
:form_params => form_params,
|
|
673
|
+
:body => post_body,
|
|
674
|
+
:auth_names => auth_names,
|
|
675
|
+
:return_type => return_type
|
|
676
|
+
)
|
|
677
|
+
|
|
678
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
679
|
+
if @api_client.config.debugging
|
|
680
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#patch_api_workspace_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
681
|
+
end
|
|
682
|
+
return data, status_code, headers
|
|
683
|
+
end
|
|
684
|
+
|
|
685
|
+
# Override workspace settings or return them to the default
|
|
686
|
+
# Workspace admins only (dashboard session). A value overrides the default for this workspace; `null` returns the setting to the default; omitted settings are unchanged. Takes effect immediately on this API instance and within 5 seconds on the others (read from the tenant config cache; no per-request query). Every change is audited (`workspace.settings.update`). Settings: `holdPeriodMinutes` (1–120; default `SEAT_HOLD_TTL_SEC`, 10 min) — TTL of new and renewed seat/GA holds; `maxSeatsPerHoldToken` (1–64; default 64) — seats one hold token may hold across appends; `ticketBuyerValidation` (default off) — buyer tokens are minted only for a registered ticket buyer id (`POST /ticket-buyers`) and bind it, buyer holds must carry it; `gaPlacesToChannels` (default on) — inventory channels may receive GA place quotas (`areaPlaces`). Each setting either uses the platform default or is overridden for this workspace; `sources` says which.
|
|
687
|
+
# @param patch_api_workspace_settings_request [PatchApiWorkspaceSettingsRequest]
|
|
688
|
+
# @param [Hash] opts the optional parameters
|
|
689
|
+
# @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.
|
|
690
|
+
# @return [nil]
|
|
691
|
+
def patch_api_workspace_settings(patch_api_workspace_settings_request, opts = {})
|
|
692
|
+
patch_api_workspace_settings_with_http_info(patch_api_workspace_settings_request, opts)
|
|
693
|
+
nil
|
|
694
|
+
end
|
|
695
|
+
|
|
696
|
+
# Override workspace settings or return them to the default
|
|
697
|
+
# Workspace admins only (dashboard session). A value overrides the default for this workspace; `null` returns the setting to the default; omitted settings are unchanged. Takes effect immediately on this API instance and within 5 seconds on the others (read from the tenant config cache; no per-request query). Every change is audited (`workspace.settings.update`). Settings: `holdPeriodMinutes` (1–120; default `SEAT_HOLD_TTL_SEC`, 10 min) — TTL of new and renewed seat/GA holds; `maxSeatsPerHoldToken` (1–64; default 64) — seats one hold token may hold across appends; `ticketBuyerValidation` (default off) — buyer tokens are minted only for a registered ticket buyer id (`POST /ticket-buyers`) and bind it, buyer holds must carry it; `gaPlacesToChannels` (default on) — inventory channels may receive GA place quotas (`areaPlaces`). Each setting either uses the platform default or is overridden for this workspace; `sources` says which.
|
|
698
|
+
# @param patch_api_workspace_settings_request [PatchApiWorkspaceSettingsRequest]
|
|
699
|
+
# @param [Hash] opts the optional parameters
|
|
700
|
+
# @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.
|
|
701
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
702
|
+
def patch_api_workspace_settings_with_http_info(patch_api_workspace_settings_request, opts = {})
|
|
703
|
+
if @api_client.config.debugging
|
|
704
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.patch_api_workspace_settings ...'
|
|
705
|
+
end
|
|
706
|
+
# verify the required parameter 'patch_api_workspace_settings_request' is set
|
|
707
|
+
if @api_client.config.client_side_validation && patch_api_workspace_settings_request.nil?
|
|
708
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_workspace_settings_request' when calling WorkspaceApi.patch_api_workspace_settings"
|
|
709
|
+
end
|
|
710
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
711
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_settings, the character length must be smaller than or equal to 255.'
|
|
712
|
+
end
|
|
713
|
+
|
|
714
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
715
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspace_settings, the character length must be great than or equal to 1.'
|
|
716
|
+
end
|
|
717
|
+
|
|
718
|
+
# resource path
|
|
719
|
+
local_var_path = '/api/workspace/settings'
|
|
720
|
+
|
|
721
|
+
# query parameters
|
|
722
|
+
query_params = opts[:query_params] || {}
|
|
723
|
+
|
|
724
|
+
# header parameters
|
|
725
|
+
header_params = opts[:header_params] || {}
|
|
726
|
+
# HTTP header 'Content-Type'
|
|
727
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
728
|
+
if !content_type.nil?
|
|
729
|
+
header_params['Content-Type'] = content_type
|
|
730
|
+
end
|
|
731
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
732
|
+
|
|
733
|
+
# form parameters
|
|
734
|
+
form_params = opts[:form_params] || {}
|
|
735
|
+
|
|
736
|
+
# http body (model)
|
|
737
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_workspace_settings_request)
|
|
738
|
+
|
|
739
|
+
# return_type
|
|
740
|
+
return_type = opts[:debug_return_type]
|
|
741
|
+
|
|
742
|
+
# auth_names
|
|
743
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
744
|
+
|
|
745
|
+
new_options = opts.merge(
|
|
746
|
+
:operation => :"WorkspaceApi.patch_api_workspace_settings",
|
|
747
|
+
:header_params => header_params,
|
|
748
|
+
:query_params => query_params,
|
|
749
|
+
:form_params => form_params,
|
|
750
|
+
:body => post_body,
|
|
751
|
+
:auth_names => auth_names,
|
|
752
|
+
:return_type => return_type
|
|
753
|
+
)
|
|
754
|
+
|
|
755
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
756
|
+
if @api_client.config.debugging
|
|
757
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#patch_api_workspace_settings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
758
|
+
end
|
|
759
|
+
return data, status_code, headers
|
|
760
|
+
end
|
|
761
|
+
|
|
762
|
+
# Rename one of my workspaces
|
|
763
|
+
# Sets `displayName` (1–512 characters). The caller (for a workspace admin key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent; written to the audit log (`workspace.rename`).
|
|
764
|
+
# @param workspace_id [String]
|
|
765
|
+
# @param patch_api_workspace_request [PatchApiWorkspaceRequest]
|
|
766
|
+
# @param [Hash] opts the optional parameters
|
|
767
|
+
# @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.
|
|
768
|
+
# @return [GetApiWorkspaces200ResponseItemsInner]
|
|
769
|
+
def patch_api_workspaces_by_workspace_id(workspace_id, patch_api_workspace_request, opts = {})
|
|
770
|
+
data, _status_code, _headers = patch_api_workspaces_by_workspace_id_with_http_info(workspace_id, patch_api_workspace_request, opts)
|
|
771
|
+
data
|
|
772
|
+
end
|
|
773
|
+
|
|
774
|
+
# Rename one of my workspaces
|
|
775
|
+
# Sets `displayName` (1–512 characters). The caller (for a workspace admin key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent; written to the audit log (`workspace.rename`).
|
|
776
|
+
# @param workspace_id [String]
|
|
777
|
+
# @param patch_api_workspace_request [PatchApiWorkspaceRequest]
|
|
778
|
+
# @param [Hash] opts the optional parameters
|
|
779
|
+
# @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.
|
|
780
|
+
# @return [Array<(GetApiWorkspaces200ResponseItemsInner, Integer, Hash)>] GetApiWorkspaces200ResponseItemsInner data, response status code and response headers
|
|
781
|
+
def patch_api_workspaces_by_workspace_id_with_http_info(workspace_id, patch_api_workspace_request, opts = {})
|
|
782
|
+
if @api_client.config.debugging
|
|
783
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.patch_api_workspaces_by_workspace_id ...'
|
|
784
|
+
end
|
|
785
|
+
# verify the required parameter 'workspace_id' is set
|
|
786
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
787
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.patch_api_workspaces_by_workspace_id"
|
|
788
|
+
end
|
|
789
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
790
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.patch_api_workspaces_by_workspace_id, the character length must be smaller than or equal to 128.'
|
|
791
|
+
end
|
|
792
|
+
|
|
793
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
794
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.patch_api_workspaces_by_workspace_id, the character length must be great than or equal to 1.'
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
# verify the required parameter 'patch_api_workspace_request' is set
|
|
798
|
+
if @api_client.config.client_side_validation && patch_api_workspace_request.nil?
|
|
799
|
+
fail ArgumentError, "Missing the required parameter 'patch_api_workspace_request' when calling WorkspaceApi.patch_api_workspaces_by_workspace_id"
|
|
800
|
+
end
|
|
801
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
802
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspaces_by_workspace_id, the character length must be smaller than or equal to 255.'
|
|
803
|
+
end
|
|
804
|
+
|
|
805
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
806
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.patch_api_workspaces_by_workspace_id, the character length must be great than or equal to 1.'
|
|
807
|
+
end
|
|
808
|
+
|
|
809
|
+
# resource path
|
|
810
|
+
local_var_path = '/api/workspaces/{workspaceId}'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
811
|
+
|
|
812
|
+
# query parameters
|
|
813
|
+
query_params = opts[:query_params] || {}
|
|
814
|
+
|
|
815
|
+
# header parameters
|
|
816
|
+
header_params = opts[:header_params] || {}
|
|
817
|
+
# HTTP header 'Accept' (if needed)
|
|
818
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
819
|
+
# HTTP header 'Content-Type'
|
|
820
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
821
|
+
if !content_type.nil?
|
|
822
|
+
header_params['Content-Type'] = content_type
|
|
823
|
+
end
|
|
824
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
825
|
+
|
|
826
|
+
# form parameters
|
|
827
|
+
form_params = opts[:form_params] || {}
|
|
828
|
+
|
|
829
|
+
# http body (model)
|
|
830
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_api_workspace_request)
|
|
831
|
+
|
|
832
|
+
# return_type
|
|
833
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaces200ResponseItemsInner'
|
|
834
|
+
|
|
835
|
+
# auth_names
|
|
836
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
837
|
+
|
|
838
|
+
new_options = opts.merge(
|
|
839
|
+
:operation => :"WorkspaceApi.patch_api_workspaces_by_workspace_id",
|
|
840
|
+
:header_params => header_params,
|
|
841
|
+
:query_params => query_params,
|
|
842
|
+
:form_params => form_params,
|
|
843
|
+
:body => post_body,
|
|
844
|
+
:auth_names => auth_names,
|
|
845
|
+
:return_type => return_type
|
|
846
|
+
)
|
|
847
|
+
|
|
848
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
849
|
+
if @api_client.config.debugging
|
|
850
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#patch_api_workspaces_by_workspace_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
851
|
+
end
|
|
852
|
+
return data, status_code, headers
|
|
853
|
+
end
|
|
854
|
+
|
|
855
|
+
# Rotate the public workspace key
|
|
856
|
+
# Issues a new `pub_…` key. Requires workspace_admin. The public key is not authentication — rotating it does not invalidate JWTs or API keys.
|
|
857
|
+
# @param [Hash] opts the optional parameters
|
|
858
|
+
# @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.
|
|
859
|
+
# @return [nil]
|
|
860
|
+
def post_api_workspace_public_key_rotate(opts = {})
|
|
861
|
+
post_api_workspace_public_key_rotate_with_http_info(opts)
|
|
862
|
+
nil
|
|
863
|
+
end
|
|
864
|
+
|
|
865
|
+
# Rotate the public workspace key
|
|
866
|
+
# Issues a new `pub_…` key. Requires workspace_admin. The public key is not authentication — rotating it does not invalidate JWTs or API keys.
|
|
867
|
+
# @param [Hash] opts the optional parameters
|
|
868
|
+
# @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.
|
|
869
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
870
|
+
def post_api_workspace_public_key_rotate_with_http_info(opts = {})
|
|
871
|
+
if @api_client.config.debugging
|
|
872
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.post_api_workspace_public_key_rotate ...'
|
|
873
|
+
end
|
|
874
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
875
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspace_public_key_rotate, the character length must be smaller than or equal to 255.'
|
|
876
|
+
end
|
|
877
|
+
|
|
878
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
879
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspace_public_key_rotate, the character length must be great than or equal to 1.'
|
|
880
|
+
end
|
|
881
|
+
|
|
882
|
+
# resource path
|
|
883
|
+
local_var_path = '/api/workspace/public-key/rotate'
|
|
884
|
+
|
|
885
|
+
# query parameters
|
|
886
|
+
query_params = opts[:query_params] || {}
|
|
887
|
+
|
|
888
|
+
# header parameters
|
|
889
|
+
header_params = opts[:header_params] || {}
|
|
890
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
891
|
+
|
|
892
|
+
# form parameters
|
|
893
|
+
form_params = opts[:form_params] || {}
|
|
894
|
+
|
|
895
|
+
# http body (model)
|
|
896
|
+
post_body = opts[:debug_body]
|
|
897
|
+
|
|
898
|
+
# return_type
|
|
899
|
+
return_type = opts[:debug_return_type]
|
|
900
|
+
|
|
901
|
+
# auth_names
|
|
902
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
903
|
+
|
|
904
|
+
new_options = opts.merge(
|
|
905
|
+
:operation => :"WorkspaceApi.post_api_workspace_public_key_rotate",
|
|
906
|
+
:header_params => header_params,
|
|
907
|
+
:query_params => query_params,
|
|
908
|
+
:form_params => form_params,
|
|
909
|
+
:body => post_body,
|
|
910
|
+
:auth_names => auth_names,
|
|
911
|
+
:return_type => return_type
|
|
912
|
+
)
|
|
913
|
+
|
|
914
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
915
|
+
if @api_client.config.debugging
|
|
916
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#post_api_workspace_public_key_rotate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
917
|
+
end
|
|
918
|
+
return data, status_code, headers
|
|
919
|
+
end
|
|
920
|
+
|
|
921
|
+
# Create an additional workspace
|
|
922
|
+
# Provisions a free-plan tenant and admin membership for the caller: a dashboard admin session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; it must be a full-access key), whose bound admin becomes the admin of the new workspace. Other API keys: 403 `ERR_PARTNER_SCOPE`. `isTest: true` creates a test workspace linked to the current production workspace (`parentWorkspaceId`), optionally copying its charts (`copyCharts`). Written to the audit log of the current workspace (`workspace.create` / `workspace.create_test`). Returns a new `publicKey` — not a secret and not a Bearer substitute.
|
|
923
|
+
# @param post_api_workspaces_request [PostApiWorkspacesRequest]
|
|
924
|
+
# @param [Hash] opts the optional parameters
|
|
925
|
+
# @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.
|
|
926
|
+
# @return [nil]
|
|
927
|
+
def post_api_workspaces(post_api_workspaces_request, opts = {})
|
|
928
|
+
post_api_workspaces_with_http_info(post_api_workspaces_request, opts)
|
|
929
|
+
nil
|
|
930
|
+
end
|
|
931
|
+
|
|
932
|
+
# Create an additional workspace
|
|
933
|
+
# Provisions a free-plan tenant and admin membership for the caller: a dashboard admin session, or a **workspace admin API key** (`POST /api/keys` with `workspaceAdmin: true`; it must be a full-access key), whose bound admin becomes the admin of the new workspace. Other API keys: 403 `ERR_PARTNER_SCOPE`. `isTest: true` creates a test workspace linked to the current production workspace (`parentWorkspaceId`), optionally copying its charts (`copyCharts`). Written to the audit log of the current workspace (`workspace.create` / `workspace.create_test`). Returns a new `publicKey` — not a secret and not a Bearer substitute.
|
|
934
|
+
# @param post_api_workspaces_request [PostApiWorkspacesRequest]
|
|
935
|
+
# @param [Hash] opts the optional parameters
|
|
936
|
+
# @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.
|
|
937
|
+
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
|
|
938
|
+
def post_api_workspaces_with_http_info(post_api_workspaces_request, opts = {})
|
|
939
|
+
if @api_client.config.debugging
|
|
940
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.post_api_workspaces ...'
|
|
941
|
+
end
|
|
942
|
+
# verify the required parameter 'post_api_workspaces_request' is set
|
|
943
|
+
if @api_client.config.client_side_validation && post_api_workspaces_request.nil?
|
|
944
|
+
fail ArgumentError, "Missing the required parameter 'post_api_workspaces_request' when calling WorkspaceApi.post_api_workspaces"
|
|
945
|
+
end
|
|
946
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
947
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces, the character length must be smaller than or equal to 255.'
|
|
948
|
+
end
|
|
949
|
+
|
|
950
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
951
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces, the character length must be great than or equal to 1.'
|
|
952
|
+
end
|
|
953
|
+
|
|
954
|
+
# resource path
|
|
955
|
+
local_var_path = '/api/workspaces'
|
|
956
|
+
|
|
957
|
+
# query parameters
|
|
958
|
+
query_params = opts[:query_params] || {}
|
|
959
|
+
|
|
960
|
+
# header parameters
|
|
961
|
+
header_params = opts[:header_params] || {}
|
|
962
|
+
# HTTP header 'Content-Type'
|
|
963
|
+
content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
|
|
964
|
+
if !content_type.nil?
|
|
965
|
+
header_params['Content-Type'] = content_type
|
|
966
|
+
end
|
|
967
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
968
|
+
|
|
969
|
+
# form parameters
|
|
970
|
+
form_params = opts[:form_params] || {}
|
|
971
|
+
|
|
972
|
+
# http body (model)
|
|
973
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_workspaces_request)
|
|
974
|
+
|
|
975
|
+
# return_type
|
|
976
|
+
return_type = opts[:debug_return_type]
|
|
977
|
+
|
|
978
|
+
# auth_names
|
|
979
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
980
|
+
|
|
981
|
+
new_options = opts.merge(
|
|
982
|
+
:operation => :"WorkspaceApi.post_api_workspaces",
|
|
983
|
+
:header_params => header_params,
|
|
984
|
+
:query_params => query_params,
|
|
985
|
+
:form_params => form_params,
|
|
986
|
+
:body => post_body,
|
|
987
|
+
:auth_names => auth_names,
|
|
988
|
+
:return_type => return_type
|
|
989
|
+
)
|
|
990
|
+
|
|
991
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
992
|
+
if @api_client.config.debugging
|
|
993
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#post_api_workspaces\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
994
|
+
end
|
|
995
|
+
return data, status_code, headers
|
|
996
|
+
end
|
|
997
|
+
|
|
998
|
+
# Reactivate a workspace
|
|
999
|
+
# Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`).
|
|
1000
|
+
# @param workspace_id [String]
|
|
1001
|
+
# @param [Hash] opts the optional parameters
|
|
1002
|
+
# @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.
|
|
1003
|
+
# @return [DeleteApiWorkspacesByWorkspaceId200Response]
|
|
1004
|
+
def post_api_workspaces_by_workspace_id_actions_activate(workspace_id, opts = {})
|
|
1005
|
+
data, _status_code, _headers = post_api_workspaces_by_workspace_id_actions_activate_with_http_info(workspace_id, opts)
|
|
1006
|
+
data
|
|
1007
|
+
end
|
|
1008
|
+
|
|
1009
|
+
# Reactivate a workspace
|
|
1010
|
+
# Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`).
|
|
1011
|
+
# @param workspace_id [String]
|
|
1012
|
+
# @param [Hash] opts the optional parameters
|
|
1013
|
+
# @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.
|
|
1014
|
+
# @return [Array<(DeleteApiWorkspacesByWorkspaceId200Response, Integer, Hash)>] DeleteApiWorkspacesByWorkspaceId200Response data, response status code and response headers
|
|
1015
|
+
def post_api_workspaces_by_workspace_id_actions_activate_with_http_info(workspace_id, opts = {})
|
|
1016
|
+
if @api_client.config.debugging
|
|
1017
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate ...'
|
|
1018
|
+
end
|
|
1019
|
+
# verify the required parameter 'workspace_id' is set
|
|
1020
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
1021
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate"
|
|
1022
|
+
end
|
|
1023
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
1024
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate, the character length must be smaller than or equal to 128.'
|
|
1025
|
+
end
|
|
1026
|
+
|
|
1027
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
1028
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate, the character length must be great than or equal to 1.'
|
|
1029
|
+
end
|
|
1030
|
+
|
|
1031
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
1032
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate, the character length must be smaller than or equal to 255.'
|
|
1033
|
+
end
|
|
1034
|
+
|
|
1035
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
1036
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate, the character length must be great than or equal to 1.'
|
|
1037
|
+
end
|
|
1038
|
+
|
|
1039
|
+
# resource path
|
|
1040
|
+
local_var_path = '/api/workspaces/{workspaceId}/actions/activate'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
1041
|
+
|
|
1042
|
+
# query parameters
|
|
1043
|
+
query_params = opts[:query_params] || {}
|
|
1044
|
+
|
|
1045
|
+
# header parameters
|
|
1046
|
+
header_params = opts[:header_params] || {}
|
|
1047
|
+
# HTTP header 'Accept' (if needed)
|
|
1048
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
1049
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
1050
|
+
|
|
1051
|
+
# form parameters
|
|
1052
|
+
form_params = opts[:form_params] || {}
|
|
1053
|
+
|
|
1054
|
+
# http body (model)
|
|
1055
|
+
post_body = opts[:debug_body]
|
|
1056
|
+
|
|
1057
|
+
# return_type
|
|
1058
|
+
return_type = opts[:debug_return_type] || 'DeleteApiWorkspacesByWorkspaceId200Response'
|
|
1059
|
+
|
|
1060
|
+
# auth_names
|
|
1061
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
1062
|
+
|
|
1063
|
+
new_options = opts.merge(
|
|
1064
|
+
:operation => :"WorkspaceApi.post_api_workspaces_by_workspace_id_actions_activate",
|
|
1065
|
+
:header_params => header_params,
|
|
1066
|
+
:query_params => query_params,
|
|
1067
|
+
:form_params => form_params,
|
|
1068
|
+
:body => post_body,
|
|
1069
|
+
:auth_names => auth_names,
|
|
1070
|
+
:return_type => return_type
|
|
1071
|
+
)
|
|
1072
|
+
|
|
1073
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1074
|
+
if @api_client.config.debugging
|
|
1075
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#post_api_workspaces_by_workspace_id_actions_activate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1076
|
+
end
|
|
1077
|
+
return data, status_code, headers
|
|
1078
|
+
end
|
|
1079
|
+
|
|
1080
|
+
# Deactivate a workspace
|
|
1081
|
+
# Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`). You cannot deactivate your last active workspace (409 `last_active_workspace`).
|
|
1082
|
+
# @param workspace_id [String]
|
|
1083
|
+
# @param [Hash] opts the optional parameters
|
|
1084
|
+
# @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.
|
|
1085
|
+
# @return [DeleteApiWorkspacesByWorkspaceId200Response]
|
|
1086
|
+
def post_api_workspaces_by_workspace_id_actions_deactivate(workspace_id, opts = {})
|
|
1087
|
+
data, _status_code, _headers = post_api_workspaces_by_workspace_id_actions_deactivate_with_http_info(workspace_id, opts)
|
|
1088
|
+
data
|
|
1089
|
+
end
|
|
1090
|
+
|
|
1091
|
+
# Deactivate a workspace
|
|
1092
|
+
# Dashboard session or a **workspace admin API key** (other API keys: 403 `ERR_PARTNER_SCOPE`); the caller (for a key: the admin it is bound to) must be an **admin** of the target workspace (403 otherwise, 404 when not a member). Idempotent. A deactivated workspace keeps all its data; its API keys, viewer/embed JWTs and public CDN reads are refused with 403 `workspace_deactivated` (effective on every API instance within 5 seconds), while dashboard members can still sign in so an admin can reactivate it. An admin key cannot deactivate its own workspace (409 `own_workspace`). You cannot deactivate your last active workspace (409 `last_active_workspace`).
|
|
1093
|
+
# @param workspace_id [String]
|
|
1094
|
+
# @param [Hash] opts the optional parameters
|
|
1095
|
+
# @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.
|
|
1096
|
+
# @return [Array<(DeleteApiWorkspacesByWorkspaceId200Response, Integer, Hash)>] DeleteApiWorkspacesByWorkspaceId200Response data, response status code and response headers
|
|
1097
|
+
def post_api_workspaces_by_workspace_id_actions_deactivate_with_http_info(workspace_id, opts = {})
|
|
1098
|
+
if @api_client.config.debugging
|
|
1099
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate ...'
|
|
1100
|
+
end
|
|
1101
|
+
# verify the required parameter 'workspace_id' is set
|
|
1102
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
1103
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate"
|
|
1104
|
+
end
|
|
1105
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
1106
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate, the character length must be smaller than or equal to 128.'
|
|
1107
|
+
end
|
|
1108
|
+
|
|
1109
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
1110
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate, the character length must be great than or equal to 1.'
|
|
1111
|
+
end
|
|
1112
|
+
|
|
1113
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
1114
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate, the character length must be smaller than or equal to 255.'
|
|
1115
|
+
end
|
|
1116
|
+
|
|
1117
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
1118
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate, the character length must be great than or equal to 1.'
|
|
1119
|
+
end
|
|
1120
|
+
|
|
1121
|
+
# resource path
|
|
1122
|
+
local_var_path = '/api/workspaces/{workspaceId}/actions/deactivate'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
1123
|
+
|
|
1124
|
+
# query parameters
|
|
1125
|
+
query_params = opts[:query_params] || {}
|
|
1126
|
+
|
|
1127
|
+
# header parameters
|
|
1128
|
+
header_params = opts[:header_params] || {}
|
|
1129
|
+
# HTTP header 'Accept' (if needed)
|
|
1130
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
1131
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
1132
|
+
|
|
1133
|
+
# form parameters
|
|
1134
|
+
form_params = opts[:form_params] || {}
|
|
1135
|
+
|
|
1136
|
+
# http body (model)
|
|
1137
|
+
post_body = opts[:debug_body]
|
|
1138
|
+
|
|
1139
|
+
# return_type
|
|
1140
|
+
return_type = opts[:debug_return_type] || 'DeleteApiWorkspacesByWorkspaceId200Response'
|
|
1141
|
+
|
|
1142
|
+
# auth_names
|
|
1143
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
1144
|
+
|
|
1145
|
+
new_options = opts.merge(
|
|
1146
|
+
:operation => :"WorkspaceApi.post_api_workspaces_by_workspace_id_actions_deactivate",
|
|
1147
|
+
:header_params => header_params,
|
|
1148
|
+
:query_params => query_params,
|
|
1149
|
+
:form_params => form_params,
|
|
1150
|
+
:body => post_body,
|
|
1151
|
+
:auth_names => auth_names,
|
|
1152
|
+
:return_type => return_type
|
|
1153
|
+
)
|
|
1154
|
+
|
|
1155
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1156
|
+
if @api_client.config.debugging
|
|
1157
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#post_api_workspaces_by_workspace_id_actions_deactivate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1158
|
+
end
|
|
1159
|
+
return data, status_code, headers
|
|
1160
|
+
end
|
|
1161
|
+
|
|
1162
|
+
# Set my default workspace
|
|
1163
|
+
# Makes this workspace the default of the calling user (for a **workspace admin API key**: of the admin it is bound to): dashboard sign-in opens it, and `GET /workspaces` marks it `isDefault`. Any role may set a workspace it is a member of (404 otherwise); a deactivated workspace cannot be the default (409 `workspace_deactivated`). Idempotent; written to the audit log of that workspace (`workspace.set_default`). Other API keys: 403 `ERR_PARTNER_SCOPE`.
|
|
1164
|
+
# @param workspace_id [String]
|
|
1165
|
+
# @param [Hash] opts the optional parameters
|
|
1166
|
+
# @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.
|
|
1167
|
+
# @return [GetApiWorkspaces200ResponseItemsInner]
|
|
1168
|
+
def post_api_workspaces_by_workspace_id_actions_set_default(workspace_id, opts = {})
|
|
1169
|
+
data, _status_code, _headers = post_api_workspaces_by_workspace_id_actions_set_default_with_http_info(workspace_id, opts)
|
|
1170
|
+
data
|
|
1171
|
+
end
|
|
1172
|
+
|
|
1173
|
+
# Set my default workspace
|
|
1174
|
+
# Makes this workspace the default of the calling user (for a **workspace admin API key**: of the admin it is bound to): dashboard sign-in opens it, and `GET /workspaces` marks it `isDefault`. Any role may set a workspace it is a member of (404 otherwise); a deactivated workspace cannot be the default (409 `workspace_deactivated`). Idempotent; written to the audit log of that workspace (`workspace.set_default`). Other API keys: 403 `ERR_PARTNER_SCOPE`.
|
|
1175
|
+
# @param workspace_id [String]
|
|
1176
|
+
# @param [Hash] opts the optional parameters
|
|
1177
|
+
# @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.
|
|
1178
|
+
# @return [Array<(GetApiWorkspaces200ResponseItemsInner, Integer, Hash)>] GetApiWorkspaces200ResponseItemsInner data, response status code and response headers
|
|
1179
|
+
def post_api_workspaces_by_workspace_id_actions_set_default_with_http_info(workspace_id, opts = {})
|
|
1180
|
+
if @api_client.config.debugging
|
|
1181
|
+
@api_client.config.logger.debug 'Calling API: WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default ...'
|
|
1182
|
+
end
|
|
1183
|
+
# verify the required parameter 'workspace_id' is set
|
|
1184
|
+
if @api_client.config.client_side_validation && workspace_id.nil?
|
|
1185
|
+
fail ArgumentError, "Missing the required parameter 'workspace_id' when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default"
|
|
1186
|
+
end
|
|
1187
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length > 128
|
|
1188
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default, the character length must be smaller than or equal to 128.'
|
|
1189
|
+
end
|
|
1190
|
+
|
|
1191
|
+
if @api_client.config.client_side_validation && workspace_id.to_s.length < 1
|
|
1192
|
+
fail ArgumentError, 'invalid value for "workspace_id" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default, the character length must be great than or equal to 1.'
|
|
1193
|
+
end
|
|
1194
|
+
|
|
1195
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
|
|
1196
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default, the character length must be smaller than or equal to 255.'
|
|
1197
|
+
end
|
|
1198
|
+
|
|
1199
|
+
if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
|
|
1200
|
+
fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default, the character length must be great than or equal to 1.'
|
|
1201
|
+
end
|
|
1202
|
+
|
|
1203
|
+
# resource path
|
|
1204
|
+
local_var_path = '/api/workspaces/{workspaceId}/actions/set-default'.sub('{' + 'workspaceId' + '}', CGI.escape(workspace_id.to_s))
|
|
1205
|
+
|
|
1206
|
+
# query parameters
|
|
1207
|
+
query_params = opts[:query_params] || {}
|
|
1208
|
+
|
|
1209
|
+
# header parameters
|
|
1210
|
+
header_params = opts[:header_params] || {}
|
|
1211
|
+
# HTTP header 'Accept' (if needed)
|
|
1212
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
|
|
1213
|
+
header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
|
|
1214
|
+
|
|
1215
|
+
# form parameters
|
|
1216
|
+
form_params = opts[:form_params] || {}
|
|
1217
|
+
|
|
1218
|
+
# http body (model)
|
|
1219
|
+
post_body = opts[:debug_body]
|
|
1220
|
+
|
|
1221
|
+
# return_type
|
|
1222
|
+
return_type = opts[:debug_return_type] || 'GetApiWorkspaces200ResponseItemsInner'
|
|
1223
|
+
|
|
1224
|
+
# auth_names
|
|
1225
|
+
auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']
|
|
1226
|
+
|
|
1227
|
+
new_options = opts.merge(
|
|
1228
|
+
:operation => :"WorkspaceApi.post_api_workspaces_by_workspace_id_actions_set_default",
|
|
1229
|
+
:header_params => header_params,
|
|
1230
|
+
:query_params => query_params,
|
|
1231
|
+
:form_params => form_params,
|
|
1232
|
+
:body => post_body,
|
|
1233
|
+
:auth_names => auth_names,
|
|
1234
|
+
:return_type => return_type
|
|
1235
|
+
)
|
|
1236
|
+
|
|
1237
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
1238
|
+
if @api_client.config.debugging
|
|
1239
|
+
@api_client.config.logger.debug "API called: WorkspaceApi#post_api_workspaces_by_workspace_id_actions_set_default\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
1240
|
+
end
|
|
1241
|
+
return data, status_code, headers
|
|
1242
|
+
end
|
|
1243
|
+
end
|
|
1244
|
+
end
|