growsurf-ruby 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3f7355b6a4f09692cd4f02923eda76fe0887f88b647f0cfdc461b93e36337f6
-  data.tar.gz: 16ae21e1f33b5f0ffead7caf1f93d80758fbffce09c3d634d0350f5cde7e1e36
+  metadata.gz: 493b71b685dcab98c1c2633ab0c32d9339609bba972dafb665607039a0079142
+  data.tar.gz: 75af6a27ec19b8f9e1cc8cdf8b412c4c70f9405276f444f69b305c901ca51893
 SHA512:
-  metadata.gz: c58b6e6dd858d7c7e419bd5d96d605b27d8de8518d3c9c2ff2c4dd121473404a6843f0e62dc6c4b0190c02ae7bed3821542b73ab5ebf9bf3646ee343783a92ee
-  data.tar.gz: d98124e2a70ebb54f25757c814342a2ee6f4d5595c3713ebb26386b9157474eaee6ad35825ad091f5b180455d89d9a334972fd37e53593c1c066d3d3d7b7f553
+  metadata.gz: 50054ac45d5711ca710ae6f4c16d24d4c10954fc7c0f17e99f279531e318c86663ffd866cbf263380ccc8697a902ffd3c7d78389f11a31ec74ac4c046e09fbf2
+  data.tar.gz: 6de111fb82f96ea5dbdd3c43c5c98f039f3a250c71ebd193a9ae3244f3896df02eb3bd82a6f0143ed947bee2456a8cc1f7f08da8ef48b69da0860904730e0966

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [1.3.0](https://github.com/growsurf/growsurf-ruby/compare/v1.2.1...v1.3.0) (2026-08-23)
+
+
+### Features
+
+* **api:** add affiliate and payout destination APIs ([1b34978](https://github.com/growsurf/growsurf-ruby/commit/1b34978709f715124c85d8bf77c25b6bb6488e77))
+* **api:** add affiliate and payout destination APIs ([c2ffa2c](https://github.com/growsurf/growsurf-ruby/commit/c2ffa2cb4c0247044dcfcda433d64a824f261e79))
+* v1.3.0 — safer retries, analytics additions, packaging and CI updates ([70bf8c3](https://github.com/growsurf/growsurf-ruby/commit/70bf8c3e858c692bfa8836ea04c0f81218926631))
+
+
+### Bug Fixes
+
+* **api:** align analytics reward status models ([28bd123](https://github.com/growsurf/growsurf-ruby/commit/28bd123324b6d21547abc511e0be864a0a998f8e))
+
 ## [1.2.1](https://github.com/growsurf/growsurf-ruby/compare/v1.2.0...v1.2.1) (2026-07-14)
 
 

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Growsurf
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "growsurf-ruby", "~> 1.2.1"
+gem "growsurf-ruby", "~> 1.3.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/growsurf_ruby/internal/transport/base_client.rb

@@ -67,6 +67,15 @@ module GrowsurfRuby
             end
           end
 
+          # @api private
+          #
+          # Returns whether replaying this request cannot duplicate a customer-visible mutation.
+          def retry_safe_request?(request)
+            method, operation_path = request.fetch_values(:method, :operation_path)
+            %w[get head].include?(method.to_s.downcase) ||
+              (method.to_s.casecmp?("post") && operation_path == "/api-key/rotate")
+          end
+
           # @api private
           #
           # @param request [Hash{Symbol=>Object}] .
@@ -75,6 +84,8 @@ module GrowsurfRuby
           #
           #   @option request [URI::Generic] :url
           #
+          #   @option request [String] :operation_path
+          #
           #   @option request [Hash{String=>String}] :headers
           #
           #   @option request [Object] :body
@@ -281,9 +292,11 @@ module GrowsurfRuby
             opts[:extra_headers].to_h
           )
 
+          normalized_path = "/#{path.sub(%r{/$}, '').delete_prefix('/')}"
+          retry_safe_rotation = method.to_s.casecmp?("post") && normalized_path == "/api-key/rotate"
           if @idempotency_header &&
              !headers.key?(@idempotency_header) &&
-             (!Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase) || opts.key?(:idempotency_key))
+             (retry_safe_rotation || opts.key?(:idempotency_key))
             headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key }
           end
 
@@ -319,6 +332,7 @@ module GrowsurfRuby
           {
             method: method,
             url: url,
+            operation_path: normalized_path,
             headers: headers,
             body: encoded,
             max_retries: opts.fetch(:max_retries, @max_retries),
@@ -347,7 +361,7 @@ module GrowsurfRuby
           end
           return span if span
 
-          scale = retry_count**2
+          scale = 2**retry_count
           jitter = 1 - (0.25 * rand)
           (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay)
         end
@@ -409,9 +423,12 @@ module GrowsurfRuby
               retry_count: retry_count,
               send_retry_header: send_retry_header
             )
-          in GrowsurfRuby::Errors::APIConnectionError if retry_count >= max_retries
+          in GrowsurfRuby::Errors::APIConnectionError if retry_count >= max_retries ||
+            !self.class.retry_safe_request?(request)
             raise status
-          in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: headers)
+          in (400..) if retry_count >= max_retries ||
+            !self.class.retry_safe_request?(request) ||
+            !self.class.should_retry?(status, headers: headers)
             decoded = Kernel.then do
               GrowsurfRuby::Internal::Util.decode_content(headers, stream: stream, suppress_error: true)
             ensure

data/lib/growsurf_ruby/models/affiliate_application.rb

@@ -0,0 +1,249 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#retrieve_affiliate_application
+    class AffiliateApplication < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute answers
+      #   The applicant's answers to the saved application form.
+      #
+      #   @return [Array<GrowsurfRuby::Models::AffiliateApplication::Answer>]
+      required :answers, -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::AffiliateApplication::Answer] }
+
+      # @!attribute created_at
+      #   When the application was submitted, in Unix milliseconds.
+      #
+      #   @return [Integer]
+      required :created_at, Integer, api_name: :createdAt
+
+      # @!attribute decided_at
+      #   When the decision was made, in Unix milliseconds. `null` while pending.
+      #
+      #   @return [Integer, nil]
+      required :decided_at, Integer, api_name: :decidedAt, nil?: true
+
+      # @!attribute email
+      #   Required applicant email address, or `null` after applicant data is removed
+      #   under the Program's retention policy.
+      #
+      #   @return [String, nil]
+      required :email, String, nil?: true
+
+      # @!attribute first_name
+      #   Required applicant first name, or `null` after applicant data is removed under
+      #   the Program's retention policy.
+      #
+      #   @return [String, nil]
+      required :first_name, String, api_name: :firstName, nil?: true
+
+      # @!attribute id
+      #   Application ID.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute last_name
+      #   Required applicant last name, or `null` after applicant data is removed under
+      #   the Program's retention policy.
+      #
+      #   @return [String, nil]
+      required :last_name, String, api_name: :lastName, nil?: true
+
+      # @!attribute participant_id
+      #   ID of the participant created or upgraded by approval. `null` until the
+      #   application is approved.
+      #
+      #   @return [String, nil]
+      required :participant_id, String, api_name: :participantId, nil?: true
+
+      # @!attribute reapply_allowed_at
+      #   When a denied applicant may apply again, in Unix milliseconds. `null` when not
+      #   applicable.
+      #
+      #   @return [Integer, nil]
+      required :reapply_allowed_at, Integer, api_name: :reapplyAllowedAt, nil?: true
+
+      # @!attribute rejection_reason
+      #   The structured reason recorded when the application was denied. `null` until
+      #   then.
+      #
+      #   @return [String, nil]
+      required :rejection_reason, String, api_name: :rejectionReason, nil?: true
+
+      # @!attribute reviewed_at
+      #   When the application was reviewed, in Unix milliseconds. `null` while pending.
+      #
+      #   @return [Integer, nil]
+      required :reviewed_at, Integer, api_name: :reviewedAt, nil?: true
+
+      # @!attribute risk_level
+      #   GrowSurf risk assessment. Applications that are not `LOW` risk are held for
+      #   manual review; `null` means no assessment was recorded.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::AffiliateApplication::RiskLevel, nil]
+      required :risk_level,
+               enum: -> { GrowsurfRuby::AffiliateApplication::RiskLevel },
+               api_name: :riskLevel,
+               nil?: true
+
+      # @!attribute status
+      #   Where the application is in review. Only `PENDING` applications can be decided.
+      #
+      #   @return [Symbol, GrowsurfRuby::Models::AffiliateApplication::Status]
+      required :status, enum: -> { GrowsurfRuby::AffiliateApplication::Status }
+
+      # @!attribute terms_accepted_at
+      #   When the applicant accepted the Program Terms, in Unix milliseconds, or `null`
+      #   when acceptance was not required.
+      #
+      #   @return [Integer, nil]
+      required :terms_accepted_at, Integer, api_name: :termsAcceptedAt, nil?: true
+
+      # @!method initialize(answers: nil, created_at: nil, decided_at: nil, email: nil, first_name: nil, id: nil, last_name: nil, participant_id: nil, reapply_allowed_at: nil, rejection_reason: nil, reviewed_at: nil, risk_level: nil, status: nil, terms_accepted_at: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {GrowsurfRuby::Models::AffiliateApplication} for more details.
+      #
+      #   @param answers [Array<GrowsurfRuby::Models::AffiliateApplication::Answer>] The applicant's answers to the saved application form.
+      #
+      #   @param created_at [Integer] When the application was submitted, in Unix milliseconds.
+      #
+      #   @param decided_at [Integer, nil] When the decision was made, in Unix milliseconds. `null` while pending.
+      #
+      #   @param email [String, nil] Required applicant email address, or `null` after applicant data is removed
+      #
+      #   @param first_name [String, nil] Required applicant first name, or `null` after applicant data is removed under
+      #
+      #   @param id [String] Application ID.
+      #
+      #   @param last_name [String, nil] Required applicant last name, or `null` after applicant data is removed under
+      #
+      #   @param participant_id [String, nil] ID of the participant created or upgraded by approval. `null` until the
+      #
+      #   @param reapply_allowed_at [Integer, nil] When a denied applicant may apply again, in Unix milliseconds. `null` when not
+      #
+      #   @param rejection_reason [String, nil] The structured reason recorded when the application was denied. `null` until
+      #
+      #   @param reviewed_at [Integer, nil] When the application was reviewed, in Unix milliseconds. `null` while pending.
+      #
+      #   @param risk_level [Symbol, GrowsurfRuby::Models::AffiliateApplication::RiskLevel, nil] GrowSurf risk assessment. Applications that are not `LOW` risk are held for
+      #
+      #   @param status [Symbol, GrowsurfRuby::Models::AffiliateApplication::Status] Where the application is in review. Only `PENDING` applications can be decided.
+      #
+      #   @param terms_accepted_at [Integer, nil] When the applicant accepted the Program Terms, in Unix milliseconds, or `null`
+      #
+      class Answer < GrowsurfRuby::Internal::Type::BaseModel
+        # @!attribute field_id
+        #   Stable key of the saved application-form field this answer belongs to.
+        #
+        #   @return [String]
+        required :field_id, String, api_name: :fieldId
+
+        # @!attribute label
+        #   Customer-configured field label captured when the applicant submitted.
+        #
+        #   @return [String]
+        required :label, String
+
+        # @!attribute type
+        #   Saved field type that determined how the scalar answer was validated.
+        #
+        #   @return [Symbol, GrowsurfRuby::Models::AffiliateApplication::Answer::Type]
+        required :type, enum: -> { GrowsurfRuby::AffiliateApplication::Answer::Type }
+
+        # @!attribute value
+        #   Applicant answer represented as one validated string, number, or boolean.
+        #
+        #   @return [String, Integer, Float, Boolean]
+        required :value, -> { GrowsurfRuby::AffiliateApplication::Answer::Value }
+
+        # @!method initialize(field_id: nil, label: nil, type: nil, value: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {GrowsurfRuby::Models::AffiliateApplication::Answer} for more details.
+        #
+        #   @param field_id [String] Stable key of the saved application-form field this answer belongs to.
+        #
+        #   @param label [String] Customer-configured field label captured when the applicant submitted.
+        #
+        #   @param type [Symbol, GrowsurfRuby::Models::AffiliateApplication::Answer::Type] Saved field type that determined how the scalar answer was validated.
+        #
+        #   @param value [String, Integer, Float, Boolean] Applicant answer represented as one validated scalar.
+
+        class Value
+          extend GrowsurfRuby::Internal::Type::Converter
+          extend GrowsurfRuby::Internal::Util::SorbetRuntimeSupport
+
+          private_class_method :new
+
+          def self.===(other)
+            scalar?(other)
+          end
+
+          def self.coerce(value, state:)
+            matches = scalar?(value)
+            state.fetch(:exactness)[matches ? :yes : :no] += 1
+            state[:error] = ArgumentError.new("expected a string, number, or boolean") unless matches
+            value
+          end
+
+          def self.to_sorbet_type
+            T.any(String, Integer, Float, T::Boolean)
+          end
+
+          def self.scalar?(value)
+            value.is_a?(String) ||
+              value.is_a?(Integer) ||
+              value.is_a?(Float) ||
+              value == true ||
+              value == false
+          end
+          private_class_method :scalar?
+        end
+
+        module Type
+          extend GrowsurfRuby::Internal::Type::Enum
+
+          TEXT = :text
+          TEXTAREA = :textarea
+          URL = :url
+          COUNTRY = :country
+          NUMBER = :number
+          DROPDOWN = :dropdown
+          RADIO = :radio
+          CHECKBOX = :checkbox
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # GrowSurf risk assessment. Applications that are not `LOW` risk are held for
+      # manual review; `null` means no assessment was recorded.
+      #
+      # @see GrowsurfRuby::Models::AffiliateApplication#risk_level
+      module RiskLevel
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        LOW = :LOW
+        MEDIUM = :MEDIUM
+        HIGH = :HIGH
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Where the application is in review. Only `PENDING` applications can be decided.
+      #
+      # @see GrowsurfRuby::Models::AffiliateApplication#status
+      module Status
+        extend GrowsurfRuby::Internal::Type::Enum
+
+        PENDING = :PENDING
+        APPROVED = :APPROVED
+        DENIED = :DENIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/growsurf_ruby/models/affiliate_application_list_response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module GrowsurfRuby
+  module Models
+    # @see GrowsurfRuby::Resources::Campaign#list_affiliate_applications
+    class AffiliateApplicationListResponse < GrowsurfRuby::Internal::Type::BaseModel
+      # @!attribute applications
+      #   One page of the program's applications, newest first.
+      #
+      #   @return [Array<GrowsurfRuby::Models::AffiliateApplication>]
+      required :applications,
+               -> { GrowsurfRuby::Internal::Type::ArrayOf[GrowsurfRuby::AffiliateApplication] }
+
+      # @!attribute total
+      #   Total number of applications matching the filter.
+      #
+      #   @return [Integer]
+      required :total, Integer
+
+      # @!attribute limit
+      #   The page size used.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   The offset this page started at.
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!method initialize(applications:, total:, limit: nil, offset: nil)
+      #   @param applications [Array<GrowsurfRuby::Models::AffiliateApplication>] One page of the program's applications, newest first.
+      #
+      #   @param total [Integer] Total number of applications matching the filter.
+      #
+      #   @param limit [Integer] The page size used.
+      #
+      #   @param offset [Integer] The offset this page started at.
+    end
+  end
+end