late-sdk 0.0.697 → 0.0.698

data/lib/zernio-sdk/models/select_instagram_account200_response_account.rb

@@ -0,0 +1,249 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  class SelectInstagramAccount200ResponseAccount < ApiModelBase
+    # ID of the created SocialAccount
+    attr_accessor :account_id
+
+    attr_accessor :platform
+
+    attr_accessor :username
+
+    # Name of the Facebook Page backing this account
+    attr_accessor :display_name
+
+    attr_accessor :profile_picture
+
+    attr_accessor :is_active
+
+    attr_accessor :login_method
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account_id' => :'accountId',
+        :'platform' => :'platform',
+        :'username' => :'username',
+        :'display_name' => :'displayName',
+        :'profile_picture' => :'profilePicture',
+        :'is_active' => :'isActive',
+        :'login_method' => :'loginMethod'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'account_id' => :'String',
+        :'platform' => :'String',
+        :'username' => :'String',
+        :'display_name' => :'String',
+        :'profile_picture' => :'String',
+        :'is_active' => :'Boolean',
+        :'login_method' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::SelectInstagramAccount200ResponseAccount` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::SelectInstagramAccount200ResponseAccount`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'platform')
+        self.platform = attributes[:'platform']
+      end
+
+      if attributes.key?(:'username')
+        self.username = attributes[:'username']
+      end
+
+      if attributes.key?(:'display_name')
+        self.display_name = attributes[:'display_name']
+      end
+
+      if attributes.key?(:'profile_picture')
+        self.profile_picture = attributes[:'profile_picture']
+      end
+
+      if attributes.key?(:'is_active')
+        self.is_active = attributes[:'is_active']
+      end
+
+      if attributes.key?(:'login_method')
+        self.login_method = attributes[:'login_method']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      platform_validator = EnumAttributeValidator.new('String', ["instagram"])
+      return false unless platform_validator.valid?(@platform)
+      login_method_validator = EnumAttributeValidator.new('String', ["facebook_login"])
+      return false unless login_method_validator.valid?(@login_method)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] platform Object to be assigned
+    def platform=(platform)
+      validator = EnumAttributeValidator.new('String', ["instagram"])
+      unless validator.valid?(platform)
+        fail ArgumentError, "invalid value for \"platform\", must be one of #{validator.allowable_values}."
+      end
+      @platform = platform
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] login_method Object to be assigned
+    def login_method=(login_method)
+      validator = EnumAttributeValidator.new('String', ["facebook_login"])
+      unless validator.valid?(login_method)
+        fail ArgumentError, "invalid value for \"login_method\", must be one of #{validator.allowable_values}."
+      end
+      @login_method = login_method
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          account_id == o.account_id &&
+          platform == o.platform &&
+          username == o.username &&
+          display_name == o.display_name &&
+          profile_picture == o.profile_picture &&
+          is_active == o.is_active &&
+          login_method == o.login_method
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [account_id, platform, username, display_name, profile_picture, is_active, login_method].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/zernio-sdk/models/select_instagram_account_request.rb

@@ -0,0 +1,229 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  class SelectInstagramAccountRequest < ApiModelBase
+    # Profile ID from your connection flow
+    attr_accessor :profile_id
+
+    # The Facebook Page ID selected by the user, from GET /v1/connect/instagram/select-account
+    attr_accessor :page_id
+
+    # Long-lived Facebook user access token from the OAuth callback redirect
+    attr_accessor :temp_token
+
+    # Optional custom redirect URL to return to after selection
+    attr_accessor :redirect_url
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'profile_id' => :'profileId',
+        :'page_id' => :'pageId',
+        :'temp_token' => :'tempToken',
+        :'redirect_url' => :'redirect_url'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'profile_id' => :'String',
+        :'page_id' => :'String',
+        :'temp_token' => :'String',
+        :'redirect_url' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::SelectInstagramAccountRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::SelectInstagramAccountRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'profile_id')
+        self.profile_id = attributes[:'profile_id']
+      else
+        self.profile_id = nil
+      end
+
+      if attributes.key?(:'page_id')
+        self.page_id = attributes[:'page_id']
+      else
+        self.page_id = nil
+      end
+
+      if attributes.key?(:'temp_token')
+        self.temp_token = attributes[:'temp_token']
+      else
+        self.temp_token = nil
+      end
+
+      if attributes.key?(:'redirect_url')
+        self.redirect_url = attributes[:'redirect_url']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @profile_id.nil?
+        invalid_properties.push('invalid value for "profile_id", profile_id cannot be nil.')
+      end
+
+      if @page_id.nil?
+        invalid_properties.push('invalid value for "page_id", page_id cannot be nil.')
+      end
+
+      if @temp_token.nil?
+        invalid_properties.push('invalid value for "temp_token", temp_token cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @profile_id.nil?
+      return false if @page_id.nil?
+      return false if @temp_token.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] profile_id Value to be assigned
+    def profile_id=(profile_id)
+      if profile_id.nil?
+        fail ArgumentError, 'profile_id cannot be nil'
+      end
+
+      @profile_id = profile_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] page_id Value to be assigned
+    def page_id=(page_id)
+      if page_id.nil?
+        fail ArgumentError, 'page_id cannot be nil'
+      end
+
+      @page_id = page_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] temp_token Value to be assigned
+    def temp_token=(temp_token)
+      if temp_token.nil?
+        fail ArgumentError, 'temp_token cannot be nil'
+      end
+
+      @temp_token = temp_token
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          profile_id == o.profile_id &&
+          page_id == o.page_id &&
+          temp_token == o.temp_token &&
+          redirect_url == o.redirect_url
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [profile_id, page_id, temp_token, redirect_url].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/zernio-sdk/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.19.0
 =end
 
 module Zernio
-  VERSION = '0.0.697'
+  VERSION = '0.0.698'
 end

data/lib/zernio-sdk.rb

@@ -903,6 +903,9 @@ require 'zernio-sdk/models/list_inbox_reviews200_response_data_inner'
 require 'zernio-sdk/models/list_inbox_reviews200_response_data_inner_reply'
 require 'zernio-sdk/models/list_inbox_reviews200_response_data_inner_reviewer'
 require 'zernio-sdk/models/list_inbox_reviews200_response_summary'
+require 'zernio-sdk/models/list_instagram_pages200_response'
+require 'zernio-sdk/models/list_instagram_pages200_response_pages_inner'
+require 'zernio-sdk/models/list_instagram_pages200_response_pages_inner_instagram_business_account'
 require 'zernio-sdk/models/list_instagram_stories200_response'
 require 'zernio-sdk/models/list_instagram_stories200_response_data_inner'
 require 'zernio-sdk/models/list_lead_forms200_response'
@@ -1148,6 +1151,9 @@ require 'zernio-sdk/models/select_facebook_page_request_user_profile'
 require 'zernio-sdk/models/select_google_business_location200_response'
 require 'zernio-sdk/models/select_google_business_location200_response_account'
 require 'zernio-sdk/models/select_google_business_location_request'
+require 'zernio-sdk/models/select_instagram_account200_response'
+require 'zernio-sdk/models/select_instagram_account200_response_account'
+require 'zernio-sdk/models/select_instagram_account_request'
 require 'zernio-sdk/models/select_linked_in_organization200_response'
 require 'zernio-sdk/models/select_linked_in_organization200_response_account'
 require 'zernio-sdk/models/select_linked_in_organization200_response_bulk_refresh'

data/openapi.yaml

@@ -15705,6 +15705,17 @@ paths:
           in: query
           schema: { type: boolean, default: false }
           description: When true, the user is redirected to your redirect_url with raw OAuth data (code, state) instead of Zernio's default account selection UI. Use this to build a custom connect experience.
+        - name: loginMethod
+          in: query
+          schema: { type: string, enum: [instagram_login, facebook_login], default: instagram_login }
+          description: |
+            Instagram only. Which of the two Instagram connection methods to use. Ignored for every other platform.
+
+            `instagram_login` (the default, and what you get if you omit this): the Instagram Login dialog. The user authorizes their Instagram professional account directly, no Facebook Page required.
+
+            `facebook_login`: the Facebook Login dialog, i.e. "Instagram API with Facebook Login". The user authorizes a Facebook Page that has a linked Instagram professional account, and every API call for that account then runs through the Page. Use this when the customer manages Instagram through a Page and expects the Facebook consent screen. Because the user has to pick which Page to connect, the callback continues at the account-selection step, `/v1/connect/instagram/select-account`.
+
+            `facebook_login` does not support `headless=true`: its callback always redirects to Zernio's hosted account-selection page. Pass a `redirect_url` and let the standard flow return the user to you.
       security:
         - bearerAuth: []
       responses:
@@ -16135,6 +16146,142 @@ paths:
         '500':
           description: Failed to save Facebook connection
 
+  /v1/connect/instagram/select-account:
+    get:
+      operationId: listInstagramPages
+      tags: [Connect]
+      summary: List Pages with a linked Instagram account
+      description: |
+        Completes the `loginMethod=facebook_login` Instagram flow, i.e. "Instagram API with Facebook Login".
+
+        After the user authorizes on Facebook, extract `tempToken` from the redirect params and pass it here to list the Facebook Pages they manage. Only Pages that have a linked Instagram professional account are returned, so an empty array means the user has no eligible Page. Use the X-Connect-Token header if connecting via API key.
+
+        Not used by the default `instagram_login` flow, which creates the account without a selection step.
+      parameters:
+        - name: profileId
+          in: query
+          required: true
+          schema: { type: string }
+          description: Profile ID from your connection flow
+        - name: tempToken
+          in: query
+          required: true
+          schema: { type: string }
+          description: Long-lived Facebook user access token from the OAuth callback redirect
+      security:
+        - bearerAuth: []
+        - connectToken: []
+      responses:
+        '200':
+          description: Facebook Pages that have a linked Instagram professional account
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  pages:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        id: { type: string, description: Facebook Page ID }
+                        name: { type: string, description: Page name }
+                        access_token: { type: string, description: Page-specific access token }
+                        instagram_business_account:
+                          type: object
+                          description: The Instagram professional account linked to this Page
+                          properties:
+                            id: { type: string, description: Instagram Business Account ID }
+                            username: { type: string }
+                            profile_picture_url: { type: string }
+              example:
+                pages:
+                  - id: "811889972008357"
+                    name: "My Brand Page"
+                    access_token: "EAAxxxxx..."
+                    instagram_business_account:
+                      id: "17841400649984407"
+                      username: "mybrand"
+                      profile_picture_url: "https://..."
+        '400': { description: 'Missing required parameters (profileId or tempToken)' }
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '403': { description: User does not have access to the specified profile }
+    post:
+      operationId: selectInstagramAccount
+      tags: [Connect]
+      summary: Select the Page whose Instagram account to connect
+      description: |
+        Saves the selected Page as an Instagram account connected via Facebook Login. The Page access token becomes the account's access token, so every Instagram call for it runs against the Facebook Graph host.
+
+        One Instagram account per profile: if the profile already has an Instagram account, this replaces it, and picking a different Instagram identity purges the previous account's conversations, external posts and stats.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [profileId, pageId, tempToken]
+              properties:
+                profileId:
+                  type: string
+                  description: Profile ID from your connection flow
+                pageId:
+                  type: string
+                  description: 'The Facebook Page ID selected by the user, from GET /v1/connect/instagram/select-account'
+                tempToken:
+                  type: string
+                  description: Long-lived Facebook user access token from the OAuth callback redirect
+                redirect_url:
+                  type: string
+                  format: uri
+                  description: Optional custom redirect URL to return to after selection
+            example:
+              profileId: "507f1f77bcf86cd799439011"
+              pageId: "811889972008357"
+              tempToken: "EAAxxxxx..."
+              redirect_url: "https://yourdomain.com/integrations/callback"
+      security:
+        - bearerAuth: []
+        - connectToken: []
+      responses:
+        '200':
+          description: Instagram account connected
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message: { type: string }
+                  redirect_url:
+                    type: string
+                    description: Redirect URL if a custom redirect_url was provided
+                  account:
+                    type: object
+                    properties:
+                      accountId: { type: string, description: ID of the created SocialAccount }
+                      platform: { type: string, enum: [instagram] }
+                      username: { type: string }
+                      displayName: { type: string, description: Name of the Facebook Page backing this account }
+                      profilePicture: { type: string }
+                      isActive: { type: boolean }
+                      loginMethod: { type: string, enum: [facebook_login] }
+              example:
+                message: "Instagram (via Facebook) connected"
+                account:
+                  accountId: "64e1f0a9e2b5af0012ab34cd"
+                  platform: "instagram"
+                  username: "mybrand"
+                  displayName: "My Brand Page"
+                  profilePicture: "https://..."
+                  isActive: true
+                  loginMethod: "facebook_login"
+        '400':
+          description: 'Missing required fields, or the selected Page has no linked Instagram professional account'
+        '401': { $ref: '#/components/responses/Unauthorized' }
+        '402': { $ref: '#/components/responses/PaymentRequired' }
+        '403': { description: User does not have access to the specified profile }
+        '404': { description: Selected page not found among the pages this token can manage }
+
   /v1/connect/googlebusiness/locations:
     get:
       x-resource-group: "accounts"