ilovevideoeditor-sdk 1.0.0
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.
- checksums.yaml +7 -0
- data/lib/generated/ilovevideoeditor-sdk/api/api_keys_api.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/api/assets_api.rb +632 -0
- data/lib/generated/ilovevideoeditor-sdk/api/billing_api.rb +428 -0
- data/lib/generated/ilovevideoeditor-sdk/api/health_api.rb +134 -0
- data/lib/generated/ilovevideoeditor-sdk/api/integrations_api.rb +587 -0
- data/lib/generated/ilovevideoeditor-sdk/api/projects_api.rb +614 -0
- data/lib/generated/ilovevideoeditor-sdk/api/render_api.rb +656 -0
- data/lib/generated/ilovevideoeditor-sdk/api/renditions_api.rb +420 -0
- data/lib/generated/ilovevideoeditor-sdk/api/templates_api.rb +217 -0
- data/lib/generated/ilovevideoeditor-sdk/api/tools_api.rb +220 -0
- data/lib/generated/ilovevideoeditor-sdk/api/webhooks_api.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/api/workflows_api.rb +854 -0
- data/lib/generated/ilovevideoeditor-sdk/api_client.rb +397 -0
- data/lib/generated/ilovevideoeditor-sdk/api_error.rb +58 -0
- data/lib/generated/ilovevideoeditor-sdk/api_model_base.rb +88 -0
- data/lib/generated/ilovevideoeditor-sdk/configuration.rb +316 -0
- data/lib/generated/ilovevideoeditor-sdk/models/api_key.rb +246 -0
- data/lib/generated/ilovevideoeditor-sdk/models/api_key_with_secret.rb +191 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset.rb +404 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset_create.rb +303 -0
- data/lib/generated/ilovevideoeditor-sdk/models/asset_upload_url_response.rb +295 -0
- data/lib/generated/ilovevideoeditor-sdk/models/batch_delete_projects_request.rb +184 -0
- data/lib/generated/ilovevideoeditor-sdk/models/batch_delete_result.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_prices.rb +158 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_prices_tiers.rb +168 -0
- data/lib/generated/ilovevideoeditor-sdk/models/billing_subscription.rb +254 -0
- data/lib/generated/ilovevideoeditor-sdk/models/cancel_render200_response.rb +225 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_api_key_request.rb +147 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_asset201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_checkout_session200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_checkout_session_request.rb +220 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_integration201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_project200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_workflow201_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/create_workflow_request.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance.rb +219 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance_summary.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/credit_balance_usage.rb +156 -0
- data/lib/generated/ilovevideoeditor-sdk/models/delete_project200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/destination.rb +331 -0
- data/lib/generated/ilovevideoeditor-sdk/models/destination_input.rb +304 -0
- data/lib/generated/ilovevideoeditor-sdk/models/error.rb +182 -0
- data/lib/generated/ilovevideoeditor-sdk/models/estimate_render_cost_request.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_asset_signed_url200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_asset_upload_url_request.rb +214 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_destination200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_project200_response.rb +173 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_project_stats200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_render_download_url200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_rendition200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_subscription200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_template200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_usage200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_workflow200_response.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/get_workflow_run200_response.rb +175 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check200_response.rb +147 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check_detailed200_response.rb +199 -0
- data/lib/generated/ilovevideoeditor-sdk/models/health_check_detailed200_response_services.rb +156 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_api_keys200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_assets200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_integrations200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_invoices200_response.rb +158 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_projects200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_renditions200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_templates200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_webhook_subscriptions200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflow_runs200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflow_step_types200_response.rb +166 -0
- data/lib/generated/ilovevideoeditor-sdk/models/list_workflows200_response.rb +185 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project.rb +329 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project_create.rb +218 -0
- data/lib/generated/ilovevideoeditor-sdk/models/project_update.rb +239 -0
- data/lib/generated/ilovevideoeditor-sdk/models/queue_render200_response.rb +199 -0
- data/lib/generated/ilovevideoeditor-sdk/models/queue_render_request.rb +182 -0
- data/lib/generated/ilovevideoeditor-sdk/models/refresh_render_url200_response.rb +190 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate.rb +254 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate_resolution.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_cost_estimate_tier.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_job.rb +271 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_job_progress.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_list_item.rb +356 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_template_request.rb +167 -0
- data/lib/generated/ilovevideoeditor-sdk/models/render_webhook_payload.rb +357 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition.rb +335 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_cancel_result.rb +236 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_output.rb +233 -0
- data/lib/generated/ilovevideoeditor-sdk/models/rendition_stats.rb +192 -0
- data/lib/generated/ilovevideoeditor-sdk/models/run_workflow202_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/run_workflow_request.rb +149 -0
- data/lib/generated/ilovevideoeditor-sdk/models/service_health.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/template.rb +324 -0
- data/lib/generated/ilovevideoeditor-sdk/models/template_summary.rb +322 -0
- data/lib/generated/ilovevideoeditor-sdk/models/test_integration200_response.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tier_info.rb +214 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tier_info_credits.rb +165 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_request.rb +242 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_request_dimensions.rb +208 -0
- data/lib/generated/ilovevideoeditor-sdk/models/tool_job_status.rb +310 -0
- data/lib/generated/ilovevideoeditor-sdk/models/track_render_bandwidth200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/update_workflow_request.rb +174 -0
- data/lib/generated/ilovevideoeditor-sdk/models/upload_asset200_response.rb +164 -0
- data/lib/generated/ilovevideoeditor-sdk/models/usage_log.rb +302 -0
- data/lib/generated/ilovevideoeditor-sdk/models/video_json.rb +243 -0
- data/lib/generated/ilovevideoeditor-sdk/models/video_json_destination.rb +227 -0
- data/lib/generated/ilovevideoeditor-sdk/models/webhook_subscription.rb +283 -0
- data/lib/generated/ilovevideoeditor-sdk/models/webhook_subscription_create.rb +204 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow.rb +356 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_definition.rb +262 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_run.rb +372 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_run_step.rb +409 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_step.rb +262 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workflow_variable.rb +242 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workspace_integration.rb +398 -0
- data/lib/generated/ilovevideoeditor-sdk/models/workspace_integration_input.rb +260 -0
- data/lib/generated/ilovevideoeditor-sdk/version.rb +15 -0
- data/lib/generated/ilovevideoeditor-sdk.rb +150 -0
- data/lib/ilovevideoeditor/client.rb +106 -0
- data/lib/ilovevideoeditor-sdk.rb +2 -0
- metadata +181 -0
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#iLoveVideoEditor API
|
|
3
|
+
|
|
4
|
+
#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4. **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication. **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.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 ILoveVideoEditor
|
|
17
|
+
# Reference to a workspace storage integration where the rendered video should be delivered. Credentials are never stored here.
|
|
18
|
+
class VideoJSONDestination < ApiModelBase
|
|
19
|
+
# Workspace integration identifier.
|
|
20
|
+
attr_accessor :integration_id
|
|
21
|
+
|
|
22
|
+
# Storage provider the integration is configured for.
|
|
23
|
+
attr_accessor :provider
|
|
24
|
+
|
|
25
|
+
# Optional path prefix override for this render.
|
|
26
|
+
attr_accessor :path_prefix
|
|
27
|
+
|
|
28
|
+
class EnumAttributeValidator
|
|
29
|
+
attr_reader :datatype
|
|
30
|
+
attr_reader :allowable_values
|
|
31
|
+
|
|
32
|
+
def initialize(datatype, allowable_values)
|
|
33
|
+
@allowable_values = allowable_values.map do |value|
|
|
34
|
+
case datatype.to_s
|
|
35
|
+
when /Integer/i
|
|
36
|
+
value.to_i
|
|
37
|
+
when /Float/i
|
|
38
|
+
value.to_f
|
|
39
|
+
else
|
|
40
|
+
value
|
|
41
|
+
end
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
|
|
45
|
+
def valid?(value)
|
|
46
|
+
!value || allowable_values.include?(value)
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
51
|
+
def self.attribute_map
|
|
52
|
+
{
|
|
53
|
+
:'integration_id' => :'integrationId',
|
|
54
|
+
:'provider' => :'provider',
|
|
55
|
+
:'path_prefix' => :'pathPrefix'
|
|
56
|
+
}
|
|
57
|
+
end
|
|
58
|
+
|
|
59
|
+
# Returns attribute mapping this model knows about
|
|
60
|
+
def self.acceptable_attribute_map
|
|
61
|
+
attribute_map
|
|
62
|
+
end
|
|
63
|
+
|
|
64
|
+
# Returns all the JSON keys this model knows about
|
|
65
|
+
def self.acceptable_attributes
|
|
66
|
+
acceptable_attribute_map.values
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
# Attribute type mapping.
|
|
70
|
+
def self.openapi_types
|
|
71
|
+
{
|
|
72
|
+
:'integration_id' => :'String',
|
|
73
|
+
:'provider' => :'String',
|
|
74
|
+
:'path_prefix' => :'String'
|
|
75
|
+
}
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# List of attributes with nullable: true
|
|
79
|
+
def self.openapi_nullable
|
|
80
|
+
Set.new([
|
|
81
|
+
])
|
|
82
|
+
end
|
|
83
|
+
|
|
84
|
+
# Initializes the object
|
|
85
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
86
|
+
def initialize(attributes = {})
|
|
87
|
+
if (!attributes.is_a?(Hash))
|
|
88
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ILoveVideoEditor::VideoJSONDestination` initialize method"
|
|
89
|
+
end
|
|
90
|
+
|
|
91
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
92
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
93
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
94
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
95
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ILoveVideoEditor::VideoJSONDestination`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
96
|
+
end
|
|
97
|
+
h[k.to_sym] = v
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
if attributes.key?(:'integration_id')
|
|
101
|
+
self.integration_id = attributes[:'integration_id']
|
|
102
|
+
else
|
|
103
|
+
self.integration_id = nil
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
if attributes.key?(:'provider')
|
|
107
|
+
self.provider = attributes[:'provider']
|
|
108
|
+
else
|
|
109
|
+
self.provider = nil
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
if attributes.key?(:'path_prefix')
|
|
113
|
+
self.path_prefix = attributes[:'path_prefix']
|
|
114
|
+
end
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
118
|
+
# @return Array for valid properties with the reasons
|
|
119
|
+
def list_invalid_properties
|
|
120
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
121
|
+
invalid_properties = Array.new
|
|
122
|
+
if @integration_id.nil?
|
|
123
|
+
invalid_properties.push('invalid value for "integration_id", integration_id cannot be nil.')
|
|
124
|
+
end
|
|
125
|
+
|
|
126
|
+
if @provider.nil?
|
|
127
|
+
invalid_properties.push('invalid value for "provider", provider cannot be nil.')
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
invalid_properties
|
|
131
|
+
end
|
|
132
|
+
|
|
133
|
+
# Check to see if the all the properties in the model are valid
|
|
134
|
+
# @return true if the model is valid
|
|
135
|
+
def valid?
|
|
136
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
137
|
+
return false if @integration_id.nil?
|
|
138
|
+
return false if @provider.nil?
|
|
139
|
+
provider_validator = EnumAttributeValidator.new('String', ["s3", "r2", "b2", "wasabi", "gcs", "azure", "drive"])
|
|
140
|
+
return false unless provider_validator.valid?(@provider)
|
|
141
|
+
true
|
|
142
|
+
end
|
|
143
|
+
|
|
144
|
+
# Custom attribute writer method with validation
|
|
145
|
+
# @param [Object] integration_id Value to be assigned
|
|
146
|
+
def integration_id=(integration_id)
|
|
147
|
+
if integration_id.nil?
|
|
148
|
+
fail ArgumentError, 'integration_id cannot be nil'
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
@integration_id = integration_id
|
|
152
|
+
end
|
|
153
|
+
|
|
154
|
+
# Custom attribute writer method checking allowed values (enum).
|
|
155
|
+
# @param [Object] provider Object to be assigned
|
|
156
|
+
def provider=(provider)
|
|
157
|
+
validator = EnumAttributeValidator.new('String', ["s3", "r2", "b2", "wasabi", "gcs", "azure", "drive"])
|
|
158
|
+
unless validator.valid?(provider)
|
|
159
|
+
fail ArgumentError, "invalid value for \"provider\", must be one of #{validator.allowable_values}."
|
|
160
|
+
end
|
|
161
|
+
@provider = provider
|
|
162
|
+
end
|
|
163
|
+
|
|
164
|
+
# Checks equality by comparing each attribute.
|
|
165
|
+
# @param [Object] Object to be compared
|
|
166
|
+
def ==(o)
|
|
167
|
+
return true if self.equal?(o)
|
|
168
|
+
self.class == o.class &&
|
|
169
|
+
integration_id == o.integration_id &&
|
|
170
|
+
provider == o.provider &&
|
|
171
|
+
path_prefix == o.path_prefix
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# @see the `==` method
|
|
175
|
+
# @param [Object] Object to be compared
|
|
176
|
+
def eql?(o)
|
|
177
|
+
self == o
|
|
178
|
+
end
|
|
179
|
+
|
|
180
|
+
# Calculates hash code according to all attributes.
|
|
181
|
+
# @return [Integer] Hash code
|
|
182
|
+
def hash
|
|
183
|
+
[integration_id, provider, path_prefix].hash
|
|
184
|
+
end
|
|
185
|
+
|
|
186
|
+
# Builds the object from hash
|
|
187
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
188
|
+
# @return [Object] Returns the model itself
|
|
189
|
+
def self.build_from_hash(attributes)
|
|
190
|
+
return nil unless attributes.is_a?(Hash)
|
|
191
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
192
|
+
transformed_hash = {}
|
|
193
|
+
openapi_types.each_pair do |key, type|
|
|
194
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
195
|
+
transformed_hash["#{key}"] = nil
|
|
196
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
197
|
+
# check to ensure the input is an array given that the attribute
|
|
198
|
+
# is documented as an array but the input is not
|
|
199
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
200
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
201
|
+
end
|
|
202
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
203
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
204
|
+
end
|
|
205
|
+
end
|
|
206
|
+
new(transformed_hash)
|
|
207
|
+
end
|
|
208
|
+
|
|
209
|
+
# Returns the object in the form of hash
|
|
210
|
+
# @return [Hash] Returns the object in the form of hash
|
|
211
|
+
def to_hash
|
|
212
|
+
hash = {}
|
|
213
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
214
|
+
value = self.send(attr)
|
|
215
|
+
if value.nil?
|
|
216
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
217
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
218
|
+
end
|
|
219
|
+
|
|
220
|
+
hash[param] = _to_hash(value)
|
|
221
|
+
end
|
|
222
|
+
hash
|
|
223
|
+
end
|
|
224
|
+
|
|
225
|
+
end
|
|
226
|
+
|
|
227
|
+
end
|
|
@@ -0,0 +1,283 @@
|
|
|
1
|
+
=begin
|
|
2
|
+
#iLoveVideoEditor API
|
|
3
|
+
|
|
4
|
+
#Cloud video rendering API for iLoveVideoEditor. Submit a `VideoJSON` payload, queue a render job, and download the resulting MP4. **Authentication** - **API Key** (`x-api-key` header) — accepted by render pipeline and tool endpoints. - **Bearer Token** (`Authorization: Bearer <jwt>`) — required for user-scoped project, asset, billing, and webhook endpoints. - Many endpoints accept either form of authentication. **SDKs** Official typed SDKs are available for JavaScript/TypeScript, PHP, Python, Ruby, and Go. See https://ilovevideoeditor.com/docs/sdks **Outbound Webhooks** Render lifecycle events (`render.completed`, `render.failed`) are delivered to your endpoints as signed HTTP POST requests. See the `Webhooks` tag and the root-level `x-webhook-docs` extension for the payload format (`RenderWebhookPayload`), signature headers, HMAC verification, and the retry policy.
|
|
5
|
+
|
|
6
|
+
The version of the OpenAPI document: 1.0.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 ILoveVideoEditor
|
|
17
|
+
class WebhookSubscription < ApiModelBase
|
|
18
|
+
attr_accessor :id
|
|
19
|
+
|
|
20
|
+
attr_accessor :url
|
|
21
|
+
|
|
22
|
+
attr_accessor :events
|
|
23
|
+
|
|
24
|
+
# Per-subscription signing secret (`whsec_…`).
|
|
25
|
+
attr_accessor :secret
|
|
26
|
+
|
|
27
|
+
attr_accessor :created_at
|
|
28
|
+
|
|
29
|
+
class EnumAttributeValidator
|
|
30
|
+
attr_reader :datatype
|
|
31
|
+
attr_reader :allowable_values
|
|
32
|
+
|
|
33
|
+
def initialize(datatype, allowable_values)
|
|
34
|
+
@allowable_values = allowable_values.map do |value|
|
|
35
|
+
case datatype.to_s
|
|
36
|
+
when /Integer/i
|
|
37
|
+
value.to_i
|
|
38
|
+
when /Float/i
|
|
39
|
+
value.to_f
|
|
40
|
+
else
|
|
41
|
+
value
|
|
42
|
+
end
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
def valid?(value)
|
|
47
|
+
!value || allowable_values.include?(value)
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
|
52
|
+
def self.attribute_map
|
|
53
|
+
{
|
|
54
|
+
:'id' => :'id',
|
|
55
|
+
:'url' => :'url',
|
|
56
|
+
:'events' => :'events',
|
|
57
|
+
:'secret' => :'secret',
|
|
58
|
+
:'created_at' => :'createdAt'
|
|
59
|
+
}
|
|
60
|
+
end
|
|
61
|
+
|
|
62
|
+
# Returns attribute mapping this model knows about
|
|
63
|
+
def self.acceptable_attribute_map
|
|
64
|
+
attribute_map
|
|
65
|
+
end
|
|
66
|
+
|
|
67
|
+
# Returns all the JSON keys this model knows about
|
|
68
|
+
def self.acceptable_attributes
|
|
69
|
+
acceptable_attribute_map.values
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
# Attribute type mapping.
|
|
73
|
+
def self.openapi_types
|
|
74
|
+
{
|
|
75
|
+
:'id' => :'String',
|
|
76
|
+
:'url' => :'String',
|
|
77
|
+
:'events' => :'Array<String>',
|
|
78
|
+
:'secret' => :'String',
|
|
79
|
+
:'created_at' => :'Time'
|
|
80
|
+
}
|
|
81
|
+
end
|
|
82
|
+
|
|
83
|
+
# List of attributes with nullable: true
|
|
84
|
+
def self.openapi_nullable
|
|
85
|
+
Set.new([
|
|
86
|
+
])
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
# Initializes the object
|
|
90
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
91
|
+
def initialize(attributes = {})
|
|
92
|
+
if (!attributes.is_a?(Hash))
|
|
93
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `ILoveVideoEditor::WebhookSubscription` initialize method"
|
|
94
|
+
end
|
|
95
|
+
|
|
96
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
|
97
|
+
acceptable_attribute_map = self.class.acceptable_attribute_map
|
|
98
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
|
99
|
+
if (!acceptable_attribute_map.key?(k.to_sym))
|
|
100
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `ILoveVideoEditor::WebhookSubscription`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
|
|
101
|
+
end
|
|
102
|
+
h[k.to_sym] = v
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
if attributes.key?(:'id')
|
|
106
|
+
self.id = attributes[:'id']
|
|
107
|
+
else
|
|
108
|
+
self.id = nil
|
|
109
|
+
end
|
|
110
|
+
|
|
111
|
+
if attributes.key?(:'url')
|
|
112
|
+
self.url = attributes[:'url']
|
|
113
|
+
else
|
|
114
|
+
self.url = nil
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
if attributes.key?(:'events')
|
|
118
|
+
if (value = attributes[:'events']).is_a?(Array)
|
|
119
|
+
self.events = value
|
|
120
|
+
end
|
|
121
|
+
else
|
|
122
|
+
self.events = nil
|
|
123
|
+
end
|
|
124
|
+
|
|
125
|
+
if attributes.key?(:'secret')
|
|
126
|
+
self.secret = attributes[:'secret']
|
|
127
|
+
else
|
|
128
|
+
self.secret = nil
|
|
129
|
+
end
|
|
130
|
+
|
|
131
|
+
if attributes.key?(:'created_at')
|
|
132
|
+
self.created_at = attributes[:'created_at']
|
|
133
|
+
else
|
|
134
|
+
self.created_at = nil
|
|
135
|
+
end
|
|
136
|
+
end
|
|
137
|
+
|
|
138
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
|
139
|
+
# @return Array for valid properties with the reasons
|
|
140
|
+
def list_invalid_properties
|
|
141
|
+
warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
|
|
142
|
+
invalid_properties = Array.new
|
|
143
|
+
if @id.nil?
|
|
144
|
+
invalid_properties.push('invalid value for "id", id cannot be nil.')
|
|
145
|
+
end
|
|
146
|
+
|
|
147
|
+
if @url.nil?
|
|
148
|
+
invalid_properties.push('invalid value for "url", url cannot be nil.')
|
|
149
|
+
end
|
|
150
|
+
|
|
151
|
+
if @events.nil?
|
|
152
|
+
invalid_properties.push('invalid value for "events", events cannot be nil.')
|
|
153
|
+
end
|
|
154
|
+
|
|
155
|
+
if @secret.nil?
|
|
156
|
+
invalid_properties.push('invalid value for "secret", secret cannot be nil.')
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
if @created_at.nil?
|
|
160
|
+
invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
invalid_properties
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Check to see if the all the properties in the model are valid
|
|
167
|
+
# @return true if the model is valid
|
|
168
|
+
def valid?
|
|
169
|
+
warn '[DEPRECATED] the `valid?` method is obsolete'
|
|
170
|
+
return false if @id.nil?
|
|
171
|
+
return false if @url.nil?
|
|
172
|
+
return false if @events.nil?
|
|
173
|
+
return false if @secret.nil?
|
|
174
|
+
return false if @created_at.nil?
|
|
175
|
+
true
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
# Custom attribute writer method with validation
|
|
179
|
+
# @param [Object] id Value to be assigned
|
|
180
|
+
def id=(id)
|
|
181
|
+
if id.nil?
|
|
182
|
+
fail ArgumentError, 'id cannot be nil'
|
|
183
|
+
end
|
|
184
|
+
|
|
185
|
+
@id = id
|
|
186
|
+
end
|
|
187
|
+
|
|
188
|
+
# Custom attribute writer method with validation
|
|
189
|
+
# @param [Object] url Value to be assigned
|
|
190
|
+
def url=(url)
|
|
191
|
+
if url.nil?
|
|
192
|
+
fail ArgumentError, 'url cannot be nil'
|
|
193
|
+
end
|
|
194
|
+
|
|
195
|
+
@url = url
|
|
196
|
+
end
|
|
197
|
+
|
|
198
|
+
# Custom attribute writer method with validation
|
|
199
|
+
# @param [Object] secret Value to be assigned
|
|
200
|
+
def secret=(secret)
|
|
201
|
+
if secret.nil?
|
|
202
|
+
fail ArgumentError, 'secret cannot be nil'
|
|
203
|
+
end
|
|
204
|
+
|
|
205
|
+
@secret = secret
|
|
206
|
+
end
|
|
207
|
+
|
|
208
|
+
# Custom attribute writer method with validation
|
|
209
|
+
# @param [Object] created_at Value to be assigned
|
|
210
|
+
def created_at=(created_at)
|
|
211
|
+
if created_at.nil?
|
|
212
|
+
fail ArgumentError, 'created_at cannot be nil'
|
|
213
|
+
end
|
|
214
|
+
|
|
215
|
+
@created_at = created_at
|
|
216
|
+
end
|
|
217
|
+
|
|
218
|
+
# Checks equality by comparing each attribute.
|
|
219
|
+
# @param [Object] Object to be compared
|
|
220
|
+
def ==(o)
|
|
221
|
+
return true if self.equal?(o)
|
|
222
|
+
self.class == o.class &&
|
|
223
|
+
id == o.id &&
|
|
224
|
+
url == o.url &&
|
|
225
|
+
events == o.events &&
|
|
226
|
+
secret == o.secret &&
|
|
227
|
+
created_at == o.created_at
|
|
228
|
+
end
|
|
229
|
+
|
|
230
|
+
# @see the `==` method
|
|
231
|
+
# @param [Object] Object to be compared
|
|
232
|
+
def eql?(o)
|
|
233
|
+
self == o
|
|
234
|
+
end
|
|
235
|
+
|
|
236
|
+
# Calculates hash code according to all attributes.
|
|
237
|
+
# @return [Integer] Hash code
|
|
238
|
+
def hash
|
|
239
|
+
[id, url, events, secret, created_at].hash
|
|
240
|
+
end
|
|
241
|
+
|
|
242
|
+
# Builds the object from hash
|
|
243
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
|
244
|
+
# @return [Object] Returns the model itself
|
|
245
|
+
def self.build_from_hash(attributes)
|
|
246
|
+
return nil unless attributes.is_a?(Hash)
|
|
247
|
+
attributes = attributes.transform_keys(&:to_sym)
|
|
248
|
+
transformed_hash = {}
|
|
249
|
+
openapi_types.each_pair do |key, type|
|
|
250
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
|
251
|
+
transformed_hash["#{key}"] = nil
|
|
252
|
+
elsif type =~ /\AArray<(.*)>/i
|
|
253
|
+
# check to ensure the input is an array given that the attribute
|
|
254
|
+
# is documented as an array but the input is not
|
|
255
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
|
256
|
+
transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
|
|
257
|
+
end
|
|
258
|
+
elsif !attributes[attribute_map[key]].nil?
|
|
259
|
+
transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
|
|
260
|
+
end
|
|
261
|
+
end
|
|
262
|
+
new(transformed_hash)
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
# Returns the object in the form of hash
|
|
266
|
+
# @return [Hash] Returns the object in the form of hash
|
|
267
|
+
def to_hash
|
|
268
|
+
hash = {}
|
|
269
|
+
self.class.attribute_map.each_pair do |attr, param|
|
|
270
|
+
value = self.send(attr)
|
|
271
|
+
if value.nil?
|
|
272
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
|
273
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
|
274
|
+
end
|
|
275
|
+
|
|
276
|
+
hash[param] = _to_hash(value)
|
|
277
|
+
end
|
|
278
|
+
hash
|
|
279
|
+
end
|
|
280
|
+
|
|
281
|
+
end
|
|
282
|
+
|
|
283
|
+
end
|