freeclimb 1.0.0 → 1.0.1
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 +4 -4
- data/README.md +9 -12
- data/docs/DefaultApi.md +48 -48
- data/lib/freeclimb/api/default_api.rb +54 -54
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/version.rb +1 -1
- metadata +2 -3
- data/git_push.sh +0 -58
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9f88ad04a40c5e40e22eaae7ef66620bc87ac29f03cdafb009d3f4d4fb358553
|
4
|
+
data.tar.gz: 2f7a9d95cfd9aace14a39c1f9b17d3fbf35fa3c9ce68aa1bb3c6dabab8879dac
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dd9bb1928fda76a192fdea8ba36cb206ebfb8c6018eec7bc5abd7fc8aac1dd3a2c5794a35b0fa1688764a461a5d2e9350e7ec485638be0dc2b0f263a550c799b
|
7
|
+
data.tar.gz: 702ab18e99416aa95c95aaa58cb01b33f638af19ca93c07c035d66ce5549aae25f87a18437b3ee49f098fe25d35d5af5290c41cd69440fc13eaa9f665d657c92
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
|
-
- Package version: 1.0.
|
10
|
+
- Package version: 1.0.1
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
@@ -23,16 +23,16 @@ gem build freeclimb.gemspec
|
|
23
23
|
Then either install the gem locally:
|
24
24
|
|
25
25
|
```shell
|
26
|
-
gem install ./freeclimb-1.0.
|
26
|
+
gem install ./freeclimb-1.0.1.gem
|
27
27
|
```
|
28
28
|
|
29
|
-
(for development, run `gem install --dev ./freeclimb-1.0.
|
29
|
+
(for development, run `gem install --dev ./freeclimb-1.0.1.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 'freeclimb', '~> 1.0.
|
35
|
+
gem 'freeclimb', '~> 1.0.1'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -48,7 +48,7 @@ Include the Ruby code directly using `-I` as follows:
|
|
48
48
|
ruby -Ilib script.rb
|
49
49
|
```
|
50
50
|
|
51
|
-
##
|
51
|
+
## Testing Your Installation
|
52
52
|
|
53
53
|
Please follow the [installation](#installation) procedure and then run the following code:
|
54
54
|
|
@@ -64,16 +64,13 @@ Freeclimb.configure do |config|
|
|
64
64
|
end
|
65
65
|
|
66
66
|
api_instance = Freeclimb::DefaultApi.new
|
67
|
-
opts = {
|
68
|
-
buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
|
69
|
-
}
|
70
67
|
|
71
68
|
begin
|
72
|
-
#
|
73
|
-
result = api_instance.
|
69
|
+
#Get an Account
|
70
|
+
result = api_instance.get_an_account
|
74
71
|
p result
|
75
72
|
rescue Freeclimb::ApiError => e
|
76
|
-
puts "Exception when calling DefaultApi->
|
73
|
+
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
77
74
|
end
|
78
75
|
|
79
76
|
```
|
@@ -84,6 +81,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
84
81
|
|
85
82
|
Class | Method | HTTP request | Description
|
86
83
|
------------ | ------------- | ------------- | -------------
|
84
|
+
*Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
87
85
|
*Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
|
88
86
|
*Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
|
89
87
|
*Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
|
@@ -101,7 +99,6 @@ Class | Method | HTTP request | Description
|
|
101
99
|
*Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
|
102
100
|
*Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
|
103
101
|
*Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
|
104
|
-
*Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
105
102
|
*Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
|
106
103
|
*Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
|
107
104
|
*Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
|
data/docs/DefaultApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
7
8
|
[**buy_a_phone_number**](DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
|
8
9
|
[**create_a_conference**](DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
|
9
10
|
[**create_a_queue**](DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
|
@@ -21,7 +22,6 @@ Method | HTTP request | Description
|
|
21
22
|
[**get_a_participant**](DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
|
22
23
|
[**get_a_queue**](DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
|
23
24
|
[**get_a_recording**](DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
|
24
|
-
[**get_an_account**](DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
|
25
25
|
[**get_an_application**](DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
|
26
26
|
[**get_an_incoming_number**](DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
|
27
27
|
[**get_an_sms_message**](DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
|
@@ -53,6 +53,53 @@ Method | HTTP request | Description
|
|
53
53
|
|
54
54
|
|
55
55
|
|
56
|
+
## get_an_account
|
57
|
+
|
58
|
+
> AccountResult get_an_account
|
59
|
+
|
60
|
+
Get an Account
|
61
|
+
|
62
|
+
### Example
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
# load the gem
|
66
|
+
require 'freeclimb'
|
67
|
+
# setup authorization
|
68
|
+
Freeclimb.configure do |config|
|
69
|
+
# Configure HTTP basic authorization: fc
|
70
|
+
config.username = 'ACCOUNT ID'
|
71
|
+
config.password = 'AUTH TOKEN'
|
72
|
+
end
|
73
|
+
|
74
|
+
api_instance = Freeclimb::DefaultApi.new
|
75
|
+
|
76
|
+
begin
|
77
|
+
#Get an Account
|
78
|
+
result = api_instance.get_an_account
|
79
|
+
p result
|
80
|
+
rescue Freeclimb::ApiError => e
|
81
|
+
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
This endpoint does not need any parameter.
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
[**AccountResult**](AccountResult.md)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
[fc](../README.md#fc)
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
56
103
|
## buy_a_phone_number
|
57
104
|
|
58
105
|
> IncomingNumberResult buy_a_phone_number(opts)
|
@@ -941,53 +988,6 @@ Name | Type | Description | Notes
|
|
941
988
|
- **Accept**: application/json
|
942
989
|
|
943
990
|
|
944
|
-
## get_an_account
|
945
|
-
|
946
|
-
> AccountResult get_an_account
|
947
|
-
|
948
|
-
Get an Account
|
949
|
-
|
950
|
-
### Example
|
951
|
-
|
952
|
-
```ruby
|
953
|
-
# load the gem
|
954
|
-
require 'freeclimb'
|
955
|
-
# setup authorization
|
956
|
-
Freeclimb.configure do |config|
|
957
|
-
# Configure HTTP basic authorization: fc
|
958
|
-
config.username = 'ACCOUNT ID'
|
959
|
-
config.password = 'AUTH TOKEN'
|
960
|
-
end
|
961
|
-
|
962
|
-
api_instance = Freeclimb::DefaultApi.new
|
963
|
-
|
964
|
-
begin
|
965
|
-
#Get an Account
|
966
|
-
result = api_instance.get_an_account
|
967
|
-
p result
|
968
|
-
rescue Freeclimb::ApiError => e
|
969
|
-
puts "Exception when calling DefaultApi->get_an_account: #{e}"
|
970
|
-
end
|
971
|
-
```
|
972
|
-
|
973
|
-
### Parameters
|
974
|
-
|
975
|
-
This endpoint does not need any parameter.
|
976
|
-
|
977
|
-
### Return type
|
978
|
-
|
979
|
-
[**AccountResult**](AccountResult.md)
|
980
|
-
|
981
|
-
### Authorization
|
982
|
-
|
983
|
-
[fc](../README.md#fc)
|
984
|
-
|
985
|
-
### HTTP request headers
|
986
|
-
|
987
|
-
- **Content-Type**: Not defined
|
988
|
-
- **Accept**: application/json
|
989
|
-
|
990
|
-
|
991
991
|
## get_an_application
|
992
992
|
|
993
993
|
> ApplicationResult get_an_application(application_id)
|
@@ -24,6 +24,60 @@ module Freeclimb
|
|
24
24
|
@account_id = account_id
|
25
25
|
end
|
26
26
|
end
|
27
|
+
# Get an Account
|
28
|
+
# @param [Hash] opts the optional parameters
|
29
|
+
# @return [AccountResult]
|
30
|
+
def get_an_account(opts = {})
|
31
|
+
data, _status_code, _headers = get_an_account_with_http_info(opts)
|
32
|
+
data
|
33
|
+
end
|
34
|
+
|
35
|
+
# Get an Account
|
36
|
+
# @param [Hash] opts the optional parameters
|
37
|
+
# @return [Array<(AccountResult, Integer, Hash)>] AccountResult data, response status code and response headers
|
38
|
+
def get_an_account_with_http_info(opts = {})
|
39
|
+
if @api_client.config.debugging
|
40
|
+
@api_client.config.logger.debug 'Calling API: DefaultApi.get_an_account ...'
|
41
|
+
end
|
42
|
+
# resource path
|
43
|
+
local_var_path = '/Accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
|
44
|
+
|
45
|
+
# query parameters
|
46
|
+
query_params = opts[:query_params] || {}
|
47
|
+
|
48
|
+
# header parameters
|
49
|
+
header_params = opts[:header_params] || {}
|
50
|
+
# HTTP header 'Accept' (if needed)
|
51
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
52
|
+
|
53
|
+
# form parameters
|
54
|
+
form_params = opts[:form_params] || {}
|
55
|
+
|
56
|
+
# http body (model)
|
57
|
+
post_body = opts[:body]
|
58
|
+
|
59
|
+
# return_type
|
60
|
+
return_type = opts[:return_type] || 'AccountResult'
|
61
|
+
|
62
|
+
# auth_names
|
63
|
+
auth_names = opts[:auth_names] || ['fc']
|
64
|
+
|
65
|
+
new_options = opts.merge(
|
66
|
+
:header_params => header_params,
|
67
|
+
:query_params => query_params,
|
68
|
+
:form_params => form_params,
|
69
|
+
:body => post_body,
|
70
|
+
:auth_names => auth_names,
|
71
|
+
:return_type => return_type
|
72
|
+
)
|
73
|
+
|
74
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
75
|
+
if @api_client.config.debugging
|
76
|
+
@api_client.config.logger.debug "API called: DefaultApi#get_an_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
77
|
+
end
|
78
|
+
return data, status_code, headers
|
79
|
+
end
|
80
|
+
|
27
81
|
# Buy a Phone Number
|
28
82
|
# @param [Hash] opts the optional parameters
|
29
83
|
# @option opts [BuyIncomingNumberRequest] :buy_incoming_number_request Incoming Number transaction details
|
@@ -1054,60 +1108,6 @@ module Freeclimb
|
|
1054
1108
|
return data, status_code, headers
|
1055
1109
|
end
|
1056
1110
|
|
1057
|
-
# Get an Account
|
1058
|
-
# @param [Hash] opts the optional parameters
|
1059
|
-
# @return [AccountResult]
|
1060
|
-
def get_an_account(opts = {})
|
1061
|
-
data, _status_code, _headers = get_an_account_with_http_info(opts)
|
1062
|
-
data
|
1063
|
-
end
|
1064
|
-
|
1065
|
-
# Get an Account
|
1066
|
-
# @param [Hash] opts the optional parameters
|
1067
|
-
# @return [Array<(AccountResult, Integer, Hash)>] AccountResult data, response status code and response headers
|
1068
|
-
def get_an_account_with_http_info(opts = {})
|
1069
|
-
if @api_client.config.debugging
|
1070
|
-
@api_client.config.logger.debug 'Calling API: DefaultApi.get_an_account ...'
|
1071
|
-
end
|
1072
|
-
# resource path
|
1073
|
-
local_var_path = '/Accounts/{accountId}'.sub('{' + 'accountId' + '}', CGI.escape(@account_id.to_s))
|
1074
|
-
|
1075
|
-
# query parameters
|
1076
|
-
query_params = opts[:query_params] || {}
|
1077
|
-
|
1078
|
-
# header parameters
|
1079
|
-
header_params = opts[:header_params] || {}
|
1080
|
-
# HTTP header 'Accept' (if needed)
|
1081
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1082
|
-
|
1083
|
-
# form parameters
|
1084
|
-
form_params = opts[:form_params] || {}
|
1085
|
-
|
1086
|
-
# http body (model)
|
1087
|
-
post_body = opts[:body]
|
1088
|
-
|
1089
|
-
# return_type
|
1090
|
-
return_type = opts[:return_type] || 'AccountResult'
|
1091
|
-
|
1092
|
-
# auth_names
|
1093
|
-
auth_names = opts[:auth_names] || ['fc']
|
1094
|
-
|
1095
|
-
new_options = opts.merge(
|
1096
|
-
:header_params => header_params,
|
1097
|
-
:query_params => query_params,
|
1098
|
-
:form_params => form_params,
|
1099
|
-
:body => post_body,
|
1100
|
-
:auth_names => auth_names,
|
1101
|
-
:return_type => return_type
|
1102
|
-
)
|
1103
|
-
|
1104
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
1105
|
-
if @api_client.config.debugging
|
1106
|
-
@api_client.config.logger.debug "API called: DefaultApi#get_an_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1107
|
-
end
|
1108
|
-
return data, status_code, headers
|
1109
|
-
end
|
1110
|
-
|
1111
1111
|
# Get an Application
|
1112
1112
|
# @param application_id [String] A string that uniquely identifies this application resource.
|
1113
1113
|
# @param [Hash] opts the optional parameters
|
data/lib/freeclimb/api_client.rb
CHANGED
@@ -30,7 +30,7 @@ module Freeclimb
|
|
30
30
|
# @option config [Configuration] Configuration for initializing the object, default to Configuration.default
|
31
31
|
def initialize(config = Configuration.default)
|
32
32
|
@config = config
|
33
|
-
@user_agent = "
|
33
|
+
@user_agent = "FreeClimbSDK/1.0.1/ruby"
|
34
34
|
@default_headers = {
|
35
35
|
'Content-Type' => 'application/json',
|
36
36
|
'User-Agent' => @user_agent
|
data/lib/freeclimb/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: freeclimb
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.0.
|
4
|
+
version: 1.0.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- OpenAPI-Generator
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2020-
|
11
|
+
date: 2020-03-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|
@@ -150,7 +150,6 @@ files:
|
|
150
150
|
- docs/UpdateConferenceParticipantRequest.md
|
151
151
|
- docs/UpdateConferenceRequest.md
|
152
152
|
- freeclimb.gemspec
|
153
|
-
- git_push.sh
|
154
153
|
- lib/freeclimb.rb
|
155
154
|
- lib/freeclimb/api/default_api.rb
|
156
155
|
- lib/freeclimb/api_client.rb
|
data/git_push.sh
DELETED
@@ -1,58 +0,0 @@
|
|
1
|
-
#!/bin/sh
|
2
|
-
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
3
|
-
#
|
4
|
-
# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update" "gitlab.com"
|
5
|
-
|
6
|
-
git_user_id=$1
|
7
|
-
git_repo_id=$2
|
8
|
-
release_note=$3
|
9
|
-
git_host=$4
|
10
|
-
|
11
|
-
if [ "$git_host" = "" ]; then
|
12
|
-
git_host="github.com"
|
13
|
-
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
|
14
|
-
fi
|
15
|
-
|
16
|
-
if [ "$git_user_id" = "" ]; then
|
17
|
-
git_user_id="GIT_USER_ID"
|
18
|
-
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
19
|
-
fi
|
20
|
-
|
21
|
-
if [ "$git_repo_id" = "" ]; then
|
22
|
-
git_repo_id="GIT_REPO_ID"
|
23
|
-
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
24
|
-
fi
|
25
|
-
|
26
|
-
if [ "$release_note" = "" ]; then
|
27
|
-
release_note="Minor update"
|
28
|
-
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
29
|
-
fi
|
30
|
-
|
31
|
-
# Initialize the local directory as a Git repository
|
32
|
-
git init
|
33
|
-
|
34
|
-
# Adds the files in the local repository and stages them for commit.
|
35
|
-
git add .
|
36
|
-
|
37
|
-
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
38
|
-
git commit -m "$release_note"
|
39
|
-
|
40
|
-
# Sets the new remote
|
41
|
-
git_remote=`git remote`
|
42
|
-
if [ "$git_remote" = "" ]; then # git remote not defined
|
43
|
-
|
44
|
-
if [ "$GIT_TOKEN" = "" ]; then
|
45
|
-
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
46
|
-
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
|
47
|
-
else
|
48
|
-
git remote add origin https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git
|
49
|
-
fi
|
50
|
-
|
51
|
-
fi
|
52
|
-
|
53
|
-
git pull origin master
|
54
|
-
|
55
|
-
# Pushes (Forces) the changes in the local repository up to the remote repository
|
56
|
-
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
|
57
|
-
git push origin master 2>&1 | grep -v 'To https'
|
58
|
-
|