increase 0.3.2 → 1.0.0

data/lib/increase/models/oauth_application.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::OAuthApplications#retrieve
+    class OAuthApplication < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The OAuth Application's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute client_id
+      #   The OAuth Application's client_id. Use this to authenticate with the OAuth
+      #   Application.
+      #
+      #   @return [String]
+      required :client_id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #   Application 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
+      #   Application was deleted.
+      #
+      #   @return [Time, nil]
+      required :deleted_at, Time, nil?: true
+
+      # @!attribute name
+      #   The name you chose for this OAuth Application.
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute status
+      #   Whether the application is active.
+      #
+      #   @return [Symbol, Increase::Models::OAuthApplication::Status]
+      required :status, enum: -> { Increase::OAuthApplication::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `oauth_application`.
+      #
+      #   @return [Symbol, Increase::Models::OAuthApplication::Type]
+      required :type, enum: -> { Increase::OAuthApplication::Type }
+
+      # @!method initialize(id:, client_id:, created_at:, deleted_at:, name:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthApplication} for more details.
+      #
+      #   An OAuth Application lets you build an application for others to use with their
+      #   Increase data. You can create an OAuth Application via the Dashboard and read
+      #   information about it with the API. Learn more about OAuth
+      #   [here](https://increase.com/documentation/oauth).
+      #
+      #   @param id [String] The OAuth Application's identifier.
+      #
+      #   @param client_id [String] The OAuth Application's client_id. Use this to authenticate with the OAuth Appli
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #
+      #   @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #
+      #   @param name [String, nil] The name you chose for this OAuth Application.
+      #
+      #   @param status [Symbol, Increase::Models::OAuthApplication::Status] Whether the application is active.
+      #
+      #   @param type [Symbol, Increase::Models::OAuthApplication::Type] A constant representing the object's type. For this resource it will always be `
+
+      # Whether the application is active.
+      #
+      # @see Increase::Models::OAuthApplication#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The application is active and can be used by your users.
+        ACTIVE = :active
+
+        # The application is deleted.
+        DELETED = :deleted
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `oauth_application`.
+      #
+      # @see Increase::Models::OAuthApplication#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        OAUTH_APPLICATION = :oauth_application
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/oauth_application_list_params.rb

@@ -0,0 +1,122 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::OAuthApplications#list
+    class OAuthApplicationListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::OAuthApplicationListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::OAuthApplicationListParams::CreatedAt }
+
+      # @!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.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::OAuthApplicationListParams::Status, nil]
+      optional :status, -> { Increase::OAuthApplicationListParams::Status }
+
+      # @!method initialize(created_at: nil, cursor: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthApplicationListParams} for more details.
+      #
+      #   @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 ob
+      #
+      #   @param status [Increase::Models::OAuthApplicationListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::OAuthApplicationListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Return results whose value is in the provided list. For GET requests, this
+        #   should be encoded as a comma-delimited string, such as `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::OAuthApplicationListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::OAuthApplicationListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::OAuthApplicationListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::OAuthApplicationListParams::Status::In>] Return results whose value is in the provided list. For GET requests, this shoul
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The application is active and can be used by your users.
+          ACTIVE = :active
+
+          # The application is deleted.
+          DELETED = :deleted
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/oauth_application_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::OAuthApplications#retrieve
+    class OAuthApplicationRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/oauth_connection.rb

@@ -0,0 +1,104 @@
+# 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:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthConnection} for more details.
+      #
+      #   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
+      #
+      #   @param deleted_at [Time, nil] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth
+      #
+      #   @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 `
+
+      # 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

@@ -0,0 +1,83 @@
+# 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.
+      #
+      #   @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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthConnectionListParams} for more details.
+      #
+      #   @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 ob
+      #
+      #   @param oauth_application_id [String] Filter results to only include OAuth Connections for a specific OAuth Applicatio
+      #
+      #   @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)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::OAuthConnectionListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::OAuthConnectionListParams::Status::In>] Filter to OAuth Connections by their status. By default, return only the `active
+
+        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

@@ -0,0 +1,14 @@
+# 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
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/oauth_token.rb

@@ -0,0 +1,67 @@
+# 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 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:, token_type:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthToken} for more details.
+      #
+      #   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
+      #
+      #   @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 `
+
+      # 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

@@ -0,0 +1,78 @@
+# 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 redundent 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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::OAuthTokenCreateParams} for more details.
+      #
+      #   @param grant_type [Symbol, Increase::Models::OAuthTokenCreateParams::GrantType] The credential you request in exchange for the code. In Production, this is alwa
+      #
+      #   @param client_id [String] The public identifier for your application.
+      #
+      #   @param client_secret [String] The secret that confirms you own the application. This is redundent given that t
+      #
+      #   @param code [String] The authorization code generated by the user and given to you as a query paramet
+      #
+      #   @param production_token [String] The production token you want to exchange for a sandbox token. This is only avai
+      #
+      #   @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