Merge pull request #150 from square/fern-bot/04-16-2025-0315PM

🌿 Fern Regeneration -- April 16, 2025

Author: mikekono

.mock/definition/__package__.yml

@@ -3378,6 +3378,38 @@ types:
           from the `amount_money` and `buyer_supplied_money` fields.
     source:
       openapi: openapi/openapi.json
+  CatalogAvailabilityPeriod:
+    docs: Represents a time period of availability.
+    properties:
+      start_local_time:
+        type: optional<nullable<string>>
+        docs: >-
+          The start time of an availability period, specified in local time
+          using partial-time
+
+          RFC 3339 format. For example, `8:30:00` for a period starting at 8:30
+          in the morning.
+
+          Note that the seconds value is always :00, but it is appended for
+          conformance to the RFC.
+      end_local_time:
+        type: optional<nullable<string>>
+        docs: >-
+          The end time of an availability period, specified in local time using
+          partial-time
+
+          RFC 3339 format. For example, `21:00:00` for a period ending at 9:00
+          in the evening.
+
+          Note that the seconds value is always :00, but it is appended for
+          conformance to the RFC.
+      day_of_week:
+        type: optional<DayOfWeek>
+        docs: |-
+          The day of the week for this availability period.
+          See [DayOfWeek](#type-dayofweek) for possible values
+    source:
+      openapi: openapi/openapi.json
   CatalogCategory:
     docs: A category to which a `CatalogItem` instance belongs.
     properties:
@@ -4188,6 +4220,16 @@ types:
           variations in a specified order.
 
           Maximum: 6 item options.
+      ecom_uri:
+        type: optional<nullable<string>>
+        docs: >-
+          Deprecated; see go/ecomUriUseCases. A URI pointing to a published
+          e-commerce product page for the Item.
+      ecom_image_uris:
+        type: optional<nullable<list<string>>>
+        docs: >-
+          Deprecated; see go/ecomUriUseCases. A comma-separated list of encoded
+          URIs pointing to a set of published e-commerce images for the Item.
       image_ids:
         type: optional<nullable<list<string>>>
         docs: |-
@@ -4287,6 +4329,9 @@ types:
       reporting_category:
         type: optional<CatalogObjectCategory>
         docs: The item's reporting category.
+      is_alcoholic:
+        type: optional<nullable<boolean>>
+        docs: Indicates whether this item is alcoholic (`true`) or not (`false`).
     source:
       openapi: openapi/openapi.json
   CatalogItemFoodAndBeverageDetails:
@@ -5129,6 +5174,8 @@ types:
       CHECKOUT_LINK: CatalogObjectCheckoutLink
       ADDRESS: CatalogObjectAddress
       SUBSCRIPTION_PRODUCT: CatalogObjectSubscriptionProduct
+      SUBSCRIPTION_PLAN_VARIATION: CatalogObjectSubscriptionPlanVariation
+      AVAILABILITY_PERIOD: CatalogObjectAvailabilityPeriod
     source:
       openapi: openapi/openapi.json
   CatalogObjectBatch:
@@ -6156,6 +6203,43 @@ types:
           SubscriptionPlan.
     source:
       openapi: openapi/openapi.json
+  CatalogSubscriptionPlanVariation:
+    docs: >-
+      Describes a subscription plan variation. A subscription plan variation
+      represents how the subscription for a product or service is sold.
+
+      For more information, see [Subscription Plans and
+      Variations](https://developer.squareup.com/docs/subscriptions-api/plans-and-variations).
+    properties:
+      name:
+        type: string
+        docs: The name of the plan variation.
+      phases:
+        docs: >-
+          A list containing each [SubscriptionPhase](entity:SubscriptionPhase)
+          for this plan variation.
+        type: list<SubscriptionPhase>
+      subscription_plan_id:
+        type: optional<nullable<string>>
+        docs: The id of the subscription plan, if there is one.
+      monthly_billing_anchor_date:
+        type: optional<nullable<long>>
+        docs: The day of the month the billing period starts.
+      can_prorate:
+        type: optional<nullable<boolean>>
+        docs: Whether bills for this plan variation can be split for proration.
+      successor_plan_variation_id:
+        type: optional<nullable<string>>
+        docs: >-
+          The ID of a "successor" plan variation to this one. If the field is
+          set, and this object is disabled at all
+
+          locations, it indicates that this variation is deprecated and the
+          object identified by the successor ID be used in
+
+          its stead.
+    source:
+      openapi: openapi/openapi.json
   CatalogTax:
     docs: A tax applicable to an item.
     properties:
@@ -13464,12 +13548,20 @@ types:
       public_url:
         type: optional<string>
         docs: >-
-          The URL of the Square-hosted invoice page.
+          A temporary link to the Square-hosted payment page where the customer
+          can pay the
+
+          invoice. If the link expires, customers can provide the email address
+          or phone number
+
+          associated with the invoice and request a new link directly from the
+          expired payment page. 
 
-          After you publish the invoice using the `PublishInvoice` endpoint,
-          Square hosts the invoice
 
-          page and returns the page URL in the response.
+          This field is added after the invoice is published and reaches the
+          scheduled date
+
+          (if one is defined).
         access: read-only
       next_payment_amount_money:
         type: optional<Money>
@@ -14181,7 +14273,7 @@ types:
       - CANCELED
       - FAILED
       - PAYMENT_PENDING
-    docs: Indicates the status of an invoice.
+    docs: Indicates the status of an [invoice](entity:Invoice).
     source:
       openapi: openapi/openapi.json
   ItemVariationLocationOverrides:
@@ -20691,9 +20783,10 @@ types:
         type: optional<nullable<boolean>>
         docs: >-
           Indicates whether the `Payment` objects created from this
-          `TerminalCheckout` are automatically
+          `TerminalCheckout` are
 
-          `COMPLETED` or left in an `APPROVED` state for later modification.
+          automatically `COMPLETED` or left in an `APPROVED` state for later
+          modification.
 
 
           Default: true
@@ -25001,9 +25094,7 @@ types:
         docs: The reference to the Square order ID for the checkout request.
       payment_options:
         type: optional<PaymentOptions>
-        docs: >-
-          Payment-specific options for the checkout request. Supported only in
-          the US.
+        docs: Payment-specific options for the checkout request.
       device_options:
         type: DeviceCheckoutOptions
         docs: >-
@@ -25114,9 +25205,6 @@ types:
           To set this field, PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS OAuth
           permission is required. For more information, see
           [Permissions](https://developer.squareup.com/docs/payments-api/take-payments-and-collect-fees#permissions).
-
-
-          Supported only in the US.
       statement_description_identifier:
         type: optional<nullable<string>>
         docs: >-
@@ -25126,8 +25214,7 @@ types:
           part of the statement description. This can be, for example, an
           invoice number, ticket number,
 
-          or short description that uniquely identifies the purchase. Supported
-          only in the US.
+          or short description that uniquely identifies the purchase.
         validation:
           maxLength: 20
       tip_money:
@@ -25137,9 +25224,7 @@ types:
           may only be set for a
 
           checkout that has tipping disabled (`tip_settings.allow_tipping` is
-          `false`). Supported only in
-
-          the US.
+          `false`).
     source:
       openapi: openapi/openapi.json
   TerminalCheckoutQuery:
@@ -26939,6 +27024,28 @@ types:
       - CatalogObjectBase
     source:
       openapi: openapi/openapi.json
+  CatalogObjectSubscriptionPlanVariation:
+    properties:
+      subscription_plan_variation_data:
+        type: optional<CatalogSubscriptionPlanVariation>
+        docs: >-
+          Structured data for a `CatalogSubscriptionPlanVariation`, set for
+          CatalogObjects of type `SUBSCRIPTION_PLAN_VARIATION`.
+    extends:
+      - CatalogObjectBase
+    source:
+      openapi: openapi/openapi.json
+  CatalogObjectAvailabilityPeriod:
+    properties:
+      availability_period_data:
+        type: optional<CatalogAvailabilityPeriod>
+        docs: >-
+          Structured data for a `CatalogAvailabilityPeriod`, set for
+          CatalogObjects of type `AVAILABILITY_PERIOD`.
+    extends:
+      - CatalogObjectBase
+    source:
+      openapi: openapi/openapi.json
   CatalogObjectComponent:
     properties: {}
     extends:

.mock/definition/api.yml

@@ -10,7 +10,7 @@ headers:
   Square-Version:
     name: version
     env: VERSION
-    type: literal<"2025-03-19">
+    type: literal<"2025-04-16">
 auth-schemes:
   Bearer:
     scheme: bearer

.mock/definition/catalog.yml

@@ -49,7 +49,6 @@ service:
         body:
           properties:
             object_ids:
-              type: optional<nullable<list<string>>>
               docs: >-
                 The IDs of the CatalogObjects to be deleted. When an object is
                 deleted, other objects
@@ -58,6 +57,7 @@ service:
                 (for example, deleting a
 
                 CatalogItem will delete its CatalogItemVariation.
+              type: list<string>
         content-type: application/json
       response:
         docs: Success

.mock/definition/catalog/object.yml

@@ -111,6 +111,9 @@ service:
                   skip_modifier_screen: true
                   item_options:
                     - {}
+                  ecom_uri: ecom_uri
+                  ecom_image_uris:
+                    - ecom_image_uris
                   image_ids:
                     - image_ids
                   sort_name: sort_name
@@ -119,6 +122,7 @@ service:
                   channels:
                     - channels
                   is_archived: true
+                  is_alcoholic: true
                 type: ITEM
               id_mappings:
                 - client_object_id: '#Cocoa'
@@ -269,6 +273,9 @@ service:
                   skip_modifier_screen: true
                   item_options:
                     - {}
+                  ecom_uri: ecom_uri
+                  ecom_image_uris:
+                    - ecom_image_uris
                   image_ids:
                     - image_ids
                   sort_name: sort_name
@@ -277,6 +284,7 @@ service:
                   channels:
                     - channels
                   is_archived: true
+                  is_alcoholic: true
                 type: ITEM
               related_objects:
                 - id: id

.mock/definition/invoices.yml

@@ -160,7 +160,8 @@ service:
                   title: title
                   description: description
                   scheduled_at: scheduled_at
-                  public_url: https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ
+                  public_url: >-
+                    https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9
                   next_payment_amount_money:
                     amount: 3000
                     currency: USD
@@ -508,7 +509,8 @@ service:
                   title: title
                   description: description
                   scheduled_at: scheduled_at
-                  public_url: https://squareup.com/pay-invoice/h9sfsfTGTSnYEhISUDBhEQ
+                  public_url: >-
+                    https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9
                   next_payment_amount_money:
                     amount: 3000
                     currency: USD
@@ -1148,7 +1150,7 @@ service:
                 description: We appreciate your business!
                 scheduled_at: '2030-01-13T10:00:00Z'
                 public_url: >-
-                  https://squareup.com/pay-invoice/inv:0-ChCHu2mZEabLeeHahQnXDjZQECY
+                  https://squareup.com/pay-invoice/invtmp:5e22a2c2-47c1-46d6-b061-808764dfe2b9
                 next_payment_amount_money:
                   amount: 1000000
                   currency: UNKNOWN_CURRENCY

.mock/fern.config.json

@@ -1,4 +1,4 @@
 {
   "organization" : "square",
-  "version" : "0.56.24"
+  "version" : "0.57.17"
 }