bombbomb 1.0.0 → 2.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (103) hide show
  1. checksums.yaml +5 -13
  2. data/README.md +140 -31
  3. data/bombbomb.gemspec +3 -3
  4. data/docs/AccountsApi.md +384 -0
  5. data/docs/AutomationsApi.md +115 -0
  6. data/docs/ContactsApi.md +436 -0
  7. data/docs/Curriculum.md +15 -0
  8. data/docs/CurriculumApi.md +109 -0
  9. data/docs/CurriculumUserProgress.md +12 -0
  10. data/docs/CurriculumWithProgress.md +15 -0
  11. data/docs/EmailsApi.md +633 -0
  12. data/docs/FilesApi.md +272 -0
  13. data/docs/FormsApi.md +60 -0
  14. data/docs/HostedDoc.md +13 -0
  15. data/docs/IntegrationsApi.md +285 -0
  16. data/docs/JerichoConfiguration.md +6 -1
  17. data/docs/JerichoPerformance.md +4 -0
  18. data/docs/ListsApi.md +265 -0
  19. data/docs/OrdersApi.md +60 -0
  20. data/docs/PromptBot.md +22 -0
  21. data/docs/PromptBotBot.md +18 -0
  22. data/docs/PromptSocialPrompt.md +20 -0
  23. data/docs/PromptsApi.md +661 -7
  24. data/docs/SignUploadRequest.md +9 -0
  25. data/docs/SignUploadResponse.md +9 -0
  26. data/docs/SocialsApi.md +653 -0
  27. data/docs/TeamPublicRepresentation.md +10 -0
  28. data/docs/TeamsApi.md +1048 -64
  29. data/docs/UtilitiesApi.md +5 -5
  30. data/docs/VideoEmailPrompt.md +24 -10
  31. data/docs/VideoEncodingStatusResponse.md +10 -0
  32. data/docs/VideoPublicRepresentation.md +18 -0
  33. data/docs/VideoRecorderMethodResponse.md +15 -0
  34. data/docs/VideosApi.md +287 -0
  35. data/docs/WebhooksApi.md +46 -5
  36. data/lib/bombbomb.rb +25 -1
  37. data/lib/bombbomb/api/accounts_api.rb +459 -0
  38. data/lib/bombbomb/api/automations_api.rb +150 -0
  39. data/lib/bombbomb/api/contacts_api.rb +499 -0
  40. data/lib/bombbomb/api/curriculum_api.rb +143 -0
  41. data/lib/bombbomb/api/emails_api.rb +716 -0
  42. data/lib/bombbomb/api/files_api.rb +323 -0
  43. data/lib/bombbomb/api/forms_api.rb +90 -0
  44. data/lib/bombbomb/api/integrations_api.rb +333 -0
  45. data/lib/bombbomb/api/lists_api.rb +316 -0
  46. data/lib/bombbomb/api/orders_api.rb +91 -0
  47. data/lib/bombbomb/api/prompts_api.rb +761 -8
  48. data/lib/bombbomb/api/socials_api.rb +745 -0
  49. data/lib/bombbomb/api/teams_api.rb +1203 -114
  50. data/lib/bombbomb/api/utilities_api.rb +5 -5
  51. data/lib/bombbomb/api/videos_api.rb +343 -0
  52. data/lib/bombbomb/api/webhooks_api.rb +57 -5
  53. data/lib/bombbomb/api_client.rb +1 -1
  54. data/lib/bombbomb/api_error.rb +1 -1
  55. data/lib/bombbomb/configuration.rb +2 -2
  56. data/lib/bombbomb/models/bb_web_hook.rb +1 -1
  57. data/lib/bombbomb/models/curriculum.rb +272 -0
  58. data/lib/bombbomb/models/curriculum_user_progress.rb +240 -0
  59. data/lib/bombbomb/models/curriculum_with_progress.rb +272 -0
  60. data/lib/bombbomb/models/hosted_doc.rb +250 -0
  61. data/lib/bombbomb/models/inline_response_200.rb +1 -1
  62. data/lib/bombbomb/models/inline_response_200_items.rb +1 -1
  63. data/lib/bombbomb/models/jericho_configuration.rb +56 -6
  64. data/lib/bombbomb/models/jericho_performance.rb +45 -5
  65. data/lib/bombbomb/models/o_auth_client.rb +1 -1
  66. data/lib/bombbomb/models/prompt_bot.rb +340 -0
  67. data/lib/bombbomb/models/prompt_bot_bot.rb +300 -0
  68. data/lib/bombbomb/models/prompt_social_prompt.rb +322 -0
  69. data/lib/bombbomb/models/sign_upload_request.rb +210 -0
  70. data/lib/bombbomb/models/sign_upload_response.rb +210 -0
  71. data/lib/bombbomb/models/string.rb +1 -1
  72. data/lib/bombbomb/models/team_public_representation.rb +220 -0
  73. data/lib/bombbomb/models/video_email_prompt.rb +209 -74
  74. data/lib/bombbomb/models/video_encoding_status_response.rb +220 -0
  75. data/lib/bombbomb/models/video_public_representation.rb +302 -0
  76. data/lib/bombbomb/models/video_recorder_method_response.rb +270 -0
  77. data/lib/bombbomb/version.rb +2 -2
  78. data/spec/api/accounts_api_spec.rb +96 -0
  79. data/spec/api/automations_api_spec.rb +71 -0
  80. data/spec/api/contacts_api_spec.rb +58 -0
  81. data/spec/api/curriculum_api_spec.rb +69 -0
  82. data/spec/api/emails_api_spec.rb +104 -0
  83. data/spec/api/files_api_spec.rb +58 -0
  84. data/spec/api/forms_api_spec.rb +58 -0
  85. data/spec/api/integrations_api_spec.rb +58 -0
  86. data/spec/api/lists_api_spec.rb +83 -0
  87. data/spec/api/orders_api_spec.rb +58 -0
  88. data/spec/api/socials_api_spec.rb +135 -0
  89. data/spec/api/videos_api_spec.rb +86 -0
  90. data/spec/models/curriculum_spec.rb +95 -0
  91. data/spec/models/curriculum_user_progress_spec.rb +77 -0
  92. data/spec/models/curriculum_with_progress_spec.rb +95 -0
  93. data/spec/models/hosted_doc_spec.rb +83 -0
  94. data/spec/models/prompt_bot_bot_spec.rb +113 -0
  95. data/spec/models/prompt_bot_spec.rb +137 -0
  96. data/spec/models/prompt_social_prompt_spec.rb +125 -0
  97. data/spec/models/sign_upload_request_spec.rb +59 -0
  98. data/spec/models/sign_upload_response_spec.rb +59 -0
  99. data/spec/models/team_public_representation_spec.rb +65 -0
  100. data/spec/models/video_encoding_status_response_spec.rb +65 -0
  101. data/spec/models/video_public_representation_spec.rb +113 -0
  102. data/spec/models/video_recorder_method_response_spec.rb +95 -0
  103. metadata +143 -43
checksums.yaml CHANGED
@@ -1,15 +1,7 @@
1
1
  ---
2
- !binary "U0hBMQ==":
3
- metadata.gz: !binary |-
4
- OGZjNmNlYmEwNTRiZjZmNjdiYTE2NGQ4NTc2NjE0NmYyZmU3ZmY0OA==
5
- data.tar.gz: !binary |-
6
- NGY0ODRmNzllN2ViZjI5YTliMWU1Nzg1YjJiNWJhODkwYTAzYmRhNA==
2
+ SHA256:
3
+ metadata.gz: cff8bb80873e06526c7f969d14fda328b14d3ee53d23ff3fb2a2a1c7581a0733
4
+ data.tar.gz: 585d5715cf8cf8c25e8804fca5827d419a22198e8dd367af941bd14f3de08757
7
5
  SHA512:
8
- metadata.gz: !binary |-
9
- YTNjZmE2MjU1N2IxMjQxOWM1NzdhNGI0MTcwOWEzNWIzZTliMTMwZjllNTQw
10
- NjZkN2MxMjgyYWI2ZDI2NjIyMzRlYzg1ODE0YWNjMjJhYTM4ODNmMTNlZGUw
11
- MjY4NzY2MjNhZmMwZTdkZmZmMWMwYTA4ZTFmYWIxOGE4MGU1ZDA=
12
- data.tar.gz: !binary |-
13
- NTg4MzBjMzJiODc1MGQwYjhmZjJhMTkzOGMxZTM5OTE0YTI3YmMzZmE0MDE0
14
- ZTAyMDJmNTYwMDk0NzczNDdlMzU4MmVmMWUwYWZlNjVlMWFmM2ViMTQ5MzU4
15
- NzMyZWVkZmE4NjliOWJlZDhiYmRlMzk4NzAzNmMxYzE0OTkzMWY=
6
+ metadata.gz: b88ae86b5d4b615f17833155aa23344cf6dc35de8ec7075fe8e945720bc2d6866ab16b1ad87feb8339e9fd0c29da7da1fda950e31aad77698a5164c2a332eb44
7
+ data.tar.gz: fde9eabd85cccb66bf9ac680ffec3b82c6aff0410089f5a398cbdf9eedc6ca6489fdf64ed8086acb1b70b219f72b5aef64dd9a4495388d9491119500dd53cf26
data/README.md CHANGED
@@ -6,9 +6,9 @@ We make it easy to build relationships using simple videos.
6
6
 
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
- - API version: 2.0
10
- - Package version: 1.0.0
11
- - Build date: 2016-09-08T16:50:41.458Z
9
+ - API version: 2.0.0
10
+ - Package version: 2.0.0
11
+ - Build date: 2018-05-30T21:55:54.971Z
12
12
  - Build package: class io.swagger.codegen.languages.RubyClientCodegen
13
13
 
14
14
  ## Installation
@@ -24,15 +24,15 @@ gem build bombbomb.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./bombbomb-1.0.0.gem
27
+ gem install ./bombbomb-2.0.0.gem
28
28
  ```
29
- (for development, run `gem install --dev ./bombbomb-1.0.0.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./bombbomb-2.0.0.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'bombbomb', '~> 1.0.0'
35
+ gem 'bombbomb', '~> 2.0.0'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -61,55 +61,156 @@ BombBomb.configure do |config|
61
61
  config.access_token = 'YOUR ACCESS TOKEN'
62
62
  end
63
63
 
64
- api_instance = BombBomb::PromptsApi.new
65
-
66
- prompt = BombBomb::VideoEmailPrompt.new # VideoEmailPrompt | The Video Email Prompt to be created
67
-
64
+ api_instance = BombBomb::AccountsApi.new
68
65
 
69
66
  begin
70
- #Prompts user to send a video
71
- result = api_instance.create_video_email_prompt(prompt)
72
- p result
67
+ #Get account details.
68
+ api_instance.account_details
73
69
  rescue BombBomb::ApiError => e
74
- puts "Exception when calling PromptsApi->create_video_email_prompt: #{e}"
70
+ puts "Exception when calling AccountsApi->account_details: #{e}"
75
71
  end
76
72
 
77
73
  ```
78
74
 
79
75
  ## Documentation for API Endpoints
80
76
 
81
- All URIs are relative to *https://dev.api.bombbomb.com/v2*
77
+ All URIs are relative to *https://api.bombbomb.com/v2*
82
78
 
83
79
  Class | Method | HTTP request | Description
84
80
  ------------ | ------------- | ------------- | -------------
81
+ *BombBomb::AccountsApi* | [**account_details**](docs/AccountsApi.md#account_details) | **GET** /accounts | Get account details.
82
+ *BombBomb::AccountsApi* | [**create_account**](docs/AccountsApi.md#create_account) | **POST** /accounts | Create Account
83
+ *BombBomb::AccountsApi* | [**get_client_statistics**](docs/AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
84
+ *BombBomb::AccountsApi* | [**get_user_country**](docs/AccountsApi.md#get_user_country) | **GET** /accounts/{clientId}/country | Gets user country
85
+ *BombBomb::AccountsApi* | [**reset_api_key**](docs/AccountsApi.md#reset_api_key) | **PUT** /accounts/apikey | Reset API key
86
+ *BombBomb::AccountsApi* | [**subscription_purchase_allowed**](docs/AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
87
+ *BombBomb::AccountsApi* | [**update_profile_data**](docs/AccountsApi.md#update_profile_data) | **POST** /account/profile/ | Add profile information.
88
+ *BombBomb::AutomationsApi* | [**get_drip_drop_stats**](docs/AutomationsApi.md#get_drip_drop_stats) | **GET** /automation/{dripId}/dripdrop/{dripDropId}/stats | Get Automation Email Stats
89
+ *BombBomb::AutomationsApi* | [**get_drip_stats**](docs/AutomationsApi.md#get_drip_stats) | **GET** /automation/{id}/stats | Get Automation Stats
90
+ *BombBomb::ContactsApi* | [**add_contacts_csv**](docs/ContactsApi.md#add_contacts_csv) | **POST** /contacts/import_csv | Add contacts from a CSV file.
91
+ *BombBomb::ContactsApi* | [**add_new_contact**](docs/ContactsApi.md#add_new_contact) | **POST** /contacts/ | Add a contact.
92
+ *BombBomb::ContactsApi* | [**add_new_custom_field**](docs/ContactsApi.md#add_new_custom_field) | **POST** /contacts/custom_fields/ | Add custom fields.
93
+ *BombBomb::ContactsApi* | [**add_pasted_contacts**](docs/ContactsApi.md#add_pasted_contacts) | **POST** /contacts/paste | Add pasted contacts.
94
+ *BombBomb::ContactsApi* | [**c_sv_to_object**](docs/ContactsApi.md#c_sv_to_object) | **POST** /csv-to-object | Format CSV.
95
+ *BombBomb::ContactsApi* | [**delete_contacts**](docs/ContactsApi.md#delete_contacts) | **PUT** /contacts/delete | Delete Contacts
96
+ *BombBomb::ContactsApi* | [**get_contact_by_id**](docs/ContactsApi.md#get_contact_by_id) | **GET** /contact/{id} | Get Contact Details
97
+ *BombBomb::ContactsApi* | [**get_custom_fields**](docs/ContactsApi.md#get_custom_fields) | **GET** /contacts/custom_fields/ | Get custom fields.
98
+ *BombBomb::CurriculumApi* | [**get_curricula**](docs/CurriculumApi.md#get_curricula) | **GET** /curricula/ | Get Curricula
99
+ *BombBomb::CurriculumApi* | [**get_user_curriculum_with_progress**](docs/CurriculumApi.md#get_user_curriculum_with_progress) | **GET** /curriculum/getForUserWithProgress | Get Detailed For User
100
+ *BombBomb::EmailsApi* | [**create_printing_press_email**](docs/EmailsApi.md#create_printing_press_email) | **POST** /emails/print | Create an Email with Printing Press
101
+ *BombBomb::EmailsApi* | [**get_all_templates_for_current_user**](docs/EmailsApi.md#get_all_templates_for_current_user) | **GET** /emails/templates | Get all user templates
102
+ *BombBomb::EmailsApi* | [**get_email_tracking**](docs/EmailsApi.md#get_email_tracking) | **GET** /emails/{emailId}/tracking | Get Email Tracking
103
+ *BombBomb::EmailsApi* | [**get_email_tracking_interactions**](docs/EmailsApi.md#get_email_tracking_interactions) | **GET** /emails/{emailId}/tracking/interactions | Get Email Tracking Interactions
104
+ *BombBomb::EmailsApi* | [**get_hourly_email_tracking**](docs/EmailsApi.md#get_hourly_email_tracking) | **GET** /emails/{emailId}/tracking/hourly | Get Hourly Email Tracking
105
+ *BombBomb::EmailsApi* | [**get_live_fire_data**](docs/EmailsApi.md#get_live_fire_data) | **GET** /emails/livefire | Get livefire feed data
106
+ *BombBomb::EmailsApi* | [**get_quick_send_templates**](docs/EmailsApi.md#get_quick_send_templates) | **GET** /emails/quicksend/templates | Get all quicksend templates
107
+ *BombBomb::EmailsApi* | [**get_template_html_for_template_id**](docs/EmailsApi.md#get_template_html_for_template_id) | **GET** /emails/templates/{templateId}/html | Get the HTML for a given template
108
+ *BombBomb::EmailsApi* | [**get_video_quick_sender_data**](docs/EmailsApi.md#get_video_quick_sender_data) | **GET** /emails/quicksend | Get quicksend data
109
+ *BombBomb::EmailsApi* | [**save_quick_sender_settings**](docs/EmailsApi.md#save_quick_sender_settings) | **POST** /emails/quicksend/settings | Save quicksender settings
110
+ *BombBomb::EmailsApi* | [**video_quick_sender**](docs/EmailsApi.md#video_quick_sender) | **POST** /emails/quicksend | Send a quicksend email
111
+ *BombBomb::FilesApi* | [**doc_host_delete**](docs/FilesApi.md#doc_host_delete) | **DELETE** /files/{docId} | Delete file
112
+ *BombBomb::FilesApi* | [**doc_host_get**](docs/FilesApi.md#doc_host_get) | **GET** /files/{docId} | Get file
113
+ *BombBomb::FilesApi* | [**doc_host_list**](docs/FilesApi.md#doc_host_list) | **GET** /files | List all files
114
+ *BombBomb::FilesApi* | [**doc_host_upload_v2**](docs/FilesApi.md#doc_host_upload_v2) | **POST** /files | Upload a file
115
+ *BombBomb::FilesApi* | [**get_hosted_images_paged**](docs/FilesApi.md#get_hosted_images_paged) | **GET** /files/images/paged | Get paged hosted images
116
+ *BombBomb::FormsApi* | [**get_form_tracking_as_csv**](docs/FormsApi.md#get_form_tracking_as_csv) | **GET** /forms/{id}/tracking/export | Get csv
117
+ *BombBomb::IntegrationsApi* | [**connect_integration**](docs/IntegrationsApi.md#connect_integration) | **POST** /integrations | Activate an integration for a user.
118
+ *BombBomb::IntegrationsApi* | [**delete_integration**](docs/IntegrationsApi.md#delete_integration) | **DELETE** /integrations | Remove an integration for a user.
119
+ *BombBomb::IntegrationsApi* | [**get_integration_health**](docs/IntegrationsApi.md#get_integration_health) | **GET** /integrations/health/{code} | Get health for a given integration
120
+ *BombBomb::IntegrationsApi* | [**get_integration_page_components**](docs/IntegrationsApi.md#get_integration_page_components) | **GET** /integrations/pageComponents | Get page components for a given integration
121
+ *BombBomb::IntegrationsApi* | [**sync_users_integrated_lists**](docs/IntegrationsApi.md#sync_users_integrated_lists) | **GET** /integrations/sync | Synchronize your integration list or lists.
122
+ *BombBomb::ListsApi* | [**add_new_list**](docs/ListsApi.md#add_new_list) | **POST** /lists/ | Add list.
123
+ *BombBomb::ListsApi* | [**clear_list**](docs/ListsApi.md#clear_list) | **PUT** /lists/{listId}/clear | Clear Contacts from List
124
+ *BombBomb::ListsApi* | [**copy_list_contacts**](docs/ListsApi.md#copy_list_contacts) | **POST** /lists/{listId}/copy | Copy All Contacts from a List
125
+ *BombBomb::ListsApi* | [**get_all_lists**](docs/ListsApi.md#get_all_lists) | **GET** /lists/ | Get all Lists
126
+ *BombBomb::ListsApi* | [**suppress_all_in_list**](docs/ListsApi.md#suppress_all_in_list) | **PUT** /lists/{listId}/suppress | Suppress All Contacts from List
127
+ *BombBomb::OrdersApi* | [**template_asset_delete**](docs/OrdersApi.md#template_asset_delete) | **DELETE** /orders/templates/images | Deletes image from user s3 store
128
+ *BombBomb::PromptsApi* | [**create_prompt_bot**](docs/PromptsApi.md#create_prompt_bot) | **POST** /prompts/bots | Create a running Prompt Bot for a list
85
129
  *BombBomb::PromptsApi* | [**create_video_email_prompt**](docs/PromptsApi.md#create_video_email_prompt) | **POST** /prompt | Prompts user to send a video
130
+ *BombBomb::PromptsApi* | [**get_alternate_campaign_content**](docs/PromptsApi.md#get_alternate_campaign_content) | **GET** /campaign/{campaignId}/content/alternate | List alternate campaign content
131
+ *BombBomb::PromptsApi* | [**get_pending_video_email_prompts**](docs/PromptsApi.md#get_pending_video_email_prompts) | **GET** /prompt/pending | List pending prompts
132
+ *BombBomb::PromptsApi* | [**get_prompt_bots**](docs/PromptsApi.md#get_prompt_bots) | **GET** /prompts/bots | List Prompt Bots
133
+ *BombBomb::PromptsApi* | [**get_prompt_campaigns**](docs/PromptsApi.md#get_prompt_campaigns) | **GET** /prompts/{userId}/campaigns | List Prompt Campaigns
86
134
  *BombBomb::PromptsApi* | [**get_video_email_prompt**](docs/PromptsApi.md#get_video_email_prompt) | **GET** /prompt/{id} | Gets a prompt
135
+ *BombBomb::PromptsApi* | [**get_video_email_prompts**](docs/PromptsApi.md#get_video_email_prompts) | **GET** /prompt/ | List prompts
87
136
  *BombBomb::PromptsApi* | [**respond_to_video_email_prompt**](docs/PromptsApi.md#respond_to_video_email_prompt) | **POST** /prompt/{id}/response | Respond to a prompt
137
+ *BombBomb::PromptsApi* | [**sync_prompt_subscriptions**](docs/PromptsApi.md#sync_prompt_subscriptions) | **POST** /prompts/campaigns/sync | Syncs Campaigns and One to Ones Subscriptions for User
138
+ *BombBomb::PromptsApi* | [**update_prompt**](docs/PromptsApi.md#update_prompt) | **PUT** /prompts/{id} | Update Prompt
139
+ *BombBomb::PromptsApi* | [**update_prompt_bot**](docs/PromptsApi.md#update_prompt_bot) | **PUT** /prompts/bots/{id} | Update Prompt Bot
140
+ *BombBomb::PromptsApi* | [**update_prompt_campaign**](docs/PromptsApi.md#update_prompt_campaign) | **PUT** /prompts/campaigns/{id} | Update Prompt Campaign
141
+ *BombBomb::PromptsApi* | [**update_prompt_template**](docs/PromptsApi.md#update_prompt_template) | **PUT** /prompts/{id}/content | Update Prompt Content
142
+ *BombBomb::SocialsApi* | [**get_facebook_pages**](docs/SocialsApi.md#get_facebook_pages) | **GET** /socials/facebook/pages | Gets facebook pages
143
+ *BombBomb::SocialsApi* | [**get_social_article_properties**](docs/SocialsApi.md#get_social_article_properties) | **GET** /socials/properties | Gets the social email properties
144
+ *BombBomb::SocialsApi* | [**get_social_authorizations**](docs/SocialsApi.md#get_social_authorizations) | **GET** /socials/authorizations | Get authorizations for all social integration
145
+ *BombBomb::SocialsApi* | [**get_social_profile_properties**](docs/SocialsApi.md#get_social_profile_properties) | **GET** /socials/profile | Gets the profile properties
146
+ *BombBomb::SocialsApi* | [**get_social_stats**](docs/SocialsApi.md#get_social_stats) | **GET** /socials/{promptId}/stats | Get social stats for a prompt
147
+ *BombBomb::SocialsApi* | [**post_social_content**](docs/SocialsApi.md#post_social_content) | **POST** /socials/content | Creates social content
148
+ *BombBomb::SocialsApi* | [**retry_social_send**](docs/SocialsApi.md#retry_social_send) | **POST** /socials/send/retry | Sends social content
149
+ *BombBomb::SocialsApi* | [**send_social**](docs/SocialsApi.md#send_social) | **POST** /socials/send | Sends social content
150
+ *BombBomb::SocialsApi* | [**update_client_group_send_mechanism**](docs/SocialsApi.md#update_client_group_send_mechanism) | **PUT** /socials/client/sendMechanism | Gets the auto shares from the client group assoc id
151
+ *BombBomb::SocialsApi* | [**update_client_groups_send_mechanism**](docs/SocialsApi.md#update_client_groups_send_mechanism) | **PUT** /socials/client/sendMechanisms | Toggles the prompt campaigns in a users account
152
+ *BombBomb::SocialsApi* | [**update_facebook_pages**](docs/SocialsApi.md#update_facebook_pages) | **PUT** /socials/facebook/pages | Updates facebook page Ids
153
+ *BombBomb::SocialsApi* | [**update_social_content**](docs/SocialsApi.md#update_social_content) | **PUT** /socials/content | Updates social content
154
+ *BombBomb::TeamsApi* | [**add_team_member**](docs/TeamsApi.md#add_team_member) | **POST** /team/{teamId}/member | Add Member to Team
155
+ *BombBomb::TeamsApi* | [**add_users**](docs/TeamsApi.md#add_users) | **POST** /team/{teamId}/members | Add users to group.
156
+ *BombBomb::TeamsApi* | [**add_users_from_csv**](docs/TeamsApi.md#add_users_from_csv) | **POST** /team/{teamId}/members/csv | Add members to group from CSV
88
157
  *BombBomb::TeamsApi* | [**cancel_jericho_send**](docs/TeamsApi.md#cancel_jericho_send) | **DELETE** /team/{teamId}/jericho/{jerichoId} | Cancel a Jericho Send
158
+ *BombBomb::TeamsApi* | [**create_subteam**](docs/TeamsApi.md#create_subteam) | **POST** /team/{teamId}/subteam | Add a Subteam
159
+ *BombBomb::TeamsApi* | [**delete_subteam**](docs/TeamsApi.md#delete_subteam) | **DELETE** /team/{teamId}/subteam | Delete Subteam
160
+ *BombBomb::TeamsApi* | [**get_all_client_group_associations**](docs/TeamsApi.md#get_all_client_group_associations) | **GET** /team/associations/ | Lists team associations
89
161
  *BombBomb::TeamsApi* | [**get_client_group_assets**](docs/TeamsApi.md#get_client_group_assets) | **GET** /team/assets/ | Lists team assets
162
+ *BombBomb::TeamsApi* | [**get_client_group_statistics**](docs/TeamsApi.md#get_client_group_statistics) | **GET** /team/{teamId}/stats | Get Team statistics
90
163
  *BombBomb::TeamsApi* | [**get_jericho_sends**](docs/TeamsApi.md#get_jericho_sends) | **GET** /team/{teamId}/jericho | List Jericho Sends
91
164
  *BombBomb::TeamsApi* | [**get_jericho_stats**](docs/TeamsApi.md#get_jericho_stats) | **GET** /team/{teamId}/jericho/{jerichoId}/performance | Gets Jericho performance statistics
165
+ *BombBomb::TeamsApi* | [**get_paged_client_group_members**](docs/TeamsApi.md#get_paged_client_group_members) | **GET** /team/{teamId}/members | List Team Members
166
+ *BombBomb::TeamsApi* | [**get_subteams**](docs/TeamsApi.md#get_subteams) | **GET** /team/{teamId}/subteam | List Subteams
167
+ *BombBomb::TeamsApi* | [**get_team_prompt_aggregate_stats**](docs/TeamsApi.md#get_team_prompt_aggregate_stats) | **GET** /team/{clientGroupId}/campaign/stats | Get aggregate stats for campaigns
168
+ *BombBomb::TeamsApi* | [**get_team_prompt_campaigns**](docs/TeamsApi.md#get_team_prompt_campaigns) | **GET** /team/{clientGroupId}/campaign | Get campaigns for team
169
+ *BombBomb::TeamsApi* | [**invite_to_social_prompt_team**](docs/TeamsApi.md#invite_to_social_prompt_team) | **POST** /teams/prompt/invite | Invite a list to join the admin's social prompt team
92
170
  *BombBomb::TeamsApi* | [**queue_jericho_send**](docs/TeamsApi.md#queue_jericho_send) | **POST** /team/{teamId}/jericho | Creates a Jericho send.
171
+ *BombBomb::TeamsApi* | [**remove_member_from_team**](docs/TeamsApi.md#remove_member_from_team) | **DELETE** /team/{teamId}/member/{userId} | Remove Member from Team
172
+ *BombBomb::TeamsApi* | [**resend_team_member_invitation**](docs/TeamsApi.md#resend_team_member_invitation) | **POST** /team/{teamId}/{memberUserId}/rewelcome | Resend invite
173
+ *BombBomb::TeamsApi* | [**update_jericho_prompt_send**](docs/TeamsApi.md#update_jericho_prompt_send) | **PUT** /team/{teamId}/jericho/{jerichoId} | Updates the Jericho Prompt Settings
174
+ *BombBomb::TeamsApi* | [**update_team**](docs/TeamsApi.md#update_team) | **POST** /team/{teamId} | Update a team
175
+ *BombBomb::TeamsApi* | [**update_team_member**](docs/TeamsApi.md#update_team_member) | **PUT** /team/{teamId}/member | Update Member of Team
93
176
  *BombBomb::UtilitiesApi* | [**create_o_auth_client**](docs/UtilitiesApi.md#create_o_auth_client) | **POST** /oauthclient | Create an OAuth Client
94
177
  *BombBomb::UtilitiesApi* | [**delete_o_auth_client**](docs/UtilitiesApi.md#delete_o_auth_client) | **DELETE** /oauthclient/{id} | Delete an OAuth Client
95
178
  *BombBomb::UtilitiesApi* | [**get_o_auth_clients**](docs/UtilitiesApi.md#get_o_auth_clients) | **GET** /oauthclient | Lists OAuth Clients
96
179
  *BombBomb::UtilitiesApi* | [**get_spec**](docs/UtilitiesApi.md#get_spec) | **GET** /spec | Describes this api
180
+ *BombBomb::VideosApi* | [**get_video_encoding_status**](docs/VideosApi.md#get_video_encoding_status) | **GET** /videos/{videoId}/status | Video Encoding Status
181
+ *BombBomb::VideosApi* | [**get_video_recorder**](docs/VideosApi.md#get_video_recorder) | **GET** /videos/live/getRecorder | Get Live Video Recorder HTML
182
+ *BombBomb::VideosApi* | [**mark_live_recording_complete**](docs/VideosApi.md#mark_live_recording_complete) | **POST** /videos/live/markComplete | Completes a live recording
183
+ *BombBomb::VideosApi* | [**sign_upload**](docs/VideosApi.md#sign_upload) | **POST** /video/signedUpload | Generate Signed Url
184
+ *BombBomb::VideosApi* | [**update_video_thumbnail_v2**](docs/VideosApi.md#update_video_thumbnail_v2) | **PUT** /videos/thumbnail | Upload thumbnail
97
185
  *BombBomb::WebhooksApi* | [**add_web_hook**](docs/WebhooksApi.md#add_web_hook) | **POST** /webhook | Add Webhook
98
186
  *BombBomb::WebhooksApi* | [**delete_web_hook**](docs/WebhooksApi.md#delete_web_hook) | **DELETE** /webhook/{hookId} | Deletes Webhook
99
187
  *BombBomb::WebhooksApi* | [**get_web_hooks**](docs/WebhooksApi.md#get_web_hooks) | **GET** /webhook/ | Lists Webhooks
188
+ *BombBomb::WebhooksApi* | [**list_web_hook_events**](docs/WebhooksApi.md#list_web_hook_events) | **GET** /webhook/events | Describe WebHook Events
100
189
  *BombBomb::WebhooksApi* | [**send_webhook_example**](docs/WebhooksApi.md#send_webhook_example) | **POST** /webhook/test | Sends test Webhook
101
190
 
102
191
 
103
192
  ## Documentation for Models
104
193
 
105
194
  - [BombBomb::BBWebHook](docs/BBWebHook.md)
195
+ - [BombBomb::Curriculum](docs/Curriculum.md)
196
+ - [BombBomb::CurriculumUserProgress](docs/CurriculumUserProgress.md)
197
+ - [BombBomb::CurriculumWithProgress](docs/CurriculumWithProgress.md)
198
+ - [BombBomb::HostedDoc](docs/HostedDoc.md)
106
199
  - [BombBomb::InlineResponse200](docs/InlineResponse200.md)
107
200
  - [BombBomb::InlineResponse200Items](docs/InlineResponse200Items.md)
108
201
  - [BombBomb::JerichoConfiguration](docs/JerichoConfiguration.md)
109
202
  - [BombBomb::JerichoPerformance](docs/JerichoPerformance.md)
110
203
  - [BombBomb::OAuthClient](docs/OAuthClient.md)
204
+ - [BombBomb::PromptBot](docs/PromptBot.md)
205
+ - [BombBomb::PromptSocialPrompt](docs/PromptSocialPrompt.md)
206
+ - [BombBomb::SignUploadRequest](docs/SignUploadRequest.md)
207
+ - [BombBomb::SignUploadResponse](docs/SignUploadResponse.md)
111
208
  - [BombBomb::String](docs/String.md)
209
+ - [BombBomb::TeamPublicRepresentation](docs/TeamPublicRepresentation.md)
112
210
  - [BombBomb::VideoEmailPrompt](docs/VideoEmailPrompt.md)
211
+ - [BombBomb::VideoEncodingStatusResponse](docs/VideoEncodingStatusResponse.md)
212
+ - [BombBomb::VideoPublicRepresentation](docs/VideoPublicRepresentation.md)
213
+ - [BombBomb::VideoRecorderMethodResponse](docs/VideoRecorderMethodResponse.md)
113
214
 
114
215
 
115
216
  ## Documentation for Authorization
@@ -119,21 +220,29 @@ Class | Method | HTTP request | Description
119
220
 
120
221
  - **Type**: OAuth
121
222
  - **Flow**: implicit
122
- - **Authorization URL**: https://dev.app.bombbomb.com/auth/authorize
223
+ - **Authorization URL**: https://app.bombbomb.com/auth/authorize
123
224
  - **Scopes**:
124
- - all:manage: Manage All
125
- - all:read: Read All
126
- - email:manage: Manage Email
127
- - email:read: Read Email
128
- - video:manage: Manage Video
129
- - video:read: Read Video
130
- - contact:manage: Manage Contact
131
- - contact:read: Read Contact
132
- - automation:manage: Manage Automation
133
- - automation:read: Read Automation
134
- - form:manage: Manage Form
135
- - form:read: Read Form
136
- - team:manage: Manage Team
137
- - team:read: Read Team
138
- - settings:manage: Manage Settings
225
+ - all:manage: View & Manage your BombBomb information
226
+ - all:read: View your BombBomb information
227
+ - email:manage: View & Manage your BombBomb emails
228
+ - email:read: View your BombBomb emails
229
+ - video:manage: View & Manage your BombBomb videos
230
+ - video:read: View your BombBomb videos
231
+ - contact:manage: View & Manage your BombBomb contacts
232
+ - contact:read: View your BombBomb contacts
233
+ - curriculum:manage: View & Manage your BombBomb challenges
234
+ - curriculum:read: View your BombBomb challenges
235
+ - automation:manage: View & Manage your BombBomb automations
236
+ - automation:read: View your BombBomb automations
237
+ - form:manage: View & Manage your BombBomb forms
238
+ - form:read: View your BombBomb forms
239
+ - list:manage: View & Manage your BombBomb lists
240
+ - team:manage: View & Manage your BombBomb teams
241
+ - team:read: View your BombBomb teams
242
+ - order:manage: Manage your BombBomb orders
243
+ - settings:manage: Manage your BombBomb settings
244
+ - file:manage: View & Manage your BombBomb files
245
+ - file:read: View your BombBomb files
246
+ - account:manage: View & Manage your BombBomb account
247
+ - account:read: View your BombBomb account
139
248
 
@@ -5,7 +5,7 @@
5
5
 
6
6
  #We make it easy to build relationships using simple videos.
7
7
 
8
- OpenAPI spec version: 2.0
8
+ OpenAPI spec version: 2.0.0
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
 
@@ -30,8 +30,8 @@ Gem::Specification.new do |s|
30
30
  s.name = "bombbomb"
31
31
  s.version = BombBomb::VERSION
32
32
  s.platform = Gem::Platform::RUBY
33
- s.authors = ["Swagger-Codegen"]
34
- s.email = [""]
33
+ s.authors = ["BombBomb"]
34
+ s.email = ["support@bombbomb.com"]
35
35
  s.homepage = "http://developer.bombbomb.com"
36
36
  s.summary = "A ruby wrapper for BombBomb's API"
37
37
  s.description = "We make it easy to build relationships using simple videos."
@@ -0,0 +1,384 @@
1
+ # BombBomb::AccountsApi
2
+
3
+ All URIs are relative to *https://api.bombbomb.com/v2*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**account_details**](AccountsApi.md#account_details) | **GET** /accounts | Get account details.
8
+ [**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create Account
9
+ [**get_client_statistics**](AccountsApi.md#get_client_statistics) | **GET** /accounts/stats | Get Client Statistics
10
+ [**get_user_country**](AccountsApi.md#get_user_country) | **GET** /accounts/{clientId}/country | Gets user country
11
+ [**reset_api_key**](AccountsApi.md#reset_api_key) | **PUT** /accounts/apikey | Reset API key
12
+ [**subscription_purchase_allowed**](AccountsApi.md#subscription_purchase_allowed) | **GET** /accounts/purchaseable | Check if subscription purchase allowed.
13
+ [**update_profile_data**](AccountsApi.md#update_profile_data) | **POST** /account/profile/ | Add profile information.
14
+
15
+
16
+ # **account_details**
17
+ > account_details
18
+
19
+ Get account details.
20
+
21
+ Get the details of the user's account.
22
+
23
+ ### Example
24
+ ```ruby
25
+ # load the gem
26
+ require 'bombbomb'
27
+ # setup authorization
28
+ BombBomb.configure do |config|
29
+ # Configure OAuth2 access token for authorization: BBOAuth2
30
+ config.access_token = 'YOUR ACCESS TOKEN'
31
+ end
32
+
33
+ api_instance = BombBomb::AccountsApi.new
34
+
35
+ begin
36
+ #Get account details.
37
+ api_instance.account_details
38
+ rescue BombBomb::ApiError => e
39
+ puts "Exception when calling AccountsApi->account_details: #{e}"
40
+ end
41
+ ```
42
+
43
+ ### Parameters
44
+ This endpoint does not need any parameter.
45
+
46
+ ### Return type
47
+
48
+ nil (empty response body)
49
+
50
+ ### Authorization
51
+
52
+ [BBOAuth2](../README.md#BBOAuth2)
53
+
54
+ ### HTTP request headers
55
+
56
+ - **Content-Type**: application/x-www-form-urlencoded
57
+ - **Accept**: application/json
58
+
59
+
60
+
61
+ # **create_account**
62
+ > String create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
63
+
64
+ Create Account
65
+
66
+ Creates a new BombBomb account. This method is currently only available to paid seat admins.
67
+
68
+ ### Example
69
+ ```ruby
70
+ # load the gem
71
+ require 'bombbomb'
72
+ # setup authorization
73
+ BombBomb.configure do |config|
74
+ # Configure OAuth2 access token for authorization: BBOAuth2
75
+ config.access_token = 'YOUR ACCESS TOKEN'
76
+ end
77
+
78
+ api_instance = BombBomb::AccountsApi.new
79
+
80
+ team_id = "team_id_example" # String | The team id
81
+
82
+ first_name = "first_name_example" # String | First name of the user.
83
+
84
+ last_name = "last_name_example" # String | Last name of the user.
85
+
86
+ email_address = "email_address_example" # String | Email address of the user.
87
+
88
+ company_name = "company_name_example" # String | Company of the user.
89
+
90
+ phone = "phone_example" # String | Phone number of the user.
91
+
92
+ opts = {
93
+ country: "country_example", # String | Country of the user.
94
+ industry: "industry_example", # String | Industry of the user.
95
+ address: "address_example", # String | Street Address of the user.
96
+ city: "city_example", # String | City of the user.
97
+ postal_code: "postal_code_example", # String | Postal/Zip code of the user.
98
+ prevent_welcome_email: true # BOOLEAN | prevent an email with login credentials from being sent to the new account. must be set to 'true'
99
+ }
100
+
101
+ begin
102
+ #Create Account
103
+ result = api_instance.create_account(team_id, first_name, last_name, email_address, company_name, phone, opts)
104
+ p result
105
+ rescue BombBomb::ApiError => e
106
+ puts "Exception when calling AccountsApi->create_account: #{e}"
107
+ end
108
+ ```
109
+
110
+ ### Parameters
111
+
112
+ Name | Type | Description | Notes
113
+ ------------- | ------------- | ------------- | -------------
114
+ **team_id** | **String**| The team id |
115
+ **first_name** | **String**| First name of the user. |
116
+ **last_name** | **String**| Last name of the user. |
117
+ **email_address** | **String**| Email address of the user. |
118
+ **company_name** | **String**| Company of the user. |
119
+ **phone** | **String**| Phone number of the user. |
120
+ **country** | **String**| Country of the user. | [optional]
121
+ **industry** | **String**| Industry of the user. | [optional]
122
+ **address** | **String**| Street Address of the user. | [optional]
123
+ **city** | **String**| City of the user. | [optional]
124
+ **postal_code** | **String**| Postal/Zip code of the user. | [optional]
125
+ **prevent_welcome_email** | **BOOLEAN**| prevent an email with login credentials from being sent to the new account. must be set to 'true' | [optional]
126
+
127
+ ### Return type
128
+
129
+ **String**
130
+
131
+ ### Authorization
132
+
133
+ [BBOAuth2](../README.md#BBOAuth2)
134
+
135
+ ### HTTP request headers
136
+
137
+ - **Content-Type**: application/x-www-form-urlencoded
138
+ - **Accept**: application/json
139
+
140
+
141
+
142
+ # **get_client_statistics**
143
+ > get_client_statistics(opts)
144
+
145
+ Get Client Statistics
146
+
147
+ Gets general statics for a Client
148
+
149
+ ### Example
150
+ ```ruby
151
+ # load the gem
152
+ require 'bombbomb'
153
+ # setup authorization
154
+ BombBomb.configure do |config|
155
+ # Configure OAuth2 access token for authorization: BBOAuth2
156
+ config.access_token = 'YOUR ACCESS TOKEN'
157
+ end
158
+
159
+ api_instance = BombBomb::AccountsApi.new
160
+
161
+ opts = {
162
+ client_id: "client_id_example", # String | Client ID of the account to retrieve. Defaults to yourself.
163
+ refresh: true, # BOOLEAN | Boolean for whether data returned should be from cache or not.
164
+ statistic_values: "statistic_values_example" # String | Array of data that should be returned, used exclusively for cacheless data
165
+ }
166
+
167
+ begin
168
+ #Get Client Statistics
169
+ api_instance.get_client_statistics(opts)
170
+ rescue BombBomb::ApiError => e
171
+ puts "Exception when calling AccountsApi->get_client_statistics: #{e}"
172
+ end
173
+ ```
174
+
175
+ ### Parameters
176
+
177
+ Name | Type | Description | Notes
178
+ ------------- | ------------- | ------------- | -------------
179
+ **client_id** | **String**| Client ID of the account to retrieve. Defaults to yourself. | [optional]
180
+ **refresh** | **BOOLEAN**| Boolean for whether data returned should be from cache or not. | [optional]
181
+ **statistic_values** | **String**| Array of data that should be returned, used exclusively for cacheless data | [optional]
182
+
183
+ ### Return type
184
+
185
+ nil (empty response body)
186
+
187
+ ### Authorization
188
+
189
+ [BBOAuth2](../README.md#BBOAuth2)
190
+
191
+ ### HTTP request headers
192
+
193
+ - **Content-Type**: application/x-www-form-urlencoded
194
+ - **Accept**: application/json
195
+
196
+
197
+
198
+ # **get_user_country**
199
+ > get_user_country
200
+
201
+ Gets user country
202
+
203
+ Gets the users country
204
+
205
+ ### Example
206
+ ```ruby
207
+ # load the gem
208
+ require 'bombbomb'
209
+ # setup authorization
210
+ BombBomb.configure do |config|
211
+ # Configure OAuth2 access token for authorization: BBOAuth2
212
+ config.access_token = 'YOUR ACCESS TOKEN'
213
+ end
214
+
215
+ api_instance = BombBomb::AccountsApi.new
216
+
217
+ begin
218
+ #Gets user country
219
+ api_instance.get_user_country
220
+ rescue BombBomb::ApiError => e
221
+ puts "Exception when calling AccountsApi->get_user_country: #{e}"
222
+ end
223
+ ```
224
+
225
+ ### Parameters
226
+ This endpoint does not need any parameter.
227
+
228
+ ### Return type
229
+
230
+ nil (empty response body)
231
+
232
+ ### Authorization
233
+
234
+ [BBOAuth2](../README.md#BBOAuth2)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: application/x-www-form-urlencoded
239
+ - **Accept**: application/json
240
+
241
+
242
+
243
+ # **reset_api_key**
244
+ > reset_api_key
245
+
246
+ Reset API key
247
+
248
+ Resets the current user's API key and returns the new key
249
+
250
+ ### Example
251
+ ```ruby
252
+ # load the gem
253
+ require 'bombbomb'
254
+ # setup authorization
255
+ BombBomb.configure do |config|
256
+ # Configure OAuth2 access token for authorization: BBOAuth2
257
+ config.access_token = 'YOUR ACCESS TOKEN'
258
+ end
259
+
260
+ api_instance = BombBomb::AccountsApi.new
261
+
262
+ begin
263
+ #Reset API key
264
+ api_instance.reset_api_key
265
+ rescue BombBomb::ApiError => e
266
+ puts "Exception when calling AccountsApi->reset_api_key: #{e}"
267
+ end
268
+ ```
269
+
270
+ ### Parameters
271
+ This endpoint does not need any parameter.
272
+
273
+ ### Return type
274
+
275
+ nil (empty response body)
276
+
277
+ ### Authorization
278
+
279
+ [BBOAuth2](../README.md#BBOAuth2)
280
+
281
+ ### HTTP request headers
282
+
283
+ - **Content-Type**: application/x-www-form-urlencoded
284
+ - **Accept**: application/json
285
+
286
+
287
+
288
+ # **subscription_purchase_allowed**
289
+ > subscription_purchase_allowed
290
+
291
+ Check if subscription purchase allowed.
292
+
293
+ Check whether the user can purchase a subscription.
294
+
295
+ ### Example
296
+ ```ruby
297
+ # load the gem
298
+ require 'bombbomb'
299
+ # setup authorization
300
+ BombBomb.configure do |config|
301
+ # Configure OAuth2 access token for authorization: BBOAuth2
302
+ config.access_token = 'YOUR ACCESS TOKEN'
303
+ end
304
+
305
+ api_instance = BombBomb::AccountsApi.new
306
+
307
+ begin
308
+ #Check if subscription purchase allowed.
309
+ api_instance.subscription_purchase_allowed
310
+ rescue BombBomb::ApiError => e
311
+ puts "Exception when calling AccountsApi->subscription_purchase_allowed: #{e}"
312
+ end
313
+ ```
314
+
315
+ ### Parameters
316
+ This endpoint does not need any parameter.
317
+
318
+ ### Return type
319
+
320
+ nil (empty response body)
321
+
322
+ ### Authorization
323
+
324
+ [BBOAuth2](../README.md#BBOAuth2)
325
+
326
+ ### HTTP request headers
327
+
328
+ - **Content-Type**: application/x-www-form-urlencoded
329
+ - **Accept**: application/json
330
+
331
+
332
+
333
+ # **update_profile_data**
334
+ > update_profile_data(opts)
335
+
336
+ Add profile information.
337
+
338
+ Add profile information to this users account
339
+
340
+ ### Example
341
+ ```ruby
342
+ # load the gem
343
+ require 'bombbomb'
344
+ # setup authorization
345
+ BombBomb.configure do |config|
346
+ # Configure OAuth2 access token for authorization: BBOAuth2
347
+ config.access_token = 'YOUR ACCESS TOKEN'
348
+ end
349
+
350
+ api_instance = BombBomb::AccountsApi.new
351
+
352
+ opts = {
353
+ profile_data: "profile_data_example" # String | Profile field information for the account
354
+ }
355
+
356
+ begin
357
+ #Add profile information.
358
+ api_instance.update_profile_data(opts)
359
+ rescue BombBomb::ApiError => e
360
+ puts "Exception when calling AccountsApi->update_profile_data: #{e}"
361
+ end
362
+ ```
363
+
364
+ ### Parameters
365
+
366
+ Name | Type | Description | Notes
367
+ ------------- | ------------- | ------------- | -------------
368
+ **profile_data** | **String**| Profile field information for the account | [optional]
369
+
370
+ ### Return type
371
+
372
+ nil (empty response body)
373
+
374
+ ### Authorization
375
+
376
+ [BBOAuth2](../README.md#BBOAuth2)
377
+
378
+ ### HTTP request headers
379
+
380
+ - **Content-Type**: application/x-www-form-urlencoded
381
+ - **Accept**: application/json
382
+
383
+
384
+