ynab 5.0.0 → 5.2.0

data/open_api_spec.yaml

@@ -5,7 +5,7 @@ info:
     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
-  version: 1.79.0
+  version: 1.85.0
 servers:
   - url: https://api.ynab.com/v1
 security:
@@ -622,6 +622,43 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ErrorResponse"
+    post:
+      tags:
+        - Payees
+      summary: Create a payee
+      description: Creates a new payee
+      operationId: createPayee
+      parameters:
+        - name: plan_id
+          in: path
+          description: 'The id of the plan. "last-used" can be used to specify the last
+            used plan and "default" can be used if default plan selection is
+            enabled (see: https://api.ynab.com/#oauth-default-plan).'
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: The payee to create
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/PostPayeeWrapper"
+        required: true
+      responses:
+        "201":
+          description: The payee was successfully created
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/SavePayeeResponse"
+        "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
   /plans/{plan_id}/payees/{payee_id}:
     get:
       tags:
@@ -1008,7 +1045,7 @@ paths:
     get:
       tags:
         - Transactions
-      summary: Get all transactions
+      summary: Get transactions
       description: Returns plan transactions, excluding any pending transactions
       operationId: getTransactions
       parameters:
@@ -1024,6 +1061,14 @@ paths:
           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).
+            Defaults to one year ago when not specified.
+          schema:
+            type: string
+            format: date
+        - name: until_date
+          in: query
+          description: If specified, only transactions on or before this date will be
+            included.  The date should be ISO formatted (e.g. 2016-12-30).
           schema:
             type: string
             format: date
@@ -1316,7 +1361,7 @@ paths:
     get:
       tags:
         - Transactions
-      summary: Get all account transactions
+      summary: Get account transactions
       description: Returns all transactions for a specified account, excluding any
         pending transactions
       operationId: getTransactionsByAccount
@@ -1339,6 +1384,14 @@ paths:
           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).
+            Defaults to one year ago when not specified.
+          schema:
+            type: string
+            format: date
+        - name: until_date
+          in: query
+          description: If specified, only transactions on or before this date will be
+            included.  The date should be ISO formatted (e.g. 2016-12-30).
           schema:
             type: string
             format: date
@@ -1375,7 +1428,7 @@ paths:
     get:
       tags:
         - Transactions
-      summary: Get all category transactions
+      summary: Get category transactions
       description: Returns all transactions for a specified category, excluding any
         pending transactions
       operationId: getTransactionsByCategory
@@ -1398,6 +1451,14 @@ paths:
           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).
+            Defaults to one year ago when not specified.
+          schema:
+            type: string
+            format: date
+        - name: until_date
+          in: query
+          description: If specified, only transactions on or before this date will be
+            included.  The date should be ISO formatted (e.g. 2016-12-30).
           schema:
             type: string
             format: date
@@ -1434,7 +1495,7 @@ paths:
     get:
       tags:
         - Transactions
-      summary: Get all payee transactions
+      summary: Get payee transactions
       description: Returns all transactions for a specified payee, excluding any
         pending transactions
       operationId: getTransactionsByPayee
@@ -1457,6 +1518,14 @@ paths:
           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).
+            Defaults to one year ago when not specified.
+          schema:
+            type: string
+            format: date
+        - name: until_date
+          in: query
+          description: If specified, only transactions on or before this date will be
+            included.  The date should be ISO formatted (e.g. 2016-12-30).
           schema:
             type: string
             format: date
@@ -1493,7 +1562,7 @@ paths:
     get:
       tags:
         - Transactions
-      summary: Get all plan month transactions
+      summary: Get plan month transactions
       description: Returns all transactions for a specified month, excluding any
         pending transactions
       operationId: getTransactionsByMonth
@@ -1520,6 +1589,13 @@ paths:
           schema:
             type: string
             format: date
+        - name: until_date
+          in: query
+          description: If specified, only transactions on or before 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
@@ -1897,7 +1973,7 @@ components:
             accounts:
               type: array
               items:
-                $ref: "#/components/schemas/Account"
+                $ref: "#/components/schemas/AccountBase"
             payees:
               type: array
               items:
@@ -1913,27 +1989,27 @@ components:
             categories:
               type: array
               items:
-                $ref: "#/components/schemas/Category"
+                $ref: "#/components/schemas/CategoryBase"
             months:
               type: array
               items:
-                $ref: "#/components/schemas/MonthDetail"
+                $ref: "#/components/schemas/MonthDetailBase"
             transactions:
               type: array
               items:
-                $ref: "#/components/schemas/TransactionSummary"
+                $ref: "#/components/schemas/TransactionSummaryBase"
             subtransactions:
               type: array
               items:
-                $ref: "#/components/schemas/SubTransaction"
+                $ref: "#/components/schemas/SubTransactionBase"
             scheduled_transactions:
               type: array
               items:
-                $ref: "#/components/schemas/ScheduledTransactionSummary"
+                $ref: "#/components/schemas/ScheduledTransactionSummaryBase"
             scheduled_subtransactions:
               type: array
               items:
-                $ref: "#/components/schemas/ScheduledSubTransaction"
+                $ref: "#/components/schemas/ScheduledSubTransactionBase"
     PlanSettingsResponse:
       required:
         - data
@@ -1987,7 +2063,7 @@ components:
           properties:
             account:
               $ref: "#/components/schemas/Account"
-    Account:
+    AccountBase:
       required:
         - balance
         - cleared_balance
@@ -2067,6 +2143,32 @@ components:
           type: boolean
           description: Whether or not the account has been deleted.  Deleted accounts will
             only be included in delta requests.
+    Account:
+      allOf:
+        - $ref: "#/components/schemas/AccountBase"
+        - type: object
+          properties:
+            balance_formatted:
+              type: string
+              description: The current available balance of the account formatted in the plan's currency format
+            balance_currency:
+              type: number
+              format: double
+              description: The current available balance of the account as a decimal currency amount
+            cleared_balance_formatted:
+              type: string
+              description: The current cleared balance of the account formatted in the plan's currency format
+            cleared_balance_currency:
+              type: number
+              format: double
+              description: The current cleared balance of the account as a decimal currency amount
+            uncleared_balance_formatted:
+              type: string
+              description: The current uncleared balance of the account formatted in the plan's currency format
+            uncleared_balance_currency:
+              type: number
+              format: double
+              description: The current uncleared balance of the account as a decimal currency amount
     PostAccountWrapper:
       required:
         - account
@@ -2085,7 +2187,7 @@ components:
           type: string
           description: The name of the account
         type:
-          $ref: "#/components/schemas/AccountType"
+          $ref: "#/components/schemas/SaveAccountType"
         balance:
           type: integer
           description: The current balance of the account in milliunits format
@@ -2097,6 +2199,16 @@ components:
       additionalProperties:
         type: integer
         format: int64
+    SaveAccountType:
+      type: string
+      description: The type of account to create or update
+      enum:
+        - checking
+        - savings
+        - cash
+        - creditCard
+        - otherAsset
+        - otherLiability
     AccountType:
       type: string
       description: The type of account
@@ -2162,6 +2274,7 @@ components:
       required:
         - deleted
         - hidden
+        - internal
         - id
         - name
       type: object
@@ -2174,11 +2287,14 @@ components:
         hidden:
           type: boolean
           description: Whether or not the category group is hidden
+        internal:
+          type: boolean
+          description: Whether or not the category group is internal
         deleted:
           type: boolean
           description: Whether or not the category group has been deleted.  Deleted
             category groups will only be included in delta requests.
-    Category:
+    CategoryBase:
       required:
         - activity
         - balance
@@ -2186,6 +2302,7 @@ components:
         - category_group_id
         - deleted
         - hidden
+        - internal
         - id
         - name
       type: object
@@ -2203,6 +2320,9 @@ components:
         hidden:
           type: boolean
           description: Whether or not the category is hidden
+        internal:
+          type: boolean
+          description: Whether or not the category is internal
         original_category_group_id:
           type:
             - string
@@ -2357,6 +2477,76 @@ components:
           type: boolean
           description: Whether or not the category has been deleted.  Deleted categories
             will only be included in delta requests.
+    Category:
+      allOf:
+        - $ref: "#/components/schemas/CategoryBase"
+        - type: object
+          properties:
+            balance_formatted:
+              type: string
+              description: Available balance of the category formatted in the plan's currency format
+            balance_currency:
+              type: number
+              format: double
+              description: Available balance of the category as a decimal currency amount
+            activity_formatted:
+              type: string
+              description: Activity of the category formatted in the plan's currency format
+            activity_currency:
+              type: number
+              format: double
+              description: Activity of the category as a decimal currency amount
+            budgeted_formatted:
+              type: string
+              description: Assigned (budgeted) amount of the category formatted in the plan's currency format
+            budgeted_currency:
+              type: number
+              format: double
+              description: Assigned (budgeted) amount of the category as a decimal currency amount
+            goal_target_formatted:
+              type:
+                - string
+                - "null"
+              description: The goal target amount formatted in the plan's currency format
+            goal_target_currency:
+              type:
+                - number
+                - "null"
+              format: double
+              description: The goal target amount as a decimal currency amount
+            goal_under_funded_formatted:
+              type:
+                - string
+                - "null"
+              description: The goal underfunded amount formatted in the plan's currency format
+            goal_under_funded_currency:
+              type:
+                - number
+                - "null"
+              format: double
+              description: The goal underfunded amount as a decimal currency amount
+            goal_overall_funded_formatted:
+              type:
+                - string
+                - "null"
+              description: The total amount funded towards the goal formatted in the plan's currency format
+            goal_overall_funded_currency:
+              type:
+                - number
+                - "null"
+              format: double
+              description: The total amount funded towards the goal as a decimal currency amount
+            goal_overall_left_formatted:
+              type:
+                - string
+                - "null"
+              description: The amount of funding still needed to complete the goal formatted in the plan's currency format
+            goal_overall_left_currency:
+              type:
+                - number
+                - "null"
+              format: double
+              description: The amount of funding still needed to complete the goal as a decimal currency amount
     SaveCategoryResponse:
       required:
         - data
@@ -2784,7 +2974,7 @@ components:
               type: integer
               description: The knowledge of the server
               format: int64
-    TransactionSummary:
+    TransactionSummaryBase:
       required:
         - account_id
         - amount
@@ -2894,6 +3084,19 @@ components:
           type: boolean
           description: Whether or not the transaction has been deleted.  Deleted
             transactions will only be included in delta requests.
+    TransactionSummary:
+      allOf:
+        - $ref: "#/components/schemas/TransactionSummaryBase"
+        - type: object
+          properties:
+            amount_formatted:
+              type: string
+              description: The transaction amount formatted in the plan's currency format
+            amount_currency:
+              type: number
+              format: double
+              description: The transaction amount as a decimal currency amount
+
     TransactionDetail:
       allOf:
         - $ref: "#/components/schemas/TransactionSummary"
@@ -2951,6 +3154,23 @@ components:
               type: string
               description: The name of the category.  If a split transaction, this will be
                 'Split'.
+    PostPayeeWrapper:
+      required:
+        - payee
+      type: object
+      properties:
+        payee:
+          $ref: "#/components/schemas/PostPayee"
+    PostPayee:
+      required:
+        - name
+      type: object
+      properties:
+        name:
+          type: string
+          nullable: false
+          maxLength: 500
+          description: The name of the payee.
     PatchPayeeWrapper:
       required:
         - payee
@@ -2965,7 +3185,7 @@ components:
           type: string
           nullable: false
           maxLength: 500
-          description: The name of the payee. The name must be a maximum of 500 characters.
+          description: The name of the payee.
     PostCategoryGroupWrapper:
       required:
         - category_group
@@ -3018,14 +3238,15 @@ components:
         category_group_id:
           type: string
           format: uuid
+          description: The id of the category group to which this category belongs.  An internal category group may not be specified.
         goal_target:
           type:
             - integer
             - "null"
           description: The goal target amount in milliunits format.  If value is specified
-            and goal has not already been configured for category, a monthly
-            'Needed for Spending' goal will be created for the category with
-            this target amount.
+            and goal has not already been configured for category, a monthly goal
+            will be created for the category with this target amount.  If goal_type is
+            not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
           format: int64
         goal_target_date:
           type:
@@ -3033,6 +3254,13 @@ components:
             - "null"
           description: The goal target date in ISO format (e.g. 2016-12-01).
           format: date
+        goal_needs_whole_amount:
+          type:
+            - boolean
+            - "null"
+          description: Whether the goal requires the full target amount each period. Only supported for 'NEED' goals.
+            When true, the goal is configured as 'Set aside another...'.
+            When false, the goal is configured as 'Refill up to...'.
     ExistingCategory:
       allOf:
         - $ref: "#/components/schemas/SaveCategory"
@@ -3112,7 +3340,7 @@ components:
           type: array
           items:
             $ref: "#/components/schemas/SaveTransactionWithOptionalFields"
-    SubTransaction:
+    SubTransactionBase:
       required:
         - amount
         - deleted
@@ -3166,6 +3394,18 @@ components:
           type: boolean
           description: Whether or not the subtransaction has been deleted.  Deleted
             subtransactions will only be included in delta requests.
+    SubTransaction:
+      allOf:
+        - $ref: "#/components/schemas/SubTransactionBase"
+        - type: object
+          properties:
+            amount_formatted:
+              type: string
+              description: The subtransaction amount formatted in the plan's currency format
+            amount_currency:
+              type: number
+              format: double
+              description: The subtransaction amount as a decimal currency amount
     ScheduledTransactionsResponse:
       required:
         - data
@@ -3265,7 +3505,7 @@ components:
           $ref: "#/components/schemas/TransactionFlagColor"
         frequency:
           $ref: "#/components/schemas/ScheduledTransactionFrequency"
-    ScheduledTransactionSummary:
+    ScheduledTransactionSummaryBase:
       required:
         - account_id
         - amount
@@ -3339,6 +3579,18 @@ components:
           type: boolean
           description: Whether or not the scheduled transaction has been deleted.  Deleted
             scheduled transactions will only be included in delta requests.
+    ScheduledTransactionSummary:
+      allOf:
+        - $ref: "#/components/schemas/ScheduledTransactionSummaryBase"
+        - type: object
+          properties:
+            amount_formatted:
+              type: string
+              description: The scheduled transaction amount formatted in the plan's currency format
+            amount_currency:
+              type: number
+              format: double
+              description: The scheduled transaction amount as a decimal currency amount
     ScheduledTransactionDetail:
       allOf:
         - $ref: "#/components/schemas/ScheduledTransactionSummary"
@@ -3364,7 +3616,7 @@ components:
               description: If a split scheduled transaction, the subtransactions.
               items:
                 $ref: "#/components/schemas/ScheduledSubTransaction"
-    ScheduledSubTransaction:
+    ScheduledSubTransactionBase:
       required:
         - amount
         - deleted
@@ -3416,6 +3668,18 @@ components:
           description: Whether or not the scheduled subtransaction has been deleted.
             Deleted scheduled subtransactions will only be included in delta
             requests.
+    ScheduledSubTransaction:
+      allOf:
+        - $ref: "#/components/schemas/ScheduledSubTransactionBase"
+        - type: object
+          properties:
+            amount_formatted:
+              type: string
+              description: The scheduled subtransaction amount formatted in the plan's currency format
+            amount_currency:
+              type: number
+              format: double
+              description: The scheduled subtransaction amount as a decimal currency amount
     MonthSummariesResponse:
       required:
         - data
@@ -3447,7 +3711,7 @@ components:
           properties:
             month:
               $ref: "#/components/schemas/MonthDetail"
-    MonthSummary:
+    MonthSummaryBase:
       required:
         - activity
         - budgeted
@@ -3492,6 +3756,52 @@ components:
           type: boolean
           description: Whether or not the month has been deleted.  Deleted months will
             only be included in delta requests.
+    MonthSummary:
+      allOf:
+        - $ref: "#/components/schemas/MonthSummaryBase"
+        - type: object
+          properties:
+            income_formatted:
+              type: string
+              description: The total income formatted in the plan's currency format
+            income_currency:
+              type: number
+              format: double
+              description: The total income as a decimal currency amount
+            budgeted_formatted:
+              type: string
+              description: The total amount assigned formatted in the plan's currency format
+            budgeted_currency:
+              type: number
+              format: double
+              description: The total amount assigned as a decimal currency amount
+            activity_formatted:
+              type: string
+              description: The total activity amount formatted in the plan's currency format
+            activity_currency:
+              type: number
+              format: double
+              description: The total activity amount as a decimal currency amount
+            to_be_budgeted_formatted:
+              type: string
+              description: The available amount for 'Ready to Assign' formatted in the plan's currency format
+            to_be_budgeted_currency:
+              type: number
+              format: double
+              description: The available amount for 'Ready to Assign' as a decimal currency amount
+    MonthDetailBase:
+      allOf:
+        - $ref: "#/components/schemas/MonthSummaryBase"
+        - required:
+            - categories
+          type: object
+          properties:
+            categories:
+              type: array
+              description: The plan month categories.  Amounts (budgeted, activity, balance,
+                etc.) are specific to the {month} parameter specified.
+              items:
+                $ref: "#/components/schemas/CategoryBase"
     MonthDetail:
       allOf:
         - $ref: "#/components/schemas/MonthSummary"
@@ -3567,7 +3877,7 @@ components:
               type: integer
               description: The knowledge of the server
               format: int64
-    MoneyMovement:
+    MoneyMovementBase:
       required:
         - id
         - amount
@@ -3621,6 +3931,18 @@ components:
           type: integer
           description: The amount of the money movement in milliunits format
           format: int64
+    MoneyMovement:
+      allOf:
+        - $ref: "#/components/schemas/MoneyMovementBase"
+        - type: object
+          properties:
+            amount_formatted:
+              type: string
+              description: The money movement amount formatted in the plan's currency format
+            amount_currency:
+              type: number
+              format: double
+              description: The money movement amount as a decimal currency amount
     MoneyMovementGroupsResponse:
       required:
         - data

data/ynab.gemspec

@@ -19,7 +19,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.79.0."
+  s.description = "Official Ruby client for the YNAB API. API documentation available at https://api.ynab.com. Generated from server specification version 1.85.0."
   s.license     = "Apache-2.0"
   s.required_ruby_version = ">= 3.3"
   s.metadata    = {}