phonomenal_client 0.10.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 +7 -0
- data/.rspec +3 -0
- data/.rubocop.yml +13 -0
- data/CHANGELOG.md +71 -0
- data/CODE_OF_CONDUCT.md +132 -0
- data/LICENSE.txt +21 -0
- data/README.md +532 -0
- data/Rakefile +12 -0
- data/lib/phonomenal/account_context.rb +33 -0
- data/lib/phonomenal/api_handler.rb +90 -0
- data/lib/phonomenal/audio_response.rb +32 -0
- data/lib/phonomenal/calls.rb +10 -0
- data/lib/phonomenal/campaign_context.rb +147 -0
- data/lib/phonomenal/leads.rb +62 -0
- data/lib/phonomenal/response.rb +23 -0
- data/lib/phonomenal/version.rb +5 -0
- data/lib/phonomenal.rb +98 -0
- data/sig/phonomenal_client.rbs +4 -0
- metadata +78 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: b4ac7685badd4e4cf60274a6ac96e8c0ac6c185ffed6bf384d462b4a9bb9a7e1
|
|
4
|
+
data.tar.gz: ae0db569fdd9ce1c199452f5350f8e138fad5e7bea752ba8fbd272959926c93b
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: 5ddce04512e69e626dbd5e7e3d9d5a24634e5eb30ac47ce0c215fe95ce31effd761e2c107821f8bb812a9605b2cd341c0eca1cab9710827dee04f3b49f54a965
|
|
7
|
+
data.tar.gz: d063eed66b582197021c6a005ec0bc0eea37c8181776ccde8eae8e8f41a5f3f71273144abdbf2d5b1551db623591c5519dd1cf0ff3f719984eb2f157739486d4
|
data/.rspec
ADDED
data/.rubocop.yml
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
AllCops:
|
|
2
|
+
TargetRubyVersion: 3.0
|
|
3
|
+
|
|
4
|
+
Style/StringLiterals:
|
|
5
|
+
EnforcedStyle: double_quotes
|
|
6
|
+
|
|
7
|
+
Style/StringLiteralsInInterpolation:
|
|
8
|
+
EnforcedStyle: double_quotes
|
|
9
|
+
|
|
10
|
+
# RSpec describe/context blocks are long by nature; the metric is not meaningful here.
|
|
11
|
+
Metrics/BlockLength:
|
|
12
|
+
Exclude:
|
|
13
|
+
- "spec/**/*"
|
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
## [Unreleased]
|
|
2
|
+
|
|
3
|
+
## [0.10.0] - 2026-11-16
|
|
4
|
+
|
|
5
|
+
### Added
|
|
6
|
+
- `campaign.ivr` reads the campaign's IVR menu tree and `campaign.update_ivr(...)` replaces it:
|
|
7
|
+
main menu options and sub menus, down to sub sub menus (three levels). Options route a digit
|
|
8
|
+
to a member tag or group; in a sub menu callers press `*` for the previous menu and `0` for
|
|
9
|
+
the main menu.
|
|
10
|
+
- `member_tags` handler (`list`, `create`, `update`, `show`, `destroy`).
|
|
11
|
+
|
|
12
|
+
## [0.9.0] - 2026-11-05
|
|
13
|
+
|
|
14
|
+
### Added
|
|
15
|
+
- `campaign.voice_message_audio` fetches the audio of the campaign's own voice message
|
|
16
|
+
(what automated calls fall back to), and `campaign.voice_message_preview(lead: {...})`
|
|
17
|
+
reads it for one lead's values. Both return a `Phonomenal::AudioResponse`.
|
|
18
|
+
- The campaign's JSON has `voice_message_audio` (`personalized`, `audio_status`,
|
|
19
|
+
`audio_error`, `audio_duration_seconds`, `audio_generated_at`), and
|
|
20
|
+
`voice_message_webhook_url` also gets `event: "campaign.voice_message_audio_generated"`.
|
|
21
|
+
|
|
22
|
+
## [0.8.0] - 2026-11-03
|
|
23
|
+
|
|
24
|
+
### Added
|
|
25
|
+
- `voice_messages.audio(id)` fetches a voice message's generated audio (WAV), and
|
|
26
|
+
`voice_messages.preview(id, lead: {...})` the message read for one lead's values. Both
|
|
27
|
+
return a `Phonomenal::AudioResponse`: `success?`, `body` (the bytes), `content_type`,
|
|
28
|
+
`text` (what a preview reads) and `json` (the error, on failure).
|
|
29
|
+
- Voice messages take a `voice_id` (from `voices.list`), and show `voice_label`,
|
|
30
|
+
`personalized` and their audio's `audio_status`, `audio_error`, `audio_duration_seconds`
|
|
31
|
+
and `audio_generated_at`.
|
|
32
|
+
- Campaigns take a `voice_message_webhook_url`, which Phonomenal POSTs to
|
|
33
|
+
(`event: "voice_message.audio_generated"`) when a voice message's audio is ready or fails.
|
|
34
|
+
|
|
35
|
+
### Fixed
|
|
36
|
+
- Methods added with `add_method!` sent POST data as query parameters; they now send it
|
|
37
|
+
as a JSON body.
|
|
38
|
+
- `Phonomenal::Response` now passes unknown methods (`body`, `code`, `headers`) to the
|
|
39
|
+
HTTP response, as intended; the hook was misspelt.
|
|
40
|
+
|
|
41
|
+
## [0.7.0] - 2026-09-08
|
|
42
|
+
|
|
43
|
+
### Added
|
|
44
|
+
- `leads.unassign_all(member_email)` clears every lead held by one agent in a single call,
|
|
45
|
+
hitting the new `POST /leads/unassign_all` collection route. It returns
|
|
46
|
+
`unassigned_count` rather than a lead, and 404s when no member in the campaign has that
|
|
47
|
+
email.
|
|
48
|
+
|
|
49
|
+
## [0.6.0] - 2026-09-01
|
|
50
|
+
|
|
51
|
+
### Added
|
|
52
|
+
- `leads.bump(lead_id, bump_at:)` takes an optional scheduled time. `bump_at` is when the
|
|
53
|
+
lead becomes due for priority, so a future time schedules a bump rather than applying one
|
|
54
|
+
immediately. Omitting it keeps the previous behaviour of bumping from now.
|
|
55
|
+
- `leads.restore`, matching the server route for un-blocking a lead.
|
|
56
|
+
|
|
57
|
+
### Fixed
|
|
58
|
+
- `leads.set_follow_up` posted to `/leads/:id/set_follow_up`, which has no route on the
|
|
59
|
+
server and always 404'd. It now posts to `/leads/:id/follow_up`.
|
|
60
|
+
- `leads.unblock` posted to `/leads/:id/unblock`, which has no route. It is now an alias of
|
|
61
|
+
`leads.restore` and reaches the server.
|
|
62
|
+
|
|
63
|
+
### Removed
|
|
64
|
+
- `leads.reset`. There is no `reset` route on the server, so every call 404'd.
|
|
65
|
+
|
|
66
|
+
### Notes
|
|
67
|
+
- Lead endpoints had no test coverage at all; they are covered now.
|
|
68
|
+
|
|
69
|
+
## [0.1.0] - 2025-05-24
|
|
70
|
+
|
|
71
|
+
- Initial release
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
|
9
|
+
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
10
|
+
identity and orientation.
|
|
11
|
+
|
|
12
|
+
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
13
|
+
diverse, inclusive, and healthy community.
|
|
14
|
+
|
|
15
|
+
## Our Standards
|
|
16
|
+
|
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
|
18
|
+
community include:
|
|
19
|
+
|
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
|
24
|
+
and learning from the experience
|
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the overall
|
|
26
|
+
community
|
|
27
|
+
|
|
28
|
+
Examples of unacceptable behavior include:
|
|
29
|
+
|
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or advances of
|
|
31
|
+
any kind
|
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
33
|
+
* Public or private harassment
|
|
34
|
+
* Publishing others' private information, such as a physical or email address,
|
|
35
|
+
without their explicit permission
|
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
37
|
+
professional setting
|
|
38
|
+
|
|
39
|
+
## Enforcement Responsibilities
|
|
40
|
+
|
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
|
44
|
+
or harmful.
|
|
45
|
+
|
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
49
|
+
decisions when appropriate.
|
|
50
|
+
|
|
51
|
+
## Scope
|
|
52
|
+
|
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
|
54
|
+
an individual is officially representing the community in public spaces.
|
|
55
|
+
Examples of representing our community include using an official email address,
|
|
56
|
+
posting via an official social media account, or acting as an appointed
|
|
57
|
+
representative at an online or offline event.
|
|
58
|
+
|
|
59
|
+
## Enforcement
|
|
60
|
+
|
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
62
|
+
reported to the community leaders responsible for enforcement at
|
|
63
|
+
[INSERT CONTACT METHOD].
|
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
|
65
|
+
|
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
|
67
|
+
reporter of any incident.
|
|
68
|
+
|
|
69
|
+
## Enforcement Guidelines
|
|
70
|
+
|
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
|
73
|
+
|
|
74
|
+
### 1. Correction
|
|
75
|
+
|
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
|
77
|
+
unprofessional or unwelcome in the community.
|
|
78
|
+
|
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
|
82
|
+
|
|
83
|
+
### 2. Warning
|
|
84
|
+
|
|
85
|
+
**Community Impact**: A violation through a single incident or series of
|
|
86
|
+
actions.
|
|
87
|
+
|
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
|
91
|
+
includes avoiding interactions in community spaces as well as external channels
|
|
92
|
+
like social media. Violating these terms may lead to a temporary or permanent
|
|
93
|
+
ban.
|
|
94
|
+
|
|
95
|
+
### 3. Temporary Ban
|
|
96
|
+
|
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
|
98
|
+
sustained inappropriate behavior.
|
|
99
|
+
|
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
|
101
|
+
communication with the community for a specified period of time. No public or
|
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
|
104
|
+
Violating these terms may lead to a permanent ban.
|
|
105
|
+
|
|
106
|
+
### 4. Permanent Ban
|
|
107
|
+
|
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
|
111
|
+
|
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
113
|
+
community.
|
|
114
|
+
|
|
115
|
+
## Attribution
|
|
116
|
+
|
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
118
|
+
version 2.1, available at
|
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
120
|
+
|
|
121
|
+
Community Impact Guidelines were inspired by
|
|
122
|
+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
123
|
+
|
|
124
|
+
For answers to common questions about this code of conduct, see the FAQ at
|
|
125
|
+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
126
|
+
[https://www.contributor-covenant.org/translations][translations].
|
|
127
|
+
|
|
128
|
+
[homepage]: https://www.contributor-covenant.org
|
|
129
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
130
|
+
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
131
|
+
[FAQ]: https://www.contributor-covenant.org/faq
|
|
132
|
+
[translations]: https://www.contributor-covenant.org/translations
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2025 Venkatakrishnan Ganesh
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|