Class: DatadogAPIClient::V2::SeatsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/seats_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ SeatsAPI

Returns a new instance of SeatsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#assign_seats_user(body, opts = {}) ⇒ Object

Assign seats to users.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 29

def assign_seats_user(body, opts = {})
  data, _status_code, _headers = assign_seats_user_with_http_info(body, opts)
  data
end

#assign_seats_user_with_http_info(body, opts = {}) ⇒ Array<(AssignSeatsUserResponse, Integer, Hash)>

Assign seats to users.

Assign seats to users for a product code.

Parameters:

Returns:

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

    AssignSeatsUserResponse data, response status code and response headers



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
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 41

def assign_seats_user_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeatsAPI.assign_seats_user ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SeatsAPI.assign_seats_user"
  end
  # resource path
  local_var_path = '/api/v2/seats/users'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :assign_seats_user,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeatsAPI#assign_seats_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_seats_users(product_code, opts = {}) ⇒ Object

Get users with seats.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 96

def get_seats_users(product_code, opts = {})
  data, _status_code, _headers = get_seats_users_with_http_info(product_code, opts)
  data
end

#get_seats_users_with_http_info(product_code, opts = {}) ⇒ Array<(SeatUserDataArray, Integer, Hash)>

Get users with seats.

Get the list of users assigned seats for a product code.

Parameters:

  • product_code (String) —

    The product code for which to retrieve seat users.

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

    the optional parameters

Options Hash (opts):

  • :page_limit (Integer) —

    Maximum number of results to return.

  • :page_cursor (String) —

    Cursor for pagination.

Returns:

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

    SeatUserDataArray data, response status code and response headers



110
111
112
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
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 110

def get_seats_users_with_http_info(product_code, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeatsAPI.get_seats_users ...'
  end
  # verify the required parameter 'product_code' is set
  if @api_client.config.client_side_validation && product_code.nil?
    fail ArgumentError, "Missing the required parameter 'product_code' when calling SeatsAPI.get_seats_users"
  end
  # resource path
  local_var_path = '/api/v2/seats/users'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'product_code'] = product_code
  query_params[:'page[limit]'] = opts[:'page_limit'] if !opts[:'page_limit'].nil?
  query_params[:'page[cursor]'] = opts[:'page_cursor'] if !opts[:'page_cursor'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

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

  # http body (model)
  post_body = opts[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :get_seats_users,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeatsAPI#get_seats_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#unassign_seats_user(body, opts = {}) ⇒ Object

Unassign seats from users.

See Also:



166
167
168
169
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 166

def unassign_seats_user(body, opts = {})
  unassign_seats_user_with_http_info(body, opts)
  nil
end

#unassign_seats_user_with_http_info(body, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Unassign seats from users.

Unassign seats from users for a product code.

Parameters:

Returns:

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

    nil, response status code and response headers



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
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
 
# File 'lib/datadog_api_client/v2/api/seats_api.rb', line 178

def unassign_seats_user_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SeatsAPI.unassign_seats_user ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling SeatsAPI.unassign_seats_user"
  end
  # resource path
  local_var_path = '/api/v2/seats/users'

  # 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(['*/*'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth]

  new_options = opts.merge(
    :operation => :unassign_seats_user,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SeatsAPI#unassign_seats_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end