polar-accesslink-api-gem 0.1.0

data/lib/polar-accesslink-api-gem/api/users_api.rb

@@ -0,0 +1,221 @@
+=begin
+#Polar Accesslink API
+
+#Polar Accesslink API documentation
+
+The version of the OpenAPI document: 3.78.0
+Contact: b2bhelpdesk@polar.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module PolarAccesslinkApiGem
+  class UsersApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete user
+    # When partner wishes no longer to receive user data, user can be de-registered.This will revoke the access token authorized by user.
+    # @param user_id [Integer] User identifier
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_user(user_id, opts = {})
+      delete_user_with_http_info(user_id, opts)
+      nil
+    end
+
+    # Delete user
+    # When partner wishes no longer to receive user data, user can be de-registered.This will revoke the access token authorized by user.
+    # @param user_id [Integer] User identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_user_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.delete_user ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.delete_user"
+      end
+      pattern = Regexp.new(/[0-9]+/)
+      if @api_client.config.client_side_validation && user_id !~ pattern
+        fail ArgumentError, "invalid value for 'user_id' when calling UsersApi.delete_user, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v3/users/{user-id}'.sub('{' + 'user-id' + '}', CGI.escape(user_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # 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] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.delete_user",
+        :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: UsersApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get user information
+    # List user basic information. Note: Although it is possible to get users weight and height from this resource, the [get physical info](#get-physical-info) should be used instead.
+    # @param user_id [Integer] User identifier
+    # @param [Hash] opts the optional parameters
+    # @return [User]
+    def get_user_information(user_id, opts = {})
+      data, _status_code, _headers = get_user_information_with_http_info(user_id, opts)
+      data
+    end
+
+    # Get user information
+    # List user basic information. Note: Although it is possible to get users weight and height from this resource, the [get physical info](#get-physical-info) should be used instead.
+    # @param user_id [Integer] User identifier
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def get_user_information_with_http_info(user_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.get_user_information ...'
+      end
+      # verify the required parameter 'user_id' is set
+      if @api_client.config.client_side_validation && user_id.nil?
+        fail ArgumentError, "Missing the required parameter 'user_id' when calling UsersApi.get_user_information"
+      end
+      pattern = Regexp.new(/[0-9]+/)
+      if @api_client.config.client_side_validation && user_id !~ pattern
+        fail ArgumentError, "invalid value for 'user_id' when calling UsersApi.get_user_information, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v3/users/{user-id}'.sub('{' + 'user-id' + '}', CGI.escape(user_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', 'application/xml'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'User'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.get_user_information",
+        :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: UsersApi#get_user_information\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Register user
+    # Once partner has been authorized by user, partner must register the user before being able to access its data. API user-id and Polar User Id (polar-user-id) are interchangeable terms.
+    # @param register [Register] 
+    # @param [Hash] opts the optional parameters
+    # @return [User]
+    def register_user(register, opts = {})
+      data, _status_code, _headers = register_user_with_http_info(register, opts)
+      data
+    end
+
+    # Register user
+    # Once partner has been authorized by user, partner must register the user before being able to access its data. API user-id and Polar User Id (polar-user-id) are interchangeable terms.
+    # @param register [Register] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers
+    def register_user_with_http_info(register, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: UsersApi.register_user ...'
+      end
+      # verify the required parameter 'register' is set
+      if @api_client.config.client_side_validation && register.nil?
+        fail ArgumentError, "Missing the required parameter 'register' when calling UsersApi.register_user"
+      end
+      # resource path
+      local_var_path = '/v3/users'
+
+      # 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', 'application/xml'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/xml', 'application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(register)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'User'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"UsersApi.register_user",
+        :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: UsersApi#register_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/polar-accesslink-api-gem/api/webhooks_api.rb

@@ -0,0 +1,278 @@
+=begin
+#Polar Accesslink API
+
+#Polar Accesslink API documentation
+
+The version of the OpenAPI document: 3.78.0
+Contact: b2bhelpdesk@polar.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.2.1
+
+=end
+
+require 'cgi'
+
+module PolarAccesslinkApiGem
+  class WebhooksApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create webhook
+    # Create new webhook.  When creating webhook the Accesslink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created.  **Note!** Save the *signature_secret_key* from response since this is the only chance to get it.
+    # @param webhook_request [WebhookRequest] Webhook to create.
+    # @param [Hash] opts the optional parameters
+    # @return [CreatedWebhook]
+    def create_webhook(webhook_request, opts = {})
+      data, _status_code, _headers = create_webhook_with_http_info(webhook_request, opts)
+      data
+    end
+
+    # Create webhook
+    # Create new webhook.  When creating webhook the Accesslink sends a ping message to the url in request body. The ping message must be answered with 200 OK or otherwise the webhook is not created.  **Note!** Save the *signature_secret_key* from response since this is the only chance to get it.
+    # @param webhook_request [WebhookRequest] Webhook to create.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreatedWebhook, Integer, Hash)>] CreatedWebhook data, response status code and response headers
+    def create_webhook_with_http_info(webhook_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook ...'
+      end
+      # verify the required parameter 'webhook_request' is set
+      if @api_client.config.client_side_validation && webhook_request.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_request' when calling WebhooksApi.create_webhook"
+      end
+      # resource path
+      local_var_path = '/v3/webhooks'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreatedWebhook'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.create_webhook",
+        :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: WebhooksApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete webhook
+    # Delete webhook by id.
+    # @param webhook_id [Integer] Webhook id to delete
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_webhook(webhook_id, opts = {})
+      delete_webhook_with_http_info(webhook_id, opts)
+      nil
+    end
+
+    # Delete webhook
+    # Delete webhook by id.
+    # @param webhook_id [Integer] Webhook id to delete
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def delete_webhook_with_http_info(webhook_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook ...'
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.delete_webhook"
+      end
+      # resource path
+      local_var_path = '/v3/webhooks/{webhook-id}'.sub('{' + 'webhook-id' + '}', CGI.escape(webhook_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'])
+
+      # 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] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.delete_webhook",
+        :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: WebhooksApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get webhook
+    # Returns created webhook if exists.
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookInfo]
+    def get_webhook(opts = {})
+      data, _status_code, _headers = get_webhook_with_http_info(opts)
+      data
+    end
+
+    # Get webhook
+    # Returns created webhook if exists.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookInfo, Integer, Hash)>] WebhookInfo data, response status code and response headers
+    def get_webhook_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...'
+      end
+      # resource path
+      local_var_path = '/v3/webhooks'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookInfo'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.get_webhook",
+        :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: WebhooksApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update webhook
+    # Edit webhook event types and/or url.  When updating webhook url the Accesslink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.
+    # @param webhook_id [Integer] Webhook id to update
+    # @param webhook_patch [WebhookPatch] New value(s) for events and/or url.
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookInfo]
+    def update_webhook(webhook_id, webhook_patch, opts = {})
+      data, _status_code, _headers = update_webhook_with_http_info(webhook_id, webhook_patch, opts)
+      data
+    end
+
+    # Update webhook
+    # Edit webhook event types and/or url.  When updating webhook url the Accesslink sends a ping message to the new address. The ping message must be answered with 200 OK or otherwise the webhook is not updated.
+    # @param webhook_id [Integer] Webhook id to update
+    # @param webhook_patch [WebhookPatch] New value(s) for events and/or url.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookInfo, Integer, Hash)>] WebhookInfo data, response status code and response headers
+    def update_webhook_with_http_info(webhook_id, webhook_patch, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook ...'
+      end
+      # verify the required parameter 'webhook_id' is set
+      if @api_client.config.client_side_validation && webhook_id.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_id' when calling WebhooksApi.update_webhook"
+      end
+      # verify the required parameter 'webhook_patch' is set
+      if @api_client.config.client_side_validation && webhook_patch.nil?
+        fail ArgumentError, "Missing the required parameter 'webhook_patch' when calling WebhooksApi.update_webhook"
+      end
+      # resource path
+      local_var_path = '/v3/webhooks/{webhook-id}'.sub('{' + 'webhook-id' + '}', CGI.escape(webhook_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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(webhook_patch)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WebhookInfo'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['Basic']
+
+      new_options = opts.merge(
+        :operation => :"WebhooksApi.update_webhook",
+        :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: WebhooksApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end