peal 0.1.0

data/docs/UploadTargetAnyOf1.md

@@ -0,0 +1,24 @@
+# Peal::UploadTargetAnyOf1
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+| **expires_at** | **String** |  |  |
+| **part_size** | **Integer** |  |  |
+| **parts** | [**Array<UploadPart>**](UploadPart.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::UploadTargetAnyOf1.new(
+  _tag: null,
+  expires_at: null,
+  part_size: null,
+  parts: null
+)
+```
+

data/docs/Usage.md

@@ -0,0 +1,24 @@
+# Peal::Usage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **assistant_requests** | [**PeriodUsage**](PeriodUsage.md) |  |  |
+| **channels** | **Integer** |  |  |
+| **members** | **Integer** |  |  |
+| **scheduled_posts** | [**PeriodUsage**](PeriodUsage.md) |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::Usage.new(
+  assistant_requests: null,
+  channels: null,
+  members: null,
+  scheduled_posts: null
+)
+```
+

data/docs/WorkspaceMember.md

@@ -0,0 +1,26 @@
+# Peal::WorkspaceMember
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **joined_at** | **String** |  |  |
+| **name** | **String** |  |  |
+| **role** | **String** |  |  |
+| **user_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::WorkspaceMember.new(
+  email: null,
+  joined_at: null,
+  name: null,
+  role: null,
+  user_id: null
+)
+```
+

data/docs/WorkspaceNotFoundEncoded.md

@@ -0,0 +1,18 @@
+# Peal::WorkspaceNotFoundEncoded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_tag** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::WorkspaceNotFoundEncoded.new(
+  _tag: null
+)
+```
+

data/docs/YouTubeOptions.md

@@ -0,0 +1,32 @@
+# Peal::YouTubeOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **category_id** | **String** |  | [optional] |
+| **contains_synthetic_media** | **Boolean** |  | [optional] |
+| **made_for_kids** | **Boolean** |  | [optional] |
+| **notify_subscribers** | **Boolean** |  | [optional] |
+| **platform** | **String** |  |  |
+| **privacy** | [**YouTubePrivacy**](YouTubePrivacy.md) |  | [optional] |
+| **tags** | **Array<String>** |  | [optional] |
+| **title** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::YouTubeOptions.new(
+  category_id: null,
+  contains_synthetic_media: null,
+  made_for_kids: null,
+  notify_subscribers: null,
+  platform: null,
+  privacy: null,
+  tags: null,
+  title: null
+)
+```
+

data/docs/YouTubePrivacy.md

@@ -0,0 +1,15 @@
+# Peal::YouTubePrivacy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'peal'
+
+instance = Peal::YouTubePrivacy.new()
+```
+

data/lib/peal/api/analytics_api.rb

@@ -0,0 +1,185 @@
+=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 AnalyticsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get a post's analytics
+    # Answers with the counts of a post on each channel it went live on, over time. A post not published yet, or whose counts were not read yet, has no targets. Needs analytics:read.
+    # @param workspace_id [String] 
+    # @param post_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [PostAnalytics]
+    def analytics_post(workspace_id, post_id, opts = {})
+      data, _status_code, _headers = analytics_post_with_http_info(workspace_id, post_id, opts)
+      data
+    end
+
+    # Get a post's analytics
+    # Answers with the counts of a post on each channel it went live on, over time. A post not published yet, or whose counts were not read yet, has no targets. Needs analytics:read.
+    # @param workspace_id [String] 
+    # @param post_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PostAnalytics, Integer, Hash)>] PostAnalytics data, response status code and response headers
+    def analytics_post_with_http_info(workspace_id, post_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_post ...'
+      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 AnalyticsApi.analytics_post"
+      end
+      # verify the required parameter 'post_id' is set
+      if @api_client.config.client_side_validation && post_id.nil?
+        fail ArgumentError, "Missing the required parameter 'post_id' when calling AnalyticsApi.analytics_post"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/analytics/posts/{postId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{postId}', CGI.escape(post_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] || 'PostAnalytics'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsApi.analytics_post",
+        :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: AnalyticsApi#analytics_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Summarize the workspace's analytics
+    # Sums up the posts published from `from` to `to`, both included and at most 366 days, as days run in `timeZone` (an IANA zone such as Europe/Paris): their latest counts in all and by channel, what they gained each day, and the five with the most engagement (likes, reposts, replies and quotes). Counts are read from the platforms every hour for 48 hours after a post goes live, then every day until it is 30 days old. Needs analytics:read.
+    # @param workspace_id [String] 
+    # @param from [String] 
+    # @param time_zone [String] 
+    # @param to [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [AnalyticsSummary]
+    def analytics_summary(workspace_id, from, time_zone, to, opts = {})
+      data, _status_code, _headers = analytics_summary_with_http_info(workspace_id, from, time_zone, to, opts)
+      data
+    end
+
+    # Summarize the workspace&#39;s analytics
+    # Sums up the posts published from &#x60;from&#x60; to &#x60;to&#x60;, both included and at most 366 days, as days run in &#x60;timeZone&#x60; (an IANA zone such as Europe/Paris): their latest counts in all and by channel, what they gained each day, and the five with the most engagement (likes, reposts, replies and quotes). Counts are read from the platforms every hour for 48 hours after a post goes live, then every day until it is 30 days old. Needs analytics:read.
+    # @param workspace_id [String] 
+    # @param from [String] 
+    # @param time_zone [String] 
+    # @param to [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AnalyticsSummary, Integer, Hash)>] AnalyticsSummary data, response status code and response headers
+    def analytics_summary_with_http_info(workspace_id, from, time_zone, to, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AnalyticsApi.analytics_summary ...'
+      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 AnalyticsApi.analytics_summary"
+      end
+      # verify the required parameter 'from' is set
+      if @api_client.config.client_side_validation && from.nil?
+        fail ArgumentError, "Missing the required parameter 'from' when calling AnalyticsApi.analytics_summary"
+      end
+      pattern = Regexp.new(/^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$/)
+      if @api_client.config.client_side_validation && from !~ pattern
+        fail ArgumentError, "invalid value for 'from' when calling AnalyticsApi.analytics_summary, must conform to the pattern #{pattern}."
+      end
+
+      # verify the required parameter 'time_zone' is set
+      if @api_client.config.client_side_validation && time_zone.nil?
+        fail ArgumentError, "Missing the required parameter 'time_zone' when calling AnalyticsApi.analytics_summary"
+      end
+      # verify the required parameter 'to' is set
+      if @api_client.config.client_side_validation && to.nil?
+        fail ArgumentError, "Missing the required parameter 'to' when calling AnalyticsApi.analytics_summary"
+      end
+      pattern = Regexp.new(/^\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[12]\d|3[01])$/)
+      if @api_client.config.client_side_validation && to !~ pattern
+        fail ArgumentError, "invalid value for 'to' when calling AnalyticsApi.analytics_summary, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/analytics/summary'.sub('{workspaceId}', CGI.escape(workspace_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'from'] = from
+      query_params[:'timeZone'] = time_zone
+      query_params[:'to'] = to
+
+      # 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] || 'AnalyticsSummary'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"AnalyticsApi.analytics_summary",
+        :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: AnalyticsApi#analytics_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/peal/api/api_keys_api.rb

@@ -0,0 +1,228 @@
+=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 ApiKeysApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create an API key
+    # Creates an API key for the workspace with some of the caller's permissions, and answers with the key itself, which is not shown again. Needs apiKey:create, and a signed-in member: API keys cannot create keys.
+    # @param workspace_id [String] 
+    # @param new_api_key [NewApiKey] 
+    # @param [Hash] opts the optional parameters
+    # @return [CreatedApiKey]
+    def api_keys_create(workspace_id, new_api_key, opts = {})
+      data, _status_code, _headers = api_keys_create_with_http_info(workspace_id, new_api_key, opts)
+      data
+    end
+
+    # Create an API key
+    # Creates an API key for the workspace with some of the caller's permissions, and answers with the key itself, which is not shown again. Needs apiKey:create, and a signed-in member: API keys cannot create keys.
+    # @param workspace_id [String] 
+    # @param new_api_key [NewApiKey] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreatedApiKey, Integer, Hash)>] CreatedApiKey data, response status code and response headers
+    def api_keys_create_with_http_info(workspace_id, new_api_key, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiKeysApi.api_keys_create ...'
+      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 ApiKeysApi.api_keys_create"
+      end
+      # verify the required parameter 'new_api_key' is set
+      if @api_client.config.client_side_validation && new_api_key.nil?
+        fail ArgumentError, "Missing the required parameter 'new_api_key' when calling ApiKeysApi.api_keys_create"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/api-keys'.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']
+      # 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(new_api_key)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CreatedApiKey'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ApiKeysApi.api_keys_create",
+        :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: ApiKeysApi#api_keys_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List API keys
+    # Lists the workspace's API keys. Needs apiKey:read.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<ApiKey>]
+    def api_keys_list(workspace_id, opts = {})
+      data, _status_code, _headers = api_keys_list_with_http_info(workspace_id, opts)
+      data
+    end
+
+    # List API keys
+    # Lists the workspace&#39;s API keys. Needs apiKey:read.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<ApiKey>, Integer, Hash)>] Array<ApiKey> data, response status code and response headers
+    def api_keys_list_with_http_info(workspace_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiKeysApi.api_keys_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 ApiKeysApi.api_keys_list"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/api-keys'.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<ApiKey>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"ApiKeysApi.api_keys_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: ApiKeysApi#api_keys_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke an API key
+    # Revokes an API key of the workspace: it stops working at once. Needs apiKey:delete.
+    # @param workspace_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def api_keys_revoke(workspace_id, api_key_id, opts = {})
+      api_keys_revoke_with_http_info(workspace_id, api_key_id, opts)
+      nil
+    end
+
+    # Revoke an API key
+    # Revokes an API key of the workspace: it stops working at once. Needs apiKey:delete.
+    # @param workspace_id [String] 
+    # @param api_key_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def api_keys_revoke_with_http_info(workspace_id, api_key_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ApiKeysApi.api_keys_revoke ...'
+      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 ApiKeysApi.api_keys_revoke"
+      end
+      # verify the required parameter 'api_key_id' is set
+      if @api_client.config.client_side_validation && api_key_id.nil?
+        fail ArgumentError, "Missing the required parameter 'api_key_id' when calling ApiKeysApi.api_keys_revoke"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/api-keys/{apiKeyId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{apiKeyId}', CGI.escape(api_key_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 => :"ApiKeysApi.api_keys_revoke",
+        :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: ApiKeysApi#api_keys_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end