talkbox_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: acb6f1a33be16c907191d9c0a6e1f7cdeee5abe68b315b7d991e2930bd282b3c
+  data.tar.gz: d8f1531a7ac4cc00598e97c2cd9b683919e8cf188bdb016faa05d17e325ef272
+SHA512:
+  metadata.gz: 4c3e11a7e36945c6c37c6e8dd9bb9364f65ab84196cc2184fae46db13396304cd882e3d0e658cf46556412c673daa60d4de8779f99a9b8ffddb4c1cdad0607f7
+  data.tar.gz: 80db3b60f5aa91e7de8377bd87ffee8744181351248f7494cf3ac38de3f17574589b155265a3225adca3194b8aa6431278d6bd754cdf2785d343c88cb80288e0

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-07
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Glenn Trigg
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,54 @@
+# TalkboxApi
+
+This is a Ruby gem for interacting with the Talkbox API.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add talkbox_api
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install talkbox_api
+```
+
+## Usage
+
+First create a connection using the API credentials created in Talkbox at https://talkbox.impactapp.com.au/account/api_credentials.
+
+```ruby
+connection = TalkboxApi::Connection.new("username", "password")
+```
+
+You can then access the API resources using the connection object. E.g.
+
+```ruby
+connection.account.get
+connection.fields.all
+connection.tags.create "New Tag"
+```
+etc.
+
+See the full API documentation at https://talkbox.impactapp.com.au/api.html.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ImpactData/talkbox_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ImpactData/talkbox_api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the TalkboxApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ImpactData/talkbox_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/talkbox_api/account.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Account resource class
+  # This class provides methods for interacting with the Talkbox API account resource.
+  class Account
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves the account details
+    # @return [Hash] The account details
+    def get
+      resp = @conn.get("#{PATH_PREFIX}/account")
+      resp.body
+    end
+
+    # Updates the account details
+    # @param details [Hash] The account details to update
+    # @return [Hash] The updated account details
+    def update(details = {})
+      @conn.put("#{PATH_PREFIX}/account", details.to_json, { "Content-Type" => "application/json" }).body
+    end
+  end
+end

data/lib/talkbox_api/communications.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Communications resource class
+  # This class provides methods for interacting with the Talkbox API communications resource.
+  class Communications
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all communications
+    # @return [Array] The list of communications
+    def all
+      @conn.get("#{PATH_PREFIX}/communications").body
+    end
+
+    # Retrieves a specific communication
+    # @param id [String] The ID of the communication to retrieve
+    # @return [Hash] The retrieved communication
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/promotions/#{id}/communications").body
+    end
+
+    # Sends a communication
+    # @param id [String] The ID of the communication to send
+    # @param params [Hash] The parameters for the communication
+    # @return [Hash] The sent communication
+    def send(id, params)
+      @conn.post("#{PATH_PREFIX}/promotions/#{id}/communications", params.to_json,
+                 { "Content-Type" => "application/json" }).body
+    end
+  end
+end

data/lib/talkbox_api/contacts.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Contacts resource class
+  # This class provides methods for interacting with the Talkbox API contacts resource.
+  class Contacts
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all contacts
+    # @param params [Hash] Optional parameters for the request
+    # @return [Array] The list of contacts
+    def retrieve(params = { page: 1 })
+      @conn.get("#{PATH_PREFIX}/contact", params).body
+    end
+
+    # Retrieves a specific contact
+    # @param id [String] The ID of the contact to retrieve
+    # @return [Hash] The retrieved contact
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/contacts/#{id}").body
+    end
+
+    # Creates a new contact
+    # @param details [Hash] The details of the contact to create
+    # @return [Hash] The created contact
+    def create(details = {})
+      @conn.post("#{PATH_PREFIX}/contacts", details.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing contact
+    # @param id [String] The ID of the contact to update
+    # @param details [Hash] The details of the contact to update
+    # @return [Hash] The updated contact
+    def update(id, details = {})
+      @conn.put("#{PATH_PREFIX}/contacts/#{id}", details.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes a contact
+    # @param id [String] The ID of the contact to delete
+    # @return [Hash] The deleted contact
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/contacts/#{id}").body
+    end
+
+    # Creates or updates a contact
+    # @param details [Hash] The details of the contact to create or update
+    # @return [Hash] The created or updated contact
+    def create_or_update(details = {})
+      @conn.post("#{PATH_PREFIX}/contacts/create_or_update", details.to_json, { "Content-Type" => "application/json" })
+           .body
+    end
+
+    # Finds a contact by email or mobile number
+    # @param email [String] The email of the contact to find
+    # @param mobile_number [String] The mobile number of the contact to find
+    # @return [Hash] The found contact
+    def find_first(email: nil, mobile_number: nil)
+      @conn.get("#{PATH_PREFIX}/contact/find_first", { email: email, mobile_number: mobile_number }).body
+    end
+
+    # Sends a resubscription email to a contact
+    # @param id [String] The ID of the contact to send the email to
+    # @return [Hash] The sent email
+    def send_resubscription_email(id)
+      @conn.post("#{PATH_PREFIX}/contacts/#{id}/send_resubscription_email").body
+    end
+
+    # Sends a resubscription SMS to a contact
+    # @param id [String] The ID of the contact to send the SMS to
+    # @return [Hash] The sent SMS
+    def send_resubscription_sms(id)
+      @conn.post("#{PATH_PREFIX}/contacts/#{id}/send_resubscription_sms").body
+    end
+
+    # Retrieves all vouchers for a contact
+    # @param id [String] The ID of the contact to retrieve vouchers for
+    # @param status [String] Optional status of the vouchers to retrieve
+    # @return [Array] The list of vouchers
+    def vouchers(id, status = nil)
+      if status
+        @conn.get("#{PATH_PREFIX}/contacts/#{id}/vouchers", { status: status }).body
+      else
+        @conn.get("#{PATH_PREFIX}/contacts/#{id}/vouchers").body
+      end
+    end
+  end
+end

data/lib/talkbox_api/email_sender_details.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # EmailSenderDetails resource class
+  # This class provides methods for interacting with the Talkbox API email sender details resource.
+  class EmailSenderDetails
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all email sender details
+    # @return [Array] The list of email sender details
+    def all
+      @conn.get("#{PATH_PREFIX}/email_sender_details").body
+    end
+
+    # Creates a new email sender detail
+    # @param params [Hash] The parameters for the new email sender detail
+    # @return [Hash] The created email sender detail
+    def create(params)
+      @conn.post("#{PATH_PREFIX}/email_sender_details", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing email sender detail
+    # @param id [String] The ID of the email sender detail to update
+    # @param params [Hash] The parameters for the updated email sender detail
+    # @return [Hash] The updated email sender detail
+    def update(id, params)
+      @conn.put("#{PATH_PREFIX}/email_sender_details/#{id}", params.to_json, { "Content-Type" => "application/json" })
+           .body
+    end
+
+    # Deletes an email sender detail
+    # @param id [String] The ID of the email sender detail to delete
+    # @return [Hash] The deleted email sender detail
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/email_sender_details/#{id}").body
+    end
+  end
+end

data/lib/talkbox_api/fields.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Fields resource class
+  # This class provides methods for interacting with the Talkbox API fields resource.
+  class Fields
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all fields
+    # @return [Array] The list of fields
+    def all
+      @conn.get("#{PATH_PREFIX}/fields").body
+    end
+
+    # Creates a new field
+    # @param name [String] The name of the field
+    # @param field_type [String] The type of the field
+    # @param options [Hash] Optional additional options for the field
+    # @return [Hash] The created field
+    def create(name, field_type, options = nil)
+      @conn.post("#{PATH_PREFIX}/fields", { name: name, field_type: field_type, options: options }.to_json,
+                 { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing field
+    # @param system_name [String] The system name of the field to update
+    # @param name [String] The new name of the field
+    # @param options [Hash] Optional additional options for the field
+    # @return [Hash] The updated field
+    def update(system_name, name, options = nil)
+      @conn.put("#{PATH_PREFIX}/fields/#{system_name}", { name: name, options: options }.to_json,
+                { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes a field
+    # @param system_name [String] The system name of the field to delete
+    # @return [Hash] The deleted field
+    def delete(system_name)
+      @conn.delete("#{PATH_PREFIX}/fields/#{system_name}").body
+    end
+  end
+end

data/lib/talkbox_api/offers.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Offers resource class
+  # This class provides methods for interacting with the Talkbox API offers resource.
+  class Offers
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all offers
+    # @return [Array] The list of offers
+    def all
+      @conn.get("#{PATH_PREFIX}/offers").body
+    end
+
+    # Retrieves a specific offer
+    # @param id [String] The ID of the offer to retrieve
+    # @return [Hash] The retrieved offer
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/offers/#{id}").body
+    end
+
+    # Creates a new offer
+    # @param params [Hash] The parameters for the new offer
+    # @return [Hash] The created offer
+    def create(params)
+      @conn.post("#{PATH_PREFIX}/offers", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing offer
+    # @param id [String] The ID of the offer to update
+    # @param params [Hash] The parameters for the updated offer
+    # @return [Hash] The updated offer
+    def update(id, params)
+      @conn.put("#{PATH_PREFIX}/offers/#{id}", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes an offer
+    # @param id [String] The ID of the offer to delete
+    # @return [Hash] The deleted offer
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/offers/#{id}").body
+    end
+  end
+end

data/lib/talkbox_api/promotions.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Promotions resource class
+  # This class provides methods for interacting with the Talkbox API promotions resource.
+  class Promotions
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Creates a new promotion
+    # @param params [Hash] The parameters for the new promotion
+    # @return [Hash] The created promotion
+    def create(params)
+      @conn.post("#{PATH_PREFIX}/promotions", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing promotion
+    # @param id [String] The ID of the promotion to update
+    # @param params [Hash] The parameters for the updated promotion
+    # @return [Hash] The updated promotion
+    def update(id, params)
+      @conn.put("#{PATH_PREFIX}/promotions/#{id}", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes a promotion
+    # @param id [String] The ID of the promotion to delete
+    # @return [Hash] The deleted promotion
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/promotions/#{id}").body
+    end
+  end
+end

data/lib/talkbox_api/sections.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Sections resource class
+  # This class provides methods for interacting with the Talkbox API sections resource.
+  class Sections
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all sections
+    # @return [Array] The list of sections
+    def all
+      @conn.get("#{PATH_PREFIX}/sections").body
+    end
+
+    # Retrieves a specific section
+    # @param id [String] The ID of the section to retrieve
+    # @return [Hash] The retrieved section
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/sections/#{id}").body
+    end
+
+    # Creates a new section
+    # @param params [Hash] The parameters for the new section
+    # @return [Hash] The created section
+    def create(params)
+      @conn.post("#{PATH_PREFIX}/sections", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing section
+    # @param id [String] The ID of the section to update
+    # @param params [Hash] The parameters for the updated section
+    # @return [Hash] The updated section
+    def update(id, params)
+      @conn.put("#{PATH_PREFIX}/sections/#{id}", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes a section
+    # @param id [String] The ID of the section to delete
+    # @return [Hash] The deleted section
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/sections/#{id}").body
+    end
+  end
+end

data/lib/talkbox_api/subscriptions.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Subscriptions resource class
+  # This class provides methods for interacting with the Talkbox API subscriptions resource.
+  class Subscriptions
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all subscriptions
+    # @param params [Hash] Optional parameters for the request
+    # @return [Array] The list of subscriptions
+    def retrieve(params = { page: 1 })
+      @conn.get("#{PATH_PREFIX}/subscriptions", params).body
+    end
+
+    # Unsubscribes a contact
+    # @param params [Hash] The parameters for the unsubscribe request
+    # @return [Hash] The unsubscribed contact
+    def unsubscribe(params)
+      @conn.post("#{PATH_PREFIX}/unsubscriptions", params.to_json, { "Content-Type" => "application/json" }).body
+    end
+  end
+end

data/lib/talkbox_api/surveys.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Surveys resource class
+  # This class provides methods for interacting with the Talkbox API surveys resource.
+  class Surveys
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all surveys
+    # @param params [Hash] Optional parameters for the request
+    # @return [Array] The list of surveys
+    def all(params = nil)
+      @conn.get("#{PATH_PREFIX}/surveys", params).body
+    end
+
+    # Retrieves the score of a survey
+    # @param params [Hash] Optional parameters for the request
+    # @return [Hash] The score of the survey
+    def score(params = nil)
+      @conn.get("#{PATH_PREFIX}/surveys/score", params).body
+    end
+  end
+end

data/lib/talkbox_api/tags.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Tags resource class
+  # This class provides methods for interacting with the Talkbox API tags resource.
+  class Tags
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all tags
+    # @return [Array] The list of tags
+    def all
+      @conn.get("#{PATH_PREFIX}/tags").body.map(&:values).to_h
+    end
+
+    # Retrieves a specific tag
+    # @param id [String] The ID of the tag to retrieve
+    # @return [Hash] The retrieved tag
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/tags/#{id}").body
+    end
+
+    # Creates a new tag
+    # @param name [String] The name of the tag
+    # @return [Hash] The created tag
+    def create(name)
+      @conn.post("#{PATH_PREFIX}/tags", { name: name }.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Updates an existing tag
+    # @param id [String] The ID of the tag to update
+    # @param name [String] The new name of the tag
+    # @return [Hash] The updated tag
+    def update(id, name)
+      @conn.put("#{PATH_PREFIX}/tags/#{id}", { name: name }.to_json, { "Content-Type" => "application/json" }).body
+    end
+
+    # Deletes a tag
+    # @param id [String] The ID of the tag to delete
+    # @return [Hash] The deleted tag
+    def delete(id)
+      @conn.delete("#{PATH_PREFIX}/tags/#{id}").body
+    end
+
+    # Untags all contacts from a tag
+    # @param id [String] The ID of the tag to untag contacts from
+    # @return [Hash] The untagged tag
+    def untag_contacts(id)
+      @conn.put("#{PATH_PREFIX}/tags/#{id}/untag_contacts").body
+    end
+
+    # Retrieves all contacts for a tag
+    # @param id [String] The ID of the tag to retrieve contacts for
+    # @return [Array] The list of contacts
+    def contacts(id)
+      @conn.get("#{PATH_PREFIX}/tags/#{id}/contacts").body
+    end
+
+    # Adds a contact to a tag
+    # @param id [String] The ID of the tag to add the contact to
+    # @param contact_id [String] The ID of the contact to add
+    # @return [Hash] The added contact
+    def add_contact(id, contact_id)
+      @conn.post("#{PATH_PREFIX}/tags/#{id}/contacts/#{contact_id}").body
+    end
+
+    # Removes a contact from a tag
+    # @param id [String] The ID of the tag to remove the contact from
+    # @param contact_id [String] The ID of the contact to remove
+    # @return [Hash] The removed contact
+    def remove_contact(id, contact_id)
+      @conn.delete("#{PATH_PREFIX}/tags/#{id}/contacts/#{contact_id}").body
+    end
+  end
+end

data/lib/talkbox_api/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  VERSION = "1.0.0"
+end

data/lib/talkbox_api/vouchers.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module TalkboxApi
+  # Vouchers resource class
+  # This class provides methods for interacting with the Talkbox API vouchers resource.
+  class Vouchers
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Retrieves all vouchers
+    # @param params [Hash] Optional parameters for the request
+    # @return [Array] The list of vouchers
+    def all(params = nil)
+      @conn.get("#{PATH_PREFIX}/vouchers", params).body
+    end
+
+    # Retrieves a specific voucher
+    # @param id [String] The ID of the voucher to retrieve
+    # @return [Hash] The retrieved voucher
+    def get(id)
+      @conn.get("#{PATH_PREFIX}/vouchers/#{id}").body
+    end
+
+    # Redeems a voucher
+    # @param id [String] The ID of the voucher to redeem
+    # @return [Hash] The redeemed voucher
+    def redeem(id)
+      @conn.put("#{PATH_PREFIX}/vouchers/#{id}").body
+    end
+  end
+end

data/lib/talkbox_api.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+require "faraday"
+require_relative "talkbox_api/account"
+require_relative "talkbox_api/communications"
+require_relative "talkbox_api/contacts"
+require_relative "talkbox_api/email_sender_details"
+require_relative "talkbox_api/fields"
+require_relative "talkbox_api/offers"
+require_relative "talkbox_api/promotions"
+require_relative "talkbox_api/sections"
+require_relative "talkbox_api/subscriptions"
+require_relative "talkbox_api/surveys"
+require_relative "talkbox_api/tags"
+require_relative "talkbox_api/version"
+require_relative "talkbox_api/vouchers"
+
+module TalkboxApi
+  PATH_PREFIX = "/service/v1"
+
+  # Main connection class for Talkbox API
+  # This class handles authentication and provides access to all Talkbox API resources.
+  # It uses Faraday for HTTP requests and caches resource instances for efficiency.
+  class Connection
+    # Initializes a new Talkbox API connection
+    # @param username [String] The Talkbox API username
+    # @param password [String] The Talkbox API password
+    # @param base_url [String] Optional custom base URL for the API (defaults to Talkbox production)
+    # @raise [Faraday::Error] If authentication fails
+    def initialize(username, password, base_url: nil)
+      @base_url = base_url || "https://talkbox.impactapp.com.au/"
+      @conn = Faraday.new(url: @base_url) do |faraday|
+        faraday.request :authorization, "basic", username, password
+        faraday.response :json
+        faraday.response :raise_error
+      end
+      # Get account here to make sure credentials/base_url are all good.
+      account.get
+    end
+
+    # Returns a Fields resource instance
+    # @return [TalkboxApi::Fields] The Fields resource
+    def fields
+      @fields ||= Fields.new(@conn)
+    end
+
+    # Returns an Account resource instance
+    # @return [TalkboxApi::Account] The Account resource
+    def account
+      @account ||= Account.new(@conn)
+    end
+
+    # Returns a Tags resource instance
+    # @return [TalkboxApi::Tags] The Tags resource
+    def tags
+      @tags ||= Tags.new(@conn)
+    end
+
+    # Returns a Contacts resource instance
+    # @return [TalkboxApi::Contacts] The Contacts resource
+    def contacts
+      @contacts ||= Contacts.new(@conn)
+    end
+
+    # Returns a Subscriptions resource instance
+    # @return [TalkboxApi::Subscriptions] The Subscriptions resource
+    def subscriptions
+      @subscriptions ||= Subscriptions.new(@conn)
+    end
+
+    # Returns a Promotions resource instance
+    # @return [TalkboxApi::Promotions] The Promotions resource
+    def promotions
+      @promotions ||= Promotions.new(@conn)
+    end
+
+    # Returns a Communications resource instance
+    # @return [TalkboxApi::Communications] The Communications resource
+    def communications
+      @communications ||= Communications.new(@conn)
+    end
+
+    # Returns an EmailSenderDetails resource instance
+    # @return [TalkboxApi::EmailSenderDetails] The EmailSenderDetails resource
+    def email_sender_details
+      @email_sender_details ||= EmailSenderDetails.new(@conn)
+    end
+
+    # Returns a Surveys resource instance
+    # @return [TalkboxApi::Surveys] The Surveys resource
+    def surveys
+      @surveys ||= Surveys.new(@conn)
+    end
+
+    # Returns a Vouchers resource instance
+    # @return [TalkboxApi::Vouchers] The Vouchers resource
+    def vouchers
+      @vouchers ||= Vouchers.new(@conn)
+    end
+
+    # Returns an Offers resource instance
+    # @return [TalkboxApi::Offers] The Offers resource
+    def offers
+      @offers ||= Offers.new(@conn)
+    end
+
+    # Returns a Sections resource instance
+    # @return [TalkboxApi::Sections] The Sections resource
+    def sections
+      @sections ||= Sections.new(@conn)
+    end
+  end
+end

data/sig/talkbox_api.rbs

@@ -0,0 +1,4 @@
+module TalkboxApi
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: talkbox_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Glenn Trigg
+bindir: exe
+cert_chain: []
+date: 2025-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A Ruby gem for interacting with the Talkbox API (see https://talkbox.impactapp.com.au/api.html)
+email:
+- ggt@glenntrigg.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/talkbox_api.rb
+- lib/talkbox_api/account.rb
+- lib/talkbox_api/communications.rb
+- lib/talkbox_api/contacts.rb
+- lib/talkbox_api/email_sender_details.rb
+- lib/talkbox_api/fields.rb
+- lib/talkbox_api/offers.rb
+- lib/talkbox_api/promotions.rb
+- lib/talkbox_api/sections.rb
+- lib/talkbox_api/subscriptions.rb
+- lib/talkbox_api/surveys.rb
+- lib/talkbox_api/tags.rb
+- lib/talkbox_api/version.rb
+- lib/talkbox_api/vouchers.rb
+- sig/talkbox_api.rbs
+homepage: https://github.com/ImpactData/talkbox_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ImpactData/talkbox_api
+  changelog_uri: https://github.com/ImpactData/talkbox_api/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.3
+specification_version: 4
+summary: A Ruby gem for interacting with the Talkbox API.
+test_files: []