ynab 3.2.0 → 3.4.0

data/lib/ynab/models/user.rb

@@ -3,10 +3,7 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies 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
 
-The version of the OpenAPI document: 1.70.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
 
 =end
 

data/lib/ynab/models/user_response.rb

@@ -3,10 +3,7 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies 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
 
-The version of the OpenAPI document: 1.70.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
 
 =end
 

data/lib/ynab/models/user_response_data.rb

@@ -3,10 +3,7 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies 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
 
-The version of the OpenAPI document: 1.70.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
 
 =end
 

data/lib/ynab/overrides/transactions_api.rb

@@ -1,15 +1,3 @@
-=begin
-#YNAB API Endpoints
-
-#Our API uses a REST based design, leverages the JSON data format, and relies 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.youneedabudget.com
-
-OpenAPI spec version: 1.0.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.0-SNAPSHOT
-
-=end
-
 require 'uri'
 require 'ynab/api/deprecated_api'
 

data/lib/ynab/version.rb

@@ -1,15 +1,3 @@
-=begin
-#YNAB API Endpoints
-
-#Our API uses a REST based design, leverages the JSON data format, and relies 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.youneedabudget.com
-
-OpenAPI spec version: 1.0.0
-
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.0-SNAPSHOT
-
-=end
-
 module YNAB
-  VERSION = '3.2.0'
+  VERSION = '3.4.0'
 end

data/lib/ynab.rb

@@ -3,10 +3,7 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies 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
 
-The version of the OpenAPI document: 1.70.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
 
 =end
 
@@ -73,6 +70,7 @@ require 'ynab/models/payee_response_data'
 require 'ynab/models/payees_response'
 require 'ynab/models/payees_response_data'
 require 'ynab/models/post_account_wrapper'
+require 'ynab/models/post_scheduled_transaction_wrapper'
 require 'ynab/models/post_transactions_wrapper'
 require 'ynab/models/put_transaction_wrapper'
 require 'ynab/models/save_account'
@@ -83,6 +81,7 @@ require 'ynab/models/save_month_category'
 require 'ynab/models/save_payee'
 require 'ynab/models/save_payee_response'
 require 'ynab/models/save_payee_response_data'
+require 'ynab/models/save_scheduled_transaction'
 require 'ynab/models/save_sub_transaction'
 require 'ynab/models/save_transaction_with_id_or_import_id'
 require 'ynab/models/save_transaction_with_optional_fields'
@@ -90,6 +89,7 @@ require 'ynab/models/save_transactions_response'
 require 'ynab/models/save_transactions_response_data'
 require 'ynab/models/scheduled_sub_transaction'
 require 'ynab/models/scheduled_transaction_detail'
+require 'ynab/models/scheduled_transaction_frequency'
 require 'ynab/models/scheduled_transaction_response'
 require 'ynab/models/scheduled_transaction_response_data'
 require 'ynab/models/scheduled_transaction_summary'

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.70.0
+  version: 1.72.0
 servers:
   - url: https://api.ynab.com/v1
 security:
@@ -959,8 +959,8 @@ paths:
         Creates a single transaction or multiple transactions.  If you provide a
         body containing a `transaction` object, a single transaction will be
         created and if you provide a body containing a `transactions` array,
-        multiple transactions will be created.  Scheduled transactions cannot be
-        created on this endpoint.
+        multiple transactions will be created.  Scheduled transactions (transactions with a future date)
+        cannot be created on this endpoint.
       operationId: createTransaction
       parameters:
         - name: budget_id
@@ -1425,6 +1425,76 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
+  /budgets/{budget_id}/months/{month}/transactions:
+    get:
+      tags:
+        - Transactions
+      summary: List transactions in month, excluding any pending transactions
+      description: Returns all transactions for a specified month
+      operationId: getTransactionsByMonth
+      parameters:
+        - name: budget_id
+          in: path
+          description: >-
+            The id of the budget. "last-used" can be used to specify the last
+            used budget and "default" can be used if default budget selection is
+            enabled (see: https://api.ynab.com/#oauth-default-budget).
+          required: true
+          schema:
+            type: string
+        - name: month
+          in: path
+          description: >-
+            The budget month in ISO format (e.g. 2016-12-01) ("current" can also
+            be used to specify the current calendar month (UTC))
+          required: true
+          schema:
+            type: string
+        - name: since_date
+          in: query
+          description: >-
+            If specified, only transactions on or after this date will be
+            included.  The date should be ISO formatted (e.g. 2016-12-30).
+          schema:
+            type: string
+            format: date
+        - name: type
+          in: query
+          description: >-
+            If specified, only transactions of the specified type will be
+            included. "uncategorized" and "unapproved" are currently supported.
+          schema:
+            type: string
+            enum:
+              - uncategorized
+              - unapproved
+        - name: last_knowledge_of_server
+          in: query
+          description: >-
+            The starting server knowledge.  If provided, only entities that have
+            changed since `last_knowledge_of_server` will be included.
+          schema:
+            type: integer
+            format: int64
+      responses:
+        "200":
+          description: The list of requested transactions
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/HybridTransactionsResponse"
+        "404":
+          description: No transactions were found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        default:
+          description: An error occurred
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
   /budgets/{budget_id}/scheduled_transactions:
     get:
       tags:
@@ -1469,6 +1539,47 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
+    post:
+      tags:
+        - Scheduled Transactions
+      summary: Create a single scheduled transaction
+      description: >-
+        Creates a single scheduled transaction.
+      operationId: createScheduledTransaction
+      parameters:
+        - name: budget_id
+          in: path
+          description: >-
+            The id of the budget. "last-used" can be used to specify the last
+            used budget and "default" can be used if default budget selection is
+            enabled (see: https://api.ynab.com/#oauth-default-budget).
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: >-
+          The scheduled transaction to create
+        content:
+          "application/json":
+            schema:
+              $ref: "#/components/schemas/PostScheduledTransactionWrapper"
+        required: true
+      responses:
+        "201":
+          description: The scheduled transaction was successfully created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ScheduledTransactionResponse"
+        "400":
+          description: >-
+            The request could not be understood due to malformed syntax or
+            validation error(s).
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+      x-codegen-request-body-name: data
   /budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}:
     get:
       tags:
@@ -2401,7 +2512,7 @@ components:
             The payee for the transaction.  To create a transfer between two
             accounts, use the account transfer payee pointing to the target
             account.  Account transfer payees are specified as
-            `tranfer_payee_id` on the account resource.
+            `transfer_payee_id` on the account resource.
           format: uuid
         payee_name:
           maxLength: 50
@@ -2875,6 +2986,64 @@ components:
           properties:
             scheduled_transaction:
               $ref: "#/components/schemas/ScheduledTransactionDetail"
+    PostScheduledTransactionWrapper:
+      required:
+        - scheduled_transaction
+      type: object
+      properties:
+        scheduled_transaction:
+          $ref: "#/components/schemas/SaveScheduledTransaction"
+    SaveScheduledTransaction:
+      required:
+        - account_id
+        - date
+      type: object
+      properties:
+        account_id:
+          type: string
+          format: uuid
+        date:
+          type: string
+          description: >-
+            The scheduled transaction date in ISO format (e.g. 2016-12-01).
+          format: date
+        amount:
+          type: integer
+          description: >-
+            The scheduled transaction amount in milliunits format.
+          format: int64
+        payee_id:
+          type: string
+          nullable: true
+          description: >-
+            The payee for the scheduled transaction.  To create a transfer between two
+            accounts, use the account transfer payee pointing to the target
+            account.  Account transfer payees are specified as
+            `transfer_payee_id` on the account resource.
+          format: uuid
+        payee_name:
+          maxLength: 50
+          type: string
+          nullable: true
+          description: >-
+            The payee name for the the scheduled transaction.  If a `payee_name` value is provided and `payee_id`
+            has a null value, the `payee_name` value will be used to resolve the
+            payee by either (1) a payee with the same name or (2) creation of a new payee.
+        category_id:
+          type: string
+          nullable: true
+          description: >-
+            The category for the scheduled transaction. Credit Card Payment categories are not permitted.
+            Creating a split scheduled transaction is not currently supported.
+          format: uuid
+        memo:
+          maxLength: 200
+          type: string
+          nullable: true
+        flag_color:
+          $ref: "#/components/schemas/TransactionFlagColor"
+        frequency:
+          $ref: "#/components/schemas/ScheduledTransactionFrequency"
     ScheduledTransactionSummary:
       required:
         - account_id
@@ -3127,6 +3296,23 @@ components:
         - cleared
         - uncleared
         - reconciled
+    ScheduledTransactionFrequency:
+      type: string
+      description: The scheduled transaction frequency
+      enum:
+        - never
+        - daily
+        - weekly
+        - everyOtherWeek
+        - twiceAMonth
+        - every4Weeks
+        - monthly
+        - everyOtherMonth
+        - every3Months
+        - every4Months
+        - twiceAYear
+        - yearly
+        - everyOtherYear
   securitySchemes:
     bearer:
       type: http

data/spec/api/scheduled_transactions_spec.rb

@@ -34,7 +34,7 @@ describe 'scheduled transactions' do
     end
   end
 
-  describe 'GET /budgets/{budget_id}/transactions' do
+  describe 'GET /budgets/{budget_id}/scheduled_transactions' do
     it 'returns a list of transactions' do
       VCR.use_cassette("scheduled_transactions") do
         response = instance.get_scheduled_transactions(budget_id)
@@ -44,7 +44,7 @@ describe 'scheduled transactions' do
     end
   end
 
-  describe 'GET /budgets/{budget_id}/transaction/{payee_id}' do
+  describe 'GET /budgets/{budget_id}/scheduled_transactions/{payee_id}' do
     it 'returns a payee' do
       VCR.use_cassette("scheduled_transaction") do
         response = instance.get_scheduled_transaction_by_id(budget_id, '1a8e4929-3ad1-4859-8443-2aeeab0684ab')
@@ -53,4 +53,22 @@ describe 'scheduled transactions' do
       end
     end
   end
+
+  describe 'POST /budgets/{budget_id}/scheduled_transactions' do
+    it 'creates a scheduled transaction' do
+      VCR.use_cassette("create_scheduled_transaction") do
+        response = instance.create_scheduled_transaction(budget_id, {
+          scheduled_transaction: {
+            date: "#{Time.now.year + 1}-01-01",
+            account_id: '49b0c987-7d2b-46ec-ba14-f8a7e79fb830',
+            amount: 20000,
+            frequency: 'weekly',
+          }
+        })
+        expect(client.last_request.response.options[:code]).to be 201
+        expect(response.data.scheduled_transaction).to be
+        expect(response.data.scheduled_transaction.amount).to eq 20000
+      end
+    end
+  end
 end

data/spec/api/transactions_spec.rb

@@ -66,6 +66,16 @@ describe 'transactions' do
     end
   end
 
+  describe 'GET /budgets/{budget_id}/months/{month}/transactions' do
+    it 'returns a list of transactions for a month' do
+      VCR.use_cassette("month_transactions") do
+        response = instance.get_transactions_by_month(budget_id, "2024-07-01")
+        expect(client.last_request.response.options[:code]).to be 200
+        expect(response.data.transactions.length).to be 2
+      end
+    end
+  end
+
   describe 'GET /budgets/{budget_id}/transaction/{transaction_id}' do
     it 'returns a transaction' do
       VCR.use_cassette("transaction") do

data/spec/fixtures/vcr_cassettes/create_scheduled_transaction.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://api.localhost:3000/v1/budgets/f419ac25-6217-4175-88dc-c3136ff5f6fd/scheduled_transactions
+    body:
+      encoding: UTF-8
+      string: '{"scheduled_transaction":{"date":"2025-01-01","account_id":"49b0c987-7d2b-46ec-ba14-f8a7e79fb830","amount":20000,"frequency":"weekly"}}'
+    headers:
+      User-Agent:
+      - api_client/ruby/3.2.0
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Bearer 9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045
+      Expect:
+      - ''
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      x-frame-options:
+      - deny
+      x-xss-protection:
+      - '0'
+      x-content-type-options:
+      - nosniff
+      x-download-options:
+      - noopen
+      x-permitted-cross-domain-policies:
+      - none
+      referrer-policy:
+      - strict-origin-when-cross-origin
+      content-type:
+      - application/json; charset=utf-8
+      vary:
+      - Accept-Encoding, Origin
+      etag:
+      - W/"a2fe3b102465b2515af0f411970ca861"
+      cache-control:
+      - max-age=0, private, must-revalidate
+      x-request-id:
+      - 0ccaa271-1563-4ab8-a6ad-db09893e62db
+      x-runtime:
+      - '0.104987'
+      server-timing:
+      - start_processing.action_controller;dur=0.01, sql.active_record;dur=31.01,
+        instantiation.active_record;dur=0.56, cache_read.active_support;dur=0.21,
+        cache_fetch_hit.active_support;dur=0.00, transaction.active_record;dur=26.93,
+        render.active_model_serializers;dur=15.03, process_action.action_controller;dur=50.91
+      Content-Length:
+      - '463'
+    body:
+      encoding: ASCII-8BIT
+      string: '{"data":{"scheduled_transaction":{"id":"5901eada-db36-4d95-b737-c1a5cc43a915","date_first":"2025-01-01","date_next":"2025-01-01","frequency":"weekly","amount":20000,"memo":null,"flag_color":null,"flag_name":null,"account_id":"49b0c987-7d2b-46ec-ba14-f8a7e79fb830","account_name":"Checking","payee_id":null,"payee_name":null,"category_id":null,"category_name":"Uncategorized","transfer_account_id":null,"deleted":false,"subtransactions":[]},"server_knowledge":64}}'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://localhost:3000/papi/v1/budgets/f419ac25-6217-4175-88dc-c3136ff5f6fd/scheduled_transactions
+  recorded_at: Mon, 08 Jul 2024 23:16:33 GMT
+recorded_with: VCR 6.2.0

data/spec/fixtures/vcr_cassettes/month_transactions.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.localhost:3000/v1/budgets/f419ac25-6217-4175-88dc-c3136ff5f6fd/months/2024-07-01/transactions
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - api_client/ruby/0.4.0
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Authorization:
+      - Bearer 9f1a2c4842b614a771aaae9220fc54ae835e298c4654dc2c9205fc1d7bd1a045
+      Expect:
+      - ''
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Vary:
+      - Accept-Encoding, Origin
+      ETag:
+      - W/"d2b4b29be1231be9847defe032df6712"
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - b79f3971-7666-4b04-8d8b-bd5258dd02bc
+      X-Runtime:
+      - '0.186443'
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: UTF-8
+      string: '{"data":{"transactions":[{"type":"subtransaction","id":"008908a3-07c2-4684-b4c1-6f1024814f8d","parent_transaction_id":"910a79e1-29f5-4789-a2a0-2a69c2f94a2b","date":"2018-03-26","amount":-15000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":"2676f959-c5de-4db2-8d3f-2503777b25fb","category_id":"b457e34a-234e-40b2-992e-40055171e644","transfer_account_id":null,"import_id":null},{"type":"transaction","id":"d477e91a-1f2b-4df5-8069-6b61dee51259","parent_transaction_id":null,"date":"2018-03-27","amount":-13000,"memo":"","cleared":"uncleared","approved":true,"flag_color":null,"account_id":"16addaa3-cfaf-4e57-933c-7e1645f000f0","payee_id":"2676f959-c5de-4db2-8d3f-2503777b25fb","category_id":"84ffe61c-081c-44db-ad23-6ee809206c40","transfer_account_id":null,"import_id":null}]}}'
+    http_version: '1.1'
+    adapter_metadata:
+      effective_url: http://api.localhost:3000/v1/budgets/6e6aa585-8537-4afc-950f-93d55fac17fa/months/2024-07-01/transactions
+  recorded_at: Tue, 27 Mar 2018 17:03:22 GMT
+recorded_with: VCR 3.0.3

data/templates/README.md

@@ -0,0 +1,3 @@
+This directory contains override templates for generating Ruby code from the OpenAPI spec.  They modify the default behavior or the generator.
+
+The source for these are located at https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/ruby-client.

data/templates/api_info.mustache

@@ -0,0 +1,9 @@
+{{#appName}}
+#{{{.}}}
+
+{{/appName}}
+{{#appDescription}}
+#{{{.}}}
+{{/appDescription}}
+{{#infoEmail}}Contact: {{{.}}}{{/infoEmail}}
+Generated by: OpenAPI Generator (https://openapi-generator.tech)

data/templates/gemspec.mustache

@@ -0,0 +1,41 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+{{> api_info}}
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "{{gemName}}/version"
+
+Gem::Specification.new do |s|
+  s.name        = "{{gemName}}{{^gemName}}{{{appName}}}{{/gemName}}"
+  s.version     = {{moduleName}}::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["{{gemAuthor}}{{^gemAuthor}}OpenAPI-Generator{{/gemAuthor}}"]
+  s.email       = ["{{gemAuthorEmail}}{{^gemAuthorEmail}}{{infoEmail}}{{/gemAuthorEmail}}"]
+  s.homepage    = "{{gemHomepage}}{{^gemHomepage}}https://openapi-generator.tech{{/gemHomepage}}"
+  s.summary     = "{{gemSummary}}{{^gemSummary}}{{{appName}}} Ruby Gem{{/gemSummary}}"
+  s.description = "{{gemDescription}}{{^gemDescription}}{{{appDescription}}}{{^appDescription}}{{{appName}}} Ruby Gem{{/appDescription}}{{/gemDescription}} Generated from server specification version {{version}} using OpenAPI Generator version {{generatorVersion}}."
+  s.license     = "{{{gemLicense}}}{{^gemLicense}}Unlicense{{/gemLicense}}"
+  s.required_ruby_version = "{{{gemRequiredRubyVersion}}}{{^gemRequiredRubyVersion}}>= 2.7{{/gemRequiredRubyVersion}}"
+  s.metadata    = {{{gemMetadata}}}{{^gemMetadata}}{}{{/gemMetadata}}
+
+  {{#isFaraday}}
+  s.add_runtime_dependency 'faraday', '>= 1.0.1', '< 3.0'
+  s.add_runtime_dependency 'faraday-multipart'
+  s.add_runtime_dependency 'marcel'
+  {{/isFaraday}}
+  {{#isTyphoeus}}
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  {{/isTyphoeus}}
+  {{#isHttpx}}
+  s.add_runtime_dependency 'httpx', '~> 1.0', '>= 1.0.0'
+  {{/isHttpx}}
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/ynab.gemspec

@@ -5,10 +5,7 @@
 
 #Our API uses a REST based design, leverages the JSON data format, and relies 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
 
-The version of the OpenAPI document: 1.70.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.6.0
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
 
 =end
 
@@ -22,8 +19,8 @@ Gem::Specification.new do |s|
   s.authors     = ["YNAB"]
   s.email       = ["api@ynab.com"]
   s.homepage    = "https://github.com/ynab/ynab-sdk-ruby"
-  s.summary     = "YNAB API Endpoints Ruby Gem"
-  s.description = "Ruby gem wrapper for the YNAB API. Read the documentation at https://api.ynab.com"
+  s.summary     = "YNAB API Client for Ruby"
+  s.description = "Ruby gem wrapper for the YNAB API. Generated from server specification version 1.72.0 using OpenAPI Generator version 7.7.0."
   s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 3.3"
   s.metadata    = {}