lws 0.4.2 → 6.1.0.beta1

data/lib/lws/corporate_website.rb

@@ -20,7 +20,7 @@ module LWS::CorporateWebsite
   end
   # :nocov:
 
-  #@!visibility private
+  # @!visibility private
   def self.api
     LWS.setup_api(LWS.config.endpoints[:corporate_website] ||
                   ENDPOINT[LWS.config.environment])
@@ -33,113 +33,231 @@ module LWS::CorporateWebsite
     use_api LWS::CorporateWebsite.api
   end
 
-  # (see Generic::Task)
-  class Task < LWS::Generic::Task
-    use_api LWS::CorporateWebsite.api
-  end
-
   ### App specific classes
 
   # = The article class
   class Article < LWS::Generic::Model
     use_api LWS::CorporateWebsite.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the article
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the article
+    attribute :id
+
+    # @!attribute body
+    #   @return [String, nil] the body of the article
+    attribute :body
 
-    #@!attribute body
-    #  @return [String] the body of the article
+    # @!attribute key
+    #   @return [String] the (page) key of the article
+    attribute :key
 
-    #@!attribute key
-    #  @return [String] the (page) key of the article
-    
-    #@!attribute language
-    #  @return [String] the ID of the language of the article (2 character)
+    # @!attribute language
+    #   @return [String] the ID of the language of the article (2 character)
+    attribute :language
 
-    #@!attribute news
-    #  @return [Boolean] flag whether the article is a news article
+    # @!attribute layout
+    #   @return ["text_image_social", "text_only", "map"] the layout used for
+    #     the article
+    attribute :layout
 
-    #@!attribute sitemap
-    #  @return [Boolean] flag whether the article is included in the sitemap
+    # @!attribute menu_key
+    #   @return [String, nil] the key of menu the article belongs to
+    attribute :menu_key
 
-    #@!attribute layout
-    #  @return [String] the layout used for the article
+    # @!attribute menu_item
+    #   @return [Boolean] whether the article has a menu item
+    attribute :menu_item
 
-    #@!attribute menu_key
-    #  @return [String] the key of menu the article belongs to
+    # @!attribute news
+    #   @return [Boolean, nil] flag whether the article is a news article
+    attribute :news
 
-    #@!attribute order
-    #  @return [Fixnum] the order (number) of the article withing the page
+    # @!attribute order
+    #   @return [Fixnum, nil] the order (number) of the article withing the page
+    attribute :order
 
-    #@!attribute picture
-    #  @return [String] the path to the picture accompanying the article
+    # @!attribute picture
+    #   @return [String, nil] the path to the picture accompanying the article
+    attribute :picture
 
-    #@!attribute picture_caption
-    #  @return [String] the caption for the picture accompanying the article
+    # @!attribute picture_caption
+    #   @return [String, nil] the caption for the picture accompanying the article
+    attribute :picture_caption
 
-    #@!attribute picture_url
-    #  @return [String] the URL to the picture accompanying the article
+    # @!attribute picture_url
+    #   @return [String, nil] the URL to the picture accompanying the article
+    attribute :picture_url
 
-    #@!attribute social_avatar
-    #  @return [String] the path to the social avatar accompanying the article
+    # @!attribute sitemap
+    #   @return [Boolean] flag whether the article is included in the sitemap
+    attribute :sitemap
 
-    #@!attribute social_avatar_url
-    #  @return [String] the URL to the social avatar accompanying the article
+    # @!attribute social_avatar
+    #   @return [String, nil] the path to the social avatar accompanying the article
+    attribute :social_avatar
 
-    #@!attribute social_location
-    #  @return [String] the location of the social user accompanying the article
+    # @!attribute social_avatar_url
+    #   @return [String, nil] the URL to the social avatar accompanying the article
+    attribute :social_avatar_url
 
-    #@!attribute social_name
-    #  @return [String] the name of the social user accompanying the article
+    # @!attribute social_location
+    #   @return [String, nil] the location of the social user accompanying the article
+    attribute :social_location
 
-    #@!attribute social_text
-    #  @return [String] the text of the social user accompanying the article
+    # @!attribute social_name
+    #   @return [String, nil] the name of the social user accompanying the article
+    attribute :social_name
 
-    #@!attribute title
-    #  @return [String] the title of the article
+    # @!attribute social_text
+    #   @return [String, nil] the text of the social user accompanying the article
+    attribute :social_text
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the article was created
+    # @!attribute title
+    #   @return [String, nil] the title of the article
+    attribute :title
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the article was last updated
+    # @!attribute url
+    #   @return [String] the (partial) URL of the article
+    attribute :url
 
-    self # To ensure that YARD does not skip the attributes of this class
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the article was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the article was last updated
+    attribute :updated_at
   end
 
   # = The opening hours class
   class OfficeTime < LWS::Generic::Model
     use_api LWS::CorporateWebsite.api
 
-    #@!attribute id [r]
-    #  @return [Fixnum] the (unique) ID of the office time
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the office time
+    attribute :id
+
+    # @!attribute announce
+    #   @return [String, nil] the date/time when the special office times
+    #     need to be announced on
+    attribute :announce
+
+    # @!attribute display_text
+    #   @return [String] the displayed text of the special office time
+    attribute :display_text
+
+    # @!attribute end
+    #   @return [String] the end date/time of the special office times
+    attribute :end
 
-    #@!attribute announce
-    #  @return [String] the date when the special office times need to be
-    #    announced on
+    # @!attribute language
+    #   @return [String] the ID of the language the office time is for (2 characters)
+    attribute :language
+
+    # @!attribute motive
+    #   @return [String] the special office time motive/key
+    attribute :motive
+
+    # @!attribute start
+    #   @return [String] the start date/time of the special office times
+    attribute :start
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the office time was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the office time was last updated
+    attribute :updated_at
+  end
+
+  # = The social page class
+  class SocialPage < LWS::Generic::Model
+    use_api LWS::CorporateWebsite.api
 
-    #@!attribute display_text
-    #  @return [String] the displayed text of the special office time
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the social page
+    attribute :id
 
-    #@!attribute language
-    #  @return [String] the ID of the language the office time is for (2 characters)
+    # @!attribute account
+    #   @return [LWS::Auth::Account] the account used for posting the social page
+    belongs_to :account, class_name: "LWS::Auth::Account"
 
-    #@!attribute motive
-    #  @return [String] the special office time motive/key
+    # @!attribute account_id
+    #   @return [Fixnum] the ID of the account used for posting the social page
+    attribute :account_id
 
-    #@!attribute start
-    #  @return [String] the start date/time of the special office times
+    # @!attribute company
+    #   @return [LWS::Auth::Company] the account used for posting the social page
+    belongs_to :company, class_name: "LWS::Auth::Company"
 
-    #@!attribute end
-    #  @return [String] the end date/time of the special office times
+    # @!attribute company_id
+    #   @return [Fixnum] the ID of the account used for posting the social page
+    attribute :company_id
 
-    #@!attribute created_at
-    #  @return [String] the timestamp of when the office time was created
+    # @!attribute provider
+    #   @return ["facebook", "linkedin", "twitter", nil] the social page provider
+    attribute :provider
 
-    #@!attribute updated_at
-    #  @return [String] the timestamp of when the office time was last updated
+    # @!attribute provider_uid
+    #   @return [String] the UID suplied by the social page provider
+    attribute :provider_uid
 
-    self # To ensure that YARD does not skip the attributes of this class
+    # @!attribute uid_type
+    #   @return ["personal", "page"] the social page UID type
+    attribute :uid_type
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the social page was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the social page was last updated
+    attribute :updated_at
   end
 
+  # = The social post class
+  class SocialPost < LWS::Generic::Model
+    use_api LWS::CorporateWebsite.api
+
+    # @!attribute id [r]
+    #   @return [Fixnum] the (unique) ID of the social post
+    attribute :id
+
+    # @!attribute article
+    #   @return [Article] the article associated with the social post
+    belongs_to :article
+
+    # @!attribute article_id
+    #   @return [Fixnum] the ID of the article associated with the social post
+    attribute :article_id
+
+    # @!attribute description
+    #   @return [String] the description of the social post
+    attribute :description
+
+    # @!attribute link
+    #   @return [String, nil] the link used in the social post
+    attribute :link
+
+    # @!attribute lat
+    #   @return [Float, nil] the latitude of the location of the social post
+    attribute :lat
+
+    # @!attribute long
+    #   @return [Float, nil] the longitude of the location of the social post
+    attribute :long
+
+    # @!attribute title
+    #   @return [String] the title of the social post
+    attribute :title
+
+    # @!attribute created_at [r]
+    #   @return [String] the timestamp of when the social post was created
+    attribute :created_at
+
+    # @!attribute updated_at [r]
+    #   @return [String] the timestamp of when the social post was last updated
+    attribute :updated_at
+  end
 end