increase 1.362.0 → 1.364.0

data/lib/increase/models/oauth_connection.rb

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::OAuthConnections#retrieve
-    class OAuthConnection < Increase::Internal::Type::BaseModel
-      # @!attribute id
-      #   The OAuth Connection's identifier.
-      #
-      #   @return [String]
-      required :id, String
-
-      # @!attribute created_at
-      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
-      #   Connection was created.
-      #
-      #   @return [Time]
-      required :created_at, Time
-
-      # @!attribute deleted_at
-      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
-      #   Connection was deleted.
-      #
-      #   @return [Time, nil]
-      required :deleted_at, Time, nil?: true
-
-      # @!attribute group_id
-      #   The identifier of the Group that has authorized your OAuth application.
-      #
-      #   @return [String]
-      required :group_id, String
-
-      # @!attribute oauth_application_id
-      #   The identifier of the OAuth application this connection is for.
-      #
-      #   @return [String]
-      required :oauth_application_id, String
-
-      # @!attribute status
-      #   Whether the connection is active.
-      #
-      #   @return [Symbol, Increase::Models::OAuthConnection::Status]
-      required :status, enum: -> { Increase::OAuthConnection::Status }
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `oauth_connection`.
-      #
-      #   @return [Symbol, Increase::Models::OAuthConnection::Type]
-      required :type, enum: -> { Increase::OAuthConnection::Type }
-
-      # @!method initialize(id:, created_at:, deleted_at:, group_id:, oauth_application_id:, status:, type:)
-      #   When a user authorizes your OAuth application, an OAuth Connection object is
-      #   created. Learn more about OAuth
-      #   [here](https://increase.com/documentation/oauth).
-      #
-      #   @param id [String] The OAuth Connection's identifier.
-      #
-      #   @param created_at [Time]
-      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
-      #     Connection was created.
-      #
-      #   @param deleted_at [Time, nil]
-      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
-      #     Connection was deleted.
-      #
-      #   @param group_id [String] The identifier of the Group that has authorized your OAuth application.
-      #
-      #   @param oauth_application_id [String] The identifier of the OAuth application this connection is for.
-      #
-      #   @param status [Symbol, Increase::Models::OAuthConnection::Status] Whether the connection is active.
-      #
-      #   @param type [Symbol, Increase::Models::OAuthConnection::Type]
-      #     A constant representing the object's type. For this resource it will always be
-      #     `oauth_connection`.
-
-      # Whether the connection is active.
-      #
-      # @see Increase::Models::OAuthConnection#status
-      module Status
-        extend Increase::Internal::Type::Enum
-
-        # The OAuth connection is active.
-        ACTIVE = :active
-
-        # The OAuth connection is permanently deactivated.
-        INACTIVE = :inactive
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `oauth_connection`.
-      #
-      # @see Increase::Models::OAuthConnection#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        OAUTH_CONNECTION = :oauth_connection
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/oauth_connection_list_params.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::OAuthConnections#list
-    class OAuthConnectionListParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute cursor
-      #   Return the page of entries after this one.
-      #
-      #   @return [String, nil]
-      optional :cursor, String
-
-      # @!attribute limit
-      #   Limit the size of the list that is returned. The default (and maximum) is 100
-      #   objects.
-      #
-      #   Defaults to `100`.
-      #
-      #   @return [Integer, nil]
-      optional :limit, Integer
-
-      # @!attribute oauth_application_id
-      #   Filter results to only include OAuth Connections for a specific OAuth
-      #   Application.
-      #
-      #   @return [String, nil]
-      optional :oauth_application_id, String
-
-      # @!attribute status
-      #
-      #   @return [Increase::Models::OAuthConnectionListParams::Status, nil]
-      optional :status, -> { Increase::OAuthConnectionListParams::Status }
-
-      # @!method initialize(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {})
-      #   @param cursor [String] Return the page of entries after this one.
-      #
-      #   @param limit [Integer]
-      #     Limit the size of the list that is returned. The default (and maximum) is 100
-      #     objects.
-      #
-      #     Defaults to `100`.
-      #
-      #   @param oauth_application_id [String]
-      #     Filter results to only include OAuth Connections for a specific OAuth
-      #     Application.
-      #
-      #   @param status [Increase::Models::OAuthConnectionListParams::Status]
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-
-      class Status < Increase::Internal::Type::BaseModel
-        # @!attribute in_
-        #   Filter to OAuth Connections by their status. By default, return only the
-        #   `active` ones. For GET requests, this should be encoded as a comma-delimited
-        #   string, such as `?in=one,two,three`.
-        #
-        #   @return [Array<Symbol, Increase::Models::OAuthConnectionListParams::Status::In>, nil]
-        optional :in_,
-                 -> {
-                   Increase::Internal::Type::ArrayOf[enum: Increase::OAuthConnectionListParams::Status::In]
-                 },
-                 api_name: :in
-
-        # @!method initialize(in_: nil)
-        #   @param in_ [Array<Symbol, Increase::Models::OAuthConnectionListParams::Status::In>]
-        #     Filter to OAuth Connections by their status. By default, return only the
-        #     `active` ones. For GET requests, this should be encoded as a comma-delimited
-        #     string, such as `?in=one,two,three`.
-
-        module In
-          extend Increase::Internal::Type::Enum
-
-          # The OAuth connection is active.
-          ACTIVE = :active
-
-          # The OAuth connection is permanently deactivated.
-          INACTIVE = :inactive
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-    end
-  end
-end

data/lib/increase/models/oauth_connection_retrieve_params.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::OAuthConnections#retrieve
-    class OAuthConnectionRetrieveParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute oauth_connection_id
-      #   The identifier of the OAuth Connection.
-      #
-      #   @return [String]
-      required :oauth_connection_id, String
-
-      # @!method initialize(oauth_connection_id:, request_options: {})
-      #   @param oauth_connection_id [String] The identifier of the OAuth Connection.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-    end
-  end
-end

data/lib/increase/models/oauth_token.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::OAuthTokens#create
-    class OAuthToken < Increase::Internal::Type::BaseModel
-      # @!attribute access_token
-      #   You may use this token in place of an API key to make OAuth requests on a user's
-      #   behalf.
-      #
-      #   @return [String]
-      required :access_token, String
-
-      # @!attribute group_id
-      #   The Group's identifier. A Group is the top-level organization in Increase.
-      #
-      #   @return [String]
-      required :group_id, String
-
-      # @!attribute token_type
-      #   The type of OAuth token.
-      #
-      #   @return [Symbol, Increase::Models::OAuthToken::TokenType]
-      required :token_type, enum: -> { Increase::OAuthToken::TokenType }
-
-      # @!attribute type
-      #   A constant representing the object's type. For this resource it will always be
-      #   `oauth_token`.
-      #
-      #   @return [Symbol, Increase::Models::OAuthToken::Type]
-      required :type, enum: -> { Increase::OAuthToken::Type }
-
-      # @!method initialize(access_token:, group_id:, token_type:, type:)
-      #   A token that is returned to your application when a user completes the OAuth
-      #   flow and may be used to authenticate requests. Learn more about OAuth
-      #   [here](/documentation/oauth).
-      #
-      #   @param access_token [String]
-      #     You may use this token in place of an API key to make OAuth requests on a user's
-      #     behalf.
-      #
-      #   @param group_id [String] The Group's identifier. A Group is the top-level organization in Increase.
-      #
-      #   @param token_type [Symbol, Increase::Models::OAuthToken::TokenType] The type of OAuth token.
-      #
-      #   @param type [Symbol, Increase::Models::OAuthToken::Type]
-      #     A constant representing the object's type. For this resource it will always be
-      #     `oauth_token`.
-
-      # The type of OAuth token.
-      #
-      # @see Increase::Models::OAuthToken#token_type
-      module TokenType
-        extend Increase::Internal::Type::Enum
-
-        BEARER = :bearer
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `oauth_token`.
-      #
-      # @see Increase::Models::OAuthToken#type
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        OAUTH_TOKEN = :oauth_token
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/models/oauth_token_create_params.rb

@@ -1,85 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Models
-    # @see Increase::Resources::OAuthTokens#create
-    class OAuthTokenCreateParams < Increase::Internal::Type::BaseModel
-      extend Increase::Internal::Type::RequestParameters::Converter
-      include Increase::Internal::Type::RequestParameters
-
-      # @!attribute grant_type
-      #   The credential you request in exchange for the code. In Production, this is
-      #   always `authorization_code`. In Sandbox, you can pass either enum value.
-      #
-      #   @return [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
-      required :grant_type, enum: -> { Increase::OAuthTokenCreateParams::GrantType }
-
-      # @!attribute client_id
-      #   The public identifier for your application.
-      #
-      #   @return [String, nil]
-      optional :client_id, String
-
-      # @!attribute client_secret
-      #   The secret that confirms you own the application. This is redundant given that
-      #   the request is made with your API key but it's a required component of OAuth
-      #   2.0.
-      #
-      #   @return [String, nil]
-      optional :client_secret, String
-
-      # @!attribute code
-      #   The authorization code generated by the user and given to you as a query
-      #   parameter.
-      #
-      #   @return [String, nil]
-      optional :code, String
-
-      # @!attribute production_token
-      #   The production token you want to exchange for a sandbox token. This is only
-      #   available in Sandbox. Set `grant_type` to `production_token` to use this
-      #   parameter.
-      #
-      #   @return [String, nil]
-      optional :production_token, String
-
-      # @!method initialize(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {})
-      #   @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
-      #     The credential you request in exchange for the code. In Production, this is
-      #     always `authorization_code`. In Sandbox, you can pass either enum value.
-      #
-      #   @param client_id [String] The public identifier for your application.
-      #
-      #   @param client_secret [String]
-      #     The secret that confirms you own the application. This is redundant given that
-      #     the request is made with your API key but it's a required component of OAuth
-      #     2.0.
-      #
-      #   @param code [String]
-      #     The authorization code generated by the user and given to you as a query
-      #     parameter.
-      #
-      #   @param production_token [String]
-      #     The production token you want to exchange for a sandbox token. This is only
-      #     available in Sandbox. Set `grant_type` to `production_token` to use this
-      #     parameter.
-      #
-      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
-
-      # The credential you request in exchange for the code. In Production, this is
-      # always `authorization_code`. In Sandbox, you can pass either enum value.
-      module GrantType
-        extend Increase::Internal::Type::Enum
-
-        # An OAuth authorization code.
-        AUTHORIZATION_CODE = :authorization_code
-
-        # An OAuth production token.
-        PRODUCTION_TOKEN = :production_token
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/increase/resources/groups.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class Groups
-      # Returns details for the currently authenticated Group.
-      #
-      # @overload retrieve(request_options: {})
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::Group]
-      #
-      # @see Increase::Models::GroupRetrieveParams
-      def retrieve(params = {})
-        @client.request(
-          method: :get,
-          path: "groups/current",
-          model: Increase::Group,
-          options: params[:request_options]
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/oauth_applications.rb

@@ -1,68 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class OAuthApplications
-      # Retrieve an OAuth Application
-      #
-      # @overload retrieve(oauth_application_id, request_options: {})
-      #
-      # @param oauth_application_id [String] The identifier of the OAuth Application.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::OAuthApplication]
-      #
-      # @see Increase::Models::OAuthApplicationRetrieveParams
-      def retrieve(oauth_application_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["oauth_applications/%1$s", oauth_application_id],
-          model: Increase::OAuthApplication,
-          options: params[:request_options]
-        )
-      end
-
-      # List OAuth Applications
-      #
-      # @overload list(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
-      #
-      # @param created_at [Increase::Models::OAuthApplicationListParams::CreatedAt]
-      #
-      # @param cursor [String] Return the page of entries after this one.
-      #
-      # @param limit [Integer]
-      #   Limit the size of the list that is returned. The default (and maximum) is 100
-      #   objects.
-      #
-      #   Defaults to `100`.
-      #
-      # @param status [Increase::Models::OAuthApplicationListParams::Status]
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::OAuthApplication>]
-      #
-      # @see Increase::Models::OAuthApplicationListParams
-      def list(params = {})
-        parsed, options = Increase::OAuthApplicationListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "oauth_applications",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::OAuthApplication,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/oauth_connections.rb

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class OAuthConnections
-      # Retrieve an OAuth Connection
-      #
-      # @overload retrieve(oauth_connection_id, request_options: {})
-      #
-      # @param oauth_connection_id [String] The identifier of the OAuth Connection.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::OAuthConnection]
-      #
-      # @see Increase::Models::OAuthConnectionRetrieveParams
-      def retrieve(oauth_connection_id, params = {})
-        @client.request(
-          method: :get,
-          path: ["oauth_connections/%1$s", oauth_connection_id],
-          model: Increase::OAuthConnection,
-          options: params[:request_options]
-        )
-      end
-
-      # List OAuth Connections
-      #
-      # @overload list(cursor: nil, limit: nil, oauth_application_id: nil, status: nil, request_options: {})
-      #
-      # @param cursor [String] Return the page of entries after this one.
-      #
-      # @param limit [Integer]
-      #   Limit the size of the list that is returned. The default (and maximum) is 100
-      #   objects.
-      #
-      #   Defaults to `100`.
-      #
-      # @param oauth_application_id [String]
-      #   Filter results to only include OAuth Connections for a specific OAuth
-      #   Application.
-      #
-      # @param status [Increase::Models::OAuthConnectionListParams::Status]
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Internal::Page<Increase::Models::OAuthConnection>]
-      #
-      # @see Increase::Models::OAuthConnectionListParams
-      def list(params = {})
-        parsed, options = Increase::OAuthConnectionListParams.dump_request(params)
-        query = Increase::Internal::Util.encode_query_params(parsed)
-        @client.request(
-          method: :get,
-          path: "oauth_connections",
-          query: query,
-          page: Increase::Internal::Page,
-          model: Increase::OAuthConnection,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/lib/increase/resources/oauth_tokens.rb

@@ -1,54 +0,0 @@
-# frozen_string_literal: true
-
-module Increase
-  module Resources
-    class OAuthTokens
-      # Create an OAuth Token
-      #
-      # @overload create(grant_type:, client_id: nil, client_secret: nil, code: nil, production_token: nil, request_options: {})
-      #
-      # @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType]
-      #   The credential you request in exchange for the code. In Production, this is
-      #   always `authorization_code`. In Sandbox, you can pass either enum value.
-      #
-      # @param client_id [String] The public identifier for your application.
-      #
-      # @param client_secret [String]
-      #   The secret that confirms you own the application. This is redundant given that
-      #   the request is made with your API key but it's a required component of OAuth
-      #   2.0.
-      #
-      # @param code [String]
-      #   The authorization code generated by the user and given to you as a query
-      #   parameter.
-      #
-      # @param production_token [String]
-      #   The production token you want to exchange for a sandbox token. This is only
-      #   available in Sandbox. Set `grant_type` to `production_token` to use this
-      #   parameter.
-      #
-      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Increase::Models::OAuthToken]
-      #
-      # @see Increase::Models::OAuthTokenCreateParams
-      def create(params)
-        parsed, options = Increase::OAuthTokenCreateParams.dump_request(params)
-        @client.request(
-          method: :post,
-          path: "oauth/tokens",
-          body: parsed,
-          model: Increase::OAuthToken,
-          options: options
-        )
-      end
-
-      # @api private
-      #
-      # @param client [Increase::Client]
-      def initialize(client:)
-        @client = client
-      end
-    end
-  end
-end

data/rbi/increase/models/group.rbi

@@ -1,74 +0,0 @@
-# typed: strong
-
-module Increase
-  module Models
-    class Group < Increase::Internal::Type::BaseModel
-      OrHash =
-        T.type_alias { T.any(Increase::Group, Increase::Internal::AnyHash) }
-
-      # The Group identifier.
-      sig { returns(String) }
-      attr_accessor :id
-
-      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
-      # was created.
-      sig { returns(Time) }
-      attr_accessor :created_at
-
-      # A constant representing the object's type. For this resource it will always be
-      # `group`.
-      sig { returns(Increase::Group::Type::TaggedSymbol) }
-      attr_accessor :type
-
-      # Groups represent organizations using Increase. You can retrieve information
-      # about your own organization via the API. More commonly, OAuth platforms can
-      # retrieve information about the organizations that have granted them access.
-      # Learn more about OAuth [here](https://increase.com/documentation/oauth).
-      sig do
-        params(
-          id: String,
-          created_at: Time,
-          type: Increase::Group::Type::OrSymbol
-        ).returns(T.attached_class)
-      end
-      def self.new(
-        # The Group identifier.
-        id:,
-        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group
-        # was created.
-        created_at:,
-        # A constant representing the object's type. For this resource it will always be
-        # `group`.
-        type:
-      )
-      end
-
-      sig do
-        override.returns(
-          {
-            id: String,
-            created_at: Time,
-            type: Increase::Group::Type::TaggedSymbol
-          }
-        )
-      end
-      def to_hash
-      end
-
-      # A constant representing the object's type. For this resource it will always be
-      # `group`.
-      module Type
-        extend Increase::Internal::Type::Enum
-
-        TaggedSymbol = T.type_alias { T.all(Symbol, Increase::Group::Type) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        GROUP = T.let(:group, Increase::Group::Type::TaggedSymbol)
-
-        sig { override.returns(T::Array[Increase::Group::Type::TaggedSymbol]) }
-        def self.values
-        end
-      end
-    end
-  end
-end