license_manager 0.3.0 → 0.3.2

data/lib/license_manager/api/integrations_api.rb

@@ -19,6 +19,69 @@ module LicenseManager
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Start connecting a Slack channel
+    # Returns the URL of Slack's consent screen, where the user picks the channel getting the product's notifications. Slack then redirects to the app's integrations page. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SlackAuthorize]
+    def authorize_slack(product_id, opts = {})
+      data, _status_code, _headers = authorize_slack_with_http_info(product_id, opts)
+      data
+    end
+
+    # Start connecting a Slack channel
+    # Returns the URL of Slack's consent screen, where the user picks the channel getting the product's notifications. Slack then redirects to the app's integrations page. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SlackAuthorize, Integer, Hash)>] SlackAuthorize data, response status code and response headers
+    def authorize_slack_with_http_info(product_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.authorize_slack ...'
+      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 IntegrationsApi.authorize_slack"
+      end
+      # resource path
+      local_var_path = '/v1/products/{productId}/integrations/slack/authorize'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SlackAuthorize'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.authorize_slack",
+        :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: IntegrationsApi#authorize_slack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Check an integration
     # Checks right away, as done every day, that the API key still works and can manage the webhook endpoint, which is pointed at the server's webhook URL again (or created again when it was deleted). Updates the status. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
     # @param id [String] 
@@ -230,6 +293,69 @@ module LicenseManager
       return data, status_code, headers
     end
 
+    # Remove a Slack connection
+    # Stops posting to the channel and revokes the installation's token in Slack. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration: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_slack_connection(id, opts = {})
+      delete_slack_connection_with_http_info(id, opts)
+      nil
+    end
+
+    # Remove a Slack connection
+    # Stops posting to the channel and revokes the installation&#39;s token in Slack. Doesn&#39;t accept tokens: only API keys and sessions.  **Required role permission**: &#x60;integration: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_slack_connection_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.delete_slack_connection ...'
+      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 IntegrationsApi.delete_slack_connection"
+      end
+      # resource path
+      local_var_path = '/v1/slack-connections/{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 => :"IntegrationsApi.delete_slack_connection",
+        :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: IntegrationsApi#delete_slack_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete a mapping
     # Paying the price no longer creates licenses. The licenses it created stay. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
     # @param id [String] 
@@ -356,6 +482,69 @@ module LicenseManager
       return data, status_code, headers
     end
 
+    # Get the Slack integration of a product
+    # Slack channels getting notifications about the product's licenses: purchases, renewals, failed payments and cancellations. Doesn't accept tokens: only API keys and sessions.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [SlackIntegration]
+    def get_slack_integration(product_id, opts = {})
+      data, _status_code, _headers = get_slack_integration_with_http_info(product_id, opts)
+      data
+    end
+
+    # Get the Slack integration of a product
+    # Slack channels getting notifications about the product&#39;s licenses: purchases, renewals, failed payments and cancellations. Doesn&#39;t accept tokens: only API keys and sessions.
+    # @param product_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SlackIntegration, Integer, Hash)>] SlackIntegration data, response status code and response headers
+    def get_slack_integration_with_http_info(product_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.get_slack_integration ...'
+      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 IntegrationsApi.get_slack_integration"
+      end
+      # resource path
+      local_var_path = '/v1/products/{productId}/integrations/slack'.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']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SlackIntegration'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.get_slack_integration",
+        :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: IntegrationsApi#get_slack_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get the Stripe integration of a product
     # The organization connects one Stripe account for its live products, and one in test mode for its test products. Its mappings tell which Stripe prices create licenses of the product. Doesn't accept tokens: only API keys and sessions.
     # @param product_id [String] 
@@ -482,6 +671,69 @@ module LicenseManager
       return data, status_code, headers
     end
 
+    # Send a test message to a Slack channel
+    # Posts a message to the channel, to check it gets the notifications. Marks the connection `revoked` when Slack says it won't work again. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` 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 [SlackConnection]
+    def test_slack_connection(id, opts = {})
+      data, _status_code, _headers = test_slack_connection_with_http_info(id, opts)
+      data
+    end
+
+    # Send a test message to a Slack channel
+    # Posts a message to the channel, to check it gets the notifications. Marks the connection &#x60;revoked&#x60; when Slack says it won&#39;t work again. Doesn&#39;t accept tokens: only API keys and sessions.  **Required role permission**: &#x60;integration: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 [Hash] opts the optional parameters
+    # @return [Array<(SlackConnection, Integer, Hash)>] SlackConnection data, response status code and response headers
+    def test_slack_connection_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.test_slack_connection ...'
+      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 IntegrationsApi.test_slack_connection"
+      end
+      # resource path
+      local_var_path = '/v1/slack-connections/{id}/test'.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] || 'SlackConnection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.test_slack_connection",
+        :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: IntegrationsApi#test_slack_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an integration
     # Changes the settings of the integration, for every product of its mode. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
     # @param id [String] 
@@ -556,6 +808,80 @@ module LicenseManager
       return data, status_code, headers
     end
 
+    # Update a Slack connection
+    # Changes the notifications the channel gets. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
+    # @param id [String] 
+    # @param update_slack_connection [UpdateSlackConnection] 
+    # @param [Hash] opts the optional parameters
+    # @return [SlackConnection]
+    def update_slack_connection(id, update_slack_connection, opts = {})
+      data, _status_code, _headers = update_slack_connection_with_http_info(id, update_slack_connection, opts)
+      data
+    end
+
+    # Update a Slack connection
+    # Changes the notifications the channel gets. Doesn&#39;t accept tokens: only API keys and sessions.  **Required role permission**: &#x60;integration: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_slack_connection [UpdateSlackConnection] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SlackConnection, Integer, Hash)>] SlackConnection data, response status code and response headers
+    def update_slack_connection_with_http_info(id, update_slack_connection, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IntegrationsApi.update_slack_connection ...'
+      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 IntegrationsApi.update_slack_connection"
+      end
+      # verify the required parameter 'update_slack_connection' is set
+      if @api_client.config.client_side_validation && update_slack_connection.nil?
+        fail ArgumentError, "Missing the required parameter 'update_slack_connection' when calling IntegrationsApi.update_slack_connection"
+      end
+      # resource path
+      local_var_path = '/v1/slack-connections/{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_slack_connection)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SlackConnection'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['apiKey']
+
+      new_options = opts.merge(
+        :operation => :"IntegrationsApi.update_slack_connection",
+        :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: IntegrationsApi#update_slack_connection\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Change the policy of a mapping
     # Only affects the licenses created afterwards. Doesn't accept tokens: only API keys and sessions.  **Required role permission**: `integration:update` when called with a session, granted by the member's role. API keys aren't limited by roles.
     # @param id [String] 

data/lib/license_manager/api/licenses_api.rb

@@ -420,7 +420,7 @@ module LicenseManager
     # @option opts [Integer] :page Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`. (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 `20`. (default to 20)
     # @option opts [String] :sort Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`. (default to '-createdAt')
-    # @option opts [String] :search Case-insensitive text the key contains.
+    # @option opts [String] :search Case-insensitive text the key or the email of the customer contains.
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
@@ -451,7 +451,7 @@ module LicenseManager
     # @option opts [Integer] :page Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`. (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 `20`. (default to 20)
     # @option opts [String] :sort Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`. (default to '-createdAt')
-    # @option opts [String] :search Case-insensitive text the key contains.
+    # @option opts [String] :search Case-insensitive text the key or the email of the customer contains.
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :machine_version Only returns the licenses with at least one active machine running this version of the product.
@@ -582,7 +582,7 @@ module LicenseManager
     # @option opts [Integer] :page Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`. (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 `20`. (default to 20)
     # @option opts [String] :sort Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`. (default to '-createdAt')
-    # @option opts [String] :search Case-insensitive text the key contains.
+    # @option opts [String] :search Case-insensitive text the key or the email of the customer contains.
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :customer_id Only returns the licenses of this customer.
@@ -614,7 +614,7 @@ module LicenseManager
     # @option opts [Integer] :page Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`. (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 `20`. (default to 20)
     # @option opts [String] :sort Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`. (default to '-createdAt')
-    # @option opts [String] :search Case-insensitive text the key contains.
+    # @option opts [String] :search Case-insensitive text the key or the email of the customer contains.
     # @option opts [String] :key Only returns the license with this exact key, case included. Keys of test products start with `TEST-`.
     # @option opts [String] :policy_id Only returns the licenses following this policy.
     # @option opts [String] :customer_id Only returns the licenses of this customer.

data/lib/license_manager/models/license.rb

@@ -23,6 +23,8 @@ module LicenseManager
 
     attr_accessor :customer_id
 
+    attr_accessor :customer
+
     # Unique within the product. Case sensitive: `validateKey` compares keys exactly.
     attr_accessor :key
 
@@ -103,6 +105,7 @@ module LicenseManager
         :'product_id' => :'productId',
         :'policy_id' => :'policyId',
         :'customer_id' => :'customerId',
+        :'customer' => :'customer',
         :'key' => :'key',
         :'created_at' => :'createdAt',
         :'expires_at' => :'expiresAt',
@@ -142,6 +145,7 @@ module LicenseManager
         :'product_id' => :'String',
         :'policy_id' => :'String',
         :'customer_id' => :'String',
+        :'customer' => :'LicenseCustomer',
         :'key' => :'String',
         :'created_at' => :'Time',
         :'expires_at' => :'Time',
@@ -231,6 +235,12 @@ module LicenseManager
         self.customer_id = nil
       end
 
+      if attributes.key?(:'customer')
+        self.customer = attributes[:'customer']
+      else
+        self.customer = nil
+      end
+
       if attributes.key?(:'key')
         self.key = attributes[:'key']
       else
@@ -369,6 +379,10 @@ module LicenseManager
         invalid_properties.push('invalid value for "customer_id", customer_id cannot be nil.')
       end
 
+      if @customer.nil?
+        invalid_properties.push('invalid value for "customer", customer cannot be nil.')
+      end
+
       if @key.nil?
         invalid_properties.push('invalid value for "key", key cannot be nil.')
       end
@@ -412,6 +426,7 @@ module LicenseManager
       return false if @product_id.nil?
       return false if @policy_id.nil?
       return false if @customer_id.nil?
+      return false if @customer.nil?
       return false if @key.nil?
       return false if @created_at.nil?
       return false if @max_offline_duration_seconds.nil?
@@ -463,6 +478,16 @@ module LicenseManager
       @customer_id = customer_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] customer Value to be assigned
+    def customer=(customer)
+      if customer.nil?
+        fail ArgumentError, 'customer cannot be nil'
+      end
+
+      @customer = customer
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] key Value to be assigned
     def key=(key)
@@ -552,6 +577,7 @@ module LicenseManager
           product_id == o.product_id &&
           policy_id == o.policy_id &&
           customer_id == o.customer_id &&
+          customer == o.customer &&
           key == o.key &&
           created_at == o.created_at &&
           expires_at == o.expires_at &&
@@ -582,7 +608,7 @@ module LicenseManager
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, product_id, policy_id, customer_id, key, created_at, expires_at, meta, stripe_payment_intent_id, max_machines, max_offline_duration_seconds, active_machine_count, last_activated_at, max_version, price, status, cancellable_until, canceled_at, cancellation_reason, subscription, cancellation_comment, stripe_refund_id, updated_at].hash
+      [id, product_id, policy_id, customer_id, customer, key, created_at, expires_at, meta, stripe_payment_intent_id, max_machines, max_offline_duration_seconds, active_machine_count, last_activated_at, max_version, price, status, cancellable_until, canceled_at, cancellation_reason, subscription, cancellation_comment, stripe_refund_id, updated_at].hash
     end
 
     # Builds the object from hash