freeclimb 4.3.0 → 4.4.0

data/docs/SMSTenDLCBrandsListResultAllOf.md

@@ -0,0 +1,18 @@
+# Freeclimb::SMSTenDLCBrandsListResultAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **brands** | [**Array<SMSTenDLCBrand>**](SMSTenDLCBrand.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCBrandsListResultAllOf.new(
+  brands: null
+)
+```
+

data/docs/SMSTenDLCCampaign.md

@@ -0,0 +1,78 @@
+# Freeclimb::SMSTenDLCCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | ID of the account that created this Queue. | [optional] |
+| **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |  |
+| **csp_id** | **String** | Alphanumeric identifier of the CSP associated with this campaign. |  |
+| **reseller_id** | **String** | Alphanumeric identifier of the reseller that you want to associate with this campaign. | [optional] |
+| **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.  | [optional] |
+| **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
+| **auto_renewal** | **Boolean** | Campaign subscription auto-renewal status. | [optional] |
+| **billed_date** | **Time** | Campaign recent billed date. | [optional] |
+| **brand_id** | **String** | Alphanumeric identifier of the brand associated with this campaign. |  |
+| **usecase** | **String** | Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. |  |
+| **sub_usecases** | **Array<String>** | Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases |  |
+| **description** | **String** | Summary description of this campaign. |  |
+| **embedded_link** | **Boolean** | Does message generated by the campaign include URL link in SMS? | [optional][default to false] |
+| **embedded_phone** | **Boolean** | Does message generated by the campaign include phone number in SMS? | [optional][default to false] |
+| **affiliate_marketing** | **Boolean** | Does message content controlled by affiliate marketing other than the brand? | [optional] |
+| **number_pool** | **Boolean** | Does campaign utilize pool of phone nubers? | [optional][default to false] |
+| **age_gated** | **Boolean** | Age gated content in campaign. | [optional] |
+| **direct_lending** | **Boolean** |  | [optional] |
+| **subscriber_optin** | **Boolean** | Does campaign require subscriber to opt-in before SMS is sent to subscriber? | [optional][default to false] |
+| **subscriber_optout** | **Boolean** | Does campaign support subscriber opt-out keyword(s)? | [optional][default to false] |
+| **subscriber_help** | **Boolean** | Does campaign responds to help keyword(s)? | [optional][default to false] |
+| **sample1** | **String** | Message sample. Some campaign tiers require 1 or more message samples. | [optional] |
+| **sample2** | **String** | Message sample. Some campaign tiers require 2 or more message samples. | [optional] |
+| **sample3** | **String** | Message sample. Some campaign tiers require 3 or more message samples. | [optional] |
+| **sample4** | **String** | Message sample. Some campaign tiers require 4 or more message samples. | [optional] |
+| **sample5** | **String** | Message sample. Some campaign tiers require 5 or more message samples. | [optional] |
+| **message_flow** | **String** | Message flow description. | [optional] |
+| **help_message** | **String** | Help message of the campaign. | [optional] |
+| **reference_id** | **String** | 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] |
+| **mock** | **Boolean** | Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. |  |
+| **next_renewal_or_expiration_date** | **Date** | When the campaign would be due for its next renew/bill date. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCCampaign.new(
+  account_id: null,
+  campaign_id: null,
+  csp_id: null,
+  reseller_id: null,
+  status: null,
+  create_date: null,
+  auto_renewal: null,
+  billed_date: null,
+  brand_id: null,
+  usecase: null,
+  sub_usecases: null,
+  description: null,
+  embedded_link: null,
+  embedded_phone: null,
+  affiliate_marketing: null,
+  number_pool: null,
+  age_gated: null,
+  direct_lending: null,
+  subscriber_optin: null,
+  subscriber_optout: null,
+  subscriber_help: null,
+  sample1: null,
+  sample2: null,
+  sample3: null,
+  sample4: null,
+  sample5: null,
+  message_flow: null,
+  help_message: null,
+  reference_id: null,
+  mock: null,
+  next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
+)
+```
+

data/docs/SMSTenDLCCampaignsListResult.md

@@ -0,0 +1,32 @@
+# Freeclimb::SMSTenDLCCampaignsListResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total amount of requested resource. | [optional] |
+| **start** | **Integer** | Resource index at start of current page | [optional] |
+| **_end** | **Integer** | Resource index at end of current page | [optional] |
+| **page** | **Integer** | Current page | [optional] |
+| **num_pages** | **Integer** | Total number of pages | [optional] |
+| **page_size** | **Integer** | Number of items per page | [optional] |
+| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
+| **campaigns** | [**Array<SMSTenDLCCampaign>**](SMSTenDLCCampaign.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCCampaignsListResult.new(
+  total: null,
+  start: null,
+  _end: null,
+  page: null,
+  num_pages: null,
+  page_size: null,
+  next_page_uri: null,
+  campaigns: null
+)
+```
+

data/docs/SMSTenDLCCampaignsListResultAllOf.md

@@ -0,0 +1,18 @@
+# Freeclimb::SMSTenDLCCampaignsListResultAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaigns** | [**Array<SMSTenDLCCampaign>**](SMSTenDLCCampaign.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCCampaignsListResultAllOf.new(
+  campaigns: null
+)
+```
+

data/docs/SMSTenDLCPartnerCampaign.md

@@ -0,0 +1,74 @@
+# Freeclimb::SMSTenDLCPartnerCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | ID of the account that created this Queue. | [optional] |
+| **campaign_id** | **String** | Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC. |  |
+| **status** | **String** | Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status.  | [optional] |
+| **create_date** | **Time** | Unix timestamp when campaign was created. | [optional] |
+| **brand_id** | **String** | Alphanumeric identifier of the brand associated with this campaign. |  |
+| **usecase** | **String** | Campaign usecase. Must be of defined valid types. Use `/registry/enum/usecase` operation to retrieve usecases available for given brand. |  |
+| **description** | **String** | Summary description of this campaign. |  |
+| **embedded_link** | **Boolean** | Does message generated by the campaign include URL link in SMS? | [optional][default to false] |
+| **embedded_phone** | **Boolean** | Does message generated by the campaign include phone number in SMS? | [optional][default to false] |
+| **affiliate_marketing** | **Boolean** | Does message content controlled by affiliate marketing other than the brand? | [optional] |
+| **number_pool** | **Boolean** | Does campaign utilize pool of phone nubers? | [optional][default to false] |
+| **age_gated** | **Boolean** | Age gated content in campaign. | [optional] |
+| **direct_lending** | **Boolean** |  | [optional] |
+| **subscriber_optin** | **Boolean** | Does campaign require subscriber to opt-in before SMS is sent to subscriber? | [optional][default to false] |
+| **subscriber_optout** | **Boolean** | Does campaign support subscriber opt-out keyword(s)? | [optional][default to false] |
+| **subscriber_help** | **Boolean** | Does campaign responds to help keyword(s)? | [optional][default to false] |
+| **sample1** | **String** | Message sample. Some campaign tiers require 1 or more message samples. | [optional] |
+| **sample2** | **String** | Message sample. Some campaign tiers require 2 or more message samples. | [optional] |
+| **sample3** | **String** | Message sample. Some campaign tiers require 3 or more message samples. | [optional] |
+| **sample4** | **String** | Message sample. Some campaign tiers require 4 or more message samples. | [optional] |
+| **sample5** | **String** | Message sample. Some campaign tiers require 5 or more message samples. | [optional] |
+| **message_flow** | **String** | Message flow description. | [optional] |
+| **help_message** | **String** | Help message of the campaign. | [optional] |
+| **optin_keywords** | **String** | Subscriber opt-in keywords. Multiple keywords are comma separated without space. | [optional] |
+| **optout_keywords** | **String** | Subscriber opt-out keywords. Multiple keywords are comma separated without space. | [optional] |
+| **help_keywords** | **String** | Subscriber help keywords. Multiple keywords are comma separated without space. | [optional] |
+| **optin_message** | **String** | Subscriber opt-in message. | [optional] |
+| **optout_message** | **String** | Subscriber opt-out message. | [optional] |
+| **brand** | [**SMSTenDLCPartnerCampaignBrand**](SMSTenDLCPartnerCampaignBrand.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCPartnerCampaign.new(
+  account_id: null,
+  campaign_id: null,
+  status: null,
+  create_date: null,
+  brand_id: null,
+  usecase: null,
+  description: null,
+  embedded_link: null,
+  embedded_phone: null,
+  affiliate_marketing: null,
+  number_pool: null,
+  age_gated: null,
+  direct_lending: null,
+  subscriber_optin: null,
+  subscriber_optout: null,
+  subscriber_help: null,
+  sample1: null,
+  sample2: null,
+  sample3: null,
+  sample4: null,
+  sample5: null,
+  message_flow: null,
+  help_message: null,
+  optin_keywords: null,
+  optout_keywords: null,
+  help_keywords: null,
+  optin_message: null,
+  optout_message: null,
+  brand: null
+)
+```
+

data/docs/SMSTenDLCPartnerCampaignBrand.md

@@ -0,0 +1,38 @@
+# Freeclimb::SMSTenDLCPartnerCampaignBrand
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | ID of the account that created this Queue. | [optional] |
+| **brand_id** | **String** | Unique identifier assigned to the brand by the registry. | [optional][readonly] |
+| **first_name** | **String** | First or given name.  | [optional] |
+| **last_name** | **String** | Last or Surname. | [optional] |
+| **display_name** | **String** | Display or marketing name of the brand. | [optional] |
+| **company_name** | **String** | (Required for Non-profit/private/public) Legal company name. | [optional] |
+| **phone** | **String** | Valid phone number in e.164 international format. |  |
+| **email** | **String** | Valid email address of brand support contact. |  |
+| **website** | **String** | Brand website URL. | [optional] |
+| **optional_attributes** | **Hash<String, Object>** | Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names. | [optional] |
+| **evp_vetting_score** | **Integer** | External vetting score. | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCPartnerCampaignBrand.new(
+  account_id: null,
+  brand_id: null,
+  first_name: John,
+  last_name: Doe,
+  display_name: ABC Mobile,
+  company_name: ABC Inc.,
+  phone: +12024567890,
+  email: null,
+  website: http://www.abcmobile.com,
+  optional_attributes: null,
+  evp_vetting_score: null
+)
+```
+

data/docs/SMSTenDLCPartnerCampaignsListResult.md

@@ -0,0 +1,32 @@
+# Freeclimb::SMSTenDLCPartnerCampaignsListResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total amount of requested resource. | [optional] |
+| **start** | **Integer** | Resource index at start of current page | [optional] |
+| **_end** | **Integer** | Resource index at end of current page | [optional] |
+| **page** | **Integer** | Current page | [optional] |
+| **num_pages** | **Integer** | Total number of pages | [optional] |
+| **page_size** | **Integer** | Number of items per page | [optional] |
+| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
+| **partner_campaigns** | [**Array<SMSTenDLCPartnerCampaign>**](SMSTenDLCPartnerCampaign.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCPartnerCampaignsListResult.new(
+  total: null,
+  start: null,
+  _end: null,
+  page: null,
+  num_pages: null,
+  page_size: null,
+  next_page_uri: null,
+  partner_campaigns: null
+)
+```
+

data/docs/SMSTenDLCPartnerCampaignsListResultAllOf.md

@@ -0,0 +1,18 @@
+# Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partner_campaigns** | [**Array<SMSTenDLCPartnerCampaign>**](SMSTenDLCPartnerCampaign.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf.new(
+  partner_campaigns: null
+)
+```
+