mailchimp-marketing 0.0.218

data/lib/mailchimp/types/signup_form.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # List signup form.
+    class SignupForm < Internal::Types::Model
+      field :links, -> { Internal::Types::Array[Mailchimp::Types::SignupFormLinksItem] }, optional: true, nullable: false, api_name: "_links"
+
+      field :contents, -> { Internal::Types::Array[Mailchimp::Types::SignupFormContentsItem] }, optional: true, nullable: false
+
+      field :header, -> { Mailchimp::Types::SignupFormHeader }, optional: true, nullable: false
+
+      field :list_id, -> { String }, optional: true, nullable: false
+
+      field :signup_form_url, -> { String }, optional: true, nullable: false
+
+      field :styles, -> { Internal::Types::Array[Mailchimp::Types::SignupFormStylesItem] }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_contents_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Collection of Content for List Signup Forms.
+    class SignupFormContentsItem < Internal::Types::Model
+      field :section, -> { Mailchimp::Types::SignupFormContentsItemSection }, optional: true, nullable: false
+
+      field :value, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_contents_item_section.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormContentsItemSection
+      extend Mailchimp::Internal::Types::Enum
+
+      SIGNUP_MESSAGE = "signup_message"
+      UNSUB_MESSAGE = "unsub_message"
+      SIGNUP_THANK_YOU_TITLE = "signup_thank_you_title"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_header.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Options for customizing your signup form header.
+    class SignupFormHeader < Internal::Types::Model
+      field :image_align, -> { Mailchimp::Types::SignupFormHeaderImageAlign }, optional: true, nullable: false
+
+      field :image_alt, -> { String }, optional: true, nullable: false
+
+      field :image_border_color, -> { String }, optional: true, nullable: false
+
+      field :image_border_style, -> { Mailchimp::Types::SignupFormHeaderImageBorderStyle }, optional: true, nullable: false
+
+      field :image_border_width, -> { String }, optional: true, nullable: false
+
+      field :image_height, -> { String }, optional: true, nullable: false
+
+      field :image_link, -> { String }, optional: true, nullable: false
+
+      field :image_target, -> { Mailchimp::Types::SignupFormHeaderImageTarget }, optional: true, nullable: false
+
+      field :image_url, -> { String }, optional: true, nullable: false
+
+      field :image_width, -> { String }, optional: true, nullable: false
+
+      field :text, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_header_image_align.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormHeaderImageAlign
+      extend Mailchimp::Internal::Types::Enum
+
+      NONE = "none"
+      LEFT = "left"
+      CENTER = "center"
+      RIGHT = "right"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_header_image_border_style.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormHeaderImageBorderStyle
+      extend Mailchimp::Internal::Types::Enum
+
+      NONE = "none"
+      SOLID = "solid"
+      DOTTED = "dotted"
+      DASHED = "dashed"
+      DOUBLE = "double"
+      GROOVE = "groove"
+      OUTSET = "outset"
+      INSET = "inset"
+      RIDGE = "ridge"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_header_image_target.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormHeaderImageTarget
+      extend Mailchimp::Internal::Types::Enum
+
+      BLANK = "_blank"
+      NULL = "null"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_links_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # This object represents a link from the resource where it is found to another resource or action that may be
+    # performed.
+    class SignupFormLinksItem < Internal::Types::Model
+      field :href, -> { String }, optional: true, nullable: false
+
+      field :method_, -> { Mailchimp::Types::SignupFormLinksItemMethod }, optional: true, nullable: false, api_name: "method"
+
+      field :rel, -> { String }, optional: true, nullable: false
+
+      field :schema, -> { String }, optional: true, nullable: false
+
+      field :target_schema, -> { String }, optional: true, nullable: false, api_name: "targetSchema"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_links_item_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormLinksItemMethod
+      extend Mailchimp::Internal::Types::Enum
+
+      GET = "GET"
+      POST = "POST"
+      PUT = "PUT"
+      PATCH = "PATCH"
+      DELETE = "DELETE"
+      OPTIONS = "OPTIONS"
+      HEAD = "HEAD"
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_styles_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Collection of Element style for List Signup Forms.
+    class SignupFormStylesItem < Internal::Types::Model
+      field :options, -> { Internal::Types::Array[Mailchimp::Types::SignupFormStylesItemOptionsItem] }, optional: true, nullable: false
+
+      field :selector, -> { Mailchimp::Types::SignupFormStylesItemSelector }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_styles_item_options_item.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # An option for Signup Form Styles.
+    class SignupFormStylesItemOptionsItem < Internal::Types::Model
+      field :property, -> { String }, optional: true, nullable: false
+
+      field :value, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/signup_form_styles_item_selector.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SignupFormStylesItemSelector
+      extend Mailchimp::Internal::Types::Enum
+
+      PAGE_BACKGROUND = "page_background"
+      PAGE_HEADER = "page_header"
+      PAGE_OUTER_WRAPPER = "page_outer_wrapper"
+      BODY_BACKGROUND = "body_background"
+      BODY_LINK_STYLE = "body_link_style"
+      FORMS_BUTTONS = "forms_buttons"
+      FORMS_BUTTONS_HOVERED = "forms_buttons_hovered"
+      FORMS_FIELD_LABEL = "forms_field_label"
+      FORMS_FIELD_TEXT = "forms_field_text"
+      FORMS_REQUIRED = "forms_required"
+      FORMS_REQUIRED_LEGEND = "forms_required_legend"
+      FORMS_HELP_TEXT = "forms_help_text"
+      FORMS_ERRORS = "forms_errors"
+      MONKEY_REWARDS_BADGE = "monkey_rewards_badge"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # A single SMS campaign.
+    class SmsCampaign < Internal::Types::Model
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :web_id, -> { String }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :status, -> { String }, optional: true, nullable: false
+
+      field :channel, -> { String }, optional: true, nullable: false
+
+      field :list_id, -> { Integer }, optional: true, nullable: false
+
+      field :recipient_count, -> { Integer }, optional: true, nullable: false
+
+      field :create_time, -> { String }, optional: true, nullable: false
+
+      field :send_time, -> { String }, optional: true, nullable: false
+
+      field :updated_at, -> { String }, optional: true, nullable: false
+
+      field :expire_time, -> { String }, optional: true, nullable: false
+
+      field :is_send_now, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :folder_id, -> { String }, optional: true, nullable: false
+
+      field :segments, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false
+
+      field :excluded_segments, -> { Internal::Types::Array[Integer] }, optional: true, nullable: false
+
+      field :links, -> { Internal::Types::Array[Mailchimp::Types::SmsCampaignLinksItem] }, optional: true, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # The content of an SMS campaign.
+    class SmsCampaignContent < Internal::Types::Model
+      field :message_body, -> { String }, optional: true, nullable: false
+
+      field :estimated_segments, -> { Integer }, optional: true, nullable: false
+
+      field :merge_fields, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :media, -> { Internal::Types::Array[Mailchimp::Types::SmsCampaignContentMediaItem] }, optional: true, nullable: false
+
+      field :source, -> { Mailchimp::Types::SmsCampaignContentSource }, optional: true, nullable: false
+
+      field :properties, -> { Mailchimp::Types::SmsCampaignContentProperties }, optional: true, nullable: false
+
+      field :links, -> { Internal::Types::Array[Mailchimp::Types::SmsCampaignContentLinksItem] }, optional: true, nullable: false, api_name: "_links"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content_links_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # This object represents a link from the resource where it is found to another resource or action that may be
+    # performed.
+    class SmsCampaignContentLinksItem < Internal::Types::Model
+      field :href, -> { String }, optional: true, nullable: false
+
+      field :method_, -> { Mailchimp::Types::SmsCampaignContentLinksItemMethod }, optional: true, nullable: false, api_name: "method"
+
+      field :rel, -> { String }, optional: true, nullable: false
+
+      field :schema, -> { String }, optional: true, nullable: false
+
+      field :target_schema, -> { String }, optional: true, nullable: false, api_name: "targetSchema"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content_links_item_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SmsCampaignContentLinksItemMethod
+      extend Mailchimp::Internal::Types::Enum
+
+      GET = "GET"
+      POST = "POST"
+      PUT = "PUT"
+      PATCH = "PATCH"
+      DELETE = "DELETE"
+      OPTIONS = "OPTIONS"
+      HEAD = "HEAD"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content_media_item.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    class SmsCampaignContentMediaItem < Internal::Types::Model
+      field :url, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content_properties.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Additional content properties.
+    class SmsCampaignContentProperties < Internal::Types::Model
+      field :content_type, -> { String }, optional: true, nullable: false
+
+      field :sender, -> { String }, optional: true, nullable: false
+
+      field :optout_message_language, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_content_source.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # The source that created or imported this content.
+    class SmsCampaignContentSource < Internal::Types::Model
+      field :type, -> { String }, optional: true, nullable: false
+
+      field :id, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_links_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # This object represents a link from the resource where it is found to another resource or action that may be
+    # performed.
+    class SmsCampaignLinksItem < Internal::Types::Model
+      field :href, -> { String }, optional: true, nullable: false
+
+      field :method_, -> { Mailchimp::Types::SmsCampaignLinksItemMethod }, optional: true, nullable: false, api_name: "method"
+
+      field :rel, -> { String }, optional: true, nullable: false
+
+      field :schema, -> { String }, optional: true, nullable: false
+
+      field :target_schema, -> { String }, optional: true, nullable: false, api_name: "targetSchema"
+    end
+  end
+end

data/lib/mailchimp/types/sms_campaign_links_item_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SmsCampaignLinksItemMethod
+      extend Mailchimp::Internal::Types::Enum
+
+      GET = "GET"
+      POST = "POST"
+      PUT = "PUT"
+      PATCH = "PATCH"
+      DELETE = "DELETE"
+      OPTIONS = "OPTIONS"
+      HEAD = "HEAD"
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_in_automation_queue.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Information about subscribers in an Automation email queue.
+    class SubscriberInAutomationQueue < Internal::Types::Model
+      field :links, -> { Internal::Types::Array[Internal::Types::Array[Mailchimp::Types::SubscriberInAutomationQueueLinksItemItem]] }, optional: true, nullable: false, api_name: "_links"
+
+      field :email_address, -> { String }, optional: true, nullable: false
+
+      field :email_id, -> { String }, optional: true, nullable: false
+
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :list_id, -> { String }, optional: true, nullable: false
+
+      field :list_is_active, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :next_send, -> { String }, optional: true, nullable: false
+
+      field :workflow_id, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_in_automation_queue_links_item_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # This object represents a link from the resource where it is found to another resource or action that may be
+    # performed.
+    class SubscriberInAutomationQueueLinksItemItem < Internal::Types::Model
+      field :href, -> { String }, optional: true, nullable: false
+
+      field :method_, -> { Mailchimp::Types::SubscriberInAutomationQueueLinksItemItemMethod }, optional: true, nullable: false, api_name: "method"
+
+      field :rel, -> { String }, optional: true, nullable: false
+
+      field :schema, -> { String }, optional: true, nullable: false
+
+      field :target_schema, -> { String }, optional: true, nullable: false, api_name: "targetSchema"
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_in_automation_queue_links_item_item_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SubscriberInAutomationQueueLinksItemItemMethod
+      extend Mailchimp::Internal::Types::Enum
+
+      GET = "GET"
+      POST = "POST"
+      PUT = "PUT"
+      PATCH = "PATCH"
+      DELETE = "DELETE"
+      OPTIONS = "OPTIONS"
+      HEAD = "HEAD"
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Information about a specific list.
+    class SubscriberList < Internal::Types::Model
+      field :links, -> { Internal::Types::Array[Mailchimp::Types::SubscriberListLinksItem] }, optional: true, nullable: false, api_name: "_links"
+
+      field :beamer_address, -> { String }, optional: true, nullable: false
+
+      field :campaign_defaults, -> { Mailchimp::Types::SubscriberListCampaignDefaults }, optional: true, nullable: false
+
+      field :contact, -> { Mailchimp::Types::SubscriberListContact }, optional: true, nullable: false
+
+      field :date_created, -> { String }, optional: true, nullable: false
+
+      field :double_optin, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :email_type_option, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :has_welcome, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :id, -> { String }, optional: true, nullable: false
+
+      field :list_rating, -> { Integer }, optional: true, nullable: false
+
+      field :marketing_permissions, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :modules, -> { Internal::Types::Array[String] }, optional: true, nullable: false
+
+      field :name, -> { String }, optional: true, nullable: false
+
+      field :notify_on_subscribe, -> { String }, optional: true, nullable: false
+
+      field :notify_on_unsubscribe, -> { String }, optional: true, nullable: false
+
+      field :permission_reminder, -> { String }, optional: true, nullable: false
+
+      field :stats, -> { Mailchimp::Types::SubscriberListStats }, optional: true, nullable: false
+
+      field :subscribe_url_long, -> { String }, optional: true, nullable: false
+
+      field :subscribe_url_short, -> { String }, optional: true, nullable: false
+
+      field :use_archive_bar, -> { Internal::Types::Boolean }, optional: true, nullable: false
+
+      field :visibility, -> { Mailchimp::Types::SubscriberListVisibility }, optional: true, nullable: false
+
+      field :web_id, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_campaign_defaults.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # [Default values for
+    # campaigns](https://mailchimp.com/help/edit-your-emails-subject-preview-text-from-name-or-from-email-address/)
+    # created for this list.
+    class SubscriberListCampaignDefaults < Internal::Types::Model
+      field :from_email, -> { String }, optional: true, nullable: false
+
+      field :from_name, -> { String }, optional: true, nullable: false
+
+      field :language, -> { String }, optional: true, nullable: false
+
+      field :subject, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_contact.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # [Contact information displayed in campaign footers](https://mailchimp.com/help/about-campaign-footers/) to comply
+    # with international spam laws.
+    class SubscriberListContact < Internal::Types::Model
+      field :address1, -> { String }, optional: true, nullable: false
+
+      field :address2, -> { String }, optional: true, nullable: false
+
+      field :city, -> { String }, optional: true, nullable: false
+
+      field :company, -> { String }, optional: true, nullable: false
+
+      field :country, -> { String }, optional: true, nullable: false
+
+      field :phone, -> { String }, optional: true, nullable: false
+
+      field :state, -> { String }, optional: true, nullable: false
+
+      field :zip, -> { String }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_links_item.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # This object represents a link from the resource where it is found to another resource or action that may be
+    # performed.
+    class SubscriberListLinksItem < Internal::Types::Model
+      field :href, -> { String }, optional: true, nullable: false
+
+      field :method_, -> { Mailchimp::Types::SubscriberListLinksItemMethod }, optional: true, nullable: false, api_name: "method"
+
+      field :rel, -> { String }, optional: true, nullable: false
+
+      field :schema, -> { String }, optional: true, nullable: false
+
+      field :target_schema, -> { String }, optional: true, nullable: false, api_name: "targetSchema"
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_links_item_method.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SubscriberListLinksItemMethod
+      extend Mailchimp::Internal::Types::Enum
+
+      GET = "GET"
+      POST = "POST"
+      PUT = "PUT"
+      PATCH = "PATCH"
+      DELETE = "DELETE"
+      OPTIONS = "OPTIONS"
+      HEAD = "HEAD"
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_stats.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    # Stats for the list. Many of these are cached for at least five minutes.
+    class SubscriberListStats < Internal::Types::Model
+      field :avg_sub_rate, -> { Integer }, optional: true, nullable: false
+
+      field :avg_unsub_rate, -> { Integer }, optional: true, nullable: false
+
+      field :campaign_count, -> { Integer }, optional: true, nullable: false
+
+      field :campaign_last_sent, -> { String }, optional: true, nullable: false
+
+      field :cleaned_count, -> { Integer }, optional: true, nullable: false
+
+      field :cleaned_count_since_send, -> { Integer }, optional: true, nullable: false
+
+      field :click_rate, -> { Integer }, optional: true, nullable: false
+
+      field :last_sub_date, -> { String }, optional: true, nullable: false
+
+      field :last_unsub_date, -> { String }, optional: true, nullable: false
+
+      field :member_count, -> { Integer }, optional: true, nullable: false
+
+      field :member_count_since_send, -> { Integer }, optional: true, nullable: false
+
+      field :merge_field_count, -> { Integer }, optional: true, nullable: false
+
+      field :open_rate, -> { Integer }, optional: true, nullable: false
+
+      field :target_sub_rate, -> { Integer }, optional: true, nullable: false
+
+      field :total_contacts, -> { Integer }, optional: true, nullable: false
+
+      field :unsubscribe_count, -> { Integer }, optional: true, nullable: false
+
+      field :unsubscribe_count_since_send, -> { Integer }, optional: true, nullable: false
+    end
+  end
+end

data/lib/mailchimp/types/subscriber_list_visibility.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Mailchimp
+  module Types
+    module SubscriberListVisibility
+      extend Mailchimp::Internal::Types::Enum
+
+      PUB = "pub"
+      PRV = "prv"
+    end
+  end
+end