Class: SendGrid4r::Client

Inherits:

Object

• Object
• SendGrid4r::Client

Includes:

REST::API

Defined in:

lib/sendgrid4r/client.rb

Overview

SendGrid Web API v3 Client implementation

Constant Summary

Constants included from REST::Request

REST::Request::BASE_URL

Instance Attribute Summary

• #raw_resp ⇒ Object

  Returns the value of attribute raw_resp.

Instance Method Summary

• #initialize(username: nil, password: nil, api_key: nil, raw_response: false) ⇒ Client constructor

  A new instance of Client.

Methods included from REST::Mail

#send, url

Methods included from REST::Request

#create_args, #delete, #execute, #finish, #get, #patch, #post, #process_array_params, #process_url_params, #put

Methods included from REST::IpAccessManagement

create_ip_activities, create_ip_activity, create_whitelisted_ip, create_whitelisted_ip_result, create_whitelisted_ips, #delete_whitelisted_ip, #delete_whitelisted_ips, #get_ip_activities, #get_whitelisted_ip, #get_whitelisted_ips, #post_whitelisted_ips, url_activity, url_whitelist

Methods included from REST::Webhooks::Parse

create_parse_setting, create_parse_settings, #get_parse_settings, url

Methods included from REST::Webhooks::Event

create_event_notification, #get_settings_event_notification, #patch_settings_event_notification, #test_settings_event_notification, url_event

Methods included from REST::CancelScheduledSends

batch_url, create_scheduled_send, create_scheduled_sends, #delete_scheduled_send, #generate_batch_id, #get_scheduled_sends, #patch_scheduled_send, #post_scheduled_send, scheduled_sends_url, #validate_batch_id

Methods included from REST::SpamReports

create_spam_report, create_spam_reports, #delete_spam_report, #delete_spam_reports, #get_spam_report, #get_spam_reports, url

Methods included from REST::InvalidEmails

create_invalid_email, create_invalid_emails, #delete_invalid_email, #delete_invalid_emails, #get_invalid_email, #get_invalid_emails, url

Methods included from REST::Blocks

create_block, create_blocks, #delete_block, #delete_blocks, #get_block, #get_blocks, url

Methods included from REST::Bounces

create_bounce, create_bounces, #delete_bounce, #delete_bounces, #get_bounce, #get_bounces, url

Methods included from REST::Users

create_account, create_credits, create_email, create_password, create_profile, create_username, #get_user_account, #get_user_credits, #get_user_email, #get_user_profile, #get_user_username, #patch_user_profile, #put_user_email, #put_user_password, #put_user_username, url

Methods included from REST::Whitelabel::Links

#associate_wl_link, create_dns, create_link, create_links, create_record, create_result, create_validation_result, create_validation_results, #delete_wl_link, #disassociate_wl_link, #get_associated_wl_link, #get_default_wl_link, #get_wl_link, #get_wl_links, #patch_wl_link, #post_wl_link, url, #validate_wl_link

Methods included from REST::Whitelabel::Ips

create_a_record, create_ip, create_ips, create_result, create_users, create_validation_result, create_validation_results, #delete_wl_ip, #get_wl_ip, #get_wl_ips, #post_wl_ip, url, #validate_wl_ip

Methods included from REST::Whitelabel::Domains

#add_ip_to_wl_domain, #associate_wl_domain, create_dns, create_domain, create_domains, create_record, create_result, create_validation_result, create_validation_results, #delete_wl_domain, #disassociate_wl_domain, #get_associated_wl_domain, #get_default_wl_domain, #get_wl_domain, #get_wl_domains, #patch_wl_domain, #post_wl_domain, #remove_ip_from_wl_domain, url, #validate_wl_domain

Methods included from REST::EmailActivity

create_activities, create_activity, #get_email_activities, url

Methods included from REST::Subusers

create_monitor, create_subuser, create_subusers, #delete_subuser, #delete_subuser_monitor, #get_subuser_monitor, #get_subuser_reputation, #get_subusers, #patch_subuser, #post_subuser, #post_subuser_monitor, #put_subuser_assigned_ips, #put_subuser_monitor, url, url_monitor

Methods included from REST::ApiKeysManagement::Permissions

create_permissions, #get_permissions, url

Methods included from REST::ApiKeysManagement

create_api_key, create_api_keys, #delete_api_key, #get_api_key, #get_api_keys, #patch_api_key, #post_api_key, #put_api_key, url

Methods included from REST::MarketingCampaigns::Contacts::Segments

create_condition, create_segment, create_segments, #delete_segment, #get_recipients_on_segment, #get_segment, #get_segments, #patch_segment, #post_segment, url

Methods included from REST::MarketingCampaigns::Contacts::ReservedFields

create_field, create_fields, #get_reserved_fields

Methods included from REST::MarketingCampaigns::Contacts::Recipients

create_error, create_recipient, create_recipient_count, create_recipients, create_result, #delete_recipient, #delete_recipients, #get_lists_recipient_belong, #get_recipient, #get_recipients, #get_recipients_count, #patch_recipients, #post_recipients, #search_recipients, url

Methods included from REST::MarketingCampaigns::Contacts::Lists

create_list, create_lists, #delete_list, #delete_lists, #delete_recipient_from_list, #get_list, #get_lists, #get_recipients_from_list, #patch_list, #post_list, #post_recipient_to_list, #post_recipients_to_list, recipients_url, url

Methods included from REST::MarketingCampaigns::Contacts::CustomFields

create_field, create_fields, #delete_custom_field, #get_custom_field, #get_custom_fields, #post_custom_field, url

Methods included from REST::MarketingCampaigns

create_address, create_campaign, create_campaigns, create_sender, create_senders, create_verified, #delete_campaign, #delete_sender, #get_campaign, #get_campaigns, #get_schedule_time_campaign, #get_sender, #get_senders, #patch_campaign, #patch_sender, #post_campaign, #post_sender, #reschedule_campaign, #resend_sender_verification, #schedule_campaign, #send_campaign, #test_campaign, #unschedule_campaign, url, url_sender

Methods included from REST::Stats::Parse

#get_parse_stats

Methods included from REST::Stats::Advanced

#get_browsers_stats, #get_clients_stats, #get_clients_type_stats, #get_devices_stats, #get_geo_stats, #get_mailbox_providers_stats

Methods included from REST::Stats::Subuser

#get_subuser_stats_monthly, #get_subusers_stats, #get_subusers_stats_monthly, #get_subusers_stats_sums, url

Methods included from REST::Stats::Category

#get_categories_stats, #get_categories_stats_sums

Methods included from REST::Stats::Global

#get_global_stats

Methods included from REST::Categories

create_categories, create_category, #get_categories

Methods included from REST::Ips::Pools

create_pool, create_pools, #delete_pool, #get_pool, #get_pools, #post_pool, #put_pool, url

Methods included from REST::Ips::Warmup

create_warmup_ip, create_warmup_ips, #delete_warmup_ip, #get_warmup_ip, #get_warmup_ips, #post_warmup_ip, url

Methods included from REST::Ips::Addresses

create_address, create_addresses, #delete_ip_from_pool, #get_ip, #get_ips, #get_ips_assigned, #post_ip_to_pool, url

Methods included from REST::Settings::Tracking

create_click, create_google_analytics, create_open, create_subscription, #get_settings_click, #get_settings_google_analytics, #get_settings_open, #get_settings_subscription, #get_tracking_settings, #patch_settings_click, #patch_settings_google_analytics, #patch_settings_open, #patch_settings_subscription, url

Methods included from REST::Settings::Partner

create_partner, #get_partner_settings, #get_settings_new_relic, #patch_settings_new_relic, url

Methods included from REST::Settings::Mail

create_address_whitelist, create_bcc, create_bounce_purge, create_footer, create_forward_bounce, create_forward_spam, create_plain_content, create_spam_check, create_template, #get_mail_settings, #get_settings_address_whitelist, #get_settings_bcc, #get_settings_bounce_purge, #get_settings_footer, #get_settings_forward_bounce, #get_settings_forward_spam, #get_settings_plain_content, #get_settings_spam_check, #get_settings_template, #patch_settings_address_whitelist, #patch_settings_bcc, #patch_settings_bounce_purge, #patch_settings_footer, #patch_settings_forward_bounce, #patch_settings_forward_spam, #patch_settings_plain_content, #patch_settings_spam_check, #patch_settings_template, url

Methods included from REST::Settings::EnforcedTls

create_enforced_tls, #get_enforced_tls, #patch_enforced_tls, url

Methods included from REST::Settings

create_result, create_results

Methods included from REST::Sm::GlobalUnsubscribes

create_supressions, #delete_global_suppressed_email, #get_global_suppressed_email, #get_global_unsubscribes, #post_global_suppressed_emails, url, url_unsubscribes

Methods included from REST::Sm::Suppressions

create_suppression, create_suppressions, #delete_suppressed_email, #get_suppressed_emails, #get_suppressions, #post_suppressed_emails, url

Methods included from REST::Sm::Groups

create_group, create_groups, #delete_group, #get_group, #get_groups, #patch_group, #post_group, url

Methods included from REST::Sm

create_recipient_email, create_recipient_emails

Methods included from REST::TransactionalTemplates::Versions

#activate_version, create_version, #delete_version, #get_version, #patch_version, #post_version, url

Methods included from REST::TransactionalTemplates

create_template, create_templates, #delete_template, #get_template, #get_templates, #patch_template, #post_template, url

Constructor Details

#initialize(username: nil, password: nil, api_key: nil, raw_response: false) ⇒ Client

Returns a new instance of Client.

# File 'lib/sendgrid4r/client.rb', line 12

def initialize(
  username: nil, password: nil, api_key: nil, raw_response: false
)
  @auth = Auth.new(username: username, password: password, api_key: api_key)
  @raw_resp = raw_response
end

Instance Attribute Details

#raw_resp ⇒ Object

Returns the value of attribute raw_resp.

# File 'lib/sendgrid4r/client.rb', line 10

def raw_resp
  @raw_resp
end