license_manager 0.1.0

data/lib/license_manager/api/portal_api.rb

@@ -0,0 +1,310 @@
+=begin
+#LicenseManager API
+
+#Public API. Authenticate with an organization API key, or with a token scoped to a customer, license or machine on the endpoints that accept one.  ## Conventions  - **Errors** answer `{ \"error\": { \"code\", \"message\" } }`. Branch on `code`, which is stable, not on `message`. Each response lists the codes it can return, except `404`, which answers `not_found` unless it says otherwise. Unexpected errors answer `500` with `internal_error`. - **Validation** errors answer `422`, not `400`, with the `validation_error` code and an `issues` array giving the `path` and `message` of each invalid value. - **Unknown body fields are ignored**, not rejected: sending a field an endpoint doesn't accept, like `policyId` to `updateLicense`, changes nothing and doesn't fail. - **Strings** are trimmed before they're validated and stored. Emails are stored lower cased. - **Updates** only change the fields that are sent. A field sent as `null` is cleared, when it can be. - **Dates** can be sent with any offset, and are always returned in UTC, like `2026-01-15T09:30:00.000Z`. Calendar months and days are counted in UTC. - **Ids** are 8 letters and digits, after `test_` for test products and their resources. - **Lists** are paginated with `page` and `pageSize`. Items with the same value for the `sort` field are ordered by id, so pages are stable, but items created or deleted between two requests shift the pages. Items without a value for the `sort` field come last in ascending order, and first in descending order, unless the endpoint says otherwise. - **Test products** are sandboxes of a live product. Test API keys only reach test products, live API keys only live ones: the others answer `404`, as if they didn't exist. Sessions and tokens reach both.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.26.0
+
+=end
+
+require 'cgi'
+
+module LicenseManager
+  class PortalApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a link to the customer portal
+    # Link letting the customer see their licenses and deactivate their machines in the customer portal, without signing in. Anyone with the link can, until it expires or the customer is deleted: it can't be revoked otherwise. The token also works with the API endpoints that accept customer tokens.  Links can be created while the product's customer portal is disabled, but the portal answers `404` until it's enabled, and `sendPortalLink` refuses to email them.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param create_portal_link [CreatePortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [PortalLink]
+    def create_portal_link(id, create_portal_link, opts = {})
+      data, _status_code, _headers = create_portal_link_with_http_info(id, create_portal_link, opts)
+      data
+    end
+
+    # Create a link to the customer portal
+    # Link letting the customer see their licenses and deactivate their machines in the customer portal, without signing in. Anyone with the link can, until it expires or the customer is deleted: it can't be revoked otherwise. The token also works with the API endpoints that accept customer tokens.  Links can be created while the product's customer portal is disabled, but the portal answers `404` until it's enabled, and `sendPortalLink` refuses to email them.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param create_portal_link [CreatePortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PortalLink, Integer, Hash)>] PortalLink data, response status code and response headers
+    def create_portal_link_with_http_info(id, create_portal_link, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PortalApi.create_portal_link ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PortalApi.create_portal_link"
+      end
+      # verify the required parameter 'create_portal_link' is set
+      if @api_client.config.client_side_validation && create_portal_link.nil?
+        fail ArgumentError, "Missing the required parameter 'create_portal_link' when calling PortalApi.create_portal_link"
+      end
+      # resource path
+      local_var_path = '/v1/customers/{id}/portal-links'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_portal_link)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PortalLink'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PortalApi.create_portal_link",
+        :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: PortalApi#create_portal_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get the customer portal of a product
+    # Names of the product and of its organization, colors of the customer portal, and link back to the product's website. Answers `404` when the product's customer portal is disabled: with the `portal_disabled` code and the slugs of the product and its organization when signed in as a member of the organization, so they can enable it. Doesn't need authentication.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :return_url Link back to your website to show, used when its domain is one of the product&#39;s &#x60;returnDomains&#x60;.
+    # @return [Portal]
+    def get_portal(product_id, opts = {})
+      data, _status_code, _headers = get_portal_with_http_info(product_id, opts)
+      data
+    end
+
+    # Get the customer portal of a product
+    # Names of the product and of its organization, colors of the customer portal, and link back to the product&#39;s website. Answers &#x60;404&#x60; when the product&#39;s customer portal is disabled: with the &#x60;portal_disabled&#x60; code and the slugs of the product and its organization when signed in as a member of the organization, so they can enable it. Doesn&#39;t need authentication.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :return_url Link back to your website to show, used when its domain is one of the product&#39;s &#x60;returnDomains&#x60;.
+    # @return [Array<(Portal, Integer, Hash)>] Portal data, response status code and response headers
+    def get_portal_with_http_info(product_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PortalApi.get_portal ...'
+      end
+      # verify the required parameter 'product_id' is set
+      if @api_client.config.client_side_validation && product_id.nil?
+        fail ArgumentError, "Missing the required parameter 'product_id' when calling PortalApi.get_portal"
+      end
+      # resource path
+      local_var_path = '/v1/portal/{productId}'.sub('{productId}', CGI.escape(product_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'returnUrl'] = opts[:'return_url'] if !opts[:'return_url'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Portal'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"PortalApi.get_portal",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PortalApi#get_portal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Email a link to the customer portal
+    # Emails the customer of the product with this email a link to the customer portal, working for 1 hour. Answers `404` when the product's customer portal is disabled. Answers the same whether the customer exists or not, so the API doesn't tell which emails are customers. Test products only email the members of the organization: the link isn't sent to other customers, with the same answer. Doesn't need authentication.
+    # @param product_id [String] 
+    # @param request_portal_link [RequestPortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def request_portal_link(product_id, request_portal_link, opts = {})
+      request_portal_link_with_http_info(product_id, request_portal_link, opts)
+      nil
+    end
+
+    # Email a link to the customer portal
+    # Emails the customer of the product with this email a link to the customer portal, working for 1 hour. Answers &#x60;404&#x60; when the product&#39;s customer portal is disabled. Answers the same whether the customer exists or not, so the API doesn&#39;t tell which emails are customers. Test products only email the members of the organization: the link isn&#39;t sent to other customers, with the same answer. Doesn&#39;t need authentication.
+    # @param product_id [String] 
+    # @param request_portal_link [RequestPortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def request_portal_link_with_http_info(product_id, request_portal_link, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PortalApi.request_portal_link ...'
+      end
+      # verify the required parameter 'product_id' is set
+      if @api_client.config.client_side_validation && product_id.nil?
+        fail ArgumentError, "Missing the required parameter 'product_id' when calling PortalApi.request_portal_link"
+      end
+      # verify the required parameter 'request_portal_link' is set
+      if @api_client.config.client_side_validation && request_portal_link.nil?
+        fail ArgumentError, "Missing the required parameter 'request_portal_link' when calling PortalApi.request_portal_link"
+      end
+      # resource path
+      local_var_path = '/v1/portal/{productId}/request-link'.sub('{productId}', CGI.escape(product_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(request_portal_link)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"PortalApi.request_portal_link",
+        :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: PortalApi#request_portal_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Email a link to the customer portal to the customer
+    # Emails a link created with `createPortalLink` to the customer's email. Fails while the product's customer portal is disabled, and, in test products, when the customer's email isn't a member's of the organization: test products only email members, so testing never emails real customers.  **Required role permission**: `portalLink:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param send_portal_link [SendPortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def send_portal_link(id, send_portal_link, opts = {})
+      send_portal_link_with_http_info(id, send_portal_link, opts)
+      nil
+    end
+
+    # Email a link to the customer portal to the customer
+    # Emails a link created with &#x60;createPortalLink&#x60; to the customer&#39;s email. Fails while the product&#39;s customer portal is disabled, and, in test products, when the customer&#39;s email isn&#39;t a member&#39;s of the organization: test products only email members, so testing never emails real customers.  **Required role permission**: &#x60;portalLink:create&#x60; when called with a session, granted by the member&#39;s role. API keys aren&#39;t limited by roles.
+    # @param id [String] 
+    # @param send_portal_link [SendPortalLink] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def send_portal_link_with_http_info(id, send_portal_link, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PortalApi.send_portal_link ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling PortalApi.send_portal_link"
+      end
+      # verify the required parameter 'send_portal_link' is set
+      if @api_client.config.client_side_validation && send_portal_link.nil?
+        fail ArgumentError, "Missing the required parameter 'send_portal_link' when calling PortalApi.send_portal_link"
+      end
+      # resource path
+      local_var_path = '/v1/customers/{id}/portal-links/send'.sub('{id}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(send_portal_link)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PortalApi.send_portal_link",
+        :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: PortalApi#send_portal_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end