bombbomb 2.0.21454 → 2.0.22196

data/docs/SignUploadRequest.md

@@ -0,0 +1,9 @@
+# BombBomb::SignUploadRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**expiration** | **DateTime** | when the upload will expire. | [optional] 
+**conditions** | **Object** | Key/Value object of request conditions. | [optional] 
+
+

data/docs/SignUploadResponse.md

@@ -0,0 +1,9 @@
+# BombBomb::SignUploadResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**policy** | **String** | Base64 encoded policy. | [optional] 
+**signature** | **String** | Signature for policy. | [optional] 
+
+

data/docs/VideoEmailPrompt.md

@@ -8,18 +8,25 @@ Name | Type | Description | Notes
 **template_id** | **String** | Optional. The email template to be used in the sent email, if none supplied, the users' default will be applied. | [optional] 
 **email_subject_line** | **String** | The subject line of the final email | 
 **email_content** | **String** | The HTML content of the final email | 
+**thumbnail_url** | **String** | The URL of a thumbnail image for this prompt | [optional] 
 **to_email_addresses** | **Array<String>** | Email addresses to send the final email to, can be mixed with listIds. | [optional] 
 **to_lists** | **Array<String>** | List Ids to send the final email to | [optional] 
 **jericho_id** | **String** | If sent in a jericho context, this will have the jericho id | [optional] 
 **prompt_subject** | **String** | The prompt's subject line | 
-**prompt_html** | **String** | The HTML body of the prompt | 
+**prompt_html** | **String** | The suggested script of the prompt. | 
+**prompt_intro** | **String** | A paragraph intro statement about the purpose of the email you're recording a video for. | [optional] 
+**example_video_id** | **String** | An example or explanatory video to help the user understand what to say. | [optional] 
 **send_without_video** | **BOOLEAN** | Whether to send the email if no video is recorded. If set to require a video, and none is added before the videoDueDate, the prompt is cancelled. | [optional] 
 **video_due_date** | **DateTime** | When the video must be recorded by | [optional] 
 **scheduled_send_date** | **DateTime** | When the final email is scheduled to be sent | 
 **video_id** | **String** | The video that was added to the prompt. Read Only. | [optional] 
 **email_id** | **String** | The email that was created by the prompt Read Only. | [optional] 
 **job_id** | **String** | The job sent by the prompt Read Only. | [optional] 
+**prompt_bot_id** | **String** | The bot that created the prompt. | [optional] 
+**client_group_id** | **String** | The client group campaign that created the prompt. | [optional] 
 **status** | **Integer** | The status of the prompt: created = 0, sent = 10, recorded = 20, job_created = 30, timed_out = 40, declined = 50 Read Only | [optional] 
-**do_not_apply_template** | **BOOLEAN** | Controls whether a user template is applied to the message as it is sent | [optional] 
+**apply_template** | **BOOLEAN** | Controls whether a user template is applied to the message as it is sent | [optional] 
+**created_date** | **DateTime** | When the email was first sent out | [optional] 
+**last_notified** | **DateTime** | When the user was last notified about a prompt email waiting for a video | [optional] 
 
 

data/docs/VideoPublicRepresentation.md

@@ -0,0 +1,18 @@
+# BombBomb::VideoPublicRepresentation
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The id of the video | [optional] 
+**user_id** | **String** | The is of the owning user | [optional] 
+**status** | **String** | The status of the video | [optional] 
+**name** | **String** | The name of the video | [optional] 
+**description** | **String** | A description of the video | [optional] 
+**thumb_url** | **String** | The url of the thumbnail for the video | [optional] 
+**video_urls** | **Array<String>** | Urls to different formats of the video | [optional] 
+**short_url** | **String** | The url to use to link to the video | [optional] 
+**height** | **Integer** | The height of the video in pixels | [optional] 
+**width** | **Integer** | The width of the video in pixels | [optional] 
+**upload_date** | **String** | The date the video was uploaded | [optional] 
+
+

data/docs/VideoRecorderMethodResponse.md

@@ -0,0 +1,15 @@
+# BombBomb::VideoRecorderMethodResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | The id of the user for whom this video will be recorded | [optional] 
+**email** | **String** | The email address of the user for whom this video will be recorded | [optional] 
+**client_id** | **String** | The client_id of the user for whom this video will be recorded | [optional] 
+**vid_id** | **String** | The id of the video that will be recorded | [optional] 
+**content** | **String** | An HTML blob that displays a video recorder | [optional] 
+**width** | **Integer** | The width of the video recorder | [optional] 
+**height** | **Integer** | the Height of the video recorder | [optional] 
+**https** | **BOOLEAN** | Whether communication from the recorder will be handled via HTTPS (always true) | [optional] 
+
+

data/docs/VideosApi.md

@@ -0,0 +1,175 @@
+# BombBomb::VideosApi
+
+All URIs are relative to *https://api.bombbomb.com/v2*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_video_recorder**](VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
+[**mark_live_recording_complete**](VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
+[**sign_upload**](VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
+
+
+# **get_video_recorder**
+> VideoRecorderMethodResponse get_video_recorder(opts)
+
+Get Live Video Recorder HTML
+
+Returns an object with a number of properties to help you put a video recorder on your site.         This is to be used in conjunction with the VideoRecordedLive call one the user has confirmed in your UI that         the video is how they want it.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::VideosApi.new
+
+opts = { 
+  width: 56, # Integer | The width of the recorder to present.
+  video_id: "video_id_example" # String | The id of the video to record
+}
+
+begin
+  #Get Live Video Recorder HTML
+  result = api_instance.get_video_recorder(opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling VideosApi->get_video_recorder: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **width** | **Integer**| The width of the recorder to present. | [optional] 
+ **video_id** | **String**| The id of the video to record | [optional] 
+
+### Return type
+
+[**VideoRecorderMethodResponse**](VideoRecorderMethodResponse.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **mark_live_recording_complete**
+> VideoPublicRepresentation mark_live_recording_complete(video_id, filename, title)
+
+Completes a live recording
+
+Used in conjunction with the live recorder method to mark a video recording as complete.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+# setup authorization
+BombBomb.configure do |config|
+  # Configure OAuth2 access token for authorization: BBOAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = BombBomb::VideosApi.new
+
+video_id = "video_id_example" # String | The id of the video to mark as done.
+
+filename = "filename_example" # String | The filename that was chosen as the final video.
+
+title = "title_example" # String | The title to give the video
+
+
+begin
+  #Completes a live recording
+  result = api_instance.mark_live_recording_complete(video_id, filename, title)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling VideosApi->mark_live_recording_complete: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **video_id** | **String**| The id of the video to mark as done. | 
+ **filename** | **String**| The filename that was chosen as the final video. | 
+ **title** | **String**| The title to give the video | 
+
+### Return type
+
+[**VideoPublicRepresentation**](VideoPublicRepresentation.md)
+
+### Authorization
+
+[BBOAuth2](../README.md#BBOAuth2)
+
+### HTTP request headers
+
+ - **Content-Type**: application/x-www-form-urlencoded
+ - **Accept**: application/json
+
+
+
+# **sign_upload**
+> String sign_upload(policy, opts)
+
+Generate Signed Url
+
+Generates a signed url to be used for video uploads.
+
+### Example
+```ruby
+# load the gem
+require 'bombbomb'
+
+api_instance = BombBomb::VideosApi.new
+
+policy = BombBomb::SignUploadRequest.new # SignUploadRequest | The policy to sign
+
+opts = { 
+  v4: true # BOOLEAN | Whether to do v4 signing
+}
+
+begin
+  #Generate Signed Url
+  result = api_instance.sign_upload(policy, opts)
+  p result
+rescue BombBomb::ApiError => e
+  puts "Exception when calling VideosApi->sign_upload: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **policy** | [**SignUploadRequest**](SignUploadRequest.md)| The policy to sign | 
+ **v4** | **BOOLEAN**| Whether to do v4 signing | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+

data/lib/bombbomb.rb

@@ -3,7 +3,7 @@
 
 #We make it easy to build relationships using simple videos.
 
-OpenAPI spec version: 2.0.21454
+OpenAPI spec version: 2.0.22196
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
@@ -37,15 +37,23 @@ require 'bombbomb/models/inline_response_200_items'
 require 'bombbomb/models/jericho_configuration'
 require 'bombbomb/models/jericho_performance'
 require 'bombbomb/models/o_auth_client'
+require 'bombbomb/models/prompt_bot_bot'
+require 'bombbomb/models/sign_upload_request'
+require 'bombbomb/models/sign_upload_response'
 require 'bombbomb/models/string'
 require 'bombbomb/models/team_public_representation'
 require 'bombbomb/models/video_email_prompt'
+require 'bombbomb/models/video_public_representation'
+require 'bombbomb/models/video_recorder_method_response'
 
 # APIs
+require 'bombbomb/api/automations_api'
 require 'bombbomb/api/curriculum_api'
+require 'bombbomb/api/emails_api'
 require 'bombbomb/api/prompts_api'
 require 'bombbomb/api/teams_api'
 require 'bombbomb/api/utilities_api'
+require 'bombbomb/api/videos_api'
 require 'bombbomb/api/webhooks_api'
 
 module BombBomb

data/lib/bombbomb/api/automations_api.rb

@@ -0,0 +1,150 @@
+=begin
+#BombBomb
+
+#We make it easy to build relationships using simple videos.
+
+OpenAPI spec version: 2.0.22196
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+=end
+
+require "uri"
+
+module BombBomb
+  class AutomationsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get Automation Email Stats
+    # Get Automation Email Stats
+    # @param drip_id The id of the drip
+    # @param drip_drop_id The id of the drip drop
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_drip_drop_stats(drip_id, drip_drop_id, opts = {})
+      get_drip_drop_stats_with_http_info(drip_id, drip_drop_id, opts)
+      return nil
+    end
+
+    # Get Automation Email Stats
+    # Get Automation Email Stats
+    # @param drip_id The id of the drip
+    # @param drip_drop_id The id of the drip drop
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_drip_drop_stats_with_http_info(drip_id, drip_drop_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AutomationsApi.get_drip_drop_stats ..."
+      end
+      # verify the required parameter 'drip_id' is set
+      fail ArgumentError, "Missing the required parameter 'drip_id' when calling AutomationsApi.get_drip_drop_stats" if drip_id.nil?
+      # verify the required parameter 'drip_drop_id' is set
+      fail ArgumentError, "Missing the required parameter 'drip_drop_id' when calling AutomationsApi.get_drip_drop_stats" if drip_drop_id.nil?
+      # resource path
+      local_var_path = "/automation/{dripId}/dripdrop/{dripDropId}/stats".sub('{format}','json').sub('{' + 'dripId' + '}', drip_id.to_s).sub('{' + 'dripDropId' + '}', drip_drop_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['BBOAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutomationsApi#get_drip_drop_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Automation Stats
+    # Get Automation Stats
+    # @param id The id of the automation
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_drip_stats(id, opts = {})
+      get_drip_stats_with_http_info(id, opts)
+      return nil
+    end
+
+    # Get Automation Stats
+    # Get Automation Stats
+    # @param id The id of the automation
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_drip_stats_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AutomationsApi.get_drip_stats ..."
+      end
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling AutomationsApi.get_drip_stats" if id.nil?
+      # resource path
+      local_var_path = "/automation/{id}/stats".sub('{format}','json').sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/x-www-form-urlencoded']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['BBOAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutomationsApi#get_drip_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/bombbomb/api/curriculum_api.rb

@@ -3,7 +3,7 @@
 
 #We make it easy to build relationships using simple videos.
 
-OpenAPI spec version: 2.0.21454
+OpenAPI spec version: 2.0.22196
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git