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
@@ -14,27 +14,33 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # A person with access to one or more accounts in smplkit.
17
18
  class User < ApiModelBase
18
- # User's email address
19
+ # Email address used to sign in to the user account.
19
20
  attr_accessor :email
20
21
 
22
+ # Human-readable display name shown in the console and on shared resources.
21
23
  attr_accessor :display_name
22
24
 
25
+ # URL of an external profile picture (e.g. the value supplied by the user's identity provider).
23
26
  attr_accessor :profile_pic
24
27
 
25
- # Server-computed ``data:`` URL when an OIDC provider supplied a profile picture. Null otherwise — callers should fall back to Gravatar or initials.
28
+ # Server-generated `data:` URL containing the user's avatar image bytes when one has been captured. `null` when no avatar is available — callers should fall back to Gravatar or initials.
26
29
  attr_accessor :avatar_url
27
30
 
31
+ # Identity provider that authenticates the user, e.g. `google`, `microsoft`, or `email`.
28
32
  attr_accessor :auth_provider
29
33
 
34
+ # Whether the user has completed email verification.
30
35
  attr_accessor :email_verified
31
36
 
32
- # Role in current account context
37
+ # Role the user holds in the current account context. One of `OWNER`, `ADMIN`, `MEMBER`, or `VIEWER`.
33
38
  attr_accessor :role
34
39
 
35
- # Account UUID
40
+ # UUID of the account the user is acting within.
36
41
  attr_accessor :account
37
42
 
43
+ # When the user record was created.
38
44
  attr_accessor :created_at
39
45
 
40
46
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -80,6 +86,7 @@ module SmplkitGeneratedClient::App
80
86
  # List of attributes with nullable: true
81
87
  def self.openapi_nullable
82
88
  Set.new([
89
+ :'email',
83
90
  :'profile_pic',
84
91
  :'avatar_url',
85
92
  :'auth_provider',
@@ -107,8 +114,6 @@ module SmplkitGeneratedClient::App
107
114
 
108
115
  if attributes.key?(:'email')
109
116
  self.email = attributes[:'email']
110
- else
111
- self.email = nil
112
117
  end
113
118
 
114
119
  if attributes.key?(:'display_name')
@@ -153,10 +158,6 @@ module SmplkitGeneratedClient::App
153
158
  def list_invalid_properties
154
159
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
155
160
  invalid_properties = Array.new
156
- if @email.nil?
157
- invalid_properties.push('invalid value for "email", email cannot be nil.')
158
- end
159
-
160
161
  if @display_name.nil?
161
162
  invalid_properties.push('invalid value for "display_name", display_name cannot be nil.')
162
163
  end
@@ -176,23 +177,12 @@ module SmplkitGeneratedClient::App
176
177
  # @return true if the model is valid
177
178
  def valid?
178
179
  warn '[DEPRECATED] the `valid?` method is obsolete'
179
- return false if @email.nil?
180
180
  return false if @display_name.nil?
181
181
  return false if @display_name.to_s.length > 255
182
182
  return false if !@profile_pic.nil? && @profile_pic.to_s.length > 2048
183
183
  true
184
184
  end
185
185
 
186
- # Custom attribute writer method with validation
187
- # @param [Object] email Value to be assigned
188
- def email=(email)
189
- if email.nil?
190
- fail ArgumentError, 'email cannot be nil'
191
- end
192
-
193
- @email = email
194
- end
195
-
196
186
  # Custom attribute writer method with validation
197
187
  # @param [Object] display_name Value to be assigned
198
188
  def display_name=(display_name)
@@ -14,6 +14,7 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # JSON:API collection response for users.
17
18
  class UserListResponse < ApiModelBase
18
19
  attr_accessor :data
19
20
 
@@ -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 a user.
18
+ class UserRequest < 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' => :'UserResource'
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::UserRequest` 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::UserRequest`. 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 a user. `id` must not be specified for create requests (the server assigns it).
17
18
  class UserResource < 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 a user.
17
18
  class UserResponse < 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
+ # Aggregated value for this data point over `period_seconds`.
17
18
  module Value
18
19
  class << self
19
20
  # List of class defined in anyOf (OpenAPI v3)
@@ -14,7 +14,9 @@ require 'date'
14
14
  require 'time'
15
15
 
16
16
  module SmplkitGeneratedClient::App
17
+ # Body for the email-verification endpoint.
17
18
  class VerifyEmailRequest < ApiModelBase
19
+ # Verification token previously delivered to the user's email.
18
20
  attr_accessor :token
19
21
 
20
22
  # Attribute mapping from ruby-style variable name to JSON key.
@@ -19,6 +19,7 @@ require 'smplkit_app_client/configuration'
19
19
 
20
20
  # Models
21
21
  require 'smplkit_app_client/models/account'
22
+ require 'smplkit_app_client/models/account_request'
22
23
  require 'smplkit_app_client/models/account_resource'
23
24
  require 'smplkit_app_client/models/account_response'
24
25
  require 'smplkit_app_client/models/account_wipe_request'
@@ -27,6 +28,7 @@ require 'smplkit_app_client/models/add_payment_method_body'
27
28
  require 'smplkit_app_client/models/add_payment_method_data'
28
29
  require 'smplkit_app_client/models/api_key'
29
30
  require 'smplkit_app_client/models/api_key_list_response'
31
+ require 'smplkit_app_client/models/api_key_request'
30
32
  require 'smplkit_app_client/models/api_key_resource'
31
33
  require 'smplkit_app_client/models/api_key_response'
32
34
  require 'smplkit_app_client/models/auth_token_response'
@@ -36,10 +38,12 @@ require 'smplkit_app_client/models/context_batch_response'
36
38
  require 'smplkit_app_client/models/context_bulk_item'
37
39
  require 'smplkit_app_client/models/context_bulk_register'
38
40
  require 'smplkit_app_client/models/context_list_response'
41
+ require 'smplkit_app_client/models/context_request'
39
42
  require 'smplkit_app_client/models/context_resource'
40
43
  require 'smplkit_app_client/models/context_response'
41
44
  require 'smplkit_app_client/models/context_type'
42
45
  require 'smplkit_app_client/models/context_type_list_response'
46
+ require 'smplkit_app_client/models/context_type_request'
43
47
  require 'smplkit_app_client/models/context_type_resource'
44
48
  require 'smplkit_app_client/models/context_type_response'
45
49
  require 'smplkit_app_client/models/create_subscription_attributes'
@@ -50,6 +54,7 @@ require 'smplkit_app_client/models/email_resource'
50
54
  require 'smplkit_app_client/models/email_response'
51
55
  require 'smplkit_app_client/models/environment'
52
56
  require 'smplkit_app_client/models/environment_list_response'
57
+ require 'smplkit_app_client/models/environment_request'
53
58
  require 'smplkit_app_client/models/environment_resource'
54
59
  require 'smplkit_app_client/models/environment_response'
55
60
  require 'smplkit_app_client/models/error'
@@ -81,6 +86,7 @@ require 'smplkit_app_client/models/oidc_provider'
81
86
  require 'smplkit_app_client/models/page_meta'
82
87
  require 'smplkit_app_client/models/payment_method'
83
88
  require 'smplkit_app_client/models/payment_method_list_response'
89
+ require 'smplkit_app_client/models/payment_method_request'
84
90
  require 'smplkit_app_client/models/payment_method_resource'
85
91
  require 'smplkit_app_client/models/payment_method_response'
86
92
  require 'smplkit_app_client/models/plan'
@@ -94,6 +100,7 @@ require 'smplkit_app_client/models/product_resource'
94
100
  require 'smplkit_app_client/models/register_request'
95
101
  require 'smplkit_app_client/models/service'
96
102
  require 'smplkit_app_client/models/service_list_response'
103
+ require 'smplkit_app_client/models/service_request'
97
104
  require 'smplkit_app_client/models/service_resource'
98
105
  require 'smplkit_app_client/models/service_response'
99
106
  require 'smplkit_app_client/models/setup_intent_attributes'
@@ -107,6 +114,7 @@ require 'smplkit_app_client/models/subscription_response'
107
114
  require 'smplkit_app_client/models/user'
108
115
  require 'smplkit_app_client/models/user_list_meta'
109
116
  require 'smplkit_app_client/models/user_list_response'
117
+ require 'smplkit_app_client/models/user_request'
110
118
  require 'smplkit_app_client/models/user_resource'
111
119
  require 'smplkit_app_client/models/user_response'
112
120
  require 'smplkit_app_client/models/value'
@@ -79,7 +79,7 @@ describe 'AccountApi' do
79
79
  # unit tests for update_account
80
80
  # Update Current Account
81
81
  # Update the current account&#39;s settings.
82
- # @param account_response
82
+ # @param account_request
83
83
  # @param [Hash] opts the optional parameters
84
84
  # @return [AccountResponse]
85
85
  describe 'update_account test' do
@@ -90,7 +90,7 @@ describe 'AccountApi' do
90
90
 
91
91
  # unit tests for wipe_account_data
92
92
  # Wipe Account Data
93
- # Delete every config, flag, logger, log group, context, context type, environment, and customer API key (except the caller&#39;s current key) on the account. The &#x60;&#x60;common&#x60;&#x60; config is preserved as a structural anchor but its items are reset. Requires &#x60;&#x60;OWNER&#x60;&#x60; role and a &#x60;&#x60;{\&quot;confirm\&quot;: true}&#x60;&#x60; body anything else returns 400. Pass &#x60;&#x60;\&quot;generate_sample_data\&quot;: true&#x60;&#x60; to re-seed the account with the standard sample dataset after the wipe completes (best-effort; seed failures are logged but do not fail the wipe). Returns 204 on success; if any sub-delete fails the response is 500.
93
+ # Delete every config, flag, logger, log group, context, context type, environment, and customer API key (except the caller&#39;s current key) on the account. The &#x60;common&#x60; config is preserved as a structural anchor but its items are reset. Requires &#x60;OWNER&#x60; role and a body of &#x60;{\&quot;confirm\&quot;: true}&#x60; — any other value returns 400. Pass &#x60;\&quot;generate_sample_data\&quot;: true&#x60; to re-seed the account with the standard sample dataset after the wipe (best-effort; seeding failures are logged but do not fail the wipe). Returns 204 on success; 500 if any sub-delete fails.
94
94
  # @param account_wipe_request
95
95
  # @param [Hash] opts the optional parameters
96
96
  # @return [nil]
@@ -35,7 +35,7 @@ describe 'APIKeysApi' do
35
35
  # unit tests for create_api_key
36
36
  # Create API Key
37
37
  # Create a new API key. The id and key value are server-generated.
38
- # @param api_key_response
38
+ # @param api_key_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [ApiKeyResponse]
41
41
  describe 'create_api_key test' do
@@ -96,7 +96,7 @@ describe 'APIKeysApi' do
96
96
  # Update API Key
97
97
  # Update an API key by id.
98
98
  # @param id
99
- # @param api_key_response
99
+ # @param api_key_request
100
100
  # @param [Hash] opts the optional parameters
101
101
  # @return [ApiKeyResponse]
102
102
  describe 'update_api_key test' do
@@ -46,7 +46,7 @@ describe 'BillingApi' do
46
46
 
47
47
  # unit tests for create_payment_method
48
48
  # Add Payment Method
49
- # Register a Stripe payment method (&#x60;&#x60;pm_...&#x60;&#x60;) as a persistent resource. The frontend obtains the Stripe ID via SetupIntent + Stripe Elements, then POSTs it here. Body shape and server behavior per ADR-044 §5.1.
49
+ # Register a Stripe payment method (&#x60;pm_...&#x60;) on the account. The client first creates the Stripe payment method using a SetupIntent and Stripe Elements, then submits its identifier here to persist it.
50
50
  # @param add_payment_method_body
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [PaymentMethodResponse]
@@ -70,7 +70,7 @@ describe 'BillingApi' do
70
70
 
71
71
  # unit tests for delete_payment_method
72
72
  # Delete Payment Method
73
- # Detach the payment method from Stripe and soft-delete the local row. Returns 409 if this is the only PM and the account has an active paid subscription. If the deleted row was default, the oldest remaining row is promoted.
73
+ # Delete a payment method. Returns 409 if this is the only payment method on file and the account has an active paid subscription. If the deleted payment method was the default, the oldest remaining payment method is promoted to default.
74
74
  # @param id
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @return [nil]
@@ -95,7 +95,7 @@ describe 'BillingApi' do
95
95
 
96
96
  # unit tests for execute_setup_intent
97
97
  # Execute Setup Intent
98
- # Create a Stripe SetupIntent for saving a payment method. Returns a &#x60;&#x60;client_secret&#x60;&#x60; that the frontend passes to Stripe&#39;s Payment Element so the customer can securely enter card details without an immediate charge.
98
+ # Create a Stripe SetupIntent for adding a payment method without an immediate charge. Returns the &#x60;client_secret&#x60; to pass to Stripe Elements in the browser.
99
99
  # @param [Hash] opts the optional parameters
100
100
  # @return [SetupIntentResponse]
101
101
  describe 'execute_setup_intent test' do
@@ -106,7 +106,7 @@ describe 'BillingApi' do
106
106
 
107
107
  # unit tests for get_invoice
108
108
  # Get Invoice
109
- # Return a single invoice by ID. Supports content negotiation via Accept header: - &#x60;&#x60;application/pdf&#x60;&#x60; — PDF bytes proxy-streamed from Stripe - &#x60;&#x60;application/vnd.api+json&#x60;&#x60; / &#x60;&#x60;application/json&#x60;&#x60; / absent — JSON:API resource - Any other value — 406 Not Acceptable
109
+ # Return a single invoice by id. Supports content negotiation via the &#x60;Accept&#x60; header: - &#x60;application/pdf&#x60; — streams the invoice PDF. - &#x60;application/vnd.api+json&#x60;, &#x60;application/json&#x60;, or absent — returns the JSON:API invoice resource. - Any other value — &#x60;406 Not Acceptable&#x60;.
110
110
  # @param invoice_id
111
111
  # @param [Hash] opts the optional parameters
112
112
  # @return [InvoiceSingleResponse]
@@ -163,7 +163,7 @@ describe 'BillingApi' do
163
163
 
164
164
  # unit tests for set_default_payment_method
165
165
  # Set Default Payment Method
166
- # Mark this payment method as the account&#39;s default. Idempotent a no-op 200 if already default.
166
+ # Mark this payment method as the account&#39;s default. Idempotent: returns 200 with no changes when the payment method is already the default.
167
167
  # @param id
168
168
  # @param [Hash] opts the optional parameters
169
169
  # @return [PaymentMethodResponse]
@@ -199,9 +199,9 @@ describe 'BillingApi' do
199
199
 
200
200
  # unit tests for update_payment_method
201
201
  # Update Payment Method
202
- # Update the mutable fields (&#x60;&#x60;billing_details&#x60;&#x60;, &#x60;&#x60;exp_month&#x60;&#x60;, &#x60;&#x60;exp_year&#x60;&#x60;). The &#x60;&#x60;default&#x60;&#x60; field is not mutable via PUT — see ADR-044 §5.2; use the &#x60;&#x60;set_default&#x60;&#x60; action instead.
202
+ # Update the mutable fields of a payment method (&#x60;billing_details&#x60;, &#x60;exp_month&#x60;, &#x60;exp_year&#x60;). The &#x60;default&#x60; flag is not mutable via PUT — use the &#x60;set_default&#x60; action instead.
203
203
  # @param id
204
- # @param payment_method_response
204
+ # @param payment_method_request
205
205
  # @param [Hash] opts the optional parameters
206
206
  # @return [PaymentMethodResponse]
207
207
  describe 'update_payment_method test' do
@@ -35,7 +35,7 @@ describe 'ContextTypesApi' do
35
35
  # unit tests for create_context_type
36
36
  # Create Context Type
37
37
  # Create a new context type. The caller provides the id (key) in the request body.
38
- # @param context_type_response
38
+ # @param context_type_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [ContextTypeResponse]
41
41
  describe 'create_context_type test' do
@@ -83,7 +83,7 @@ describe 'ContextTypesApi' do
83
83
  # Update Context Type
84
84
  # Update a context type by id.
85
85
  # @param id
86
- # @param context_type_response
86
+ # @param context_type_request
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [ContextTypeResponse]
89
89
  describe 'update_context_type test' do
@@ -82,9 +82,9 @@ describe 'ContextsApi' do
82
82
 
83
83
  # unit tests for update_context
84
84
  # Update Context
85
- # Update a context instance by composite id (type:key). Only the human-readable display name is mutable through this endpoint; context_type and observed attributes are written by the SDK ingestion path.
85
+ # Update a context instance by composite id (type:key). Only the human-readable display name is mutable here; &#x60;context_type&#x60; and observed &#x60;attributes&#x60; are written by SDK registration and ignored on this endpoint.
86
86
  # @param id
87
- # @param context_response
87
+ # @param context_request
88
88
  # @param [Hash] opts the optional parameters
89
89
  # @return [ContextResponse]
90
90
  describe 'update_context test' do
@@ -35,7 +35,7 @@ describe 'EnvironmentsApi' do
35
35
  # unit tests for create_environment
36
36
  # Create Environment
37
37
  # Create a new environment. The caller provides the id (key) in the request body.
38
- # @param environment_response
38
+ # @param environment_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [EnvironmentResponse]
41
41
  describe 'create_environment test' do
@@ -83,7 +83,7 @@ describe 'EnvironmentsApi' do
83
83
  # Update Environment
84
84
  # Update an environment by id.
85
85
  # @param id
86
- # @param environment_response
86
+ # @param environment_request
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [EnvironmentResponse]
89
89
  describe 'update_environment test' do
@@ -46,7 +46,7 @@ describe 'MetricsApi' do
46
46
 
47
47
  # unit tests for list_metric_names
48
48
  # List Metric Names
49
- # Return distinct metric names (with a representative unit) for this account. Used by the dashboard to discover which product sections to render. Plain JSON response (not JSON:API) — this is metadata, not a metric resource.
49
+ # Return distinct metric names recorded for the account, each with a representative unit. Plain-JSON response (not JSON:API) — this is metadata for discovery, not a metric resource.
50
50
  # @param [Hash] opts the optional parameters
51
51
  # @return [MetricNamesResponse]
52
52
  describe 'list_metric_names test' do
@@ -35,7 +35,7 @@ describe 'ServicesApi' do
35
35
  # unit tests for create_service
36
36
  # Create Service
37
37
  # Create a new service. The caller provides the id (key) in the request body.
38
- # @param service_response
38
+ # @param service_request
39
39
  # @param [Hash] opts the optional parameters
40
40
  # @return [ServiceResponse]
41
41
  describe 'create_service test' do
@@ -83,7 +83,7 @@ describe 'ServicesApi' do
83
83
  # Update Service
84
84
  # Update a service by id.
85
85
  # @param id
86
- # @param service_response
86
+ # @param service_request
87
87
  # @param [Hash] opts the optional parameters
88
88
  # @return [ServiceResponse]
89
89
  describe 'update_service test' do
@@ -120,7 +120,7 @@ describe 'UsersApi' do
120
120
  # unit tests for update_current_user
121
121
  # Update Current User
122
122
  # Update the currently authenticated user&#39;s profile.
123
- # @param user_response
123
+ # @param user_request
124
124
  # @param [Hash] opts the optional parameters
125
125
  # @return [UserResponse]
126
126
  describe 'update_current_user test' do
@@ -133,7 +133,7 @@ describe 'UsersApi' do
133
133
  # Update User Role
134
134
  # Update a user&#39;s role in the account.
135
135
  # @param id
136
- # @param user_response
136
+ # @param user_request
137
137
  # @param [Hash] opts the optional parameters
138
138
  # @return [UserResponse]
139
139
  describe 'update_user_role test' do
@@ -0,0 +1,36 @@
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 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for SmplkitGeneratedClient::App::AccountRequest
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe SmplkitGeneratedClient::App::AccountRequest do
21
+ #let(:instance) { SmplkitGeneratedClient::App::AccountRequest.new }
22
+
23
+ describe 'test an instance of AccountRequest' do
24
+ it 'should create an instance of AccountRequest' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::AccountRequest)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "data"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ end
@@ -0,0 +1,36 @@
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 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for SmplkitGeneratedClient::App::ApiKeyRequest
18
+ # Automatically generated by openapi-generator (https://openapi-generator.tech)
19
+ # Please update as you see appropriate
20
+ describe SmplkitGeneratedClient::App::ApiKeyRequest do
21
+ #let(:instance) { SmplkitGeneratedClient::App::ApiKeyRequest.new }
22
+
23
+ describe 'test an instance of ApiKeyRequest' do
24
+ it 'should create an instance of ApiKeyRequest' do
25
+ # uncomment below to test the instance creation
26
+ #expect(instance).to be_instance_of(SmplkitGeneratedClient::App::ApiKeyRequest)
27
+ end
28
+ end
29
+
30
+ describe 'test attribute "data"' do
31
+ it 'should work' do
32
+ # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
33
+ end
34
+ end
35
+
36
+ end
@@ -81,10 +81,4 @@ describe SmplkitGeneratedClient::App::ApiKey do
81
81
  end
82
82
  end
83
83
 
84
- describe 'test attribute "data"' do
85
- it 'should work' do
86
- # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
87
- end
88
- end
89
-
90
84
  end