peal 0.1.0

data/lib/peal/api/channels_api.rb

@@ -0,0 +1,526 @@
+=begin
+#Peal API
+
+#Schedule posts across social platforms, follow how they did, and manage a Peal workspace's channels, media and members.
+
+The version of the OpenAPI document: 0.0.1
+Contact: hello@peal.social
+Generated by: https://openapi-generator.tech
+Generator version: 7.27.0
+
+=end
+
+require 'cgi'
+
+module Peal
+  class ChannelsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Choose the accounts to connect
+    # Connects the accounts the member chose among those a completed sign-in listed: each becomes a channel of the workspace, or reconnects the one it has. The new accounts chosen need room in the workspace's plan, all of them: otherwise none is connected (PlanLimitReached), and the choice can be made again with fewer. Only the member who completed the sign-in can choose, within 15 minutes, and once an account is connected: a choice that failed before connecting any can be made again. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param choose_accounts [ChooseAccounts] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Channel>]
+    def channels_choose_accounts(workspace_id, platform, choose_accounts, opts = {})
+      data, _status_code, _headers = channels_choose_accounts_with_http_info(workspace_id, platform, choose_accounts, opts)
+      data
+    end
+
+    # Choose the accounts to connect
+    # Connects the accounts the member chose among those a completed sign-in listed: each becomes a channel of the workspace, or reconnects the one it has. The new accounts chosen need room in the workspace&#39;s plan, all of them: otherwise none is connected (PlanLimitReached), and the choice can be made again with fewer. Only the member who completed the sign-in can choose, within 15 minutes, and once an account is connected: a choice that failed before connecting any can be made again. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param choose_accounts [ChooseAccounts] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Channel>, Integer, Hash)>] Array<Channel> data, response status code and response headers
+    def channels_choose_accounts_with_http_info(workspace_id, platform, choose_accounts, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_choose_accounts ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_choose_accounts"
+      end
+      # verify the required parameter 'platform' is set
+      if @api_client.config.client_side_validation && platform.nil?
+        fail ArgumentError, "Missing the required parameter 'platform' when calling ChannelsApi.channels_choose_accounts"
+      end
+      # verify the required parameter 'choose_accounts' is set
+      if @api_client.config.client_side_validation && choose_accounts.nil?
+        fail ArgumentError, "Missing the required parameter 'choose_accounts' when calling ChannelsApi.channels_choose_accounts"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/connect/{platform}/accounts'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{platform}', CGI.escape(platform.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(choose_accounts)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Channel>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_choose_accounts",
+        :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: ChannelsApi#channels_choose_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Complete connecting an account
+    # Completes a connection with what the platform sent back: the account becomes a channel of the workspace, or the channel it reconnects takes its new tokens. When the sign-in reached several accounts, as the Pages a Facebook user manages, the answer lists them instead, to choose with chooseAccounts. Only the member who started the connection can complete it, once. A new account needs room in the workspace's plan (PlanLimitReached). Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param connect_callback [ConnectCallback] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConnectOutcome]
+    def channels_complete_connect(workspace_id, platform, connect_callback, opts = {})
+      data, _status_code, _headers = channels_complete_connect_with_http_info(workspace_id, platform, connect_callback, opts)
+      data
+    end
+
+    # Complete connecting an account
+    # Completes a connection with what the platform sent back: the account becomes a channel of the workspace, or the channel it reconnects takes its new tokens. When the sign-in reached several accounts, as the Pages a Facebook user manages, the answer lists them instead, to choose with chooseAccounts. Only the member who started the connection can complete it, once. A new account needs room in the workspace&#39;s plan (PlanLimitReached). Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param connect_callback [ConnectCallback] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConnectOutcome, Integer, Hash)>] ConnectOutcome data, response status code and response headers
+    def channels_complete_connect_with_http_info(workspace_id, platform, connect_callback, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_complete_connect ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_complete_connect"
+      end
+      # verify the required parameter 'platform' is set
+      if @api_client.config.client_side_validation && platform.nil?
+        fail ArgumentError, "Missing the required parameter 'platform' when calling ChannelsApi.channels_complete_connect"
+      end
+      # verify the required parameter 'connect_callback' is set
+      if @api_client.config.client_side_validation && connect_callback.nil?
+        fail ArgumentError, "Missing the required parameter 'connect_callback' when calling ChannelsApi.channels_complete_connect"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/connect/{platform}/callback'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{platform}', CGI.escape(platform.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(connect_callback)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'ConnectOutcome'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_complete_connect",
+        :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: ChannelsApi#channels_complete_connect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start connecting an account
+    # Starts connecting an account of the platform: answers with the platform's sign-in page, where the browser goes next. The connection is tied to the caller and the workspace, and must be completed within 15 minutes. On a server that bills, a workspace whose plan allows no more channels gets PlanLimitReached. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param connect_channel [ConnectChannel] 
+    # @param [Hash] opts the optional parameters
+    # @return [Authorization]
+    def channels_connect(workspace_id, platform, connect_channel, opts = {})
+      data, _status_code, _headers = channels_connect_with_http_info(workspace_id, platform, connect_channel, opts)
+      data
+    end
+
+    # Start connecting an account
+    # Starts connecting an account of the platform: answers with the platform&#39;s sign-in page, where the browser goes next. The connection is tied to the caller and the workspace, and must be completed within 15 minutes. On a server that bills, a workspace whose plan allows no more channels gets PlanLimitReached. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param platform [Platform] 
+    # @param connect_channel [ConnectChannel] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Authorization, Integer, Hash)>] Authorization data, response status code and response headers
+    def channels_connect_with_http_info(workspace_id, platform, connect_channel, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_connect ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_connect"
+      end
+      # verify the required parameter 'platform' is set
+      if @api_client.config.client_side_validation && platform.nil?
+        fail ArgumentError, "Missing the required parameter 'platform' when calling ChannelsApi.channels_connect"
+      end
+      # verify the required parameter 'connect_channel' is set
+      if @api_client.config.client_side_validation && connect_channel.nil?
+        fail ArgumentError, "Missing the required parameter 'connect_channel' when calling ChannelsApi.channels_connect"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/connect/{platform}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{platform}', CGI.escape(platform.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(connect_channel)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Authorization'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_connect",
+        :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: ChannelsApi#channels_connect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Disconnect a channel
+    # Disconnects a channel from the workspace: the channel and the tokens Peal holds for it are deleted, and nothing more is posted on it. Needs channel:disconnect.
+    # @param workspace_id [String] 
+    # @param channel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def channels_disconnect(workspace_id, channel_id, opts = {})
+      channels_disconnect_with_http_info(workspace_id, channel_id, opts)
+      nil
+    end
+
+    # Disconnect a channel
+    # Disconnects a channel from the workspace: the channel and the tokens Peal holds for it are deleted, and nothing more is posted on it. Needs channel:disconnect.
+    # @param workspace_id [String] 
+    # @param channel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def channels_disconnect_with_http_info(workspace_id, channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_disconnect ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_disconnect"
+      end
+      # verify the required parameter 'channel_id' is set
+      if @api_client.config.client_side_validation && channel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.channels_disconnect"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/{channelId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{channelId}', CGI.escape(channel_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] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_disconnect",
+        :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: ChannelsApi#channels_disconnect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List channels
+    # Lists the channels connected to the workspace, oldest first. Their tokens are never shown. Needs channel:read.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Channel>]
+    def channels_list(workspace_id, opts = {})
+      data, _status_code, _headers = channels_list_with_http_info(workspace_id, opts)
+      data
+    end
+
+    # List channels
+    # Lists the channels connected to the workspace, oldest first. Their tokens are never shown. Needs channel:read.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Channel>, Integer, Hash)>] Array<Channel> data, response status code and response headers
+    def channels_list_with_http_info(workspace_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_list ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_list"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels'.sub('{workspaceId}', CGI.escape(workspace_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] || 'Array<Channel>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_list",
+        :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: ChannelsApi#channels_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List connectable platforms
+    # Lists the platforms this server can connect accounts of, in Peal's order. A platform that needs a setting the server lacks, such as an app registered on LinkedIn, X or Meta or a Google OAuth client, is left out. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [ConnectablePlatforms]
+    def channels_platforms(workspace_id, opts = {})
+      data, _status_code, _headers = channels_platforms_with_http_info(workspace_id, opts)
+      data
+    end
+
+    # List connectable platforms
+    # Lists the platforms this server can connect accounts of, in Peal&#39;s order. A platform that needs a setting the server lacks, such as an app registered on LinkedIn, X or Meta or a Google OAuth client, is left out. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConnectablePlatforms, Integer, Hash)>] ConnectablePlatforms data, response status code and response headers
+    def channels_platforms_with_http_info(workspace_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_platforms ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_platforms"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/platforms'.sub('{workspaceId}', CGI.escape(workspace_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] || 'ConnectablePlatforms'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_platforms",
+        :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: ChannelsApi#channels_platforms\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Start reconnecting a channel
+    # Starts reconnecting a channel whose token stopped working or is about to: answers with the platform's sign-in page. Completing it must sign in to the same account. A channel the workspace has takes no room in its plan, so no plan limit refuses it. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param channel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Authorization]
+    def channels_reconnect(workspace_id, channel_id, opts = {})
+      data, _status_code, _headers = channels_reconnect_with_http_info(workspace_id, channel_id, opts)
+      data
+    end
+
+    # Start reconnecting a channel
+    # Starts reconnecting a channel whose token stopped working or is about to: answers with the platform&#39;s sign-in page. Completing it must sign in to the same account. A channel the workspace has takes no room in its plan, so no plan limit refuses it. Needs channel:connect.
+    # @param workspace_id [String] 
+    # @param channel_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Authorization, Integer, Hash)>] Authorization data, response status code and response headers
+    def channels_reconnect_with_http_info(workspace_id, channel_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ChannelsApi.channels_reconnect ...'
+      end
+      # verify the required parameter 'workspace_id' is set
+      if @api_client.config.client_side_validation && workspace_id.nil?
+        fail ArgumentError, "Missing the required parameter 'workspace_id' when calling ChannelsApi.channels_reconnect"
+      end
+      # verify the required parameter 'channel_id' is set
+      if @api_client.config.client_side_validation && channel_id.nil?
+        fail ArgumentError, "Missing the required parameter 'channel_id' when calling ChannelsApi.channels_reconnect"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/channels/{channelId}/reconnect'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{channelId}', CGI.escape(channel_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] || 'Authorization'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ChannelsApi.channels_reconnect",
+        :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: ChannelsApi#channels_reconnect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end