peal 0.1.0

data/lib/peal/api/invitations_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 InvitationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Invite someone
+    # Invites someone to the workspace with a role: Peal emails them a link that works for 7 days, in their language when they have an account, in the inviter's otherwise. A pending invitation to the same address is revoked, and its link stops working. Only owners invite owners. On a server that bills, the members and the other pending invitations must leave room in the workspace's plan (PlanLimitReached). Needs invitation:create, and a member in person: not an API key, nor staff impersonating one.
+    # @param workspace_id [String] 
+    # @param new_invitation [NewInvitation] 
+    # @param [Hash] opts the optional parameters
+    # @return [Invitation]
+    def invitations_create(workspace_id, new_invitation, opts = {})
+      data, _status_code, _headers = invitations_create_with_http_info(workspace_id, new_invitation, opts)
+      data
+    end
+
+    # Invite someone
+    # Invites someone to the workspace with a role: Peal emails them a link that works for 7 days, in their language when they have an account, in the inviter's otherwise. A pending invitation to the same address is revoked, and its link stops working. Only owners invite owners. On a server that bills, the members and the other pending invitations must leave room in the workspace's plan (PlanLimitReached). Needs invitation:create, and a member in person: not an API key, nor staff impersonating one.
+    # @param workspace_id [String] 
+    # @param new_invitation [NewInvitation] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Invitation, Integer, Hash)>] Invitation data, response status code and response headers
+    def invitations_create_with_http_info(workspace_id, new_invitation, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.invitations_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 InvitationsApi.invitations_create"
+      end
+      # verify the required parameter 'new_invitation' is set
+      if @api_client.config.client_side_validation && new_invitation.nil?
+        fail ArgumentError, "Missing the required parameter 'new_invitation' when calling InvitationsApi.invitations_create"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/invitations'.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_invitation)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Invitation'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"InvitationsApi.invitations_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: InvitationsApi#invitations_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List invitations
+    # Lists the workspace's pending invitations, oldest first, expired ones included. Needs invitation:create, as an invitation's id opens its link, and a member rather than an API key; invitations to the owner role are listed to owners only.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Invitation>]
+    def invitations_list(workspace_id, opts = {})
+      data, _status_code, _headers = invitations_list_with_http_info(workspace_id, opts)
+      data
+    end
+
+    # List invitations
+    # Lists the workspace&#39;s pending invitations, oldest first, expired ones included. Needs invitation:create, as an invitation&#39;s id opens its link, and a member rather than an API key; invitations to the owner role are listed to owners only.
+    # @param workspace_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Invitation>, Integer, Hash)>] Array<Invitation> data, response status code and response headers
+    def invitations_list_with_http_info(workspace_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.invitations_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 InvitationsApi.invitations_list"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/invitations'.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<Invitation>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['bearer']
+
+      new_options = opts.merge(
+        :operation => :"InvitationsApi.invitations_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: InvitationsApi#invitations_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Revoke an invitation
+    # Revokes a pending invitation of the workspace: its link stops working at once. Needs invitation:cancel, and a member in person: not an API key, nor staff impersonating one.
+    # @param workspace_id [String] 
+    # @param invitation_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def invitations_revoke(workspace_id, invitation_id, opts = {})
+      invitations_revoke_with_http_info(workspace_id, invitation_id, opts)
+      nil
+    end
+
+    # Revoke an invitation
+    # Revokes a pending invitation of the workspace: its link stops working at once. Needs invitation:cancel, and a member in person: not an API key, nor staff impersonating one.
+    # @param workspace_id [String] 
+    # @param invitation_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def invitations_revoke_with_http_info(workspace_id, invitation_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: InvitationsApi.invitations_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 InvitationsApi.invitations_revoke"
+      end
+      # verify the required parameter 'invitation_id' is set
+      if @api_client.config.client_side_validation && invitation_id.nil?
+        fail ArgumentError, "Missing the required parameter 'invitation_id' when calling InvitationsApi.invitations_revoke"
+      end
+      # resource path
+      local_var_path = '/api/workspaces/{workspaceId}/invitations/{invitationId}'.sub('{workspaceId}', CGI.escape(workspace_id.to_s)).sub('{invitationId}', CGI.escape(invitation_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 => :"InvitationsApi.invitations_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: InvitationsApi#invitations_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end