smplkit 2.0.13 → 2.0.14

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 (125) hide show
  1. checksums.yaml +4 -4
  2. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/account_api.rb +11 -11
  3. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/api_keys_api.rb +18 -18
  4. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/billing_api.rb +21 -21
  5. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/context_types_api.rb +18 -18
  6. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/contexts_api.rb +11 -11
  7. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/environments_api.rb +18 -18
  8. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/metrics_api.rb +2 -2
  9. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/services_api.rb +18 -18
  10. data/lib/smplkit/_generated/app/lib/smplkit_app_client/api/users_api.rb +18 -18
  11. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/account.rb +14 -31
  12. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/account_request.rb +165 -0
  13. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/account_resource.rb +1 -0
  14. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/account_response.rb +1 -0
  15. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/account_wipe_request.rb +3 -3
  16. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/add_payment_method_attributes.rb +3 -1
  17. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/add_payment_method_body.rb +1 -0
  18. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/add_payment_method_data.rb +1 -0
  19. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key.rb +15 -16
  20. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key_list_response.rb +1 -0
  21. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key_request.rb +165 -0
  22. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key_resource.rb +1 -0
  23. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/api_key_response.rb +1 -0
  24. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/auth_token_response.rb +3 -0
  25. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context.rb +6 -3
  26. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_batch_response.rb +2 -0
  27. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_bulk_item.rb +4 -2
  28. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_bulk_register.rb +2 -0
  29. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_list_response.rb +1 -0
  30. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_request.rb +165 -0
  31. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_resource.rb +1 -0
  32. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_response.rb +1 -0
  33. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type.rb +5 -2
  34. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type_list_response.rb +1 -0
  35. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type_request.rb +165 -0
  36. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type_resource.rb +1 -0
  37. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/context_type_response.rb +1 -0
  38. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/create_subscription_attributes.rb +4 -0
  39. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/create_subscription_body.rb +1 -0
  40. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/create_subscription_data.rb +2 -0
  41. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email.rb +3 -1
  42. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email_resource.rb +1 -0
  43. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email_response.rb +1 -0
  44. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb +6 -0
  45. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_list_response.rb +1 -0
  46. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_request.rb +165 -0
  47. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_resource.rb +1 -0
  48. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_response.rb +1 -0
  49. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb +11 -0
  50. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_accept_request.rb +2 -0
  51. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_bulk_create_request.rb +2 -0
  52. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_create_item.rb +3 -0
  53. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_list_response.rb +1 -0
  54. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_resource.rb +1 -0
  55. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_response.rb +1 -0
  56. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice.rb +13 -0
  57. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_list_response.rb +1 -0
  58. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_resource.rb +1 -0
  59. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_single_response.rb +1 -0
  60. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/limit_definition.rb +5 -0
  61. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/login_request.rb +3 -0
  62. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_attributes.rb +7 -0
  63. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_bulk_request.rb +2 -0
  64. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_list_response.rb +1 -0
  65. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_name_item.rb +3 -0
  66. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_names_response.rb +1 -0
  67. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_resource.rb +1 -0
  68. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_attributes.rb +6 -0
  69. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_list_response.rb +1 -0
  70. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_resource.rb +1 -0
  71. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/next_tier_meta.rb +4 -0
  72. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/page_meta.rb +5 -4
  73. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method.rb +9 -1
  74. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_list_response.rb +1 -0
  75. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_request.rb +165 -0
  76. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_resource.rb +1 -0
  77. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/payment_method_response.rb +1 -0
  78. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan.rb +4 -0
  79. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_change_request.rb +2 -0
  80. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_definition.rb +3 -0
  81. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_list_response.rb +1 -0
  82. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/plan_resource.rb +1 -0
  83. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/product.rb +8 -0
  84. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/product_list_response.rb +1 -0
  85. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/product_resource.rb +1 -0
  86. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/register_request.rb +4 -1
  87. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service.rb +4 -0
  88. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_list_response.rb +1 -0
  89. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_request.rb +165 -0
  90. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_resource.rb +1 -0
  91. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/service_response.rb +1 -0
  92. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/setup_intent_attributes.rb +2 -0
  93. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/setup_intent_response.rb +1 -0
  94. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_attributes.rb +8 -0
  95. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_list_meta.rb +6 -1
  96. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_list_response.rb +1 -0
  97. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_resource.rb +1 -0
  98. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/subscription_response.rb +1 -0
  99. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user.rb +11 -21
  100. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user_list_response.rb +1 -0
  101. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user_request.rb +165 -0
  102. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user_resource.rb +1 -0
  103. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/user_response.rb +1 -0
  104. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/value.rb +1 -0
  105. data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/verify_email_request.rb +2 -0
  106. data/lib/smplkit/_generated/app/lib/smplkit_app_client.rb +8 -0
  107. data/lib/smplkit/_generated/app/spec/api/account_api_spec.rb +2 -2
  108. data/lib/smplkit/_generated/app/spec/api/api_keys_api_spec.rb +2 -2
  109. data/lib/smplkit/_generated/app/spec/api/billing_api_spec.rb +7 -7
  110. data/lib/smplkit/_generated/app/spec/api/context_types_api_spec.rb +2 -2
  111. data/lib/smplkit/_generated/app/spec/api/contexts_api_spec.rb +2 -2
  112. data/lib/smplkit/_generated/app/spec/api/environments_api_spec.rb +2 -2
  113. data/lib/smplkit/_generated/app/spec/api/metrics_api_spec.rb +1 -1
  114. data/lib/smplkit/_generated/app/spec/api/services_api_spec.rb +2 -2
  115. data/lib/smplkit/_generated/app/spec/api/users_api_spec.rb +2 -2
  116. data/lib/smplkit/_generated/app/spec/models/account_request_spec.rb +36 -0
  117. data/lib/smplkit/_generated/app/spec/models/api_key_request_spec.rb +36 -0
  118. data/lib/smplkit/_generated/app/spec/models/api_key_spec.rb +0 -6
  119. data/lib/smplkit/_generated/app/spec/models/context_request_spec.rb +36 -0
  120. data/lib/smplkit/_generated/app/spec/models/context_type_request_spec.rb +36 -0
  121. data/lib/smplkit/_generated/app/spec/models/environment_request_spec.rb +36 -0
  122. data/lib/smplkit/_generated/app/spec/models/payment_method_request_spec.rb +36 -0
  123. data/lib/smplkit/_generated/app/spec/models/service_request_spec.rb +36 -0
  124. data/lib/smplkit/_generated/app/spec/models/user_request_spec.rb +36 -0
  125. metadata +17 -1
@@ -21,26 +21,26 @@ module SmplkitGeneratedClient::App
21
21
  end
22
22
  # Create Service
23
23
  # Create a new service. The caller provides the id (key) in the request body.
24
- # @param service_response [ServiceResponse]
24
+ # @param service_request [ServiceRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [ServiceResponse]
27
- def create_service(service_response, opts = {})
28
- data, _status_code, _headers = create_service_with_http_info(service_response, opts)
27
+ def create_service(service_request, opts = {})
28
+ data, _status_code, _headers = create_service_with_http_info(service_request, opts)
29
29
  data
30
30
  end
31
31
 
32
32
  # Create Service
33
33
  # Create a new service. The caller provides the id (key) in the request body.
34
- # @param service_response [ServiceResponse]
34
+ # @param service_request [ServiceRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(ServiceResponse, Integer, Hash)>] ServiceResponse data, response status code and response headers
37
- def create_service_with_http_info(service_response, opts = {})
37
+ def create_service_with_http_info(service_request, opts = {})
38
38
  if @api_client.config.debugging
39
39
  @api_client.config.logger.debug 'Calling API: ServicesApi.create_service ...'
40
40
  end
41
- # verify the required parameter 'service_response' is set
42
- if @api_client.config.client_side_validation && service_response.nil?
43
- fail ArgumentError, "Missing the required parameter 'service_response' when calling ServicesApi.create_service"
41
+ # verify the required parameter 'service_request' is set
42
+ if @api_client.config.client_side_validation && service_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'service_request' when calling ServicesApi.create_service"
44
44
  end
45
45
  # resource path
46
46
  local_var_path = '/api/v1/services'
@@ -62,7 +62,7 @@ module SmplkitGeneratedClient::App
62
62
  form_params = opts[:form_params] || {}
63
63
 
64
64
  # http body (model)
65
- post_body = opts[:debug_body] || @api_client.object_to_http_body(service_response)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(service_request)
66
66
 
67
67
  # return_type
68
68
  return_type = opts[:debug_return_type] || 'ServiceResponse'
@@ -273,21 +273,21 @@ module SmplkitGeneratedClient::App
273
273
  # Update Service
274
274
  # Update a service by id.
275
275
  # @param id [String]
276
- # @param service_response [ServiceResponse]
276
+ # @param service_request [ServiceRequest]
277
277
  # @param [Hash] opts the optional parameters
278
278
  # @return [ServiceResponse]
279
- def update_service(id, service_response, opts = {})
280
- data, _status_code, _headers = update_service_with_http_info(id, service_response, opts)
279
+ def update_service(id, service_request, opts = {})
280
+ data, _status_code, _headers = update_service_with_http_info(id, service_request, opts)
281
281
  data
282
282
  end
283
283
 
284
284
  # Update Service
285
285
  # Update a service by id.
286
286
  # @param id [String]
287
- # @param service_response [ServiceResponse]
287
+ # @param service_request [ServiceRequest]
288
288
  # @param [Hash] opts the optional parameters
289
289
  # @return [Array<(ServiceResponse, Integer, Hash)>] ServiceResponse data, response status code and response headers
290
- def update_service_with_http_info(id, service_response, opts = {})
290
+ def update_service_with_http_info(id, service_request, opts = {})
291
291
  if @api_client.config.debugging
292
292
  @api_client.config.logger.debug 'Calling API: ServicesApi.update_service ...'
293
293
  end
@@ -295,9 +295,9 @@ module SmplkitGeneratedClient::App
295
295
  if @api_client.config.client_side_validation && id.nil?
296
296
  fail ArgumentError, "Missing the required parameter 'id' when calling ServicesApi.update_service"
297
297
  end
298
- # verify the required parameter 'service_response' is set
299
- if @api_client.config.client_side_validation && service_response.nil?
300
- fail ArgumentError, "Missing the required parameter 'service_response' when calling ServicesApi.update_service"
298
+ # verify the required parameter 'service_request' is set
299
+ if @api_client.config.client_side_validation && service_request.nil?
300
+ fail ArgumentError, "Missing the required parameter 'service_request' when calling ServicesApi.update_service"
301
301
  end
302
302
  # resource path
303
303
  local_var_path = '/api/v1/services/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -319,7 +319,7 @@ module SmplkitGeneratedClient::App
319
319
  form_params = opts[:form_params] || {}
320
320
 
321
321
  # http body (model)
322
- post_body = opts[:debug_body] || @api_client.object_to_http_body(service_response)
322
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(service_request)
323
323
 
324
324
  # return_type
325
325
  return_type = opts[:debug_return_type] || 'ServiceResponse'
@@ -465,26 +465,26 @@ module SmplkitGeneratedClient::App
465
465
 
466
466
  # Update Current User
467
467
  # Update the currently authenticated user's profile.
468
- # @param user_response [UserResponse]
468
+ # @param user_request [UserRequest]
469
469
  # @param [Hash] opts the optional parameters
470
470
  # @return [UserResponse]
471
- def update_current_user(user_response, opts = {})
472
- data, _status_code, _headers = update_current_user_with_http_info(user_response, opts)
471
+ def update_current_user(user_request, opts = {})
472
+ data, _status_code, _headers = update_current_user_with_http_info(user_request, opts)
473
473
  data
474
474
  end
475
475
 
476
476
  # Update Current User
477
477
  # Update the currently authenticated user&#39;s profile.
478
- # @param user_response [UserResponse]
478
+ # @param user_request [UserRequest]
479
479
  # @param [Hash] opts the optional parameters
480
480
  # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
481
- def update_current_user_with_http_info(user_response, opts = {})
481
+ def update_current_user_with_http_info(user_request, opts = {})
482
482
  if @api_client.config.debugging
483
483
  @api_client.config.logger.debug 'Calling API: UsersApi.update_current_user ...'
484
484
  end
485
- # verify the required parameter 'user_response' is set
486
- if @api_client.config.client_side_validation && user_response.nil?
487
- fail ArgumentError, "Missing the required parameter 'user_response' when calling UsersApi.update_current_user"
485
+ # verify the required parameter 'user_request' is set
486
+ if @api_client.config.client_side_validation && user_request.nil?
487
+ fail ArgumentError, "Missing the required parameter 'user_request' when calling UsersApi.update_current_user"
488
488
  end
489
489
  # resource path
490
490
  local_var_path = '/api/v1/users/current'
@@ -506,7 +506,7 @@ module SmplkitGeneratedClient::App
506
506
  form_params = opts[:form_params] || {}
507
507
 
508
508
  # http body (model)
509
- post_body = opts[:debug_body] || @api_client.object_to_http_body(user_response)
509
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_request)
510
510
 
511
511
  # return_type
512
512
  return_type = opts[:debug_return_type] || 'UserResponse'
@@ -534,21 +534,21 @@ module SmplkitGeneratedClient::App
534
534
  # Update User Role
535
535
  # Update a user's role in the account.
536
536
  # @param id [String]
537
- # @param user_response [UserResponse]
537
+ # @param user_request [UserRequest]
538
538
  # @param [Hash] opts the optional parameters
539
539
  # @return [UserResponse]
540
- def update_user_role(id, user_response, opts = {})
541
- data, _status_code, _headers = update_user_role_with_http_info(id, user_response, opts)
540
+ def update_user_role(id, user_request, opts = {})
541
+ data, _status_code, _headers = update_user_role_with_http_info(id, user_request, opts)
542
542
  data
543
543
  end
544
544
 
545
545
  # Update User Role
546
546
  # Update a user&#39;s role in the account.
547
547
  # @param id [String]
548
- # @param user_response [UserResponse]
548
+ # @param user_request [UserRequest]
549
549
  # @param [Hash] opts the optional parameters
550
550
  # @return [Array<(UserResponse, Integer, Hash)>] UserResponse data, response status code and response headers
551
- def update_user_role_with_http_info(id, user_response, opts = {})
551
+ def update_user_role_with_http_info(id, user_request, opts = {})
552
552
  if @api_client.config.debugging
553
553
  @api_client.config.logger.debug 'Calling API: UsersApi.update_user_role ...'
554
554
  end
@@ -556,9 +556,9 @@ module SmplkitGeneratedClient::App
556
556
  if @api_client.config.client_side_validation && id.nil?
557
557
  fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.update_user_role"
558
558
  end
559
- # verify the required parameter 'user_response' is set
560
- if @api_client.config.client_side_validation && user_response.nil?
561
- fail ArgumentError, "Missing the required parameter 'user_response' when calling UsersApi.update_user_role"
559
+ # verify the required parameter 'user_request' is set
560
+ if @api_client.config.client_side_validation && user_request.nil?
561
+ fail ArgumentError, "Missing the required parameter 'user_request' when calling UsersApi.update_user_role"
562
562
  end
563
563
  # resource path
564
564
  local_var_path = '/api/v1/users/{id}'.sub('{id}', CGI.escape(id.to_s))
@@ -580,7 +580,7 @@ module SmplkitGeneratedClient::App
580
580
  form_params = opts[:form_params] || {}
581
581
 
582
582
  # http body (model)
583
- post_body = opts[:debug_body] || @api_client.object_to_http_body(user_response)
583
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_request)
584
584
 
585
585
  # return_type
586
586
  return_type = opts[:debug_return_type] || 'UserResponse'
@@ -14,37 +14,45 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # A tenant of smplkit — the unit of isolation that owns all of a customer's resources (environments, contexts, API keys, and so on).
17
18
  class Account < ApiModelBase
19
+ # Human-readable name for the account.
18
20
  attr_accessor :name
19
21
 
22
+ # Stable URL-safe identifier for the account, derived from the account name at creation. Used in console URLs and other places that prefer a human-readable handle.
20
23
  attr_accessor :key
21
24
 
25
+ # `true` once the account has been linked to a billing provider customer record.
22
26
  attr_accessor :has_stripe_customer
23
27
 
28
+ # When the account is scheduled to expire. `null` for accounts with no expiry.
24
29
  attr_accessor :expires_at
25
30
 
31
+ # When the account was created.
26
32
  attr_accessor :created_at
27
33
 
34
+ # When the account was deleted. `null` for active accounts.
28
35
  attr_accessor :deleted_at
29
36
 
37
+ # Map of product key to the account's subscription summary for that product, including plan, status, and entitlement limits.
30
38
  attr_accessor :product_subscriptions
31
39
 
32
- # Registration entry point (from account.data)
40
+ # How the account first reached smplkit (e.g. `LOGIN`, `GET_STARTED`, `LIVE_DEMO`).
33
41
  attr_accessor :entry_point
34
42
 
35
- # Whether sample data is active (from account.settings)
43
+ # Whether the account is currently configured to display the sample dataset alongside the customer's own resources.
36
44
  attr_accessor :show_sample_data
37
45
 
38
- # Custom discount percentage that overrides the volume schedule. Null means the volume schedule applies.
46
+ # Custom discount percentage applied to the account in place of the volume-based discount schedule. `null` means the volume schedule applies.
39
47
  attr_accessor :discount_override_pct
40
48
 
41
49
  # Free-form note explaining why the override was set.
42
50
  attr_accessor :discount_override_reason
43
51
 
44
- # UUID of the admin user who set the override.
52
+ # UUID of the user who set the override.
45
53
  attr_accessor :discount_override_set_by_user_id
46
54
 
47
- # Timestamp when the override was last changed.
55
+ # When the override was last changed.
48
56
  attr_accessor :discount_override_set_at
49
57
 
50
58
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -98,6 +106,7 @@ module SmplkitGeneratedClient::App
98
106
  # List of attributes with nullable: true
99
107
  def self.openapi_nullable
100
108
  Set.new([
109
+ :'key',
101
110
  :'expires_at',
102
111
  :'created_at',
103
112
  :'deleted_at',
@@ -135,8 +144,6 @@ module SmplkitGeneratedClient::App
135
144
 
136
145
  if attributes.key?(:'key')
137
146
  self.key = attributes[:'key']
138
- else
139
- self.key = nil
140
147
  end
141
148
 
142
149
  if attributes.key?(:'has_stripe_customer')
@@ -201,14 +208,6 @@ module SmplkitGeneratedClient::App
201
208
  invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
202
209
  end
203
210
 
204
- if @key.nil?
205
- invalid_properties.push('invalid value for "key", key cannot be nil.')
206
- end
207
-
208
- if @key.to_s.length > 255
209
- invalid_properties.push('invalid value for "key", the character length must be smaller than or equal to 255.')
210
- end
211
-
212
211
  invalid_properties
213
212
  end
214
213
 
@@ -218,8 +217,6 @@ module SmplkitGeneratedClient::App
218
217
  warn '[DEPRECATED] the `valid?` method is obsolete'
219
218
  return false if @name.nil?
220
219
  return false if @name.to_s.length > 255
221
- return false if @key.nil?
222
- return false if @key.to_s.length > 255
223
220
  true
224
221
  end
225
222
 
@@ -237,20 +234,6 @@ module SmplkitGeneratedClient::App
237
234
  @name = name
238
235
  end
239
236
 
240
- # Custom attribute writer method with validation
241
- # @param [Object] key Value to be assigned
242
- def key=(key)
243
- if key.nil?
244
- fail ArgumentError, 'key cannot be nil'
245
- end
246
-
247
- if key.to_s.length > 255
248
- fail ArgumentError, 'invalid value for "key", the character length must be smaller than or equal to 255.'
249
- end
250
-
251
- @key = key
252
- end
253
-
254
237
  # Checks equality by comparing each attribute.
255
238
  # @param [Object] Object to be compared
256
239
  def ==(o)
@@ -0,0 +1,165 @@
1
+ =begin
2
+ #smplkit API
3
+
4
+ #API for the smplkit platform.
5
+
6
+ The version of the OpenAPI document: 0.1.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.22.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module SmplkitGeneratedClient::App
17
+ # JSON:API request envelope for creating or updating an account.
18
+ class AccountRequest < ApiModelBase
19
+ attr_accessor :data
20
+
21
+ # Attribute mapping from ruby-style variable name to JSON key.
22
+ def self.attribute_map
23
+ {
24
+ :'data' => :'data'
25
+ }
26
+ end
27
+
28
+ # Returns attribute mapping this model knows about
29
+ def self.acceptable_attribute_map
30
+ attribute_map
31
+ end
32
+
33
+ # Returns all the JSON keys this model knows about
34
+ def self.acceptable_attributes
35
+ acceptable_attribute_map.values
36
+ end
37
+
38
+ # Attribute type mapping.
39
+ def self.openapi_types
40
+ {
41
+ :'data' => :'AccountResource'
42
+ }
43
+ end
44
+
45
+ # List of attributes with nullable: true
46
+ def self.openapi_nullable
47
+ Set.new([
48
+ ])
49
+ end
50
+
51
+ # Initializes the object
52
+ # @param [Hash] attributes Model attributes in the form of hash
53
+ def initialize(attributes = {})
54
+ if (!attributes.is_a?(Hash))
55
+ fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::App::AccountRequest` initialize method"
56
+ end
57
+
58
+ # check to see if the attribute exists and convert string to symbol for hash key
59
+ acceptable_attribute_map = self.class.acceptable_attribute_map
60
+ attributes = attributes.each_with_object({}) { |(k, v), h|
61
+ if (!acceptable_attribute_map.key?(k.to_sym))
62
+ fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::App::AccountRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
63
+ end
64
+ h[k.to_sym] = v
65
+ }
66
+
67
+ if attributes.key?(:'data')
68
+ self.data = attributes[:'data']
69
+ else
70
+ self.data = nil
71
+ end
72
+ end
73
+
74
+ # Show invalid properties with the reasons. Usually used together with valid?
75
+ # @return Array for valid properties with the reasons
76
+ def list_invalid_properties
77
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
78
+ invalid_properties = Array.new
79
+ if @data.nil?
80
+ invalid_properties.push('invalid value for "data", data cannot be nil.')
81
+ end
82
+
83
+ invalid_properties
84
+ end
85
+
86
+ # Check to see if the all the properties in the model are valid
87
+ # @return true if the model is valid
88
+ def valid?
89
+ warn '[DEPRECATED] the `valid?` method is obsolete'
90
+ return false if @data.nil?
91
+ true
92
+ end
93
+
94
+ # Custom attribute writer method with validation
95
+ # @param [Object] data Value to be assigned
96
+ def data=(data)
97
+ if data.nil?
98
+ fail ArgumentError, 'data cannot be nil'
99
+ end
100
+
101
+ @data = data
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ data == o.data
110
+ end
111
+
112
+ # @see the `==` method
113
+ # @param [Object] Object to be compared
114
+ def eql?(o)
115
+ self == o
116
+ end
117
+
118
+ # Calculates hash code according to all attributes.
119
+ # @return [Integer] Hash code
120
+ def hash
121
+ [data].hash
122
+ end
123
+
124
+ # Builds the object from hash
125
+ # @param [Hash] attributes Model attributes in the form of hash
126
+ # @return [Object] Returns the model itself
127
+ def self.build_from_hash(attributes)
128
+ return nil unless attributes.is_a?(Hash)
129
+ attributes = attributes.transform_keys(&:to_sym)
130
+ transformed_hash = {}
131
+ openapi_types.each_pair do |key, type|
132
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = nil
134
+ elsif type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[attribute_map[key]].is_a?(Array)
138
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
139
+ end
140
+ elsif !attributes[attribute_map[key]].nil?
141
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
142
+ end
143
+ end
144
+ new(transformed_hash)
145
+ end
146
+
147
+ # Returns the object in the form of hash
148
+ # @return [Hash] Returns the object in the form of hash
149
+ def to_hash
150
+ hash = {}
151
+ self.class.attribute_map.each_pair do |attr, param|
152
+ value = self.send(attr)
153
+ if value.nil?
154
+ is_nullable = self.class.openapi_nullable.include?(attr)
155
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
156
+ end
157
+
158
+ hash[param] = _to_hash(value)
159
+ end
160
+ hash
161
+ end
162
+
163
+ end
164
+
165
+ end
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # JSON:API resource envelope for an account. `id` must not be specified for create requests (the server assigns it).
17
18
  class AccountResource < ApiModelBase
18
19
  attr_accessor :id
19
20
 
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # JSON:API single-resource response envelope for an account.
17
18
  class AccountResponse < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -14,12 +14,12 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
- # Confirmation envelope for ``POST /accounts/current/actions/wipe``.
17
+ # Confirmation envelope for the wipe-account action.
18
18
  class AccountWipeRequest < ApiModelBase
19
- # Must be ``true`` to proceed. Anything else returns 400. The frontend gates the call behind a confirmation dialog; this field is the server-side seatbelt.
19
+ # Must be `true` for the wipe to proceed. Any other value returns 400.
20
20
  attr_accessor :confirm
21
21
 
22
- # When ``true``, the wipe re-seeds the account with the same Acme Commerce sample dataset that new accounts are bootstrapped with. Best-effort: any seeding failures are logged but do not fail the wipe.
22
+ # When `true`, re-seed the account with the standard sample dataset after wiping. Best-effort: any seeding failure is logged but does not fail the wipe.
23
23
  attr_accessor :generate_sample_data
24
24
 
25
25
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,10 +14,12 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
- # Attributes for POST /api/v1/payment_methods. Distinct from ``PaymentMethod`` because this shape takes the Stripe ``pm_...`` ID at registration time; the persistent resource does not expose that ID.
17
+ # Attributes accepted when registering a new payment method. The customer first creates a Stripe payment method client-side using Stripe Elements, then submits its `pm_...` identifier here to persist it on the account.
18
18
  class AddPaymentMethodAttributes < ApiModelBase
19
+ # Identifier of the Stripe payment method to register on the account, e.g. `pm_1234567890abcdef`.
19
20
  attr_accessor :stripe_payment_method_id
20
21
 
22
+ # When `true`, make the newly registered payment method the account's default. The first payment method on an account is always set as default regardless of this field.
21
23
  attr_accessor :default
22
24
 
23
25
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # JSON:API request envelope for registering a new payment method.
17
18
  class AddPaymentMethodBody < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # Resource object for the add-payment-method request.
17
18
  class AddPaymentMethodData < ApiModelBase
18
19
  attr_accessor :type
19
20
 
@@ -14,27 +14,35 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # An API key used by SDKs, scripts, and other programmatic clients to authenticate with the smplkit API on behalf of the account. The full key value is returned in plaintext on the create response and is otherwise unavailable — record it somewhere safe immediately after creation.
17
18
  class ApiKey < ApiModelBase
19
+ # Human-readable name for the key.
18
20
  attr_accessor :name
19
21
 
22
+ # Lifecycle state of the key. `ACTIVE` keys may be used to authenticate; `REVOKED` keys are rejected.
20
23
  attr_accessor :status
21
24
 
25
+ # The bearer token value. Returned in plaintext on the create response so the caller can capture it; subsequent reads return the same value for round-tripping.
22
26
  attr_accessor :key
23
27
 
28
+ # Scope restrictions applied to the key. Empty object grants full account access; populated forms are reserved for future scope syntax.
24
29
  attr_accessor :scopes
25
30
 
31
+ # UUID of the user who created the key.
26
32
  attr_accessor :created_by
27
33
 
34
+ # Optional expiry timestamp. After this time, the key is rejected. Omit for keys that do not expire.
28
35
  attr_accessor :expires_at
29
36
 
37
+ # When the key was most recently used to authenticate.
30
38
  attr_accessor :last_used_at
31
39
 
40
+ # When the key was created.
32
41
  attr_accessor :created_at
33
42
 
43
+ # When the key was last modified.
34
44
  attr_accessor :updated_at
35
45
 
36
- attr_accessor :data
37
-
38
46
  # Attribute mapping from ruby-style variable name to JSON key.
39
47
  def self.attribute_map
40
48
  {
@@ -46,8 +54,7 @@ module SmplkitGeneratedClient::App
46
54
  :'expires_at' => :'expires_at',
47
55
  :'last_used_at' => :'last_used_at',
48
56
  :'created_at' => :'created_at',
49
- :'updated_at' => :'updated_at',
50
- :'data' => :'data'
57
+ :'updated_at' => :'updated_at'
51
58
  }
52
59
  end
53
60
 
@@ -72,8 +79,7 @@ module SmplkitGeneratedClient::App
72
79
  :'expires_at' => :'Time',
73
80
  :'last_used_at' => :'Time',
74
81
  :'created_at' => :'Time',
75
- :'updated_at' => :'Time',
76
- :'data' => :'Hash<String, Object>'
82
+ :'updated_at' => :'Time'
77
83
  }
78
84
  end
79
85
 
@@ -86,7 +92,7 @@ module SmplkitGeneratedClient::App
86
92
  :'expires_at',
87
93
  :'last_used_at',
88
94
  :'created_at',
89
- :'updated_at',
95
+ :'updated_at'
90
96
  ])
91
97
  end
92
98
 
@@ -145,12 +151,6 @@ module SmplkitGeneratedClient::App
145
151
  if attributes.key?(:'updated_at')
146
152
  self.updated_at = attributes[:'updated_at']
147
153
  end
148
-
149
- if attributes.key?(:'data')
150
- if (value = attributes[:'data']).is_a?(Hash)
151
- self.data = value
152
- end
153
- end
154
154
  end
155
155
 
156
156
  # Show invalid properties with the reasons. Usually used together with valid?
@@ -205,8 +205,7 @@ module SmplkitGeneratedClient::App
205
205
  expires_at == o.expires_at &&
206
206
  last_used_at == o.last_used_at &&
207
207
  created_at == o.created_at &&
208
- updated_at == o.updated_at &&
209
- data == o.data
208
+ updated_at == o.updated_at
210
209
  end
211
210
 
212
211
  # @see the `==` method
@@ -218,7 +217,7 @@ module SmplkitGeneratedClient::App
218
217
  # Calculates hash code according to all attributes.
219
218
  # @return [Integer] Hash code
220
219
  def hash
221
- [name, status, key, scopes, created_by, expires_at, last_used_at, created_at, updated_at, data].hash
220
+ [name, status, key, scopes, created_by, expires_at, last_used_at, created_at, updated_at].hash
222
221
  end
223
222
 
224
223
  # Builds the object from hash
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # JSON:API collection response for API keys.
17
18
  class ApiKeyListResponse < ApiModelBase
18
19
  attr_accessor :data
19
20