freeclimb 4.3.0 → 4.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/Gemfile.lock +1 -1
- data/README.md +20 -4
- data/docs/DefaultApi.md +433 -0
- data/docs/IncomingNumberRequest.md +3 -1
- data/docs/SMSTenDLCBrand.md +78 -0
- data/docs/SMSTenDLCBrandsListResult.md +32 -0
- data/docs/SMSTenDLCBrandsListResultAllOf.md +18 -0
- data/docs/SMSTenDLCCampaign.md +78 -0
- data/docs/SMSTenDLCCampaignsListResult.md +32 -0
- data/docs/SMSTenDLCCampaignsListResultAllOf.md +18 -0
- data/docs/SMSTenDLCPartnerCampaign.md +74 -0
- data/docs/SMSTenDLCPartnerCampaignBrand.md +38 -0
- data/docs/SMSTenDLCPartnerCampaignsListResult.md +32 -0
- data/docs/SMSTenDLCPartnerCampaignsListResultAllOf.md +18 -0
- data/lib/freeclimb/api/default_api.rb +360 -0
- data/lib/freeclimb/models/incoming_number_request.rb +15 -4
- data/lib/freeclimb/models/sms_ten_dlc_brand.rb +960 -0
- data/lib/freeclimb/models/sms_ten_dlc_brands_list_result.rb +306 -0
- data/lib/freeclimb/models/sms_ten_dlc_brands_list_result_all_of.rb +221 -0
- data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +814 -0
- data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result.rb +306 -0
- data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result_all_of.rb +221 -0
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +807 -0
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +445 -0
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result.rb +306 -0
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result_all_of.rb +221 -0
- data/lib/freeclimb/version.rb +1 -1
- data/lib/freeclimb.rb +10 -0
- data/openapi.json +1162 -2
- data/spec/api/default_api_spec.rb +151 -1
- data/spec/models/sms_ten_dlc_brand_spec.rb +234 -0
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +76 -0
- data/spec/models/sms_ten_dlc_campaign_spec.rb +218 -0
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +76 -0
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +94 -0
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +206 -0
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +76 -0
- metadata +105 -71
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 4c62186a01842ffd5a506080f7fd007c27758b7aa1a5abc3705e6f4bcc953293
|
|
4
|
+
data.tar.gz: 2cba7d489cec288291e7d21b250ef5776d08905f6072c62eacbdefb875f5a704
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 65817741e4f0073be329a506115607c2d29a3d521de37106257ec3f13783607b80401c4bbf5e40bca09f7921525632cddb7c9d7e78ea62735c2545b054867283
|
|
7
|
+
data.tar.gz: ad689450010a9953547b8aee0b9dee0ac4576b40be5ac3a9bcebe9422d91b21ec4a41829a5eb591bd2e026cdb6e4ff35e55f5f03eebbe3f18e48f00c95ebd23c
|
data/CHANGELOG.md
CHANGED
|
@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
|
|
|
9
9
|
|
|
10
10
|
None
|
|
11
11
|
|
|
12
|
+
<a name="4.4.0"></a>
|
|
13
|
+
|
|
14
|
+
## [4.4.0] - 2023-06-08
|
|
15
|
+
|
|
16
|
+
### Added
|
|
17
|
+
|
|
18
|
+
- Number management feature for python sdk including methods, properties, and testing
|
|
19
|
+
|
|
12
20
|
<a name="4.3.0"></a>
|
|
13
21
|
|
|
14
22
|
## [4.3.0] - 2023-04-27
|
data/Gemfile.lock
CHANGED
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: 4.
|
|
10
|
+
- Package version: 4.4.0
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
|
|
13
13
|
|
|
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
|
|
|
15
15
|
|
|
16
16
|
Add this to the Gemfile:
|
|
17
17
|
|
|
18
|
-
gem 'freeclimb', '~> 4.
|
|
18
|
+
gem 'freeclimb', '~> 4.4.0'
|
|
19
19
|
|
|
20
20
|
and run from your terminal
|
|
21
21
|
|
|
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
|
|
|
44
44
|
Then either install the gem locally:
|
|
45
45
|
|
|
46
46
|
```shell
|
|
47
|
-
gem install ./freeclimb-4.
|
|
47
|
+
gem install ./freeclimb-4.4.0.gem
|
|
48
48
|
```
|
|
49
|
-
(for development, run `gem install --dev ./freeclimb-4.
|
|
49
|
+
(for development, run `gem install --dev ./freeclimb-4.4.0.gem` to install the development dependencies)
|
|
50
50
|
|
|
51
51
|
## Getting Started
|
|
52
52
|
|
|
@@ -121,6 +121,12 @@ Class | Method | HTTP request | Description
|
|
|
121
121
|
*Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
|
|
122
122
|
*Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
|
|
123
123
|
*Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
|
|
124
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brand**](docs/DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand
|
|
125
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_brands**](docs/DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands
|
|
126
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_campaign**](docs/DefaultApi.md#get_ten_dlc_sms_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign
|
|
127
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns
|
|
128
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaign**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign
|
|
129
|
+
*Freeclimb::DefaultApi* | [**get_ten_dlc_sms_partner_campaigns**](docs/DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns
|
|
124
130
|
*Freeclimb::DefaultApi* | [**list_active_queues**](docs/DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
|
|
125
131
|
*Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
|
|
126
132
|
*Freeclimb::DefaultApi* | [**list_applications**](docs/DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications
|
|
@@ -257,6 +263,16 @@ Class | Method | HTTP request | Description
|
|
|
257
263
|
- [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
|
|
258
264
|
- [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
|
|
259
265
|
- [Freeclimb::RequestType](docs/RequestType.md)
|
|
266
|
+
- [Freeclimb::SMSTenDLCBrand](docs/SMSTenDLCBrand.md)
|
|
267
|
+
- [Freeclimb::SMSTenDLCBrandsListResult](docs/SMSTenDLCBrandsListResult.md)
|
|
268
|
+
- [Freeclimb::SMSTenDLCBrandsListResultAllOf](docs/SMSTenDLCBrandsListResultAllOf.md)
|
|
269
|
+
- [Freeclimb::SMSTenDLCCampaign](docs/SMSTenDLCCampaign.md)
|
|
270
|
+
- [Freeclimb::SMSTenDLCCampaignsListResult](docs/SMSTenDLCCampaignsListResult.md)
|
|
271
|
+
- [Freeclimb::SMSTenDLCCampaignsListResultAllOf](docs/SMSTenDLCCampaignsListResultAllOf.md)
|
|
272
|
+
- [Freeclimb::SMSTenDLCPartnerCampaign](docs/SMSTenDLCPartnerCampaign.md)
|
|
273
|
+
- [Freeclimb::SMSTenDLCPartnerCampaignBrand](docs/SMSTenDLCPartnerCampaignBrand.md)
|
|
274
|
+
- [Freeclimb::SMSTenDLCPartnerCampaignsListResult](docs/SMSTenDLCPartnerCampaignsListResult.md)
|
|
275
|
+
- [Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf](docs/SMSTenDLCPartnerCampaignsListResultAllOf.md)
|
|
260
276
|
- [Freeclimb::Say](docs/Say.md)
|
|
261
277
|
- [Freeclimb::SayAllOf](docs/SayAllOf.md)
|
|
262
278
|
- [Freeclimb::SendDigits](docs/SendDigits.md)
|
data/docs/DefaultApi.md
CHANGED
|
@@ -26,6 +26,12 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
|
|
|
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 |
|
|
28
28
|
| [**get_head_member**](DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member |
|
|
29
|
+
| [**get_ten_dlc_sms_brand**](DefaultApi.md#get_ten_dlc_sms_brand) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands/{brandId} | Get a 10DLC SMS Brand |
|
|
30
|
+
| [**get_ten_dlc_sms_brands**](DefaultApi.md#get_ten_dlc_sms_brands) | **GET** /Accounts/{accountId}/Messages/10DLC/Brands | Get list of SMS 10DLC Brands |
|
|
31
|
+
| [**get_ten_dlc_sms_campaign**](DefaultApi.md#get_ten_dlc_sms_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns/{campaignId} | Get a 10DLC SMS Campaign |
|
|
32
|
+
| [**get_ten_dlc_sms_campaigns**](DefaultApi.md#get_ten_dlc_sms_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/Campaigns | Get list of SMS 10DLC Campaigns |
|
|
33
|
+
| [**get_ten_dlc_sms_partner_campaign**](DefaultApi.md#get_ten_dlc_sms_partner_campaign) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns/{campaignId} | Get a 10DLC SMS Partner Campaign |
|
|
34
|
+
| [**get_ten_dlc_sms_partner_campaigns**](DefaultApi.md#get_ten_dlc_sms_partner_campaigns) | **GET** /Accounts/{accountId}/Messages/10DLC/PartnerCampaigns | Get list of SMS 10DLC Partner Campaigns |
|
|
29
35
|
| [**list_active_queues**](DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues |
|
|
30
36
|
| [**list_all_account_logs**](DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs |
|
|
31
37
|
| [**list_applications**](DefaultApi.md#list_applications) | **GET** /Accounts/{accountId}/Applications | List applications |
|
|
@@ -1622,6 +1628,430 @@ end
|
|
|
1622
1628
|
- **Accept**: application/json
|
|
1623
1629
|
|
|
1624
1630
|
|
|
1631
|
+
## get_ten_dlc_sms_brand
|
|
1632
|
+
|
|
1633
|
+
Get a 10DLC SMS Brand
|
|
1634
|
+
|
|
1635
|
+
### Examples
|
|
1636
|
+
|
|
1637
|
+
```ruby
|
|
1638
|
+
require 'time'
|
|
1639
|
+
require 'freeclimb'
|
|
1640
|
+
# setup authorization
|
|
1641
|
+
Freeclimb.configure do |config|
|
|
1642
|
+
# Configure HTTP basic authorization: fc
|
|
1643
|
+
config.username = 'ACCOUNT_ID'
|
|
1644
|
+
config.password = 'API_KEY'
|
|
1645
|
+
end
|
|
1646
|
+
|
|
1647
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
1648
|
+
|
|
1649
|
+
brand_id = 'brand_id_example' # String | String that uniquely identifies this brand resource.
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
begin
|
|
1653
|
+
|
|
1654
|
+
# Get a 10DLC SMS Brand
|
|
1655
|
+
result = api_instance.get_ten_dlc_sms_brand(brand_id)
|
|
1656
|
+
p result
|
|
1657
|
+
rescue Freeclimb::ApiError => e
|
|
1658
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_brand: #{e}"
|
|
1659
|
+
end
|
|
1660
|
+
```
|
|
1661
|
+
|
|
1662
|
+
#### Using the get_ten_dlc_sms_brand_with_http_info variant
|
|
1663
|
+
|
|
1664
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1665
|
+
|
|
1666
|
+
> <Array(<SMSTenDLCBrand>, Integer, Hash)> get_ten_dlc_sms_brand_with_http_info(account_id, brand_id)
|
|
1667
|
+
|
|
1668
|
+
```ruby
|
|
1669
|
+
begin
|
|
1670
|
+
# Get a 10DLC SMS Brand
|
|
1671
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_brand_with_http_info(brand_id)
|
|
1672
|
+
p status_code # => 2xx
|
|
1673
|
+
p headers # => { ... }
|
|
1674
|
+
p data # => <SMSTenDLCBrand>
|
|
1675
|
+
rescue Freeclimb::ApiError => e
|
|
1676
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_brand_with_http_info: #{e}"
|
|
1677
|
+
end
|
|
1678
|
+
```
|
|
1679
|
+
|
|
1680
|
+
### Parameters
|
|
1681
|
+
|
|
1682
|
+
| Name | Type | Description | Notes |
|
|
1683
|
+
| ---- | ---- | ----------- | ----- |
|
|
1684
|
+
|
|
1685
|
+
| **brand_id** | **String** | String that uniquely identifies this brand resource. | |
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
### Return type
|
|
1689
|
+
|
|
1690
|
+
[**SMSTenDLCBrand**](SMSTenDLCBrand.md)
|
|
1691
|
+
|
|
1692
|
+
### Authorization
|
|
1693
|
+
|
|
1694
|
+
[fc](../README.md#fc)
|
|
1695
|
+
|
|
1696
|
+
### HTTP request headers
|
|
1697
|
+
|
|
1698
|
+
- **Content-Type**: Not defined
|
|
1699
|
+
- **Accept**: application/json
|
|
1700
|
+
|
|
1701
|
+
|
|
1702
|
+
## get_ten_dlc_sms_brands
|
|
1703
|
+
|
|
1704
|
+
Get list of SMS 10DLC Brands
|
|
1705
|
+
|
|
1706
|
+
### Examples
|
|
1707
|
+
|
|
1708
|
+
```ruby
|
|
1709
|
+
require 'time'
|
|
1710
|
+
require 'freeclimb'
|
|
1711
|
+
# setup authorization
|
|
1712
|
+
Freeclimb.configure do |config|
|
|
1713
|
+
# Configure HTTP basic authorization: fc
|
|
1714
|
+
config.username = 'ACCOUNT_ID'
|
|
1715
|
+
config.password = 'API_KEY'
|
|
1716
|
+
end
|
|
1717
|
+
|
|
1718
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
1719
|
+
|
|
1720
|
+
|
|
1721
|
+
begin
|
|
1722
|
+
|
|
1723
|
+
# Get list of SMS 10DLC Brands
|
|
1724
|
+
result = api_instance.get_ten_dlc_sms_brands()
|
|
1725
|
+
p result
|
|
1726
|
+
rescue Freeclimb::ApiError => e
|
|
1727
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_brands: #{e}"
|
|
1728
|
+
end
|
|
1729
|
+
```
|
|
1730
|
+
|
|
1731
|
+
#### Using the get_ten_dlc_sms_brands_with_http_info variant
|
|
1732
|
+
|
|
1733
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1734
|
+
|
|
1735
|
+
> <Array(<SMSTenDLCBrandsListResult>, Integer, Hash)> get_ten_dlc_sms_brands_with_http_info(account_id)
|
|
1736
|
+
|
|
1737
|
+
```ruby
|
|
1738
|
+
begin
|
|
1739
|
+
# Get list of SMS 10DLC Brands
|
|
1740
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_brands_with_http_info()
|
|
1741
|
+
p status_code # => 2xx
|
|
1742
|
+
p headers # => { ... }
|
|
1743
|
+
p data # => <SMSTenDLCBrandsListResult>
|
|
1744
|
+
rescue Freeclimb::ApiError => e
|
|
1745
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_brands_with_http_info: #{e}"
|
|
1746
|
+
end
|
|
1747
|
+
```
|
|
1748
|
+
|
|
1749
|
+
### Parameters
|
|
1750
|
+
|
|
1751
|
+
| Name | Type | Description | Notes |
|
|
1752
|
+
| ---- | ---- | ----------- | ----- |
|
|
1753
|
+
|
|
1754
|
+
|
|
1755
|
+
### Return type
|
|
1756
|
+
|
|
1757
|
+
[**SMSTenDLCBrandsListResult**](SMSTenDLCBrandsListResult.md)
|
|
1758
|
+
|
|
1759
|
+
### Authorization
|
|
1760
|
+
|
|
1761
|
+
[fc](../README.md#fc)
|
|
1762
|
+
|
|
1763
|
+
### HTTP request headers
|
|
1764
|
+
|
|
1765
|
+
- **Content-Type**: Not defined
|
|
1766
|
+
- **Accept**: application/json
|
|
1767
|
+
|
|
1768
|
+
|
|
1769
|
+
## get_ten_dlc_sms_campaign
|
|
1770
|
+
|
|
1771
|
+
Get a 10DLC SMS Campaign
|
|
1772
|
+
|
|
1773
|
+
### Examples
|
|
1774
|
+
|
|
1775
|
+
```ruby
|
|
1776
|
+
require 'time'
|
|
1777
|
+
require 'freeclimb'
|
|
1778
|
+
# setup authorization
|
|
1779
|
+
Freeclimb.configure do |config|
|
|
1780
|
+
# Configure HTTP basic authorization: fc
|
|
1781
|
+
config.username = 'ACCOUNT_ID'
|
|
1782
|
+
config.password = 'API_KEY'
|
|
1783
|
+
end
|
|
1784
|
+
|
|
1785
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
1786
|
+
|
|
1787
|
+
campaign_id = 'campaign_id_example' # String | String that uniquely identifies this campaign resource.
|
|
1788
|
+
|
|
1789
|
+
|
|
1790
|
+
begin
|
|
1791
|
+
|
|
1792
|
+
# Get a 10DLC SMS Campaign
|
|
1793
|
+
result = api_instance.get_ten_dlc_sms_campaign(campaign_id)
|
|
1794
|
+
p result
|
|
1795
|
+
rescue Freeclimb::ApiError => e
|
|
1796
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_campaign: #{e}"
|
|
1797
|
+
end
|
|
1798
|
+
```
|
|
1799
|
+
|
|
1800
|
+
#### Using the get_ten_dlc_sms_campaign_with_http_info variant
|
|
1801
|
+
|
|
1802
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1803
|
+
|
|
1804
|
+
> <Array(<SMSTenDLCCampaign>, Integer, Hash)> get_ten_dlc_sms_campaign_with_http_info(account_id, campaign_id)
|
|
1805
|
+
|
|
1806
|
+
```ruby
|
|
1807
|
+
begin
|
|
1808
|
+
# Get a 10DLC SMS Campaign
|
|
1809
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_campaign_with_http_info(campaign_id)
|
|
1810
|
+
p status_code # => 2xx
|
|
1811
|
+
p headers # => { ... }
|
|
1812
|
+
p data # => <SMSTenDLCCampaign>
|
|
1813
|
+
rescue Freeclimb::ApiError => e
|
|
1814
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_campaign_with_http_info: #{e}"
|
|
1815
|
+
end
|
|
1816
|
+
```
|
|
1817
|
+
|
|
1818
|
+
### Parameters
|
|
1819
|
+
|
|
1820
|
+
| Name | Type | Description | Notes |
|
|
1821
|
+
| ---- | ---- | ----------- | ----- |
|
|
1822
|
+
|
|
1823
|
+
| **campaign_id** | **String** | String that uniquely identifies this campaign resource. | |
|
|
1824
|
+
|
|
1825
|
+
|
|
1826
|
+
### Return type
|
|
1827
|
+
|
|
1828
|
+
[**SMSTenDLCCampaign**](SMSTenDLCCampaign.md)
|
|
1829
|
+
|
|
1830
|
+
### Authorization
|
|
1831
|
+
|
|
1832
|
+
[fc](../README.md#fc)
|
|
1833
|
+
|
|
1834
|
+
### HTTP request headers
|
|
1835
|
+
|
|
1836
|
+
- **Content-Type**: Not defined
|
|
1837
|
+
- **Accept**: application/json
|
|
1838
|
+
|
|
1839
|
+
|
|
1840
|
+
## get_ten_dlc_sms_campaigns
|
|
1841
|
+
|
|
1842
|
+
Get list of SMS 10DLC Campaigns
|
|
1843
|
+
|
|
1844
|
+
### Examples
|
|
1845
|
+
|
|
1846
|
+
```ruby
|
|
1847
|
+
require 'time'
|
|
1848
|
+
require 'freeclimb'
|
|
1849
|
+
# setup authorization
|
|
1850
|
+
Freeclimb.configure do |config|
|
|
1851
|
+
# Configure HTTP basic authorization: fc
|
|
1852
|
+
config.username = 'ACCOUNT_ID'
|
|
1853
|
+
config.password = 'API_KEY'
|
|
1854
|
+
end
|
|
1855
|
+
|
|
1856
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
1857
|
+
|
|
1858
|
+
opts = {
|
|
1859
|
+
brand_id: 'brand_id_example' # String | The unique identifier for a brand
|
|
1860
|
+
}
|
|
1861
|
+
|
|
1862
|
+
begin
|
|
1863
|
+
|
|
1864
|
+
# Get list of SMS 10DLC Campaigns
|
|
1865
|
+
result = api_instance.get_ten_dlc_sms_campaigns(opts)
|
|
1866
|
+
p result
|
|
1867
|
+
rescue Freeclimb::ApiError => e
|
|
1868
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_campaigns: #{e}"
|
|
1869
|
+
end
|
|
1870
|
+
```
|
|
1871
|
+
|
|
1872
|
+
#### Using the get_ten_dlc_sms_campaigns_with_http_info variant
|
|
1873
|
+
|
|
1874
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1875
|
+
|
|
1876
|
+
> <Array(<SMSTenDLCCampaignsListResult>, Integer, Hash)> get_ten_dlc_sms_campaigns_with_http_info(account_id, opts)
|
|
1877
|
+
|
|
1878
|
+
```ruby
|
|
1879
|
+
begin
|
|
1880
|
+
# Get list of SMS 10DLC Campaigns
|
|
1881
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_campaigns_with_http_info(opts)
|
|
1882
|
+
p status_code # => 2xx
|
|
1883
|
+
p headers # => { ... }
|
|
1884
|
+
p data # => <SMSTenDLCCampaignsListResult>
|
|
1885
|
+
rescue Freeclimb::ApiError => e
|
|
1886
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_campaigns_with_http_info: #{e}"
|
|
1887
|
+
end
|
|
1888
|
+
```
|
|
1889
|
+
|
|
1890
|
+
### Parameters
|
|
1891
|
+
|
|
1892
|
+
| Name | Type | Description | Notes |
|
|
1893
|
+
| ---- | ---- | ----------- | ----- |
|
|
1894
|
+
|
|
1895
|
+
| **brand_id** | **String** | The unique identifier for a brand | [optional] |
|
|
1896
|
+
|
|
1897
|
+
|
|
1898
|
+
### Return type
|
|
1899
|
+
|
|
1900
|
+
[**SMSTenDLCCampaignsListResult**](SMSTenDLCCampaignsListResult.md)
|
|
1901
|
+
|
|
1902
|
+
### Authorization
|
|
1903
|
+
|
|
1904
|
+
[fc](../README.md#fc)
|
|
1905
|
+
|
|
1906
|
+
### HTTP request headers
|
|
1907
|
+
|
|
1908
|
+
- **Content-Type**: Not defined
|
|
1909
|
+
- **Accept**: application/json
|
|
1910
|
+
|
|
1911
|
+
|
|
1912
|
+
## get_ten_dlc_sms_partner_campaign
|
|
1913
|
+
|
|
1914
|
+
Get a 10DLC SMS Partner Campaign
|
|
1915
|
+
|
|
1916
|
+
### Examples
|
|
1917
|
+
|
|
1918
|
+
```ruby
|
|
1919
|
+
require 'time'
|
|
1920
|
+
require 'freeclimb'
|
|
1921
|
+
# setup authorization
|
|
1922
|
+
Freeclimb.configure do |config|
|
|
1923
|
+
# Configure HTTP basic authorization: fc
|
|
1924
|
+
config.username = 'ACCOUNT_ID'
|
|
1925
|
+
config.password = 'API_KEY'
|
|
1926
|
+
end
|
|
1927
|
+
|
|
1928
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
1929
|
+
|
|
1930
|
+
campaign_id = 'campaign_id_example' # String | String that uniquely identifies this campaign resource.
|
|
1931
|
+
|
|
1932
|
+
|
|
1933
|
+
begin
|
|
1934
|
+
|
|
1935
|
+
# Get a 10DLC SMS Partner Campaign
|
|
1936
|
+
result = api_instance.get_ten_dlc_sms_partner_campaign(campaign_id)
|
|
1937
|
+
p result
|
|
1938
|
+
rescue Freeclimb::ApiError => e
|
|
1939
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_partner_campaign: #{e}"
|
|
1940
|
+
end
|
|
1941
|
+
```
|
|
1942
|
+
|
|
1943
|
+
#### Using the get_ten_dlc_sms_partner_campaign_with_http_info variant
|
|
1944
|
+
|
|
1945
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1946
|
+
|
|
1947
|
+
> <Array(<SMSTenDLCPartnerCampaign>, Integer, Hash)> get_ten_dlc_sms_partner_campaign_with_http_info(account_id, campaign_id)
|
|
1948
|
+
|
|
1949
|
+
```ruby
|
|
1950
|
+
begin
|
|
1951
|
+
# Get a 10DLC SMS Partner Campaign
|
|
1952
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_partner_campaign_with_http_info(campaign_id)
|
|
1953
|
+
p status_code # => 2xx
|
|
1954
|
+
p headers # => { ... }
|
|
1955
|
+
p data # => <SMSTenDLCPartnerCampaign>
|
|
1956
|
+
rescue Freeclimb::ApiError => e
|
|
1957
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_partner_campaign_with_http_info: #{e}"
|
|
1958
|
+
end
|
|
1959
|
+
```
|
|
1960
|
+
|
|
1961
|
+
### Parameters
|
|
1962
|
+
|
|
1963
|
+
| Name | Type | Description | Notes |
|
|
1964
|
+
| ---- | ---- | ----------- | ----- |
|
|
1965
|
+
|
|
1966
|
+
| **campaign_id** | **String** | String that uniquely identifies this campaign resource. | |
|
|
1967
|
+
|
|
1968
|
+
|
|
1969
|
+
### Return type
|
|
1970
|
+
|
|
1971
|
+
[**SMSTenDLCPartnerCampaign**](SMSTenDLCPartnerCampaign.md)
|
|
1972
|
+
|
|
1973
|
+
### Authorization
|
|
1974
|
+
|
|
1975
|
+
[fc](../README.md#fc)
|
|
1976
|
+
|
|
1977
|
+
### HTTP request headers
|
|
1978
|
+
|
|
1979
|
+
- **Content-Type**: Not defined
|
|
1980
|
+
- **Accept**: application/json
|
|
1981
|
+
|
|
1982
|
+
|
|
1983
|
+
## get_ten_dlc_sms_partner_campaigns
|
|
1984
|
+
|
|
1985
|
+
Get list of SMS 10DLC Partner Campaigns
|
|
1986
|
+
|
|
1987
|
+
### Examples
|
|
1988
|
+
|
|
1989
|
+
```ruby
|
|
1990
|
+
require 'time'
|
|
1991
|
+
require 'freeclimb'
|
|
1992
|
+
# setup authorization
|
|
1993
|
+
Freeclimb.configure do |config|
|
|
1994
|
+
# Configure HTTP basic authorization: fc
|
|
1995
|
+
config.username = 'ACCOUNT_ID'
|
|
1996
|
+
config.password = 'API_KEY'
|
|
1997
|
+
end
|
|
1998
|
+
|
|
1999
|
+
api_instance = Freeclimb::DefaultApi.new
|
|
2000
|
+
|
|
2001
|
+
opts = {
|
|
2002
|
+
brand_id: 'brand_id_example' # String | The unique identifier for a brand
|
|
2003
|
+
}
|
|
2004
|
+
|
|
2005
|
+
begin
|
|
2006
|
+
|
|
2007
|
+
# Get list of SMS 10DLC Partner Campaigns
|
|
2008
|
+
result = api_instance.get_ten_dlc_sms_partner_campaigns(opts)
|
|
2009
|
+
p result
|
|
2010
|
+
rescue Freeclimb::ApiError => e
|
|
2011
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_partner_campaigns: #{e}"
|
|
2012
|
+
end
|
|
2013
|
+
```
|
|
2014
|
+
|
|
2015
|
+
#### Using the get_ten_dlc_sms_partner_campaigns_with_http_info variant
|
|
2016
|
+
|
|
2017
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2018
|
+
|
|
2019
|
+
> <Array(<SMSTenDLCPartnerCampaignsListResult>, Integer, Hash)> get_ten_dlc_sms_partner_campaigns_with_http_info(account_id, opts)
|
|
2020
|
+
|
|
2021
|
+
```ruby
|
|
2022
|
+
begin
|
|
2023
|
+
# Get list of SMS 10DLC Partner Campaigns
|
|
2024
|
+
data, status_code, headers = api_instance.get_ten_dlc_sms_partner_campaigns_with_http_info(opts)
|
|
2025
|
+
p status_code # => 2xx
|
|
2026
|
+
p headers # => { ... }
|
|
2027
|
+
p data # => <SMSTenDLCPartnerCampaignsListResult>
|
|
2028
|
+
rescue Freeclimb::ApiError => e
|
|
2029
|
+
puts "Error when calling DefaultApi->get_ten_dlc_sms_partner_campaigns_with_http_info: #{e}"
|
|
2030
|
+
end
|
|
2031
|
+
```
|
|
2032
|
+
|
|
2033
|
+
### Parameters
|
|
2034
|
+
|
|
2035
|
+
| Name | Type | Description | Notes |
|
|
2036
|
+
| ---- | ---- | ----------- | ----- |
|
|
2037
|
+
|
|
2038
|
+
| **brand_id** | **String** | The unique identifier for a brand | [optional] |
|
|
2039
|
+
|
|
2040
|
+
|
|
2041
|
+
### Return type
|
|
2042
|
+
|
|
2043
|
+
[**SMSTenDLCPartnerCampaignsListResult**](SMSTenDLCPartnerCampaignsListResult.md)
|
|
2044
|
+
|
|
2045
|
+
### Authorization
|
|
2046
|
+
|
|
2047
|
+
[fc](../README.md#fc)
|
|
2048
|
+
|
|
2049
|
+
### HTTP request headers
|
|
2050
|
+
|
|
2051
|
+
- **Content-Type**: Not defined
|
|
2052
|
+
- **Accept**: application/json
|
|
2053
|
+
|
|
2054
|
+
|
|
1625
2055
|
## list_active_queues
|
|
1626
2056
|
|
|
1627
2057
|
List Active Queues
|
|
@@ -2280,6 +2710,7 @@ opts = {
|
|
|
2280
2710
|
has_application: true, # Boolean | Indication of whether the phone number has an application linked to it.
|
|
2281
2711
|
voice_enabled: true, # Boolean | Indicates whether the phone number can handle Calls. Typically set to true for all numbers.
|
|
2282
2712
|
sms_enabled: true, # Boolean | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers.
|
|
2713
|
+
has_campaign: true, # Boolean | Indication of whether the phone number has a campaign associated with it
|
|
2283
2714
|
capabilities_voice: true, # Boolean |
|
|
2284
2715
|
capabilities_sms: true, # Boolean |
|
|
2285
2716
|
capabilities_toll_free: true, # Boolean |
|
|
@@ -2337,6 +2768,8 @@ end
|
|
|
2337
2768
|
|
|
2338
2769
|
| **sms_enabled** | **Boolean** | Indication of whether the phone number can handle sending and receiving SMS messages. Typically set to true for all numbers. | [optional][default to true] |
|
|
2339
2770
|
|
|
2771
|
+
| **has_campaign** | **Boolean** | Indication of whether the phone number has a campaign associated with it | [optional] |
|
|
2772
|
+
|
|
2340
2773
|
| **capabilities_voice** | **Boolean** | | [optional] |
|
|
2341
2774
|
|
|
2342
2775
|
| **capabilities_sms** | **Boolean** | | [optional] |
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **application_id** | **String** | ID of the Application that should handle calls to this number. | [optional] |
|
|
8
8
|
| **_alias** | **String** | Description for this phone number. | [optional] |
|
|
9
|
+
| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,7 +15,8 @@ require 'freeclimb'
|
|
|
14
15
|
|
|
15
16
|
instance = Freeclimb::IncomingNumberRequest.new(
|
|
16
17
|
application_id: null,
|
|
17
|
-
_alias: null
|
|
18
|
+
_alias: null,
|
|
19
|
+
campaign_id: null
|
|
18
20
|
)
|
|
19
21
|
```
|
|
20
22
|
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
# Freeclimb::SMSTenDLCBrand
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | ID of the account that created this Queue. | [optional] |
|
|
8
|
+
| **entity_type** | **String** | Entity type behind the brand. This is the form of business establishment. | |
|
|
9
|
+
| **csp_id** | **String** | Unique identifier assigned to the csp by the registry. | [optional][readonly] |
|
|
10
|
+
| **brand_id** | **String** | Unique identifier assigned to the brand by the registry. | [optional][readonly] |
|
|
11
|
+
| **first_name** | **String** | First or given name. | [optional] |
|
|
12
|
+
| **last_name** | **String** | Last or Surname. | [optional] |
|
|
13
|
+
| **display_name** | **String** | Display or marketing name of the brand. | |
|
|
14
|
+
| **company_name** | **String** | (Required for Non-profit/private/public) Legal company name. | [optional] |
|
|
15
|
+
| **ein** | **String** | (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S. | [optional] |
|
|
16
|
+
| **ein_issuing_country** | **String** | ISO2 2 characters country code. Example: US - United States | [optional] |
|
|
17
|
+
| **phone** | **String** | Valid phone number in e.164 international format. | |
|
|
18
|
+
| **street** | **String** | Street number and name. | [optional] |
|
|
19
|
+
| **city** | **String** | City name | [optional] |
|
|
20
|
+
| **state** | **String** | State. Must be 2 letters code for United States. | [optional] |
|
|
21
|
+
| **postal_code** | **String** | Postal codes. Use 5 digit zipcode for United States | [optional] |
|
|
22
|
+
| **country** | **String** | ISO2 2 characters country code. Example: US - United States | |
|
|
23
|
+
| **email** | **String** | Valid email address of brand support contact. | |
|
|
24
|
+
| **stock_symbol** | **String** | (Required for public company) stock symbol. | [optional] |
|
|
25
|
+
| **stock_exchange** | **String** | (Required for public company) stock exchange. | [optional] |
|
|
26
|
+
| **ip_address** | **String** | IP address of the browser requesting to create brand identity. | [optional] |
|
|
27
|
+
| **website** | **String** | Brand website URL. | [optional] |
|
|
28
|
+
| **brand_relationship** | **String** | Brand relationship to the CSP | |
|
|
29
|
+
| **vertical** | **String** | Vertical or industry segment of the brand. | |
|
|
30
|
+
| **alt_business_id** | **String** | Alternate business identifier such as DUNS, LEI, or GIIN | [optional] |
|
|
31
|
+
| **alt_business_id_type** | **String** | The type of the Alternative business identifier | [optional] |
|
|
32
|
+
| **universal_ein** | **String** | Universal EIN of Brand, Read Only. | [optional][readonly] |
|
|
33
|
+
| **reference_id** | **String** | Caller supplied brand reference ID. If supplied, the value must be unique across all submitted brands. Can be used to prevent duplicate brand registrations. | [optional] |
|
|
34
|
+
| **optional_attributes** | **Hash<String, Object>** | Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names. | [optional] |
|
|
35
|
+
| **mock** | **Boolean** | Test brand. | |
|
|
36
|
+
| **identity_status** | **String** | TCR assessment of the brand identification status. | |
|
|
37
|
+
| **create_date** | **Time** | Unix timestamp when brand was created. | [optional] |
|
|
38
|
+
|
|
39
|
+
## Example
|
|
40
|
+
|
|
41
|
+
```ruby
|
|
42
|
+
require 'freeclimb'
|
|
43
|
+
|
|
44
|
+
instance = Freeclimb::SMSTenDLCBrand.new(
|
|
45
|
+
account_id: null,
|
|
46
|
+
entity_type: null,
|
|
47
|
+
csp_id: null,
|
|
48
|
+
brand_id: null,
|
|
49
|
+
first_name: John,
|
|
50
|
+
last_name: Doe,
|
|
51
|
+
display_name: ABC Mobile,
|
|
52
|
+
company_name: ABC Inc.,
|
|
53
|
+
ein: 111111111,
|
|
54
|
+
ein_issuing_country: US,
|
|
55
|
+
phone: +12024567890,
|
|
56
|
+
street: 123 6th Ave,
|
|
57
|
+
city: New York,
|
|
58
|
+
state: NY,
|
|
59
|
+
postal_code: 10001,
|
|
60
|
+
country: US,
|
|
61
|
+
email: null,
|
|
62
|
+
stock_symbol: ABC,
|
|
63
|
+
stock_exchange: NASDAQ,
|
|
64
|
+
ip_address: null,
|
|
65
|
+
website: http://www.abcmobile.com,
|
|
66
|
+
brand_relationship: null,
|
|
67
|
+
vertical: null,
|
|
68
|
+
alt_business_id: null,
|
|
69
|
+
alt_business_id_type: null,
|
|
70
|
+
universal_ein: null,
|
|
71
|
+
reference_id: null,
|
|
72
|
+
optional_attributes: null,
|
|
73
|
+
mock: null,
|
|
74
|
+
identity_status: null,
|
|
75
|
+
create_date: null
|
|
76
|
+
)
|
|
77
|
+
```
|
|
78
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Freeclimb::SMSTenDLCBrandsListResult
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **total** | **Integer** | Total amount of requested resource. | [optional] |
|
|
8
|
+
| **start** | **Integer** | Resource index at start of current page | [optional] |
|
|
9
|
+
| **_end** | **Integer** | Resource index at end of current page | [optional] |
|
|
10
|
+
| **page** | **Integer** | Current page | [optional] |
|
|
11
|
+
| **num_pages** | **Integer** | Total number of pages | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | Number of items per page | [optional] |
|
|
13
|
+
| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
|
|
14
|
+
| **brands** | [**Array<SMSTenDLCBrand>**](SMSTenDLCBrand.md) | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'freeclimb'
|
|
20
|
+
|
|
21
|
+
instance = Freeclimb::SMSTenDLCBrandsListResult.new(
|
|
22
|
+
total: null,
|
|
23
|
+
start: null,
|
|
24
|
+
_end: null,
|
|
25
|
+
page: null,
|
|
26
|
+
num_pages: null,
|
|
27
|
+
page_size: null,
|
|
28
|
+
next_page_uri: null,
|
|
29
|
+
brands: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|