stackone_client 0.2.44 → 0.2.46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/lib/stack_one/crm.rb +71 -0
  3. data/lib/stack_one/lms.rb +41 -0
  4. data/lib/stack_one/models/operations/crm_get_contact_custom_field_definition_queryparam_filter.rb +24 -0
  5. data/lib/stack_one/models/operations/crm_get_contact_custom_field_definition_request.rb +60 -0
  6. data/lib/stack_one/models/operations/crm_get_contact_custom_field_definition_response.rb +33 -0
  7. data/lib/stack_one/models/operations/crm_list_contact_custom_field_definitions_queryparam_filter.rb +24 -0
  8. data/lib/stack_one/models/operations/crm_list_contact_custom_field_definitions_request.rb +57 -0
  9. data/lib/stack_one/models/operations/crm_list_contact_custom_field_definitions_response.rb +33 -0
  10. data/lib/stack_one/models/operations/lms_delete_content_request.rb +27 -0
  11. data/lib/stack_one/models/operations/lms_delete_content_response.rb +33 -0
  12. data/lib/stack_one/models/operations/lms_list_assignments_queryparam_filter.rb +9 -3
  13. data/lib/stack_one/models/operations/lms_list_assignments_request.rb +1 -1
  14. data/lib/stack_one/models/operations/lms_list_completions_queryparam_filter.rb +6 -3
  15. data/lib/stack_one/models/operations/lms_list_completions_request.rb +1 -1
  16. data/lib/stack_one/models/operations/lms_list_user_assignments_queryparam_filter.rb +9 -3
  17. data/lib/stack_one/models/operations/lms_list_user_assignments_request.rb +1 -1
  18. data/lib/stack_one/models/operations/lms_list_user_completions_queryparam_filter.rb +6 -3
  19. data/lib/stack_one/models/operations/lms_list_user_completions_request.rb +1 -1
  20. data/lib/stack_one/models/operations/stackone_list_linked_accounts_request.rb +5 -2
  21. data/lib/stack_one/models/operations.rb +8 -0
  22. data/lib/stack_one/models/shared/assignment.rb +23 -2
  23. data/lib/stack_one/models/shared/atsdocumentapimodel_value.rb +1 -0
  24. data/lib/stack_one/models/shared/content_launch_method.rb +27 -0
  25. data/lib/stack_one/models/shared/content_value.rb +1 -0
  26. data/lib/stack_one/models/shared/createemploymentapimodel.rb +5 -2
  27. data/lib/stack_one/models/shared/crmcreatecontactrequestdto.rb +5 -2
  28. data/lib/stack_one/models/shared/deleteresult.rb +30 -0
  29. data/lib/stack_one/models/shared/employment.rb +5 -2
  30. data/lib/stack_one/models/shared/hriscreateemploymentrequestdto.rb +5 -2
  31. data/lib/stack_one/models/shared/hriscreateworkeligibilityrequestdto_schemas_document_value.rb +1 -0
  32. data/lib/stack_one/models/shared/hrisdocumentapimodel_schemas_value.rb +1 -0
  33. data/lib/stack_one/models/shared/hrisdocumentsuploadrequestdto_schemas_file_format_value.rb +1 -0
  34. data/lib/stack_one/models/shared/iamuser_schemas_value.rb +1 -0
  35. data/lib/stack_one/models/shared/learningobjecttypeenum.rb +27 -0
  36. data/lib/stack_one/models/shared/learningobjecttypeenum_value.rb +19 -0
  37. data/lib/stack_one/models/shared/lmscreatecontentrequestdto.rb +6 -3
  38. data/lib/stack_one/models/shared/lmscreatecontentrequestdto_content_type.rb +2 -2
  39. data/lib/stack_one/models/shared/lmscreatecontentrequestdto_schemas_value.rb +19 -0
  40. data/lib/stack_one/models/shared/lmscreatecontentrequestdto_value.rb +2 -3
  41. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto.rb +6 -3
  42. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto_content_launch_method.rb +27 -0
  43. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto_content_type.rb +2 -2
  44. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto_schemas_value.rb +19 -0
  45. data/lib/stack_one/models/shared/lmsupsertcontentrequestdto_value.rb +2 -3
  46. data/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto.rb +5 -2
  47. data/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto_type.rb +27 -0
  48. data/lib/stack_one/models/shared/marketingcreatecontentblocksrequestdto_value.rb +20 -0
  49. data/lib/stack_one/models/shared/unifieduploadrequestdto_schemas_value.rb +1 -0
  50. data/lib/stack_one/models/shared/workeligibility_schemas_document_value.rb +1 -0
  51. data/lib/stack_one/models/shared.rb +9 -0
  52. data/lib/stack_one/sdkconfiguration.rb +3 -3
  53. metadata +19 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e01bc8d2f90e58b6208cb041385c3a8f453022d5584c279f31a1483f319287f9
4
- data.tar.gz: 3b9bdc873f00c908471bdf78374d57943b8c9994002a9cd6d479efa92d2988be
3
+ metadata.gz: d612b739d838f94bd66d400f8b5e4d0b283362df9ce2961d4c27f534a877e03a
4
+ data.tar.gz: 2f34edfc9f4743c2b632357c31009dc533ea97d203ddd220fc2a46b3f134dbcd
5
5
  SHA512:
6
- metadata.gz: 4c8330fc8eadf1143d6a4b45fba112fa7d6e71a2d0d250817905568c2d0a3e27d2b92341af2cd1d4d4ca5864b2a1ff0b060829138d5b4bdfaed52a9122367007
7
- data.tar.gz: 1ff24ea228535a8bbd3960fd5c7cb774c826f97ceca4a6a071f61bf3254411ca00fe676810e3fe5dd2e3516ba6e75d2c1940cec35bd1d318be9152550eaacc34
6
+ metadata.gz: c04f3355e7245bf2de3a34f77c60d07ead29463790a577e1ecedc3da32eba64a557ffde37ddb76e82c280d5262bc2eb0a7826c7b8f0a7990714a37a58abbe7a0
7
+ data.tar.gz: 349ded6728e06fb719c0ddb1bf0ced267f6bdfd77aa829725ec8c1431ee47ff90df424819e02c49d880494b824147dd61bc6d4d3c43173411dce10c29adbcba9
data/lib/stack_one/crm.rb CHANGED
@@ -141,6 +141,44 @@ module StackOne
141
141
  end
142
142
 
143
143
 
144
+ sig { params(request: T.nilable(::StackOne::Operations::CrmGetContactCustomFieldDefinitionRequest)).returns(::StackOne::Operations::CrmGetContactCustomFieldDefinitionResponse) }
145
+ def get_contact_custom_field_definition(request)
146
+ # get_contact_custom_field_definition - Get Contact Custom Field Definition
147
+ url, params = @sdk_configuration.get_server_details
148
+ base_url = Utils.template_url(url, params)
149
+ url = Utils.generate_url(
150
+ ::StackOne::Operations::CrmGetContactCustomFieldDefinitionRequest,
151
+ base_url,
152
+ '/unified/crm/custom_field_definitions/contacts/{id}',
153
+ request
154
+ )
155
+ headers = Utils.get_headers(request)
156
+ query_params = Utils.get_query_params(::StackOne::Operations::CrmGetContactCustomFieldDefinitionRequest, request)
157
+ headers['Accept'] = 'application/json'
158
+ headers['user-agent'] = @sdk_configuration.user_agent
159
+
160
+ r = @sdk_configuration.client.get(url) do |req|
161
+ req.headers = headers
162
+ req.params = query_params
163
+ Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
164
+ end
165
+
166
+ content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
167
+
168
+ res = ::StackOne::Operations::CrmGetContactCustomFieldDefinitionResponse.new(
169
+ status_code: r.status, content_type: content_type, raw_response: r
170
+ )
171
+ if r.status == 200
172
+ if Utils.match_content_type(content_type, 'application/json')
173
+ out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::CustomFieldDefinitionResultApiModel)
174
+ res.custom_field_definition_result_api_model = out
175
+ end
176
+ elsif [400, 403, 412, 429, 500, 501].include?(r.status)
177
+ end
178
+ res
179
+ end
180
+
181
+
144
182
  sig { params(request: T.nilable(::StackOne::Operations::CrmGetListRequest)).returns(::StackOne::Operations::CrmGetListResponse) }
145
183
  def get_list(request)
146
184
  # get_list - Get List
@@ -212,6 +250,39 @@ module StackOne
212
250
  end
213
251
 
214
252
 
253
+ sig { params(request: T.nilable(::StackOne::Operations::CrmListContactCustomFieldDefinitionsRequest)).returns(::StackOne::Operations::CrmListContactCustomFieldDefinitionsResponse) }
254
+ def list_contact_custom_field_definitions(request)
255
+ # list_contact_custom_field_definitions - List Contact Custom Field Definitions
256
+ url, params = @sdk_configuration.get_server_details
257
+ base_url = Utils.template_url(url, params)
258
+ url = "#{base_url}/unified/crm/custom_field_definitions/contacts"
259
+ headers = Utils.get_headers(request)
260
+ query_params = Utils.get_query_params(::StackOne::Operations::CrmListContactCustomFieldDefinitionsRequest, request)
261
+ headers['Accept'] = 'application/json'
262
+ headers['user-agent'] = @sdk_configuration.user_agent
263
+
264
+ r = @sdk_configuration.client.get(url) do |req|
265
+ req.headers = headers
266
+ req.params = query_params
267
+ Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
268
+ end
269
+
270
+ content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
271
+
272
+ res = ::StackOne::Operations::CrmListContactCustomFieldDefinitionsResponse.new(
273
+ status_code: r.status, content_type: content_type, raw_response: r
274
+ )
275
+ if r.status == 200
276
+ if Utils.match_content_type(content_type, 'application/json')
277
+ out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::CustomFieldDefinitionsPaginated)
278
+ res.custom_field_definitions_paginated = out
279
+ end
280
+ elsif [400, 403, 412, 429, 500, 501].include?(r.status)
281
+ end
282
+ res
283
+ end
284
+
285
+
215
286
  sig { params(request: T.nilable(::StackOne::Operations::CrmListContactsRequest)).returns(::StackOne::Operations::CrmListContactsResponse) }
216
287
  def list_contacts(request)
217
288
  # list_contacts - List Contacts
data/lib/stack_one/lms.rb CHANGED
@@ -163,6 +163,47 @@ module StackOne
163
163
  end
164
164
 
165
165
 
166
+ sig { params(id: ::String, x_account_id: ::String).returns(::StackOne::Operations::LmsDeleteContentResponse) }
167
+ def delete_content(id, x_account_id)
168
+ # delete_content - Delete Content
169
+ request = ::StackOne::Operations::LmsDeleteContentRequest.new(
170
+
171
+ id: id,
172
+ x_account_id: x_account_id
173
+ )
174
+ url, params = @sdk_configuration.get_server_details
175
+ base_url = Utils.template_url(url, params)
176
+ url = Utils.generate_url(
177
+ ::StackOne::Operations::LmsDeleteContentRequest,
178
+ base_url,
179
+ '/unified/lms/content/{id}',
180
+ request
181
+ )
182
+ headers = Utils.get_headers(request)
183
+ headers['Accept'] = 'application/json'
184
+ headers['user-agent'] = @sdk_configuration.user_agent
185
+
186
+ r = @sdk_configuration.client.delete(url) do |req|
187
+ req.headers = headers
188
+ Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
189
+ end
190
+
191
+ content_type = r.headers.fetch('Content-Type', 'application/octet-stream')
192
+
193
+ res = ::StackOne::Operations::LmsDeleteContentResponse.new(
194
+ status_code: r.status, content_type: content_type, raw_response: r
195
+ )
196
+ if r.status == 200
197
+ if Utils.match_content_type(content_type, 'application/json')
198
+ out = Utils.unmarshal_complex(r.env.response_body, ::StackOne::Shared::DeleteResult)
199
+ res.delete_result = out
200
+ end
201
+ elsif [400, 403, 412, 429, 500, 501].include?(r.status)
202
+ end
203
+ res
204
+ end
205
+
206
+
166
207
  sig { params(request: T.nilable(::StackOne::Operations::LmsGetAssignmentRequest)).returns(::StackOne::Operations::LmsGetAssignmentResponse) }
167
208
  def get_assignment(request)
168
209
  # get_assignment - Get Assignment
@@ -0,0 +1,24 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+ # Filter parameters that allow greater customisation of the list response
11
+ class CrmGetContactCustomFieldDefinitionQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # Use a string with a date to only select results updated after that given date
15
+ field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
+
17
+
18
+ sig { params(updated_after: T.nilable(::String)).void }
19
+ def initialize(updated_after: nil)
20
+ @updated_after = updated_after
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,60 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class CrmGetContactCustomFieldDefinitionRequest < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
16
+ # The account identifier
17
+ field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
18
+ # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
19
+ field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
20
+ # Filter parameters that allow greater customisation of the list response
21
+ field :filter, T.nilable(::StackOne::Operations::CrmGetContactCustomFieldDefinitionQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } }
22
+ # The unified cursor
23
+ field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
24
+ # The page number of the results to fetch
25
+ #
26
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
27
+ field :page, T.nilable(::String), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
28
+ # The number of results per page
29
+ field :page_size, T.nilable(::String), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } }
30
+ # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
31
+ field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } }
32
+ # Indicates that the raw request result is returned
33
+ field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } }
34
+ # The sync token to select the only updated results
35
+ #
36
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
37
+ field :sync_token, T.nilable(::String), { 'query_param': { 'field_name': 'sync_token', 'style': 'form', 'explode': true } }
38
+ # Use a string with a date to only select results updated after that given date
39
+ #
40
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
41
+ field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } }
42
+
43
+
44
+ sig { params(id: ::String, x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::CrmGetContactCustomFieldDefinitionQueryParamFilter), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), sync_token: T.nilable(::String), updated_after: T.nilable(::String)).void }
45
+ def initialize(id: nil, x_account_id: nil, fields_: nil, filter: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, sync_token: nil, updated_after: nil)
46
+ @id = id
47
+ @x_account_id = x_account_id
48
+ @fields_ = fields_
49
+ @filter = filter
50
+ @next_ = next_
51
+ @page = page
52
+ @page_size = page_size
53
+ @proxy = proxy
54
+ @raw = raw
55
+ @sync_token = sync_token
56
+ @updated_after = updated_after
57
+ end
58
+ end
59
+ end
60
+ end
@@ -0,0 +1,33 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class CrmGetContactCustomFieldDefinitionResponse < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # HTTP response content type for this operation
15
+ field :content_type, ::String
16
+ # Raw HTTP response; suitable for custom response parsing
17
+ field :raw_response, ::Faraday::Response
18
+ # HTTP response status code for this operation
19
+ field :status_code, ::Integer
20
+ # The contact custom field definition was retrieved.
21
+ field :custom_field_definition_result_api_model, T.nilable(::StackOne::Shared::CustomFieldDefinitionResultApiModel)
22
+
23
+
24
+ sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, custom_field_definition_result_api_model: T.nilable(::StackOne::Shared::CustomFieldDefinitionResultApiModel)).void }
25
+ def initialize(content_type: nil, raw_response: nil, status_code: nil, custom_field_definition_result_api_model: nil)
26
+ @content_type = content_type
27
+ @raw_response = raw_response
28
+ @status_code = status_code
29
+ @custom_field_definition_result_api_model = custom_field_definition_result_api_model
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,24 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+ # Filter parameters that allow greater customisation of the list response
11
+ class CrmListContactCustomFieldDefinitionsQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # Use a string with a date to only select results updated after that given date
15
+ field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
+
17
+
18
+ sig { params(updated_after: T.nilable(::String)).void }
19
+ def initialize(updated_after: nil)
20
+ @updated_after = updated_after
21
+ end
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,57 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class CrmListContactCustomFieldDefinitionsRequest < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # The account identifier
15
+ field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
16
+ # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
17
+ field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
18
+ # Filter parameters that allow greater customisation of the list response
19
+ field :filter, T.nilable(::StackOne::Operations::CrmListContactCustomFieldDefinitionsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } }
20
+ # The unified cursor
21
+ field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
22
+ # The page number of the results to fetch
23
+ #
24
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
25
+ field :page, T.nilable(::String), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
26
+ # The number of results per page
27
+ field :page_size, T.nilable(::String), { 'query_param': { 'field_name': 'page_size', 'style': 'form', 'explode': true } }
28
+ # Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
29
+ field :proxy, T.nilable(T::Hash[Symbol, ::Object]), { 'query_param': { 'field_name': 'proxy', 'style': 'deepObject', 'explode': true } }
30
+ # Indicates that the raw request result is returned
31
+ field :raw, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'raw', 'style': 'form', 'explode': true } }
32
+ # The sync token to select the only updated results
33
+ #
34
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
35
+ field :sync_token, T.nilable(::String), { 'query_param': { 'field_name': 'sync_token', 'style': 'form', 'explode': true } }
36
+ # Use a string with a date to only select results updated after that given date
37
+ #
38
+ # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
39
+ field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after', 'style': 'form', 'explode': true } }
40
+
41
+
42
+ sig { params(x_account_id: ::String, fields_: T.nilable(::String), filter: T.nilable(::StackOne::Operations::CrmListContactCustomFieldDefinitionsQueryParamFilter), next_: T.nilable(::String), page: T.nilable(::String), page_size: T.nilable(::String), proxy: T.nilable(T::Hash[Symbol, ::Object]), raw: T.nilable(T::Boolean), sync_token: T.nilable(::String), updated_after: T.nilable(::String)).void }
43
+ def initialize(x_account_id: nil, fields_: nil, filter: nil, next_: nil, page: nil, page_size: nil, proxy: nil, raw: nil, sync_token: nil, updated_after: nil)
44
+ @x_account_id = x_account_id
45
+ @fields_ = fields_
46
+ @filter = filter
47
+ @next_ = next_
48
+ @page = page
49
+ @page_size = page_size
50
+ @proxy = proxy
51
+ @raw = raw
52
+ @sync_token = sync_token
53
+ @updated_after = updated_after
54
+ end
55
+ end
56
+ end
57
+ end
@@ -0,0 +1,33 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class CrmListContactCustomFieldDefinitionsResponse < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # HTTP response content type for this operation
15
+ field :content_type, ::String
16
+ # Raw HTTP response; suitable for custom response parsing
17
+ field :raw_response, ::Faraday::Response
18
+ # HTTP response status code for this operation
19
+ field :status_code, ::Integer
20
+ # The list of contacts custom field definitions was retrieved.
21
+ field :custom_field_definitions_paginated, T.nilable(::StackOne::Shared::CustomFieldDefinitionsPaginated)
22
+
23
+
24
+ sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, custom_field_definitions_paginated: T.nilable(::StackOne::Shared::CustomFieldDefinitionsPaginated)).void }
25
+ def initialize(content_type: nil, raw_response: nil, status_code: nil, custom_field_definitions_paginated: nil)
26
+ @content_type = content_type
27
+ @raw_response = raw_response
28
+ @status_code = status_code
29
+ @custom_field_definitions_paginated = custom_field_definitions_paginated
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,27 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class LmsDeleteContentRequest < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
16
+ # The account identifier
17
+ field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
18
+
19
+
20
+ sig { params(id: ::String, x_account_id: ::String).void }
21
+ def initialize(id: nil, x_account_id: nil)
22
+ @id = id
23
+ @x_account_id = x_account_id
24
+ end
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,33 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module StackOne
8
+ module Operations
9
+
10
+
11
+ class LmsDeleteContentResponse < ::StackOne::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # HTTP response content type for this operation
15
+ field :content_type, ::String
16
+ # Raw HTTP response; suitable for custom response parsing
17
+ field :raw_response, ::Faraday::Response
18
+ # HTTP response status code for this operation
19
+ field :status_code, ::Integer
20
+ # The content was deleted successfully.
21
+ field :delete_result, T.nilable(::StackOne::Shared::DeleteResult)
22
+
23
+
24
+ sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, delete_result: T.nilable(::StackOne::Shared::DeleteResult)).void }
25
+ def initialize(content_type: nil, raw_response: nil, status_code: nil, delete_result: nil)
26
+ @content_type = content_type
27
+ @raw_response = raw_response
28
+ @status_code = status_code
29
+ @delete_result = delete_result
30
+ end
31
+ end
32
+ end
33
+ end
@@ -7,16 +7,22 @@
7
7
  module StackOne
8
8
  module Operations
9
9
 
10
- # Filter parameters that allow greater customisation of the list response
10
+ # LMS Assignment Filter
11
11
  class LmsListAssignmentsQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
+ # Filter to select assignment by completed status
15
+ field :completed, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'completed' } }
16
+ # Filter to select assignment by learning object type.
17
+ field :learning_object_type, T.nilable(::String), { 'query_param': { 'field_name': 'learning_object_type' } }
14
18
  # Use a string with a date to only select results updated after that given date
15
19
  field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
20
 
17
21
 
18
- sig { params(updated_after: T.nilable(::String)).void }
19
- def initialize(updated_after: nil)
22
+ sig { params(completed: T.nilable(T::Boolean), learning_object_type: T.nilable(::String), updated_after: T.nilable(::String)).void }
23
+ def initialize(completed: nil, learning_object_type: nil, updated_after: nil)
24
+ @completed = completed
25
+ @learning_object_type = learning_object_type
20
26
  @updated_after = updated_after
21
27
  end
22
28
  end
@@ -15,7 +15,7 @@ module StackOne
15
15
  field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
16
16
  # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
17
17
  field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
18
- # Filter parameters that allow greater customisation of the list response
18
+ # LMS Assignment Filter
19
19
  field :filter, T.nilable(::StackOne::Operations::LmsListAssignmentsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'form', 'explode': true } }
20
20
  # The unified cursor
21
21
  field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
@@ -7,16 +7,19 @@
7
7
  module StackOne
8
8
  module Operations
9
9
 
10
- # Filter parameters that allow greater customisation of the list response
10
+ # LMS Completions Filter
11
11
  class LmsListCompletionsQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
+ # Filter to select completions by learning object type.
15
+ field :learning_object_type, T.nilable(::String), { 'query_param': { 'field_name': 'learning_object_type' } }
14
16
  # Use a string with a date to only select results updated after that given date
15
17
  field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
18
 
17
19
 
18
- sig { params(updated_after: T.nilable(::String)).void }
19
- def initialize(updated_after: nil)
20
+ sig { params(learning_object_type: T.nilable(::String), updated_after: T.nilable(::String)).void }
21
+ def initialize(learning_object_type: nil, updated_after: nil)
22
+ @learning_object_type = learning_object_type
20
23
  @updated_after = updated_after
21
24
  end
22
25
  end
@@ -15,7 +15,7 @@ module StackOne
15
15
  field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
16
16
  # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
17
17
  field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
18
- # Filter parameters that allow greater customisation of the list response
18
+ # LMS Completions Filter
19
19
  field :filter, T.nilable(::StackOne::Operations::LmsListCompletionsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'deepObject', 'explode': true } }
20
20
  # The unified cursor
21
21
  field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
@@ -7,16 +7,22 @@
7
7
  module StackOne
8
8
  module Operations
9
9
 
10
- # Filter parameters that allow greater customisation of the list response
10
+ # LMS Assignment Filter
11
11
  class LmsListUserAssignmentsQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
+ # Filter to select assignment by completed status
15
+ field :completed, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'completed' } }
16
+ # Filter to select assignment by learning object type.
17
+ field :learning_object_type, T.nilable(::String), { 'query_param': { 'field_name': 'learning_object_type' } }
14
18
  # Use a string with a date to only select results updated after that given date
15
19
  field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
20
 
17
21
 
18
- sig { params(updated_after: T.nilable(::String)).void }
19
- def initialize(updated_after: nil)
22
+ sig { params(completed: T.nilable(T::Boolean), learning_object_type: T.nilable(::String), updated_after: T.nilable(::String)).void }
23
+ def initialize(completed: nil, learning_object_type: nil, updated_after: nil)
24
+ @completed = completed
25
+ @learning_object_type = learning_object_type
20
26
  @updated_after = updated_after
21
27
  end
22
28
  end
@@ -17,7 +17,7 @@ module StackOne
17
17
  field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
18
18
  # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
19
19
  field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
20
- # Filter parameters that allow greater customisation of the list response
20
+ # LMS Assignment Filter
21
21
  field :filter, T.nilable(::StackOne::Operations::LmsListUserAssignmentsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'form', 'explode': true } }
22
22
  # The unified cursor
23
23
  field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
@@ -7,16 +7,19 @@
7
7
  module StackOne
8
8
  module Operations
9
9
 
10
- # Filter parameters that allow greater customisation of the list response
10
+ # LMS Completions Filter
11
11
  class LmsListUserCompletionsQueryParamFilter < ::StackOne::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
+ # Filter to select completions by learning object type.
15
+ field :learning_object_type, T.nilable(::String), { 'query_param': { 'field_name': 'learning_object_type' } }
14
16
  # Use a string with a date to only select results updated after that given date
15
17
  field :updated_after, T.nilable(::String), { 'query_param': { 'field_name': 'updated_after' } }
16
18
 
17
19
 
18
- sig { params(updated_after: T.nilable(::String)).void }
19
- def initialize(updated_after: nil)
20
+ sig { params(learning_object_type: T.nilable(::String), updated_after: T.nilable(::String)).void }
21
+ def initialize(learning_object_type: nil, updated_after: nil)
22
+ @learning_object_type = learning_object_type
20
23
  @updated_after = updated_after
21
24
  end
22
25
  end
@@ -17,7 +17,7 @@ module StackOne
17
17
  field :x_account_id, ::String, { 'header': { 'field_name': 'x-account-id', 'style': 'simple', 'explode': false } }
18
18
  # The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
19
19
  field :fields_, T.nilable(::String), { 'query_param': { 'field_name': 'fields', 'style': 'form', 'explode': true } }
20
- # Filter parameters that allow greater customisation of the list response
20
+ # LMS Completions Filter
21
21
  field :filter, T.nilable(::StackOne::Operations::LmsListUserCompletionsQueryParamFilter), { 'query_param': { 'field_name': 'filter', 'style': 'form', 'explode': true } }
22
22
  # The unified cursor
23
23
  field :next_, T.nilable(::String), { 'query_param': { 'field_name': 'next', 'style': 'form', 'explode': true } }
@@ -25,16 +25,19 @@ module StackOne
25
25
  field :provider, T.nilable(::String), { 'query_param': { 'field_name': 'provider', 'style': 'form', 'explode': true } }
26
26
  # The providers list of the results to fetch
27
27
  field :providers, T.nilable(T::Array[::String]), { 'query_param': { 'field_name': 'providers', 'style': 'form', 'explode': true } }
28
+ # The status of the results to fetch
29
+ field :status, T.nilable(T::Array[::String]), { 'query_param': { 'field_name': 'status', 'style': 'form', 'explode': true } }
28
30
 
29
31
 
30
- sig { params(account_ids: T.nilable(T::Array[::String]), origin_owner_id: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), provider: T.nilable(::String), providers: T.nilable(T::Array[::String])).void }
31
- def initialize(account_ids: nil, origin_owner_id: nil, page: nil, page_size: nil, provider: nil, providers: nil)
32
+ sig { params(account_ids: T.nilable(T::Array[::String]), origin_owner_id: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), provider: T.nilable(::String), providers: T.nilable(T::Array[::String]), status: T.nilable(T::Array[::String])).void }
33
+ def initialize(account_ids: nil, origin_owner_id: nil, page: nil, page_size: nil, provider: nil, providers: nil, status: nil)
32
34
  @account_ids = account_ids
33
35
  @origin_owner_id = origin_owner_id
34
36
  @page = page
35
37
  @page_size = page_size
36
38
  @provider = provider
37
39
  @providers = providers
40
+ @status = status
38
41
  end
39
42
  end
40
43
  end
@@ -163,11 +163,17 @@ module StackOne
163
163
  autoload :CrmGetAccountResponse, 'stack_one/models/operations/crm_get_account_response.rb'
164
164
  autoload :CrmGetContactRequest, 'stack_one/models/operations/crm_get_contact_request.rb'
165
165
  autoload :CrmGetContactResponse, 'stack_one/models/operations/crm_get_contact_response.rb'
166
+ autoload :CrmGetContactCustomFieldDefinitionQueryParamFilter, 'stack_one/models/operations/crm_get_contact_custom_field_definition_queryparam_filter.rb'
167
+ autoload :CrmGetContactCustomFieldDefinitionRequest, 'stack_one/models/operations/crm_get_contact_custom_field_definition_request.rb'
168
+ autoload :CrmGetContactCustomFieldDefinitionResponse, 'stack_one/models/operations/crm_get_contact_custom_field_definition_response.rb'
166
169
  autoload :CrmGetListRequest, 'stack_one/models/operations/crm_get_list_request.rb'
167
170
  autoload :CrmGetListResponse, 'stack_one/models/operations/crm_get_list_response.rb'
168
171
  autoload :CrmListAccountsQueryParamFilter, 'stack_one/models/operations/crm_list_accounts_queryparam_filter.rb'
169
172
  autoload :CrmListAccountsRequest, 'stack_one/models/operations/crm_list_accounts_request.rb'
170
173
  autoload :CrmListAccountsResponse, 'stack_one/models/operations/crm_list_accounts_response.rb'
174
+ autoload :CrmListContactCustomFieldDefinitionsQueryParamFilter, 'stack_one/models/operations/crm_list_contact_custom_field_definitions_queryparam_filter.rb'
175
+ autoload :CrmListContactCustomFieldDefinitionsRequest, 'stack_one/models/operations/crm_list_contact_custom_field_definitions_request.rb'
176
+ autoload :CrmListContactCustomFieldDefinitionsResponse, 'stack_one/models/operations/crm_list_contact_custom_field_definitions_response.rb'
171
177
  autoload :CrmListContactsQueryParamFilter, 'stack_one/models/operations/crm_list_contacts_queryparam_filter.rb'
172
178
  autoload :CrmListContactsRequest, 'stack_one/models/operations/crm_list_contacts_request.rb'
173
179
  autoload :CrmListContactsResponse, 'stack_one/models/operations/crm_list_contacts_response.rb'
@@ -301,6 +307,8 @@ module StackOne
301
307
  autoload :LmsCreateContentResponse, 'stack_one/models/operations/lms_create_content_response.rb'
302
308
  autoload :LmsCreateUserCompletionRequest, 'stack_one/models/operations/lms_create_user_completion_request.rb'
303
309
  autoload :LmsCreateUserCompletionResponse, 'stack_one/models/operations/lms_create_user_completion_response.rb'
310
+ autoload :LmsDeleteContentRequest, 'stack_one/models/operations/lms_delete_content_request.rb'
311
+ autoload :LmsDeleteContentResponse, 'stack_one/models/operations/lms_delete_content_response.rb'
304
312
  autoload :LmsGetAssignmentRequest, 'stack_one/models/operations/lms_get_assignment_request.rb'
305
313
  autoload :LmsGetAssignmentResponse, 'stack_one/models/operations/lms_get_assignment_response.rb'
306
314
  autoload :LmsGetCategoryRequest, 'stack_one/models/operations/lms_get_category_request.rb'