Class: ClerkHttpClient::InvitationsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/clerk-http-client/api/invitations_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ InvitationsApi

Returns a new instance of InvitationsApi.



19
20
21
 
# File 'lib/clerk-http-client/api/invitations_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/clerk-http-client/api/invitations_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#all(opts = {}) ⇒ Array<Invitation>

List all invitations Returns all non-revoked invitations for your application, sorted by creation date

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

  • :status (String) —

    Filter invitations based on their status

Returns:



100
101
102
103
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 100

def all(opts = {})
  data, _status_code, _headers = all_with_http_info(opts)
  data
end

#all_with_http_info(opts = {}) ⇒ Array<(Array<Invitation>, Integer, Hash)>

List all invitations Returns all non-revoked invitations for your application, sorted by creation date GET array

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Float) —

    Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. (default to 10)

  • :offset (Float) —

    Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. (default to 0)

  • :status (String) —

    Filter invitations based on their status

Returns:

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

    Array<Invitation> data, response status code and response headers



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 113

def all_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvitationsApi.list_invitations ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvitationsApi.list_invitations, must be smaller than or equal to 500.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InvitationsApi.list_invitations, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
    fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling InvitationsApi.list_invitations, must be greater than or equal to 0.'
  end

  allowable_values = ["pending", "accepted", "revoked", "expired"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/invitations'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?

  # 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] || ['bearerAuth']

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

#create(create_invitation_request, opts = {}) ⇒ Invitation

Create an invitation Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.

Parameters:

  • create_invitation_request (CreateInvitationRequest) —

    Required parameters

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 28

def create(create_invitation_request, opts = {})
  data, _status_code, _headers = create_with_http_info(create_invitation_request, opts)
  data
end

#create_with_http_info(create_invitation_request, opts = {}) ⇒ Array<(Invitation, Integer, Hash)>

Create an invitation Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error. POST

Parameters:

  • create_invitation_request (CreateInvitationRequest) —

    Required parameters

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

    the optional parameters

Returns:

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

    Invitation data, 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
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 39

def create_with_http_info(create_invitation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvitationsApi.create_invitation ...'
  end
  # verify the required parameter 'create_invitation_request' is set
  if @api_client.config.client_side_validation && create_invitation_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_invitation_request' when calling InvitationsApi.create_invitation"
  end
  # resource path
  local_var_path = '/invitations'

  # 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(create_invitation_request)

  # return_type
  return_type = opts[:debug_return_type] || 'Invitation'

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

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

#revoke(invitation_id, opts = {}) ⇒ RevokeInvitation200Response

Revokes an invitation Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn’t prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.

Parameters:

  • invitation_id (String) —

    The ID of the invitation to be revoked

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

    the optional parameters

Returns:



182
183
184
185
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 182

def revoke(invitation_id, opts = {})
  data, _status_code, _headers = revoke_with_http_info(invitation_id, opts)
  data
end

#revoke_with_http_info(invitation_id, opts = {}) ⇒ Array<(RevokeInvitation200Response, Integer, Hash)>

Revokes an invitation Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn&#39;t prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked. POST

Parameters:

  • invitation_id (String) —

    The ID of the invitation to be revoked

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

    the optional parameters

Returns:

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

    RevokeInvitation200Response data, response status code and response headers



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/clerk-http-client/api/invitations_api.rb', line 193

def revoke_with_http_info(invitation_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: InvitationsApi.revoke_invitation ...'
  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.revoke_invitation"
  end
  # resource path
  local_var_path = '/invitations/{invitation_id}/revoke'.sub('{' + 'invitation_id' + '}', 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] || 'RevokeInvitation200Response'

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

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