{"id":20791701,"url":"https://github.com/mailchimp/mailchimp-transactional-ruby","last_synced_at":"2025-05-05T21:24:19.822Z","repository":{"id":45511814,"uuid":"281764779","full_name":"mailchimp/mailchimp-transactional-ruby","owner":"mailchimp","description":"The official Ruby client library for the Mailchimp Transactional API","archived":false,"fork":false,"pushed_at":"2024-02-10T01:12:43.000Z","size":106,"stargazers_count":18,"open_issues_count":0,"forks_count":3,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-30T23:51:08.470Z","etag":null,"topics":["mailchimp","mailchimp-sdk","mandrill","mandrill-api","mandrill-api-wrapper","ruby"],"latest_commit_sha":null,"homepage":"https://mailchimp.com/developer/transactional/","language":"Ruby","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mailchimp.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-22T19:23:35.000Z","updated_at":"2025-03-03T19:34:44.000Z","dependencies_parsed_at":"2024-02-07T23:24:32.823Z","dependency_job_id":"26fdbb47-0574-4723-90f4-6ec2a20d1349","html_url":"https://github.com/mailchimp/mailchimp-transactional-ruby","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmailchimp-transactional-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmailchimp-transactional-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmailchimp-transactional-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mailchimp%2Fmailchimp-transactional-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mailchimp","download_url":"https://codeload.github.com/mailchimp/mailchimp-transactional-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252577630,"owners_count":21770843,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["mailchimp","mailchimp-sdk","mandrill","mandrill-api","mandrill-api-wrapper","ruby"],"created_at":"2024-11-17T15:46:52.383Z","updated_at":"2025-05-05T21:24:19.806Z","avatar_url":"https://github.com/mailchimp.png","language":"Ruby","readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://mailchimp.com/developer/\"\u003e\n    \u003cimg src=\"https://raw.githubusercontent.com/mailchimp/mailchimp-client-lib-codegen/main/resources/images/mcdev-banner.png\" alt=\"Mailchimp Developer\" width=\"100%\" height=\"auto\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n# Mailchimp Transactional — Ruby\n\nThe official Ruby client library for the Mailchimp Transactional API (v1)\n\n## Installation\n\n### Build a gem\n\nTo build the Ruby code into a gem:\n\n```shell\ngem build MailchimpTransactional.gemspec\n```\n\nThen either install the gem locally:\n\n```shell\ngem install ./MailchimpTransactional-1.0.59.gem\n```\n(for development, run `gem install --dev ./MailchimpTransactional-1.0.59.gem` to install the development dependencies)\n\nor publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).\n\nFinally add this to the Gemfile:\n\n    gem 'MailchimpTransactional', '~\u003e 1.0.59'\n\n### Install from Git\n\nIf the Ruby gem is hosted at a git repository: https://github.com/mailchimp/mailchimp-transactional-ruby, then add the following in the Gemfile:\n\n    gem 'MailchimpTransactional', :git =\u003e 'https://github.com/mailchimp/mailchimp-transactional-ruby.git'\n\n### Include the Ruby code directly\n\nInclude the Ruby code directly using `-I` as follows:\n\n```shell\nruby -Ilib script.rb\n```\n\n## Quick Start\n\n```ruby\nrequire 'MailchimpTransactional'\n\nbegin\n  client = MailchimpTransactional::Client.new('YOUR_API_KEY')\n  resp = client.users.ping\n  p resp\nrescue MailchimpTransactional::ApiError =\u003e e\n  puts \"Error: #{e}\"\nend\n```\n\n## Sending Requests\nAll requests are sent via POST and accept a single argument as the request body parameter.\n```ruby\nclient.templates.publish({ name:'My Template' });\n```\n\n## Output Formats\nOptionally, you can set the default response format for **all requests** to one of the following:\n- `json` *(default)*\n- `xml`\n- `php`\n- `yaml`\n\n```ruby\nclient.set_default_output_format('xml');\n```\n\nYou can also set the response format for a **single request** by passing in a special `outputFormat` param to the request body.\n```ruby\nclient.senders.list({ outputFormat: 'php' });\n```\n\n## PRs and Issues\nThis repo is autogenerated from https://github.com/mailchimp/mailchimp-client-lib-codegen -- please submit PRs or issues there!\n\n## API Endpoints\n\nAll URIs are relative to *https://mandrillapp.com/api/1.0*\n\n| Method | Endpoint |\n| ---------- | -------- |\n| **allowlists.add** | /allowlists/add |\n| **allowlists.delete** | /allowlists/delete |\n| **allowlists.list** | /allowlists/list |\n| **exports.activity** | /exports/activity |\n| **exports.allowlist** | /exports/allowlist |\n| **exports.info** | /exports/info |\n| **exports.list** | /exports/list |\n| **exports.rejects** | /exports/rejects |\n| **exports.whitelist** | /exports/whitelist |\n| **inbound.add_domain** | /inbound/add-domain |\n| **inbound.add_route** | /inbound/add-route |\n| **inbound.check_domain** | /inbound/check-domain |\n| **inbound.delete_domain** | /inbound/delete-domain |\n| **inbound.delete_route** | /inbound/delete-route |\n| **inbound.domains** | /inbound/domains |\n| **inbound.routes** | /inbound/routes |\n| **inbound.send_raw** | /inbound/send-raw |\n| **inbound.update_route** | /inbound/update-route |\n| **ips.cancel_warmup** | /ips/cancel-warmup |\n| **ips.check_custom_dns** | /ips/check-custom-dns |\n| **ips.create_pool** | /ips/create-pool |\n| **ips.delete** | /ips/delete |\n| **ips.delete_pool** | /ips/delete-pool |\n| **ips.info** | /ips/info |\n| **ips.list** | /ips/list |\n| **ips.list_pools** | /ips/list-pools |\n| **ips.pool_info** | /ips/pool-info |\n| **ips.provision** | /ips/provision |\n| **ips.set_custom_dns** | /ips/set-custom-dns |\n| **ips.set_pool** | /ips/set-pool |\n| **ips.start_warmup** | /ips/start-warmup |\n| **messages.cancel_scheduled** | /messages/cancel-scheduled |\n| **messages.content** | /messages/content |\n| **messages.info** | /messages/info |\n| **messages.list_scheduled** | /messages/list-scheduled |\n| **messages.parse** | /messages/parse |\n| **messages.reschedule** | /messages/reschedule |\n| **messages.search** | /messages/search |\n| **messages.search_time_series** | /messages/search-time-series |\n| **messages.send** | /messages/send |\n| **messages.send_raw** | /messages/send-raw |\n| **messages.send_template** | /messages/send-template |\n| **metadata.add** | /metadata/add |\n| **metadata.delete** | /metadata/delete |\n| **metadata.list** | /metadata/list |\n| **metadata.update** | /metadata/update |\n| **rejects.add** | /rejects/add |\n| **rejects.delete** | /rejects/delete |\n| **rejects.list** | /rejects/list |\n| **senders.add_domain** | /senders/add-domain |\n| **senders.check_domain** | /senders/check-domain |\n| **senders.domains** | /senders/domains |\n| **senders.info** | /senders/info |\n| **senders.list** | /senders/list |\n| **senders.time_series** | /senders/time-series |\n| **senders.verify_domain** | /senders/verify-domain |\n| **subaccounts.add** | /subaccounts/add |\n| **subaccounts.delete** | /subaccounts/delete |\n| **subaccounts.info** | /subaccounts/info |\n| **subaccounts.list** | /subaccounts/list |\n| **subaccounts.pause** | /subaccounts/pause |\n| **subaccounts.resume** | /subaccounts/resume |\n| **subaccounts.update** | /subaccounts/update |\n| **tags.all_time_series** | /tags/all-time-series |\n| **tags.delete** | /tags/delete |\n| **tags.info** | /tags/info |\n| **tags.list** | /tags/list |\n| **tags.time_series** | /tags/time-series |\n| **templates.add** | /templates/add |\n| **templates.delete** | /templates/delete |\n| **templates.info** | /templates/info |\n| **templates.list** | /templates/list |\n| **templates.publish** | /templates/publish |\n| **templates.render** | /templates/render |\n| **templates.time_series** | /templates/time-series |\n| **templates.update** | /templates/update |\n| **urls.add_tracking_domain** | /urls/add-tracking-domain |\n| **urls.check_tracking_domain** | /urls/check-tracking-domain |\n| **urls.list** | /urls/list |\n| **urls.search** | /urls/search |\n| **urls.time_series** | /urls/time-series |\n| **urls.tracking_domains** | /urls/tracking-domains |\n| **users.info** | /users/info |\n| **users.ping** | /users/ping |\n| **users.ping2** | /users/ping2 |\n| **users.senders** | /users/senders |\n| **webhooks.add** | /webhooks/add |\n| **webhooks.delete** | /webhooks/delete |\n| **webhooks.info** | /webhooks/info |\n| **webhooks.list** | /webhooks/list |\n| **webhooks.update** | /webhooks/update |\n| **whitelists.add** | /whitelists/add |\n| **whitelists.delete** | /whitelists/delete |\n| **whitelists.list** | /whitelists/list |\n\n\n## Additional Libraries\n\nMailchimp Transactional libraries are available in the following languages:\n\n\u003cdiv\u003e\n  \u003ca href=\"https://github.com/mailchimp/mailchimp-transactional-node\"\u003e\n  \u003cimg src=\"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_node.png?raw=true\" width=\"44\" height=\"44\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mailchimp/mailchimp-transactional-php\"\u003e\n  \u003cimg src=\"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_php.png?raw=true\" width=\"44\" height=\"44\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mailchimp/mailchimp-transactional-ruby\"\u003e\n  \u003cimg src=\"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_ruby.png?raw=true\" width=\"44\" height=\"44\"\u003e\n  \u003c/a\u003e\n  \u003ca href=\"https://github.com/mailchimp/mailchimp-transactional-python\"\u003e\n  \u003cimg src=\"https://github.com/mailchimp/mailchimp-client-lib-codegen/blob/main/resources/images/lang_python.png?raw=true\" width=\"44\" height=\"44\"\u003e\n  \u003c/a\u003e\n\u003c/div\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailchimp%2Fmailchimp-transactional-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmailchimp%2Fmailchimp-transactional-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmailchimp%2Fmailchimp-transactional-ruby/lists"}