license_manager 0.1.0

data/lib/license_manager/api/policies_api.rb

@@ -0,0 +1,412 @@
+=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 PoliciesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a policy
+    # Without a `slug`, the policy gets one derived from its name, made unique within the product by appending a dash and 3 random lowercase letters or digits when needed. An explicit `slug` is used as is: the request fails with a `409` when it's taken.  With `isDefault: true`, the new policy replaces the product's current default policy.  A product always has a default policy, so when it has no policies the new one becomes the default: the request fails with a `409` when `isDefault` is `false`.  **Required role permission**: `policy:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param product_id [String] 
+    # @param create_policy [CreatePolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Policy]
+    def create_policy(product_id, create_policy, opts = {})
+      data, _status_code, _headers = create_policy_with_http_info(product_id, create_policy, opts)
+      data
+    end
+
+    # Create a policy
+    # Without a `slug`, the policy gets one derived from its name, made unique within the product by appending a dash and 3 random lowercase letters or digits when needed. An explicit `slug` is used as is: the request fails with a `409` when it's taken.  With `isDefault: true`, the new policy replaces the product's current default policy.  A product always has a default policy, so when it has no policies the new one becomes the default: the request fails with a `409` when `isDefault` is `false`.  **Required role permission**: `policy:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param product_id [String] 
+    # @param create_policy [CreatePolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Policy, Integer, Hash)>] Policy data, response status code and response headers
+    def create_policy_with_http_info(product_id, create_policy, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PoliciesApi.create_policy ...'
+      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 PoliciesApi.create_policy"
+      end
+      # verify the required parameter 'create_policy' is set
+      if @api_client.config.client_side_validation && create_policy.nil?
+        fail ArgumentError, "Missing the required parameter 'create_policy' when calling PoliciesApi.create_policy"
+      end
+      # resource path
+      local_var_path = '/v1/products/{productId}/policies'.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(create_policy)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Policy'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PoliciesApi.create_policy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PoliciesApi#create_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a policy
+    # Deleting the default policy makes the oldest remaining policy of the product the default. The last policy of a product can't be deleted, nor a policy that licenses follow. Its events can no longer be listed.  **Required role permission**: `policy:delete` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_policy(id, opts = {})
+      delete_policy_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a policy
+    # Deleting the default policy makes the oldest remaining policy of the product the default. The last policy of a product can&#39;t be deleted, nor a policy that licenses follow. Its events can no longer be listed.  **Required role permission**: &#x60;policy:delete&#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 [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_policy_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PoliciesApi.delete_policy ...'
+      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 PoliciesApi.delete_policy"
+      end
+      # resource path
+      local_var_path = '/v1/policies/{id}'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PoliciesApi.delete_policy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PoliciesApi#delete_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a policy
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Policy]
+    def get_policy(id, opts = {})
+      data, _status_code, _headers = get_policy_with_http_info(id, opts)
+      data
+    end
+
+    # Get a policy
+    # @param id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Policy, Integer, Hash)>] Policy data, response status code and response headers
+    def get_policy_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PoliciesApi.get_policy ...'
+      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 PoliciesApi.get_policy"
+      end
+      # resource path
+      local_var_path = '/v1/policies/{id}'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Policy'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PoliciesApi.get_policy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PoliciesApi#get_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List the policies of a product
+    # `?isDefault=true` returns the product's default policy alone: a product always has exactly one. Sorting by `duration` counts months for their average length, about 30.4 days.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page to return. Pages are numbered from 1: &#x60;1&#x60; is the first page. A page past the last one returns an empty &#x60;data&#x60;, not an error. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to &#x60;20&#x60;. (default to 20)
+    # @option opts [String] :sort Field to sort by, prefixed with &#x60;-&#x60; for descending order. Defaults to &#x60;name&#x60;. (default to 'name')
+    # @option opts [String] :search Case-insensitive text the name or slug contains.
+    # @option opts [String] :slug Only returns the policy with this exact slug.
+    # @option opts [String] :is_default &#x60;true&#x60; only returns the product&#39;s default policy, &#x60;false&#x60; only the other ones.
+    # @option opts [Integer] :license_count Only returns the policies followed by exactly this number of licenses.
+    # @option opts [Integer] :license_count_min Only returns the policies followed by at least this number of licenses.
+    # @option opts [Integer] :license_count_max Only returns the policies followed by at most this number of licenses.
+    # @return [PolicyList]
+    def list_policies(product_id, opts = {})
+      data, _status_code, _headers = list_policies_with_http_info(product_id, opts)
+      data
+    end
+
+    # List the policies of a product
+    # &#x60;?isDefault&#x3D;true&#x60; returns the product&#39;s default policy alone: a product always has exactly one. Sorting by &#x60;duration&#x60; counts months for their average length, about 30.4 days.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Page to return. Pages are numbered from 1: &#x60;1&#x60; is the first page. A page past the last one returns an empty &#x60;data&#x60;, not an error. Defaults to &#x60;1&#x60;. (default to 1)
+    # @option opts [Integer] :page_size Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to &#x60;20&#x60;. (default to 20)
+    # @option opts [String] :sort Field to sort by, prefixed with &#x60;-&#x60; for descending order. Defaults to &#x60;name&#x60;. (default to 'name')
+    # @option opts [String] :search Case-insensitive text the name or slug contains.
+    # @option opts [String] :slug Only returns the policy with this exact slug.
+    # @option opts [String] :is_default &#x60;true&#x60; only returns the product&#39;s default policy, &#x60;false&#x60; only the other ones.
+    # @option opts [Integer] :license_count Only returns the policies followed by exactly this number of licenses.
+    # @option opts [Integer] :license_count_min Only returns the policies followed by at least this number of licenses.
+    # @option opts [Integer] :license_count_max Only returns the policies followed by at most this number of licenses.
+    # @return [Array<(PolicyList, Integer, Hash)>] PolicyList data, response status code and response headers
+    def list_policies_with_http_info(product_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PoliciesApi.list_policies ...'
+      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 PoliciesApi.list_policies"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page"]" when calling PoliciesApi.list_policies, must be greater than or equal to 1.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PoliciesApi.list_policies, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PoliciesApi.list_policies, must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["name", "-name", "slug", "-slug", "duration", "-duration", "maxMachines", "-maxMachines", "maxOfflineDurationSeconds", "-maxOfflineDurationSeconds", "licenseCount", "-licenseCount", "createdAt", "-createdAt", "updatedAt", "-updatedAt", "unknown_default_open_api"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length > 200
+        fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PoliciesApi.list_policies, the character length must be smaller than or equal to 200.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'search'].nil? && opts[:'search'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"search"]" when calling PoliciesApi.list_policies, the character length must be greater than or equal to 1.'
+      end
+
+      allowable_values = ["true", "false", "unknown_default_open_api"]
+      if @api_client.config.client_side_validation && opts[:'is_default'] && !allowable_values.include?(opts[:'is_default'])
+        fail ArgumentError, "invalid value for \"is_default\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/products/{productId}/policies'.sub('{productId}', CGI.escape(product_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+      query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
+      query_params[:'slug'] = opts[:'slug'] if !opts[:'slug'].nil?
+      query_params[:'isDefault'] = opts[:'is_default'] if !opts[:'is_default'].nil?
+      query_params[:'licenseCount'] = opts[:'license_count'] if !opts[:'license_count'].nil?
+      query_params[:'licenseCountMin'] = opts[:'license_count_min'] if !opts[:'license_count_min'].nil?
+      query_params[:'licenseCountMax'] = opts[:'license_count_max'] if !opts[:'license_count_max'].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] || 'PolicyList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PoliciesApi.list_policies",
+        :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: PoliciesApi#list_policies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update a policy
+    # `isDefault: true` makes the policy the product's default, in place of the current one. A product always has a default policy, so the default can't be unset with `isDefault: false`: make another policy the default instead.  Licenses copy the settings of their policy when they're created, so changing them only affects the licenses created afterwards: update the existing licenses to change theirs.  **Required role permission**: `policy:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param update_policy [UpdatePolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Policy]
+    def update_policy(id, update_policy, opts = {})
+      data, _status_code, _headers = update_policy_with_http_info(id, update_policy, opts)
+      data
+    end
+
+    # Update a policy
+    # &#x60;isDefault: true&#x60; makes the policy the product&#39;s default, in place of the current one. A product always has a default policy, so the default can&#39;t be unset with &#x60;isDefault: false&#x60;: make another policy the default instead.  Licenses copy the settings of their policy when they&#39;re created, so changing them only affects the licenses created afterwards: update the existing licenses to change theirs.  **Required role permission**: &#x60;policy:update&#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 update_policy [UpdatePolicy] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Policy, Integer, Hash)>] Policy data, response status code and response headers
+    def update_policy_with_http_info(id, update_policy, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PoliciesApi.update_policy ...'
+      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 PoliciesApi.update_policy"
+      end
+      # verify the required parameter 'update_policy' is set
+      if @api_client.config.client_side_validation && update_policy.nil?
+        fail ArgumentError, "Missing the required parameter 'update_policy' when calling PoliciesApi.update_policy"
+      end
+      # resource path
+      local_var_path = '/v1/policies/{id}'.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(update_policy)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Policy'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"PoliciesApi.update_policy",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PoliciesApi#update_policy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end