Class: TrieveRubyClient::InvitationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/trieve_ruby_client/api/invitation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvitationApi

Returns a new instance of InvitationApi.



19
20
21
 
# File 'lib/trieve_ruby_client/api/invitation_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/trieve_ruby_client/api/invitation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#post_invitation(tr_organization, invitation_data, opts = {}) ⇒ nil

Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth’ed user or api key must have an admin or owner role for the specified dataset’s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • invitation_data (InvitationData) —

    JSON request payload to send an invitation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


28
29
30
31
 
# File 'lib/trieve_ruby_client/api/invitation_api.rb', line 28

def post_invitation(tr_organization, invitation_data, opts = {})
  post_invitation_with_http_info(tr_organization, invitation_data, opts)
  nil
end

#post_invitation_with_http_info(tr_organization, invitation_data, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Send Invitation Invitations act as a way to invite users to join an organization. After a user is invited, they will automatically be added to the organization with the role specified in the invitation once they set their. Auth&#39;ed user or api key must have an admin or owner role for the specified dataset&#39;s organization.

Parameters:

  • tr_organization (String) —

    The organization id to use for the request

  • invitation_data (InvitationData) —

    JSON request payload to send an invitation

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Integer, Hash)>) —

    nil, response status code and response headers



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/trieve_ruby_client/api/invitation_api.rb', line 39

def post_invitation_with_http_info(tr_organization, invitation_data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvitationApi.post_invitation ...'
  end
  # verify the required parameter 'tr_organization' is set
  if @api_client.config.client_side_validation && tr_organization.nil?
    fail ArgumentError, "Missing the required parameter 'tr_organization' when calling InvitationApi.post_invitation"
  end
  # verify the required parameter 'invitation_data' is set
  if @api_client.config.client_side_validation && invitation_data.nil?
    fail ArgumentError, "Missing the required parameter 'invitation_data' when calling InvitationApi.post_invitation"
  end
  # resource path
  local_var_path = '/api/invitation'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'TR-Organization'] = tr_organization

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(invitation_data)

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ApiKey']

  new_options = opts.merge(
    :operation => :"InvitationApi.post_invitation",
    :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: InvitationApi#post_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end