Add Coupon API Support to Messaging API (#637)

line/line-openapi#111

# Add Coupon API Support to Messaging API
We've supported a set of new APIs that make it possible to create,
manage, and deliver coupons via the Messaging API. These features
provide functionality similar to what's available through the LINE
Official Account Manager interface ([see
here](https://www.lycbiz.com/jp/manual/OfficialAccountManager/coupons-create/)),
allowing developers to integrate coupon-related workflows into their
bots more flexibly.

For more details, see the official announcement:
[LINE Developers News — Coupon API Released
(2025/08/06)](https://developers.line.biz/en/news/2025/08/06/coupon-api/)

## New API Endpoints
- `POST /v2/bot/coupon`
Create a new coupon.
The request includes metadata such as the coupon title, description,
image URLs, validity period, reward details(e.g. 1000yen discount),
acquisition requirements, time zone, etc.

- `GET /v2/bot/coupon`
Retrieve a list of coupons associated with the bot.

- `GET /v2/bot/coupon/{couponId}`
Fetch detailed information about a specific coupon.

- `PUT /v2/bot/coupon/{couponId}`
Mark a coupon as expired.

## Messaging API Update
Message Object now supports a new type: `type=coupon`
This allows developers to send coupons directly to users via the
Messaging API, similar to sending text, image, or template messages.

## Example Requests
### Create a Coupon
```
POST /v2/bot/coupon
Content-Type: application/json
```
#### Request body
```json
{
  "title": "1000 yen off coupon",
  "acquisitionCondition": {
    "type": "normal"
  },
  "visibility": "PUBLIC",
  "startTimestamp": 1672537600,
  "endTimestamp": 1672624000,
  "maxUseCountPerTicket": 1,
  "reward": {
    "type": "discount",
    "priceInfo": {
      "priceInfoType": "fixed",
      "fixedAmount": 1000
    }
  },
  "imageUrl": "https://example.com/coupon_image.png",
  "barcodeImageUrl": "https://example.com/coupon_barcode.png",
  "timezone": "ASIA_TOKYO"
}
```
#### Response
```json
{
  "couponId": "abc1234"
}
```


### Send a Coupon Message

```json
{
  "to": "<userId>",
  "messages": [
    {
      "type": "coupon",
      "couponId": "abc1234"
    }
  ]
}
```

---------

Co-authored-by: github-actions <[email protected]>
Co-authored-by: habara keigo <[email protected]>

Author: 3 people

lib/line/bot/v2/messaging_api/.openapi-generator/FILES

@@ -2,6 +2,8 @@
 api/messaging_api_blob_client.rb
 api/messaging_api_client.rb
 core.rb
+model/acquisition_condition_request.rb
+model/acquisition_condition_response.rb
 model/action.rb
 model/age_demographic.rb
 model/age_demographic_filter.rb
@@ -20,13 +22,44 @@ model/camera_action.rb
 model/camera_roll_action.rb
 model/carousel_column.rb
 model/carousel_template.rb
+model/cash_back_fixed_price_info_request.rb
+model/cash_back_fixed_price_info_response.rb
+model/cash_back_percentage_price_info_request.rb
+model/cash_back_percentage_price_info_response.rb
+model/cash_back_price_info_request.rb
+model/cash_back_price_info_response.rb
 model/chat_reference.rb
 model/clipboard_action.rb
 model/clipboard_imagemap_action.rb
 model/confirm_template.rb
+model/coupon_cash_back_reward_request.rb
+model/coupon_cash_back_reward_response.rb
+model/coupon_create_request.rb
+model/coupon_create_response.rb
+model/coupon_discount_reward_request.rb
+model/coupon_discount_reward_response.rb
+model/coupon_free_reward_request.rb
+model/coupon_free_reward_response.rb
+model/coupon_gift_reward_request.rb
+model/coupon_gift_reward_response.rb
+model/coupon_list_response.rb
+model/coupon_message.rb
+model/coupon_others_reward_request.rb
+model/coupon_others_reward_response.rb
+model/coupon_response.rb
+model/coupon_reward_request.rb
+model/coupon_reward_response.rb
 model/create_rich_menu_alias_request.rb
 model/datetime_picker_action.rb
 model/demographic_filter.rb
+model/discount_explicit_price_info_request.rb
+model/discount_explicit_price_info_response.rb
+model/discount_fixed_price_info_request.rb
+model/discount_fixed_price_info_response.rb
+model/discount_percentage_price_info_request.rb
+model/discount_percentage_price_info_response.rb
+model/discount_price_info_request.rb
+model/discount_price_info_response.rb
 model/emoji.rb
 model/emoji_substitution_object.rb
 model/error_detail.rb
@@ -85,6 +118,8 @@ model/issue_link_token_response.rb
 model/limit.rb
 model/location_action.rb
 model/location_message.rb
+model/lottery_acquisition_condition_request.rb
+model/lottery_acquisition_condition_response.rb
 model/mark_messages_as_read_request.rb
 model/members_ids_response.rb
 model/membership.rb
@@ -95,9 +130,12 @@ model/message.rb
 model/message_action.rb
 model/message_imagemap_action.rb
 model/message_quota_response.rb
+model/messaging_api_pager_coupon_list_response.rb
 model/multicast_request.rb
 model/narrowcast_progress_response.rb
 model/narrowcast_request.rb
+model/normal_acquisition_condition_request.rb
+model/normal_acquisition_condition_response.rb
 model/number_of_messages_response.rb
 model/operator_demographic_filter.rb
 model/operator_recipient.rb
@@ -111,6 +149,7 @@ model/quota_consumption_response.rb
 model/quota_type.rb
 model/recipient.rb
 model/redelivery_recipient.rb
+model/referral_acquisition_condition_response.rb
 model/reply_message_request.rb
 model/reply_message_response.rb
 model/rich_menu_alias_list_response.rb

lib/line/bot/v2/messaging_api/api/messaging_api_client.rb

@@ -9,6 +9,8 @@
 # Do not edit the class manually.
 
 # Models
+require_relative './model/acquisition_condition_request'
+require_relative './model/acquisition_condition_response'
 require_relative './model/action'
 require_relative './model/age_demographic'
 require_relative './model/age_demographic_filter'
@@ -27,13 +29,44 @@
 require_relative './model/camera_roll_action'
 require_relative './model/carousel_column'
 require_relative './model/carousel_template'
+require_relative './model/cash_back_fixed_price_info_request'
+require_relative './model/cash_back_fixed_price_info_response'
+require_relative './model/cash_back_percentage_price_info_request'
+require_relative './model/cash_back_percentage_price_info_response'
+require_relative './model/cash_back_price_info_request'
+require_relative './model/cash_back_price_info_response'
 require_relative './model/chat_reference'
 require_relative './model/clipboard_action'
 require_relative './model/clipboard_imagemap_action'
 require_relative './model/confirm_template'
+require_relative './model/coupon_cash_back_reward_request'
+require_relative './model/coupon_cash_back_reward_response'
+require_relative './model/coupon_create_request'
+require_relative './model/coupon_create_response'
+require_relative './model/coupon_discount_reward_request'
+require_relative './model/coupon_discount_reward_response'
+require_relative './model/coupon_free_reward_request'
+require_relative './model/coupon_free_reward_response'
+require_relative './model/coupon_gift_reward_request'
+require_relative './model/coupon_gift_reward_response'
+require_relative './model/coupon_list_response'
+require_relative './model/coupon_message'
+require_relative './model/coupon_others_reward_request'
+require_relative './model/coupon_others_reward_response'
+require_relative './model/coupon_response'
+require_relative './model/coupon_reward_request'
+require_relative './model/coupon_reward_response'
 require_relative './model/create_rich_menu_alias_request'
 require_relative './model/datetime_picker_action'
 require_relative './model/demographic_filter'
+require_relative './model/discount_explicit_price_info_request'
+require_relative './model/discount_explicit_price_info_response'
+require_relative './model/discount_fixed_price_info_request'
+require_relative './model/discount_fixed_price_info_response'
+require_relative './model/discount_percentage_price_info_request'
+require_relative './model/discount_percentage_price_info_response'
+require_relative './model/discount_price_info_request'
+require_relative './model/discount_price_info_response'
 require_relative './model/emoji'
 require_relative './model/emoji_substitution_object'
 require_relative './model/error_detail'
@@ -92,6 +125,8 @@
 require_relative './model/limit'
 require_relative './model/location_action'
 require_relative './model/location_message'
+require_relative './model/lottery_acquisition_condition_request'
+require_relative './model/lottery_acquisition_condition_response'
 require_relative './model/mark_messages_as_read_request'
 require_relative './model/members_ids_response'
 require_relative './model/membership'
@@ -102,9 +137,12 @@
 require_relative './model/message_action'
 require_relative './model/message_imagemap_action'
 require_relative './model/message_quota_response'
+require_relative './model/messaging_api_pager_coupon_list_response'
 require_relative './model/multicast_request'
 require_relative './model/narrowcast_progress_response'
 require_relative './model/narrowcast_request'
+require_relative './model/normal_acquisition_condition_request'
+require_relative './model/normal_acquisition_condition_response'
 require_relative './model/number_of_messages_response'
 require_relative './model/operator_demographic_filter'
 require_relative './model/operator_recipient'
@@ -118,6 +156,7 @@
 require_relative './model/quota_type'
 require_relative './model/recipient'
 require_relative './model/redelivery_recipient'
+require_relative './model/referral_acquisition_condition_response'
 require_relative './model/reply_message_request'
 require_relative './model/reply_message_response'
 require_relative './model/rich_menu_alias_list_response'

lib/line/bot/v2/messaging_api/core.rb

@@ -0,0 +1,77 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class AcquisitionConditionRequest
+          # @!attribute [rw] type
+          #   @return [String] Determines how the coupon is distributed or used.
+          attr_accessor :type
+
+          # @param type [String] Determines how the coupon is distributed or used.
+          def initialize(
+            type:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::MessagingApi::AcquisitionConditionRequest] Instance of the class
+          def self.create(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            klass = detect_class(type: symbolized_args[:type])
+            return klass.new(**symbolized_args) if klass # steep:ignore
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+
+          private
+
+          def self.detect_class(type:)
+            {
+              lottery: Line::Bot::V2::MessagingApi::LotteryAcquisitionConditionRequest,
+              normal: Line::Bot::V2::MessagingApi::NormalAcquisitionConditionRequest,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

lib/line/bot/v2/messaging_api/model/acquisition_condition_request.rb

@@ -0,0 +1,78 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class AcquisitionConditionResponse
+          # @!attribute [rw] type
+          #   @return [String] Determines how the coupon is distributed or used.
+          attr_accessor :type
+
+          # @param type [String] Determines how the coupon is distributed or used.
+          def initialize(
+            type:,
+            **dynamic_attributes
+          )
+            
+            @type = type
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::MessagingApi::AcquisitionConditionResponse] Instance of the class
+          def self.create(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            klass = detect_class(type: symbolized_args[:type])
+            return klass.new(**symbolized_args) if klass # steep:ignore
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+
+          private
+
+          def self.detect_class(type:)
+            {
+              lottery: Line::Bot::V2::MessagingApi::LotteryAcquisitionConditionResponse,
+              normal: Line::Bot::V2::MessagingApi::NormalAcquisitionConditionResponse,
+              referral: Line::Bot::V2::MessagingApi::ReferralAcquisitionConditionResponse,
+            }[type.to_sym]
+          end
+        end
+      end
+    end
+  end
+end

lib/line/bot/v2/messaging_api/model/acquisition_condition_response.rb

@@ -0,0 +1,72 @@
+# LINE Messaging API
+# This document describes LINE Messaging API.
+#
+# The version of the OpenAPI document: 0.0.1
+#
+# NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+# https://openapi-generator.tech
+# Do not edit the class manually.
+
+require_relative './cash_back_price_info_request'
+
+module Line
+  module Bot
+    module V2
+      module MessagingApi
+        class CashBackFixedPriceInfoRequest < CashBackPriceInfoRequest
+          # @!attribute [r] type
+          #   @return [String] 
+          attr_reader :type
+          # @!attribute [rw] fixed_amount
+          #   @return [Integer,nil] 
+          attr_accessor :fixed_amount
+
+          # @param fixed_amount [Integer,nil] 
+          def initialize(
+            fixed_amount: nil,
+            **dynamic_attributes
+          )
+            @type = "fixed"
+            
+            @fixed_amount = fixed_amount
+
+            dynamic_attributes.each do |key, value|
+              self.class.attr_accessor key
+
+              if value.is_a?(Hash)
+                struct_klass = Struct.new(*value.keys.map(&:to_sym))
+                struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
+                instance_variable_set("@#{key}", struct_klass.new(*struct_values))
+              else
+                instance_variable_set("@#{key}", value)
+              end
+            end
+          end
+
+          # Create an instance of the class from a hash
+          # @param args [Hash] Hash containing all the required attributes
+          # @return [Line::Bot::V2::MessagingApi::CashBackFixedPriceInfoRequest] Instance of the class
+          def self.create(args) # steep:ignore
+            symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
+            return new(**symbolized_args) # steep:ignore
+          end
+
+          # @param other [Object] Object to compare
+          # @return [Boolean] true if the objects are equal, false otherwise
+          def ==(other)
+            return false unless self.class == other.class
+
+            instance_variables.all? do |var|
+                instance_variable_get(var) == other.instance_variable_get(var)
+            end
+          end
+
+          # @return [Integer] Hash code of the object
+          def hash
+            [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
+          end
+        end
+      end
+    end
+  end
+end