gong_api 1.0.0

data/docs/UpdateMeetingRequest.md

@@ -0,0 +1,12 @@
+# GongAPI::UpdateMeetingRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**end_time** | **String** | The meeting end time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**external_id** | **String** | The ID as it is formed on the external system. | [optional] 
+**invitees** | [**Array<MeetingInvitee>**](MeetingInvitee.md) | A list of email addresses of invitees to the event (not including the organizer). | 
+**organizer_email** | **String** | The email address of the user who created the meeting. | [optional] 
+**start_time** | **String** | The meeting start time in ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**title** | **String** | Title of the event. | [optional] 
+

data/docs/UpdateMeetingResponse.md

@@ -0,0 +1,8 @@
+# GongAPI::UpdateMeetingResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**meeting_id** | **String** | The unique meeting identifier of the meeting. | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+

data/docs/User.md

@@ -0,0 +1,8 @@
+# GongAPI::User
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+**user** | [**UserMetadata**](UserMetadata.md) |  | [optional] 
+

data/docs/UserAccessDetails.md

@@ -0,0 +1,7 @@
+# GongAPI::UserAccessDetails
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_id** | **String** | Gong's unique numeric user ID. | [optional] 
+

data/docs/UserActivity.md

@@ -0,0 +1,9 @@
+# GongAPI::UserActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_aggregate_activity_stats** | [**AggregateActivity**](AggregateActivity.md) |  | [optional] 
+**user_email_address** | **String** | The email address of the Gong user. | [optional] 
+**user_id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional] 
+

data/docs/UserAggregateByPeriodActivities.md

@@ -0,0 +1,9 @@
+# GongAPI::UserAggregateByPeriodActivities
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_aggregate_activity** | [**Array<AggregateActivityWithDates>**](AggregateActivityWithDates.md) | A list, in which each item contains aggregate user activity for consecutive time periods in the date range. | [optional] 
+**user_email_address** | **String** | The email address of the Gong user. | [optional] 
+**user_id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional] 
+

data/docs/UserDayByDayActivity.md

@@ -0,0 +1,9 @@
+# GongAPI::UserDayByDayActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**user_daily_activity_stats** | [**Array<DailyActivityWithDates>**](DailyActivityWithDates.md) | Array of daily activity records, one for every day in the date range. | [optional] 
+**user_email_address** | **String** | The email address of the Gong user. | [optional] 
+**user_id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional] 
+

data/docs/UserIntegrationStatus.md

@@ -0,0 +1,12 @@
+# GongAPI::UserIntegrationStatus
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email** | **String** | The email address meeting organizer | [optional] 
+**exists** | **BOOLEAN** | Whether the user exists in Gong | [optional] 
+**fix_url** | **String** | A URL to place in the application to fix the problem | [optional] 
+**help_url** | **String** | A URL to the Gong help center where more information can be found about the error | [optional] 
+**user_facing_error** | **String** | The message explaining in case the integration is currently not connected | [optional] 
+**valid** | **BOOLEAN** | Whether the integration is connected for the user | [optional] 
+

data/docs/UserMetadata.md

@@ -0,0 +1,21 @@
+# GongAPI::UserMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active** | **BOOLEAN** | True if the user is active, false if not. | [optional] 
+**created** | **String** | Creation time in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC);of the Gong user. | [optional] 
+**email_address** | **String** | The email address of the Gong user. | [optional] 
+**email_aliases** | **Object** | List of email address aliases of the Gong user. | [optional] 
+**extension** | **String** | The extension number of the Gong user. | [optional] 
+**first_name** | **String** | The first name of the Gong user. | [optional] 
+**id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional] 
+**last_name** | **String** | The last name of the Gong user. | [optional] 
+**manager_id** | **String** | The manager ID of the Gong user. | [optional] 
+**meeting_consent_page_url** | **String** | The Gong recording consent meeting link | [optional] 
+**personal_meeting_urls** | **Object** | The list of personal meeting URLs of the Gong user. | [optional] 
+**phone_number** | **String** | The phone number of the Gong user. | [optional] 
+**settings** | [**Settings**](Settings.md) |  | [optional] 
+**spoken_languages** | [**Array<SpokenLanguage>**](SpokenLanguage.md) |  | [optional] 
+**title** | **String** | The job title of the Gong user. | [optional] 
+

data/docs/UserSettingsHistory.md

@@ -0,0 +1,9 @@
+# GongAPI::UserSettingsHistory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**setting** | **String** | The user capability that was changed | [optional] 
+**time** | **String** | The date and time the action was set, in the ISO-8601 format (e.g., '2018-02-18T02:30:00-07:00' or '2018-02-18T08:00:00Z', where Z stands for UTC). | [optional] 
+**value** | **BOOLEAN** | The new value that was set | [optional] 
+

data/docs/UserSimpleMetadata.md

@@ -0,0 +1,9 @@
+# GongAPI::UserSimpleMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**email_address** | **String** | The email address of the Gong user. | [optional] 
+**full_name** | **String** | The full name of the Gong user. | [optional] 
+**id** | **String** | Gong's unique numeric identifier for the user (up to 20 digits). | [optional] 
+

data/docs/UsersAggregateByPeriodActivity.md

@@ -0,0 +1,9 @@
+# GongAPI::UsersAggregateByPeriodActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**records** | [**Records**](Records.md) |  | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+**users_aggregate_activity** | [**Array<UserAggregateByPeriodActivities>**](UserAggregateByPeriodActivities.md) | A list, in which each item contains details of one user's activities. | [optional] 
+

data/docs/UsersApi.md

@@ -0,0 +1,198 @@
+# GongAPI::UsersApi
+
+All URIs are relative to *//127.0.0.1/*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_user_history_using_get**](UsersApi.md#get_user_history_using_get) | **GET** /v2/users/{id}/settings-history | Retrieve user history (/v2/users/{id}/settings-history)
+[**get_user_using_get**](UsersApi.md#get_user_using_get) | **GET** /v2/users/{id} | Retrieve user (/v2/users/{id})
+[**list_multiple_users_using_post**](UsersApi.md#list_multiple_users_using_post) | **POST** /v2/users/extensive | List users by filter (/v2/users/extensive)
+[**list_users_using_get1**](UsersApi.md#list_users_using_get1) | **GET** /v2/users | List all users (/v2/users)
+
+# **get_user_history_using_get**
+> SettingsHistory get_user_history_using_get(id)
+
+Retrieve user history (/v2/users/{id}/settings-history)
+
+Retrieve a specific user's history.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::UsersApi.new
+id = 'id_example' # String | Gong's unique numeric identifier for the user (up to 20 digits).
+
+
+begin
+  #Retrieve user history (/v2/users/{id}/settings-history)
+  result = api_instance.get_user_history_using_get(id)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling UsersApi->get_user_history_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Gong's unique numeric identifier for the user (up to 20 digits). | 
+
+### Return type
+
+[**SettingsHistory**](SettingsHistory.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_user_using_get**
+> User get_user_using_get(id)
+
+Retrieve user (/v2/users/{id})
+
+Retrieve a specific user.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::UsersApi.new
+id = 'id_example' # String | Gong's unique numeric identifier for the user (up to 20 digits).
+
+
+begin
+  #Retrieve user (/v2/users/{id})
+  result = api_instance.get_user_using_get(id)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling UsersApi->get_user_using_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Gong's unique numeric identifier for the user (up to 20 digits). | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **list_multiple_users_using_post**
+> UsersMetadata list_multiple_users_using_post(body)
+
+List users by filter (/v2/users/extensive)
+
+List multiple Users.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::UsersApi.new
+body = GongAPI::RequestMultipleUsersRequestWithCreationDates.new # RequestMultipleUsersRequestWithCreationDates | multipleUsersRequest
+
+
+begin
+  #List users by filter (/v2/users/extensive)
+  result = api_instance.list_multiple_users_using_post(body)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling UsersApi->list_multiple_users_using_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**RequestMultipleUsersRequestWithCreationDates**](RequestMultipleUsersRequestWithCreationDates.md)| multipleUsersRequest | 
+
+### Return type
+
+[**UsersMetadata**](UsersMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **list_users_using_get1**
+> UsersMetadata list_users_using_get1(opts)
+
+List all users (/v2/users)
+
+List all of the company's users.  When accessed through a Bearer token authorization method, this endpoint requires the scope 'api:users:read'.
+
+### Example
+```ruby
+# load the gem
+require 'gong_api'
+
+api_instance = GongAPI::UsersApi.new
+opts = { 
+  cursor: 'cursor_example', # String | When paging is needed, provide the value supplied by the previous API call to bring the following page of records.
+  include_avatars: true # BOOLEAN | Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results.
+}
+
+begin
+  #List all users (/v2/users)
+  result = api_instance.list_users_using_get1(opts)
+  p result
+rescue GongAPI::ApiError => e
+  puts "Exception when calling UsersApi->list_users_using_get1: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **cursor** | **String**| When paging is needed, provide the value supplied by the previous API call to bring the following page of records. | [optional] 
+ **include_avatars** | **BOOLEAN**| Avatars are synthetic users representing Gong employees (CSMs and support providers) when they access your instance. References to avatars' IDs may be found in the outputs of other API endpoints. This parameter is optional, if not provided avatars will not be included in the results. | [optional] 
+
+### Return type
+
+[**UsersMetadata**](UsersMetadata.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/UsersDayByDayActivity.md

@@ -0,0 +1,9 @@
+# GongAPI::UsersDayByDayActivity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**records** | [**Records**](Records.md) |  | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+**users_detailed_activities** | [**Array<UserDayByDayActivity>**](UserDayByDayActivity.md) | A list, in which each item contains one user's activity. | [optional] 
+

data/docs/UsersMetadata.md

@@ -0,0 +1,9 @@
+# GongAPI::UsersMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**records** | [**Records**](Records.md) |  | [optional] 
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+**users** | [**Array<UserMetadata>**](UserMetadata.md) | A list, in which each item specifies one user's metadata. | [optional] 
+

data/docs/Video.md

@@ -0,0 +1,8 @@
+# GongAPI::Video
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**duration** | **Float** | Total video segments duration in seconds. | [optional] 
+**name** | **String** | Video segment type. Can have the values: 'Browser', 'Presentation', 'WebcamPrimaryUser', 'WebcamNonCompany', and 'Webcam'.  <b>'Browser'</b>: When the video segment shows a web browser.  <b>'Presentation'</b>: When the video segment shows a presentation (such as PowerPoint).  <b>'WebcamPrimaryUser'</b>: When the video segment shows the webcam of the primary user.  <b>'WebcamNonCompany'</b>: When the video segment shows webcam speakers that gong has identified as being non-company.  <b>'Webcam'</b>: When the video segment shows any webcam. | [optional] 
+

data/docs/WorkspaceMetadata.md

@@ -0,0 +1,9 @@
+# GongAPI::WorkspaceMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **String** | The description of the workspace. | [optional] 
+**id** | **String** | Gong's unique numeric identifier for the workspace (up to 20 digits). | [optional] 
+**name** | **String** | The name of the workspace. | [optional] 
+

data/docs/WorkspacesMetadata.md

@@ -0,0 +1,8 @@
+# GongAPI::WorkspacesMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**request_id** | **String** | A Gong request reference Id, generated for this request. Can be used for troubleshooting purposes. | [optional] 
+**workspaces** | [**Array<WorkspaceMetadata>**](WorkspaceMetadata.md) | A list, in which each item provides a workspace metadata. | [optional] 
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+