Skip to content

Commit 8e89b22

Browse files
amahadayaamahadaya
authored
Resolve VCSWP-18414 (Add Number Management feature into Python sdk) (#39)
* Add Number Management feature into Python sdk * Add changes to SDK as per openapi spec changes * Update latest changelog entry * Update docs for correct references as per PR feedback
1 parent 1ebf88d commit 8e89b22

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

44 files changed

+7741
-968
lines changed

‎.openapi-generator/FILES

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,6 +108,16 @@ docs/RejectAllOf.md
108108
docs/RemoveFromConference.md
109109
docs/RemoveFromConferenceAllOf.md
110110
docs/RequestType.md
111+
docs/SMSTenDLCBrand.md
112+
docs/SMSTenDLCBrandsListResult.md
113+
docs/SMSTenDLCBrandsListResultAllOf.md
114+
docs/SMSTenDLCCampaign.md
115+
docs/SMSTenDLCCampaignsListResult.md
116+
docs/SMSTenDLCCampaignsListResultAllOf.md
117+
docs/SMSTenDLCPartnerCampaign.md
118+
docs/SMSTenDLCPartnerCampaignBrand.md
119+
docs/SMSTenDLCPartnerCampaignsListResult.md
120+
docs/SMSTenDLCPartnerCampaignsListResultAllOf.md
111121
docs/Say.md
112122
docs/SayAllOf.md
113123
docs/SendDigits.md
@@ -253,6 +263,16 @@ freeclimb/model/set_talk.py
253263
freeclimb/model/set_talk_all_of.py
254264
freeclimb/model/sms.py
255265
freeclimb/model/sms_all_of.py
266+
freeclimb/model/sms_ten_dlc_brand.py
267+
freeclimb/model/sms_ten_dlc_brands_list_result.py
268+
freeclimb/model/sms_ten_dlc_brands_list_result_all_of.py
269+
freeclimb/model/sms_ten_dlc_campaign.py
270+
freeclimb/model/sms_ten_dlc_campaigns_list_result.py
271+
freeclimb/model/sms_ten_dlc_campaigns_list_result_all_of.py
272+
freeclimb/model/sms_ten_dlc_partner_campaign.py
273+
freeclimb/model/sms_ten_dlc_partner_campaign_brand.py
274+
freeclimb/model/sms_ten_dlc_partner_campaigns_list_result.py
275+
freeclimb/model/sms_ten_dlc_partner_campaigns_list_result_all_of.py
256276
freeclimb/model/start_record_call.py
257277
freeclimb/model/terminate_conference.py
258278
freeclimb/model/terminate_conference_all_of.py
@@ -269,5 +289,4 @@ requirements.txt
269289
setup.cfg
270290
setup.py
271291
test/__init__.py
272-
test/test_default_api.py
273292
tox.ini

‎CHANGELOG.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,14 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
99

1010
None
1111

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+
1220
<a name="4.3.0"></a>
1321

1422
## [4.3.0] - 2023-04-27

‎README.md

Lines changed: 199 additions & 189 deletions
Large diffs are not rendered by default.

‎docs/DefaultApi.md

Lines changed: 553 additions & 111 deletions
Large diffs are not rendered by default.

‎docs/IncomingNumberRequest.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**application_id** | **str** | ID of the Application that should handle calls to this number. | [optional]
77
**alias** | **str** | Description for this phone number. | [optional]
8+
**campaign_id** | **str, none_type** | The campaign ID generated by the campaign registry | [optional]
89

910
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
1011

‎docs/SMSTenDLCBrand.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# SMSTenDLCBrand
2+
3+
A brand is a business identity behind the campaign.
4+
## Properties
5+
Name | Type | Description | Notes
6+
------------ | ------------- | ------------- | -------------
7+
**entity_type** | **str** | Entity type behind the brand. This is the form of business establishment. |
8+
**display_name** | **str** | Display or marketing name of the brand. |
9+
**phone** | **str** | Valid phone number in e.164 international format. |
10+
**country** | **str** | ISO2 2 characters country code. Example: US - United States |
11+
**email** | **str** | Valid email address of brand support contact. |
12+
**brand_relationship** | **str** | Brand relationship to the CSP |
13+
**vertical** | **str** | Vertical or industry segment of the brand. |
14+
**mock** | **bool** | Test brand. |
15+
**identity_status** | **str** | TCR assessment of the brand identification status. |
16+
**account_id** | **str, none_type** | ID of the account that created this Queue. | [optional]
17+
**csp_id** | **str** | Unique identifier assigned to the csp by the registry. | [optional] [readonly]
18+
**brand_id** | **str** | Unique identifier assigned to the brand by the registry. | [optional] [readonly]
19+
**first_name** | **str** | First or given name. | [optional]
20+
**last_name** | **str** | Last or Surname. | [optional]
21+
**company_name** | **str** | (Required for Non-profit/private/public) Legal company name. | [optional]
22+
**ein** | **str** | (Required for Non-profit) Government assigned corporate tax ID. EIN is 9-digits in U.S. | [optional]
23+
**ein_issuing_country** | **str** | ISO2 2 characters country code. Example: US - United States | [optional]
24+
**street** | **str** | Street number and name. | [optional]
25+
**city** | **str** | City name | [optional]
26+
**state** | **str** | State. Must be 2 letters code for United States. | [optional]
27+
**postal_code** | **str** | Postal codes. Use 5 digit zipcode for United States | [optional]
28+
**stock_symbol** | **str** | (Required for public company) stock symbol. | [optional]
29+
**stock_exchange** | **str** | (Required for public company) stock exchange. | [optional]
30+
**ip_address** | **str** | IP address of the browser requesting to create brand identity. | [optional]
31+
**website** | **str** | Brand website URL. | [optional]
32+
**alt_business_id** | **str** | Alternate business identifier such as DUNS, LEI, or GIIN | [optional]
33+
**alt_business_id_type** | **str** | The type of the Alternative business identifier | [optional]
34+
**universal_ein** | **str** | Universal EIN of Brand, Read Only. | [optional] [readonly]
35+
**reference_id** | **str** | 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]
36+
**optional_attributes** | **{str: ({str: (bool, date, datetime, dict, float, int, list, str, none_type)},)}** | Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names. | [optional]
37+
**create_date** | **datetime** | Unix timestamp when brand was created. | [optional]
38+
39+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
40+
41+

‎docs/SMSTenDLCBrandsListResult.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# SMSTenDLCBrandsListResult
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**total** | **int, none_type** | Total amount of requested resource. | [optional]
7+
**start** | **int, none_type** | Resource index at start of current page | [optional]
8+
**end** | **int, none_type** | Resource index at end of current page | [optional]
9+
**page** | **int, none_type** | Current page | [optional]
10+
**num_pages** | **int, none_type** | Total number of pages | [optional]
11+
**page_size** | **int, none_type** | Number of items per page | [optional]
12+
**next_page_uri** | **str, none_type** | Uri to retrieve the next page of items | [optional]
13+
**brands** | [**[SMSTenDLCBrand], none_type**](SMSTenDLCBrand.md) | | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+

‎docs/SMSTenDLCBrandsListResultAllOf.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# SMSTenDLCBrandsListResultAllOf
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**brands** | [**[SMSTenDLCBrand], none_type**](SMSTenDLCBrand.md) | | [optional]
7+
8+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
9+
10+

‎docs/SMSTenDLCCampaign.md

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# SMSTenDLCCampaign
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**campaign_id** | **str** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |
7+
**csp_id** | **str** | Alphanumeric identifier of the CSP associated with this campaign. |
8+
**brand_id** | **str** | Alphanumeric identifier of the brand associated with this campaign. |
9+
**usecase** | **str** | Campaign usecase. Must be of defined valid types. Use &#x60;/registry/enum/usecase&#x60; operation to retrieve usecases available for given brand. |
10+
**sub_usecases** | **[str]** | Campaign sub-usecases. Must be of defined valid sub-usecase types. Use &#x60;/registry/enum/usecase&#x60; operation to retrieve list of valid sub-usecases |
11+
**description** | **str** | Summary description of this campaign. |
12+
**mock** | **bool** | Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. |
13+
**account_id** | **str, none_type** | ID of the account that created this Queue. | [optional]
14+
**reseller_id** | **str, none_type** | Alphanumeric identifier of the reseller that you want to associate with this campaign. | [optional]
15+
**status** | **str** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. | [optional]
16+
**create_date** | **datetime** | Unix timestamp when campaign was created. | [optional]
17+
**auto_renewal** | **bool** | Campaign subscription auto-renewal status. | [optional]
18+
**billed_date** | **datetime, none_type** | Campaign recent billed date. | [optional]
19+
**embedded_link** | **bool** | Does message generated by the campaign include URL link in SMS? | [optional] if omitted the server will use the default value of False
20+
**embedded_phone** | **bool** | Does message generated by the campaign include phone number in SMS? | [optional] if omitted the server will use the default value of False
21+
**affiliate_marketing** | **bool** | Does message content controlled by affiliate marketing other than the brand? | [optional]
22+
**number_pool** | **bool** | Does campaign utilize pool of phone nubers? | [optional] if omitted the server will use the default value of False
23+
**age_gated** | **bool** | Age gated content in campaign. | [optional]
24+
**direct_lending** | **bool** | | [optional]
25+
**subscriber_optin** | **bool** | Does campaign require subscriber to opt-in before SMS is sent to subscriber? | [optional] if omitted the server will use the default value of False
26+
**subscriber_optout** | **bool** | Does campaign support subscriber opt-out keyword(s)? | [optional] if omitted the server will use the default value of False
27+
**subscriber_help** | **bool** | Does campaign responds to help keyword(s)? | [optional] if omitted the server will use the default value of False
28+
**sample1** | **str** | Message sample. Some campaign tiers require 1 or more message samples. | [optional]
29+
**sample2** | **str, none_type** | Message sample. Some campaign tiers require 2 or more message samples. | [optional]
30+
**sample3** | **str, none_type** | Message sample. Some campaign tiers require 3 or more message samples. | [optional]
31+
**sample4** | **str, none_type** | Message sample. Some campaign tiers require 4 or more message samples. | [optional]
32+
**sample5** | **str, none_type** | Message sample. Some campaign tiers require 5 or more message samples. | [optional]
33+
**message_flow** | **str, none_type** | Message flow description. | [optional]
34+
**help_message** | **str, none_type** | Help message of the campaign. | [optional]
35+
**reference_id** | **str, none_type** | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. | [optional]
36+
**next_renewal_or_expiration_date** | **date, none_type** | When the campaign would be due for its next renew/bill date. | [optional]
37+
38+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
39+
40+

‎docs/SMSTenDLCCampaignsListResult.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# SMSTenDLCCampaignsListResult
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**total** | **int, none_type** | Total amount of requested resource. | [optional]
7+
**start** | **int, none_type** | Resource index at start of current page | [optional]
8+
**end** | **int, none_type** | Resource index at end of current page | [optional]
9+
**page** | **int, none_type** | Current page | [optional]
10+
**num_pages** | **int, none_type** | Total number of pages | [optional]
11+
**page_size** | **int, none_type** | Number of items per page | [optional]
12+
**next_page_uri** | **str, none_type** | Uri to retrieve the next page of items | [optional]
13+
**campaigns** | [**[SMSTenDLCCampaign], none_type**](SMSTenDLCCampaign.md) | | [optional]
14+
15+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
16+
17+

0 commit comments

Comments
 (0)