seatschart 0.2.0 → 0.4.0

data/lib/seatschart/api/auth_api.rb

@@ -802,7 +802,7 @@ module SeatsChart
     end
 
     # Sign in with email and password
-    # Returns tokens, or a second step: `{ twoFactorRequired: true, pendingToken }` when the account has two-factor authentication (finish with `POST /auth/2fa/verify`), or `{ twoFactorEnrollmentRequired: true, pendingToken }` when the workspace requires 2FA and the account has none yet (`POST /auth/2fa/enroll/start` then `/enroll/confirm`). No session exists until the second step succeeds.
+    # Returns tokens, or a second step: `{ twoFactorRequired: true, pendingToken }` when the account has two-factor authentication (finish with `POST /auth/2fa/verify`), or `{ twoFactorEnrollmentRequired: true, pendingToken }` when the workspace requires 2FA and the account has none yet (`POST /auth/2fa/enroll/start` then `/enroll/confirm`). No session exists until the second step succeeds. An account that belongs to no workspace any more gets 403 `ERR_NO_WORKSPACE` with a single-use `newWorkspaceToken` (after its two-factor code, if it has 2FA): `POST /auth/new-workspace` starts a new workspace.
     # @param post_api_auth_login_request [PostApiAuthLoginRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -813,7 +813,7 @@ module SeatsChart
     end
 
     # Sign in with email and password
-    # Returns tokens, or a second step: `{ twoFactorRequired: true, pendingToken }` when the account has two-factor authentication (finish with `POST /auth/2fa/verify`), or `{ twoFactorEnrollmentRequired: true, pendingToken }` when the workspace requires 2FA and the account has none yet (`POST /auth/2fa/enroll/start` then `/enroll/confirm`). No session exists until the second step succeeds.
+    # Returns tokens, or a second step: `{ twoFactorRequired: true, pendingToken }` when the account has two-factor authentication (finish with `POST /auth/2fa/verify`), or `{ twoFactorEnrollmentRequired: true, pendingToken }` when the workspace requires 2FA and the account has none yet (`POST /auth/2fa/enroll/start` then `/enroll/confirm`). No session exists until the second step succeeds. An account that belongs to no workspace any more gets 403 `ERR_NO_WORKSPACE` with a single-use `newWorkspaceToken` (after its two-factor code, if it has 2FA): `POST /auth/new-workspace` starts a new workspace.
     # @param post_api_auth_login_request [PostApiAuthLoginRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -953,8 +953,85 @@ module SeatsChart
       return data, status_code, headers
     end
 
+    # Create a new workspace for an account that belongs to none
+    # An account removed from its last workspace signs in with the right password (and its two-factor code, if any) and gets 403 `ERR_NO_WORKSPACE` with a single-use `newWorkspaceToken` (5 minutes). This creates a new workspace with the account as its only admin and returns the session tokens. It never restores access to a former workspace; 409 when the account belongs to a workspace again. Written to the new workspace's audit log (`workspace.create`, `reason: no_workspace_left`).
+    # @param post_api_auth_new_workspace_request [PostApiAuthNewWorkspaceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def post_api_auth_new_workspace(post_api_auth_new_workspace_request, opts = {})
+      post_api_auth_new_workspace_with_http_info(post_api_auth_new_workspace_request, opts)
+      nil
+    end
+
+    # Create a new workspace for an account that belongs to none
+    # An account removed from its last workspace signs in with the right password (and its two-factor code, if any) and gets 403 `ERR_NO_WORKSPACE` with a single-use `newWorkspaceToken` (5 minutes). This creates a new workspace with the account as its only admin and returns the session tokens. It never restores access to a former workspace; 409 when the account belongs to a workspace again. Written to the new workspace's audit log (`workspace.create`, `reason: no_workspace_left`).
+    # @param post_api_auth_new_workspace_request [PostApiAuthNewWorkspaceRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def post_api_auth_new_workspace_with_http_info(post_api_auth_new_workspace_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AuthApi.post_api_auth_new_workspace ...'
+      end
+      # verify the required parameter 'post_api_auth_new_workspace_request' is set
+      if @api_client.config.client_side_validation && post_api_auth_new_workspace_request.nil?
+        fail ArgumentError, "Missing the required parameter 'post_api_auth_new_workspace_request' when calling AuthApi.post_api_auth_new_workspace"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling AuthApi.post_api_auth_new_workspace, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling AuthApi.post_api_auth_new_workspace, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/api/auth/new-workspace'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_auth_new_workspace_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"AuthApi.post_api_auth_new_workspace",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AuthApi#post_api_auth_new_workspace\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Rotate refresh token and issue new access JWT
-    # Consumes a one-time refresh token (Redis), revokes it, and returns a new refresh + access pair. Use `audience: viewer` for B2C embed tokens.
+    # Consumes a one-time refresh token (Redis), revokes it, and returns a new refresh + access pair. Use `audience: viewer` for B2C embed tokens. Dashboard access tokens live one hour (`expiresIn`, seconds) and viewer tokens two hours; the refresh token lives 30 days and every renewal checks workspace membership and the 2FA policy again.
     # @param post_api_auth_refresh_request [PostApiAuthRefreshRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -965,7 +1042,7 @@ module SeatsChart
     end
 
     # Rotate refresh token and issue new access JWT
-    # Consumes a one-time refresh token (Redis), revokes it, and returns a new refresh + access pair. Use &#x60;audience: viewer&#x60; for B2C embed tokens.
+    # Consumes a one-time refresh token (Redis), revokes it, and returns a new refresh + access pair. Use &#x60;audience: viewer&#x60; for B2C embed tokens. Dashboard access tokens live one hour (&#x60;expiresIn&#x60;, seconds) and viewer tokens two hours; the refresh token lives 30 days and every renewal checks workspace membership and the 2FA policy again.
     # @param post_api_auth_refresh_request [PostApiAuthRefreshRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.

data/lib/seatschart/api/billing_api.rb

@@ -20,6 +20,7 @@ module SeatsChart
       @api_client = api_client
     end
     # Get billing status and plan usage
+    # Plan, subscription, usage against the limits and the plan catalogue. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it is billed to the platform account, so only that platform admin may open checkout or the billing portal (`canManageBilling`); everyone else gets 403 `billing_managed_by_platform` there, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
     # @param [Hash] opts the optional parameters
     # @return [nil]
     def get_api_billing(opts = {})
@@ -28,6 +29,7 @@ module SeatsChart
     end
 
     # Get billing status and plan usage
+    # Plan, subscription, usage against the limits and the plan catalogue. `managedByPlatform` is true for a workspace a ticketing platform provisioned with its workspace admin key: it is billed to the platform account, so only that platform admin may open checkout or the billing portal (`canManageBilling`); everyone else gets 403 `billing_managed_by_platform` there, and plan-limit refusals carry `billingManagedByPlatform: true` instead of an upgrade prompt.
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def get_api_billing_with_http_info(opts = {})
@@ -73,6 +75,7 @@ module SeatsChart
     end
 
     # Create Stripe Checkout session for a paid plan
+    # Returns `{ url }` of a Stripe Checkout for `planId` (`starter` | `pro`). 409 `ERR_SUBSCRIPTION_EXISTS` when the workspace already has a live subscription (change plans in the billing portal: `POST /billing/portal-session`), 409 `test_workspace_not_billable` in a test workspace, 400 `plan_requires_sales` for `ultra` (Ultra On-Demand is arranged with the SeatsChart team), 409 `plan_managed_by_sales` on an Ultra On-Demand workspace,503 `stripe_not_configured` when billing is not set up.
     # @param post_api_billing_checkout_session_request [PostApiBillingCheckoutSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
@@ -83,6 +86,7 @@ module SeatsChart
     end
 
     # Create Stripe Checkout session for a paid plan
+    # Returns &#x60;{ url }&#x60; of a Stripe Checkout for &#x60;planId&#x60; (&#x60;starter&#x60; | &#x60;pro&#x60;). 409 &#x60;ERR_SUBSCRIPTION_EXISTS&#x60; when the workspace already has a live subscription (change plans in the billing portal: &#x60;POST /billing/portal-session&#x60;), 409 &#x60;test_workspace_not_billable&#x60; in a test workspace, 400 &#x60;plan_requires_sales&#x60; for &#x60;ultra&#x60; (Ultra On-Demand is arranged with the SeatsChart team), 409 &#x60;plan_managed_by_sales&#x60; on an Ultra On-Demand workspace,503 &#x60;stripe_not_configured&#x60; when billing is not set up.
     # @param post_api_billing_checkout_session_request [PostApiBillingCheckoutSessionRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.