ynab 3.7.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35929f4460ec30abd1a21c5c21542835c97e8f6bded66fb3f4ed15d13ec9658a
-  data.tar.gz: 9046362bc5a2c09a4a3fef4dd670182f9718a44bb55b97d938eea75201983bee
+  metadata.gz: 5e85fab164378b1c194af69c633cd7161809e9e497be321607fec9da7afbbb81
+  data.tar.gz: fc2c5601c227c31fb7202f3ea9bab7a9b90c8987097a43b0b44d25bf5637bcae
 SHA512:
-  metadata.gz: d26afdb2a437e4c4a795345f0aeb1d91ec30db31b2b4e89af3b3b1e80918da8480974e755772c90efd18ee4f557a86f7e69d2dfb4b86a3655cb7c37a23040193
-  data.tar.gz: 36ce35994f670df1ded39b9738f8451a84fc5205dbdf36486ba94e01acb61198222f682baa746e5b52a08a4e6ff78b900c030c8df80f5c39f228cda733c87877
+  metadata.gz: 7aac05d952641c7e087ba1dd21e1e72023709d451f32e2f4a462898f340257d3ea645ca9613e504aab6702dd8ffe148c61edcc364b56a77a336b660aab2dd581
+  data.tar.gz: a52ce7981de87bbf406abb208ca26245a202e9aa459a2014419450ae90b743e74c225e4139c7eed95ae86ebcf4f4271ea867aca8a21d8a30f09fcb72184aeec5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ynab (3.6.0)
+    ynab (3.8.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -19,7 +19,7 @@ Note: The current version of this gem requires Ruby version 3.3 or later. If you
 
 ## Usage
 To use this client you must
-[obtain an access token](https://api.ynab.com/#authentication-overview) from
+[obtain an access token](https://api.ynab.com/#authentication) from
 your [Account Settings](https://app.ynab.com/settings) page of the YNAB web
 app.
 

data/docs/Category.md

@@ -27,5 +27,6 @@
 | **goal_under_funded** | **Integer** | The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month.  The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month. | [optional] |
 | **goal_overall_funded** | **Integer** | The total amount funded towards the goal within the current goal period. | [optional] |
 | **goal_overall_left** | **Integer** | The amount of funding still needed to complete the goal within the current goal period. | [optional] |
+| **goal_snoozed_at** | **Time** | The date/time the goal was snoozed.  If the goal is not snoozed, this will be null. | [optional] |
 | **deleted** | **Boolean** | Whether or not the category has been deleted.  Deleted categories will only be included in delta requests. |  |
 

data/docs/ScheduledTransactionsApi.md

@@ -5,10 +5,10 @@ All URIs are relative to *https://api.ynab.com/v1*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_scheduled_transaction**](ScheduledTransactionsApi.md#create_scheduled_transaction) | **POST** /budgets/{budget_id}/scheduled_transactions | Create a single scheduled transaction |
-| [**delete_scheduled_transaction**](ScheduledTransactionsApi.md#delete_scheduled_transaction) | **DELETE** /budgets/{budget_id}/scheduled_transactions | Deletes an existing scheduled transaction |
+| [**delete_scheduled_transaction**](ScheduledTransactionsApi.md#delete_scheduled_transaction) | **DELETE** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Deletes an existing scheduled transaction |
 | [**get_scheduled_transaction_by_id**](ScheduledTransactionsApi.md#get_scheduled_transaction_by_id) | **GET** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Single scheduled transaction |
 | [**get_scheduled_transactions**](ScheduledTransactionsApi.md#get_scheduled_transactions) | **GET** /budgets/{budget_id}/scheduled_transactions | List scheduled transactions |
-| [**update_scheduled_transaction**](ScheduledTransactionsApi.md#update_scheduled_transaction) | **PUT** /budgets/{budget_id}/scheduled_transactions | Updates an existing scheduled transaction |
+| [**update_scheduled_transaction**](ScheduledTransactionsApi.md#update_scheduled_transaction) | **PUT** /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id} | Updates an existing scheduled transaction |
 
 
 ## create_scheduled_transaction

data/docs/TransactionResponseData.md

@@ -5,4 +5,5 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **transaction** | [**TransactionDetail**](TransactionDetail.md) |  |  |
+| **server_knowledge** | **Integer** | The knowledge of the server |  |
 

data/lib/ynab/api/scheduled_transactions_api.rb

@@ -120,7 +120,7 @@ module YNAB
         fail ArgumentError, "Missing the required parameter 'scheduled_transaction_id' when calling ScheduledTransactionsApi.delete_scheduled_transaction"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
+      local_var_path = '/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -330,7 +330,7 @@ module YNAB
         fail ArgumentError, "Missing the required parameter 'put_scheduled_transaction_wrapper' when calling ScheduledTransactionsApi.update_scheduled_transaction"
       end
       # resource path
-      local_var_path = '/budgets/{budget_id}/scheduled_transactions'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
+      local_var_path = '/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}'.sub('{' + 'budget_id' + '}', CGI.escape(budget_id.to_s)).sub('{' + 'scheduled_transaction_id' + '}', CGI.escape(scheduled_transaction_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/ynab/models/category.rb

@@ -76,6 +76,9 @@ module YNAB
     # The amount of funding still needed to complete the goal within the current goal period.
     attr_accessor :goal_overall_left
 
+    # The date/time the goal was snoozed.  If the goal is not snoozed, this will be null.
+    attr_accessor :goal_snoozed_at
+
     # Whether or not the category has been deleted.  Deleted categories will only be included in delta requests.
     attr_accessor :deleted
 
@@ -127,6 +130,7 @@ module YNAB
         :'goal_under_funded' => :'goal_under_funded',
         :'goal_overall_funded' => :'goal_overall_funded',
         :'goal_overall_left' => :'goal_overall_left',
+        :'goal_snoozed_at' => :'goal_snoozed_at',
         :'deleted' => :'deleted'
       }
     end
@@ -162,6 +166,7 @@ module YNAB
         :'goal_under_funded' => :'Integer',
         :'goal_overall_funded' => :'Integer',
         :'goal_overall_left' => :'Integer',
+        :'goal_snoozed_at' => :'Time',
         :'deleted' => :'Boolean'
       }
     end
@@ -184,6 +189,7 @@ module YNAB
         :'goal_under_funded',
         :'goal_overall_funded',
         :'goal_overall_left',
+        :'goal_snoozed_at',
       ])
     end
 
@@ -294,6 +300,10 @@ module YNAB
         self.goal_overall_left = attributes[:'goal_overall_left']
       end
 
+      if attributes.key?(:'goal_snoozed_at')
+        self.goal_snoozed_at = attributes[:'goal_snoozed_at']
+      end
+
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -356,6 +366,7 @@ module YNAB
           goal_under_funded == o.goal_under_funded &&
           goal_overall_funded == o.goal_overall_funded &&
           goal_overall_left == o.goal_overall_left &&
+          goal_snoozed_at == o.goal_snoozed_at &&
           deleted == o.deleted
     end
 
@@ -368,7 +379,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, deleted].hash
+      [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/transaction_flag_color.rb

@@ -18,9 +18,10 @@ module YNAB
     GREEN = "green".freeze
     BLUE = "blue".freeze
     PURPLE = "purple".freeze
+    EMPTY = "".freeze
 
     def self.all_vars
-      @all_vars ||= [RED, ORANGE, YELLOW, GREEN, BLUE, PURPLE].freeze
+      @all_vars ||= [RED, ORANGE, YELLOW, GREEN, BLUE, PURPLE, EMPTY].freeze
     end
 
     # Builds the enum from string

data/lib/ynab/models/transaction_response_data.rb

@@ -14,10 +14,14 @@ module YNAB
   class TransactionResponseData
     attr_accessor :transaction
 
+    # The knowledge of the server
+    attr_accessor :server_knowledge
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'transaction' => :'transaction'
+        :'transaction' => :'transaction',
+        :'server_knowledge' => :'server_knowledge'
       }
     end
 
@@ -29,7 +33,8 @@ module YNAB
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'transaction' => :'TransactionDetail'
+        :'transaction' => :'TransactionDetail',
+        :'server_knowledge' => :'Integer'
       }
     end
 
@@ -57,6 +62,10 @@ module YNAB
       if attributes.key?(:'transaction')
         self.transaction = attributes[:'transaction']
       end
+
+      if attributes.key?(:'server_knowledge')
+        self.server_knowledge = attributes[:'server_knowledge']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -70,6 +79,7 @@ module YNAB
     # @return true if the model is valid
     def valid?
       return false if @transaction.nil?
+      return false if @server_knowledge.nil?
       true
     end
 
@@ -78,7 +88,8 @@ module YNAB
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          transaction == o.transaction
+          transaction == o.transaction &&
+          server_knowledge == o.server_knowledge
     end
 
     # @see the `==` method
@@ -90,7 +101,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [transaction].hash
+      [transaction, server_knowledge].hash
     end
 
     # Builds the object from hash

data/lib/ynab/version.rb

@@ -1,3 +1,3 @@
 module YNAB
-  VERSION = '3.7.0'
+  VERSION = '3.9.0'
 end

data/open_api_spec.yaml

@@ -6,7 +6,7 @@ info:
     upon HTTPS for transport. We respond with meaningful HTTP response codes and
     if an error occurs, we include error details in the response body.  API
     Documentation is at https://api.ynab.com
-  version: 1.74.0
+  version: 1.76.0
 servers:
   - url: https://api.ynab.com/v1
 security:
@@ -1580,12 +1580,13 @@ paths:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
       x-codegen-request-body-name: data
-    put:
+  /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}:
+    get:
       tags:
         - Scheduled Transactions
-      summary: Updates an existing scheduled transaction
-      description: Updates a single scheduled transaction
-      operationId: updateScheduledTransaction
+      summary: Single scheduled transaction
+      description: Returns a single scheduled transaction
+      operationId: getScheduledTransactionById
       parameters:
         - name: budget_id
           in: path
@@ -1602,34 +1603,31 @@ paths:
           required: true
           schema:
             type: string
-      requestBody:
-        description: The scheduled transaction to update
-        content:
-          "application/json":
-            schema:
-              $ref: "#/components/schemas/PutScheduledTransactionWrapper"
-        required: true
       responses:
         "200":
-          description: The scheduled transaction was successfully updated
+          description: The requested Scheduled Transaction
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ScheduledTransactionResponse"
-        "400":
-          description: >-
-            The request could not be understood due to malformed syntax or
-            validation error(s)
+        "404":
+          description: The scheduled transaction was not found
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
-    delete:
+        default:
+          description: An error occurred
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+    put:
       tags:
         - Scheduled Transactions
-      summary: Deletes an existing scheduled transaction
-      description: Deletes a scheduled transaction
-      operationId: deleteScheduledTransaction
+      summary: Updates an existing scheduled transaction
+      description: Updates a single scheduled transaction
+      operationId: updateScheduledTransaction
       parameters:
         - name: budget_id
           in: path
@@ -1646,26 +1644,34 @@ paths:
           required: true
           schema:
             type: string
+      requestBody:
+        description: The scheduled transaction to update
+        content:
+          "application/json":
+            schema:
+              $ref: "#/components/schemas/PutScheduledTransactionWrapper"
+        required: true
       responses:
         "200":
-          description: The scheduled transaction was successfully deleted
+          description: The scheduled transaction was successfully updated
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ScheduledTransactionResponse"
-        "404":
-          description: The scheduled transaction was not found
+        "400":
+          description: >-
+            The request could not be understood due to malformed syntax or
+            validation error(s)
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
-  /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}:
-    get:
+    delete:
       tags:
         - Scheduled Transactions
-      summary: Single scheduled transaction
-      description: Returns a single scheduled transaction
-      operationId: getScheduledTransactionById
+      summary: Deletes an existing scheduled transaction
+      description: Deletes a scheduled transaction
+      operationId: deleteScheduledTransaction
       parameters:
         - name: budget_id
           in: path
@@ -1684,7 +1690,7 @@ paths:
             type: string
       responses:
         "200":
-          description: The requested Scheduled Transaction
+          description: The scheduled transaction was successfully deleted
           content:
             application/json:
               schema:
@@ -1695,12 +1701,6 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
-        default:
-          description: An error occurred
-          content:
-            application/json:
-              schema:
-                $ref: "#/components/schemas/ErrorResponse"
 components:
   schemas:
     ErrorResponse:
@@ -2304,6 +2304,13 @@ components:
             current goal period.
           format: int64
           nullable: true
+        goal_snoozed_at:
+          type: string
+          description: >-
+            The date/time the goal was snoozed.  If the goal is not snoozed, this
+            will be null.
+          format: date-time
+          nullable: true
         deleted:
           type: boolean
           description: >-
@@ -2715,10 +2722,15 @@ components:
         data:
           required:
             - transaction
+            - server_knowledge
           type: object
           properties:
             transaction:
               $ref: "#/components/schemas/TransactionDetail"
+            server_knowledge:
+              type: integer
+              description: The knowledge of the server
+              format: int64
     TransactionSummary:
       required:
         - account_id
@@ -3380,6 +3392,7 @@ components:
         - green
         - blue
         - purple
+        - ""
         - null
       nullable: true
     TransactionFlagName:

data/spec/api/transactions_spec.rb

@@ -52,7 +52,7 @@ describe 'transactions' do
         expect(client.last_request.response.options[:code]).to be 200
         expect(response.data.transactions.length).to be 2
         # We expect the flag_color to have been converted to nil for these transactions
-        expect(response.data.transactions[0].flag_color).to be_nil
+        expect(response.data.transactions[0].flag_color).to eq ""
         expect(response.data.transactions[1].flag_color).to be_nil
       end
     end

data/ynab.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |s|
   s.email       = ["api@ynab.com"]
   s.homepage    = "https://github.com/ynab/ynab-sdk-ruby"
   s.summary     = "Official Ruby client for the YNAB API"
-  s.description = "Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.74.0."
+  s.description = "Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.76.0."
   s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 3.3"
   s.metadata    = {}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: ynab
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.9.0
 platform: ruby
 authors:
 - YNAB
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -50,7 +50,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.6.0
 description: Official Ruby client for the YNAB API. API documentation available at
-  https://api.ynab.com. Generated from server specification version 1.74.0.
+  https://api.ynab.com. Generated from server specification version 1.76.0.
 email:
 - api@ynab.com
 executables: []
@@ -367,55 +367,55 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Official Ruby client for the YNAB API
 test_files:
-- spec/api/budgets_spec.rb
-- spec/api/payees_spec.rb
 - spec/api/accounts_spec.rb
+- spec/api/budgets_spec.rb
+- spec/api/categories_spec.rb
 - spec/api/months_spec.rb
 - spec/api/payee_locations_spec.rb
+- spec/api/payees_spec.rb
 - spec/api/scheduled_transactions_spec.rb
 - spec/api/transactions_spec.rb
-- spec/api/categories_spec.rb
 - spec/api_error_spec.rb
-- spec/fixtures/vcr_cassettes/category.yml
-- spec/fixtures/vcr_cassettes/payee_locations_unauthorized.yml
-- spec/fixtures/vcr_cassettes/accounts_unauthorized.yml
+- spec/fixtures/vcr_cassettes/account.yml
 - spec/fixtures/vcr_cassettes/accounts.yml
-- spec/fixtures/vcr_cassettes/create_account.yml
-- spec/fixtures/vcr_cassettes/transactions.yml
-- spec/fixtures/vcr_cassettes/transactions_unauthorized.yml
-- spec/fixtures/vcr_cassettes/import_transactions.yml
-- spec/fixtures/vcr_cassettes/scheduled_transactions_unauthorized.yml
-- spec/fixtures/vcr_cassettes/category_transactions.yml
-- spec/fixtures/vcr_cassettes/scheduled_transaction.yml
-- spec/fixtures/vcr_cassettes/bulk_transactions.yml
-- spec/fixtures/vcr_cassettes/payees_unauthorized.yml
-- spec/fixtures/vcr_cassettes/create_transactions.yml
+- spec/fixtures/vcr_cassettes/accounts_unauthorized.yml
+- spec/fixtures/vcr_cassettes/budget.yml
 - spec/fixtures/vcr_cassettes/budgets.yml
+- spec/fixtures/vcr_cassettes/budgets_unauthorized.yml
+- spec/fixtures/vcr_cassettes/bulk_transactions.yml
+- spec/fixtures/vcr_cassettes/categories.yml
 - spec/fixtures/vcr_cassettes/categories_unauthorized.yml
+- spec/fixtures/vcr_cassettes/category.yml
+- spec/fixtures/vcr_cassettes/category_transactions.yml
+- spec/fixtures/vcr_cassettes/create_account.yml
+- spec/fixtures/vcr_cassettes/create_scheduled_transaction.yml
+- spec/fixtures/vcr_cassettes/create_transaction.yml
+- spec/fixtures/vcr_cassettes/create_transactions.yml
+- spec/fixtures/vcr_cassettes/import_transactions.yml
 - spec/fixtures/vcr_cassettes/month.yml
-- spec/fixtures/vcr_cassettes/payee.yml
-- spec/fixtures/vcr_cassettes/categories.yml
+- spec/fixtures/vcr_cassettes/month_transactions.yml
 - spec/fixtures/vcr_cassettes/months.yml
-- spec/fixtures/vcr_cassettes/account.yml
-- spec/fixtures/vcr_cassettes/budgets_unauthorized.yml
-- spec/fixtures/vcr_cassettes/update_transactions.yml
-- spec/fixtures/vcr_cassettes/payees.yml
-- spec/fixtures/vcr_cassettes/scheduled_transactions.yml
+- spec/fixtures/vcr_cassettes/months_unauthorized.yml
+- spec/fixtures/vcr_cassettes/multiple_transactions.yml
 - spec/fixtures/vcr_cassettes/patch_month_category.yml
-- spec/fixtures/vcr_cassettes/update_transaction.yml
+- spec/fixtures/vcr_cassettes/payee.yml
+- spec/fixtures/vcr_cassettes/payee_location.yml
 - spec/fixtures/vcr_cassettes/payee_locations.yml
-- spec/fixtures/vcr_cassettes/create_transaction.yml
-- spec/fixtures/vcr_cassettes/months_unauthorized.yml
+- spec/fixtures/vcr_cassettes/payee_locations_unauthorized.yml
 - spec/fixtures/vcr_cassettes/payee_transactions.yml
-- spec/fixtures/vcr_cassettes/payee_location.yml
-- spec/fixtures/vcr_cassettes/multiple_transactions.yml
-- spec/fixtures/vcr_cassettes/transactions_invalid_flags.yml
+- spec/fixtures/vcr_cassettes/payees.yml
+- spec/fixtures/vcr_cassettes/payees_unauthorized.yml
+- spec/fixtures/vcr_cassettes/scheduled_transaction.yml
+- spec/fixtures/vcr_cassettes/scheduled_transactions.yml
+- spec/fixtures/vcr_cassettes/scheduled_transactions_unauthorized.yml
 - spec/fixtures/vcr_cassettes/transaction.yml
-- spec/fixtures/vcr_cassettes/month_transactions.yml
-- spec/fixtures/vcr_cassettes/budget.yml
-- spec/fixtures/vcr_cassettes/create_scheduled_transaction.yml
+- spec/fixtures/vcr_cassettes/transactions.yml
+- spec/fixtures/vcr_cassettes/transactions_invalid_flags.yml
+- spec/fixtures/vcr_cassettes/transactions_unauthorized.yml
+- spec/fixtures/vcr_cassettes/update_transaction.yml
+- spec/fixtures/vcr_cassettes/update_transactions.yml
 - spec/spec_helper.rb