line-bot-api 2.0.0 → 2.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (88) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.md +49 -1
  3. data/README.md +34 -16
  4. data/lib/line/bot/v2/messaging_api/api/messaging_api_client.rb +269 -0
  5. data/lib/line/bot/v2/messaging_api/core.rb +39 -0
  6. data/lib/line/bot/v2/messaging_api/model/acquisition_condition_request.rb +77 -0
  7. data/lib/line/bot/v2/messaging_api/model/acquisition_condition_response.rb +78 -0
  8. data/lib/line/bot/v2/messaging_api/model/cash_back_fixed_price_info_request.rb +72 -0
  9. data/lib/line/bot/v2/messaging_api/model/cash_back_fixed_price_info_response.rb +78 -0
  10. data/lib/line/bot/v2/messaging_api/model/cash_back_percentage_price_info_request.rb +72 -0
  11. data/lib/line/bot/v2/messaging_api/model/cash_back_percentage_price_info_response.rb +72 -0
  12. data/lib/line/bot/v2/messaging_api/model/cash_back_price_info_request.rb +77 -0
  13. data/lib/line/bot/v2/messaging_api/model/cash_back_price_info_response.rb +77 -0
  14. data/lib/line/bot/v2/messaging_api/model/coupon_cash_back_reward_request.rb +72 -0
  15. data/lib/line/bot/v2/messaging_api/model/coupon_cash_back_reward_response.rb +72 -0
  16. data/lib/line/bot/v2/messaging_api/model/coupon_create_request.rb +139 -0
  17. data/lib/line/bot/v2/messaging_api/model/coupon_create_response.rb +67 -0
  18. data/lib/line/bot/v2/messaging_api/model/coupon_discount_reward_request.rb +72 -0
  19. data/lib/line/bot/v2/messaging_api/model/coupon_discount_reward_response.rb +72 -0
  20. data/lib/line/bot/v2/messaging_api/model/coupon_free_reward_request.rb +66 -0
  21. data/lib/line/bot/v2/messaging_api/model/coupon_free_reward_response.rb +66 -0
  22. data/lib/line/bot/v2/messaging_api/model/coupon_gift_reward_request.rb +66 -0
  23. data/lib/line/bot/v2/messaging_api/model/coupon_gift_reward_response.rb +66 -0
  24. data/lib/line/bot/v2/messaging_api/model/coupon_list_response.rb +73 -0
  25. data/lib/line/bot/v2/messaging_api/model/coupon_message.rb +91 -0
  26. data/lib/line/bot/v2/messaging_api/model/coupon_others_reward_request.rb +66 -0
  27. data/lib/line/bot/v2/messaging_api/model/coupon_others_reward_response.rb +66 -0
  28. data/lib/line/bot/v2/messaging_api/model/coupon_response.rb +169 -0
  29. data/lib/line/bot/v2/messaging_api/model/coupon_reward_request.rb +80 -0
  30. data/lib/line/bot/v2/messaging_api/model/coupon_reward_response.rb +80 -0
  31. data/lib/line/bot/v2/messaging_api/model/discount_explicit_price_info_request.rb +78 -0
  32. data/lib/line/bot/v2/messaging_api/model/discount_explicit_price_info_response.rb +84 -0
  33. data/lib/line/bot/v2/messaging_api/model/discount_fixed_price_info_request.rb +72 -0
  34. data/lib/line/bot/v2/messaging_api/model/discount_fixed_price_info_response.rb +78 -0
  35. data/lib/line/bot/v2/messaging_api/model/discount_percentage_price_info_request.rb +72 -0
  36. data/lib/line/bot/v2/messaging_api/model/discount_percentage_price_info_response.rb +72 -0
  37. data/lib/line/bot/v2/messaging_api/model/discount_price_info_request.rb +78 -0
  38. data/lib/line/bot/v2/messaging_api/model/discount_price_info_response.rb +78 -0
  39. data/lib/line/bot/v2/messaging_api/model/lottery_acquisition_condition_request.rb +78 -0
  40. data/lib/line/bot/v2/messaging_api/model/lottery_acquisition_condition_response.rb +78 -0
  41. data/lib/line/bot/v2/messaging_api/model/message.rb +1 -0
  42. data/lib/line/bot/v2/messaging_api/model/messaging_api_pager_coupon_list_response.rb +79 -0
  43. data/lib/line/bot/v2/messaging_api/model/normal_acquisition_condition_request.rb +66 -0
  44. data/lib/line/bot/v2/messaging_api/model/normal_acquisition_condition_response.rb +66 -0
  45. data/lib/line/bot/v2/messaging_api/model/referral_acquisition_condition_response.rb +66 -0
  46. data/lib/line/bot/version.rb +1 -1
  47. data/line-bot-api.gemspec +1 -1
  48. data/sig/line/bot/v2/messaging_api/api/messaging_api_client.rbs +156 -0
  49. data/sig/line/bot/v2/messaging_api/model/acquisition_condition_request.rbs +43 -0
  50. data/sig/line/bot/v2/messaging_api/model/acquisition_condition_response.rbs +43 -0
  51. data/sig/line/bot/v2/messaging_api/model/cash_back_fixed_price_info_request.rbs +40 -0
  52. data/sig/line/bot/v2/messaging_api/model/cash_back_fixed_price_info_response.rbs +43 -0
  53. data/sig/line/bot/v2/messaging_api/model/cash_back_percentage_price_info_request.rbs +40 -0
  54. data/sig/line/bot/v2/messaging_api/model/cash_back_percentage_price_info_response.rbs +40 -0
  55. data/sig/line/bot/v2/messaging_api/model/cash_back_price_info_request.rbs +43 -0
  56. data/sig/line/bot/v2/messaging_api/model/cash_back_price_info_response.rbs +43 -0
  57. data/sig/line/bot/v2/messaging_api/model/coupon_cash_back_reward_request.rbs +40 -0
  58. data/sig/line/bot/v2/messaging_api/model/coupon_cash_back_reward_response.rbs +40 -0
  59. data/sig/line/bot/v2/messaging_api/model/coupon_create_request.rbs +76 -0
  60. data/sig/line/bot/v2/messaging_api/model/coupon_create_response.rbs +40 -0
  61. data/sig/line/bot/v2/messaging_api/model/coupon_discount_reward_request.rbs +40 -0
  62. data/sig/line/bot/v2/messaging_api/model/coupon_discount_reward_response.rbs +40 -0
  63. data/sig/line/bot/v2/messaging_api/model/coupon_free_reward_request.rbs +37 -0
  64. data/sig/line/bot/v2/messaging_api/model/coupon_free_reward_response.rbs +37 -0
  65. data/sig/line/bot/v2/messaging_api/model/coupon_gift_reward_request.rbs +37 -0
  66. data/sig/line/bot/v2/messaging_api/model/coupon_gift_reward_response.rbs +37 -0
  67. data/sig/line/bot/v2/messaging_api/model/coupon_list_response.rbs +43 -0
  68. data/sig/line/bot/v2/messaging_api/model/coupon_message.rbs +50 -0
  69. data/sig/line/bot/v2/messaging_api/model/coupon_others_reward_request.rbs +37 -0
  70. data/sig/line/bot/v2/messaging_api/model/coupon_others_reward_response.rbs +37 -0
  71. data/sig/line/bot/v2/messaging_api/model/coupon_response.rbs +91 -0
  72. data/sig/line/bot/v2/messaging_api/model/coupon_reward_request.rbs +43 -0
  73. data/sig/line/bot/v2/messaging_api/model/coupon_reward_response.rbs +43 -0
  74. data/sig/line/bot/v2/messaging_api/model/discount_explicit_price_info_request.rbs +43 -0
  75. data/sig/line/bot/v2/messaging_api/model/discount_explicit_price_info_response.rbs +46 -0
  76. data/sig/line/bot/v2/messaging_api/model/discount_fixed_price_info_request.rbs +40 -0
  77. data/sig/line/bot/v2/messaging_api/model/discount_fixed_price_info_response.rbs +43 -0
  78. data/sig/line/bot/v2/messaging_api/model/discount_percentage_price_info_request.rbs +40 -0
  79. data/sig/line/bot/v2/messaging_api/model/discount_percentage_price_info_response.rbs +40 -0
  80. data/sig/line/bot/v2/messaging_api/model/discount_price_info_request.rbs +43 -0
  81. data/sig/line/bot/v2/messaging_api/model/discount_price_info_response.rbs +43 -0
  82. data/sig/line/bot/v2/messaging_api/model/lottery_acquisition_condition_request.rbs +43 -0
  83. data/sig/line/bot/v2/messaging_api/model/lottery_acquisition_condition_response.rbs +43 -0
  84. data/sig/line/bot/v2/messaging_api/model/messaging_api_pager_coupon_list_response.rbs +43 -0
  85. data/sig/line/bot/v2/messaging_api/model/normal_acquisition_condition_request.rbs +37 -0
  86. data/sig/line/bot/v2/messaging_api/model/normal_acquisition_condition_response.rbs +37 -0
  87. data/sig/line/bot/v2/messaging_api/model/referral_acquisition_condition_response.rbs +37 -0
  88. metadata +81 -3
@@ -0,0 +1,78 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ require_relative './acquisition_condition_response'
11
+
12
+ module Line
13
+ module Bot
14
+ module V2
15
+ module MessagingApi
16
+ class LotteryAcquisitionConditionResponse < AcquisitionConditionResponse
17
+ # @!attribute [r] type
18
+ # @return [String] Determines how the coupon is distributed or used.
19
+ attr_reader :type
20
+ # @!attribute [rw] lottery_probability
21
+ # @return [Integer,nil]
22
+ attr_accessor :lottery_probability
23
+ # @!attribute [rw] max_acquire_count
24
+ # @return [Integer,nil]
25
+ attr_accessor :max_acquire_count
26
+
27
+ # @param lottery_probability [Integer,nil]
28
+ # @param max_acquire_count [Integer,nil]
29
+ def initialize(
30
+ lottery_probability: nil,
31
+ max_acquire_count: nil,
32
+ **dynamic_attributes
33
+ )
34
+ @type = "lottery"
35
+
36
+ @lottery_probability = lottery_probability
37
+ @max_acquire_count = max_acquire_count
38
+
39
+ dynamic_attributes.each do |key, value|
40
+ self.class.attr_accessor key
41
+
42
+ if value.is_a?(Hash)
43
+ struct_klass = Struct.new(*value.keys.map(&:to_sym))
44
+ struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
45
+ instance_variable_set("@#{key}", struct_klass.new(*struct_values))
46
+ else
47
+ instance_variable_set("@#{key}", value)
48
+ end
49
+ end
50
+ end
51
+
52
+ # Create an instance of the class from a hash
53
+ # @param args [Hash] Hash containing all the required attributes
54
+ # @return [Line::Bot::V2::MessagingApi::LotteryAcquisitionConditionResponse] Instance of the class
55
+ def self.create(args) # steep:ignore
56
+ symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
57
+ return new(**symbolized_args) # steep:ignore
58
+ end
59
+
60
+ # @param other [Object] Object to compare
61
+ # @return [Boolean] true if the objects are equal, false otherwise
62
+ def ==(other)
63
+ return false unless self.class == other.class
64
+
65
+ instance_variables.all? do |var|
66
+ instance_variable_get(var) == other.instance_variable_get(var)
67
+ end
68
+ end
69
+
70
+ # @return [Integer] Hash code of the object
71
+ def hash
72
+ [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
73
+ end
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
@@ -80,6 +80,7 @@ module Line
80
80
  def self.detect_class(type:)
81
81
  {
82
82
  audio: Line::Bot::V2::MessagingApi::AudioMessage,
83
+ coupon: Line::Bot::V2::MessagingApi::CouponMessage,
83
84
  flex: Line::Bot::V2::MessagingApi::FlexMessage,
84
85
  image: Line::Bot::V2::MessagingApi::ImageMessage,
85
86
  imagemap: Line::Bot::V2::MessagingApi::ImagemapMessage,
@@ -0,0 +1,79 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module MessagingApi
14
+ # Paginated response object containing a list of coupons.
15
+ class MessagingApiPagerCouponListResponse
16
+ # @!attribute [rw] items
17
+ # @return [Array[CouponListResponse]] List of coupon summary objects.
18
+ attr_accessor :items
19
+ # @!attribute [rw] _next
20
+ # @return [String,nil] Token for fetching the next page of results.
21
+ attr_accessor :_next
22
+
23
+ # @param items [Array[CouponListResponse, Hash[Symbol, untyped]]] List of coupon summary objects.
24
+ # @param _next [String,nil] Token for fetching the next page of results.
25
+ def initialize(
26
+ items:,
27
+ _next: nil,
28
+ **dynamic_attributes
29
+ )
30
+
31
+ @items = items.map do |item|
32
+ if item.is_a?(Hash)
33
+ Line::Bot::V2::MessagingApi::CouponListResponse.create(**item) # steep:ignore InsufficientKeywordArguments
34
+ else
35
+ item
36
+ end
37
+ end
38
+ @_next = _next
39
+
40
+ dynamic_attributes.each do |key, value|
41
+ self.class.attr_accessor key
42
+
43
+ if value.is_a?(Hash)
44
+ struct_klass = Struct.new(*value.keys.map(&:to_sym))
45
+ struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
46
+ instance_variable_set("@#{key}", struct_klass.new(*struct_values))
47
+ else
48
+ instance_variable_set("@#{key}", value)
49
+ end
50
+ end
51
+ end
52
+
53
+ # Create an instance of the class from a hash
54
+ # @param args [Hash] Hash containing all the required attributes
55
+ # @return [Line::Bot::V2::MessagingApi::MessagingApiPagerCouponListResponse] Instance of the class
56
+ def self.create(args) # steep:ignore
57
+ symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
58
+ return new(**symbolized_args) # steep:ignore
59
+ end
60
+
61
+ # @param other [Object] Object to compare
62
+ # @return [Boolean] true if the objects are equal, false otherwise
63
+ def ==(other)
64
+ return false unless self.class == other.class
65
+
66
+ instance_variables.all? do |var|
67
+ instance_variable_get(var) == other.instance_variable_get(var)
68
+ end
69
+ end
70
+
71
+ # @return [Integer] Hash code of the object
72
+ def hash
73
+ [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
74
+ end
75
+ end
76
+ end
77
+ end
78
+ end
79
+ end
@@ -0,0 +1,66 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ require_relative './acquisition_condition_request'
11
+
12
+ module Line
13
+ module Bot
14
+ module V2
15
+ module MessagingApi
16
+ class NormalAcquisitionConditionRequest < AcquisitionConditionRequest
17
+ # @!attribute [r] type
18
+ # @return [String] Determines how the coupon is distributed or used.
19
+ attr_reader :type
20
+
21
+ def initialize(
22
+ **dynamic_attributes
23
+ )
24
+ @type = "normal"
25
+
26
+
27
+ dynamic_attributes.each do |key, value|
28
+ self.class.attr_accessor key
29
+
30
+ if value.is_a?(Hash)
31
+ struct_klass = Struct.new(*value.keys.map(&:to_sym))
32
+ struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
33
+ instance_variable_set("@#{key}", struct_klass.new(*struct_values))
34
+ else
35
+ instance_variable_set("@#{key}", value)
36
+ end
37
+ end
38
+ end
39
+
40
+ # Create an instance of the class from a hash
41
+ # @param args [Hash] Hash containing all the required attributes
42
+ # @return [Line::Bot::V2::MessagingApi::NormalAcquisitionConditionRequest] Instance of the class
43
+ def self.create(args) # steep:ignore
44
+ symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
45
+ return new(**symbolized_args) # steep:ignore
46
+ end
47
+
48
+ # @param other [Object] Object to compare
49
+ # @return [Boolean] true if the objects are equal, false otherwise
50
+ def ==(other)
51
+ return false unless self.class == other.class
52
+
53
+ instance_variables.all? do |var|
54
+ instance_variable_get(var) == other.instance_variable_get(var)
55
+ end
56
+ end
57
+
58
+ # @return [Integer] Hash code of the object
59
+ def hash
60
+ [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,66 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ require_relative './acquisition_condition_response'
11
+
12
+ module Line
13
+ module Bot
14
+ module V2
15
+ module MessagingApi
16
+ class NormalAcquisitionConditionResponse < AcquisitionConditionResponse
17
+ # @!attribute [r] type
18
+ # @return [String] Determines how the coupon is distributed or used.
19
+ attr_reader :type
20
+
21
+ def initialize(
22
+ **dynamic_attributes
23
+ )
24
+ @type = "normal"
25
+
26
+
27
+ dynamic_attributes.each do |key, value|
28
+ self.class.attr_accessor key
29
+
30
+ if value.is_a?(Hash)
31
+ struct_klass = Struct.new(*value.keys.map(&:to_sym))
32
+ struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
33
+ instance_variable_set("@#{key}", struct_klass.new(*struct_values))
34
+ else
35
+ instance_variable_set("@#{key}", value)
36
+ end
37
+ end
38
+ end
39
+
40
+ # Create an instance of the class from a hash
41
+ # @param args [Hash] Hash containing all the required attributes
42
+ # @return [Line::Bot::V2::MessagingApi::NormalAcquisitionConditionResponse] Instance of the class
43
+ def self.create(args) # steep:ignore
44
+ symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
45
+ return new(**symbolized_args) # steep:ignore
46
+ end
47
+
48
+ # @param other [Object] Object to compare
49
+ # @return [Boolean] true if the objects are equal, false otherwise
50
+ def ==(other)
51
+ return false unless self.class == other.class
52
+
53
+ instance_variables.all? do |var|
54
+ instance_variable_get(var) == other.instance_variable_get(var)
55
+ end
56
+ end
57
+
58
+ # @return [Integer] Hash code of the object
59
+ def hash
60
+ [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -0,0 +1,66 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ require_relative './acquisition_condition_response'
11
+
12
+ module Line
13
+ module Bot
14
+ module V2
15
+ module MessagingApi
16
+ class ReferralAcquisitionConditionResponse < AcquisitionConditionResponse
17
+ # @!attribute [r] type
18
+ # @return [String] Determines how the coupon is distributed or used.
19
+ attr_reader :type
20
+
21
+ def initialize(
22
+ **dynamic_attributes
23
+ )
24
+ @type = "referral"
25
+
26
+
27
+ dynamic_attributes.each do |key, value|
28
+ self.class.attr_accessor key
29
+
30
+ if value.is_a?(Hash)
31
+ struct_klass = Struct.new(*value.keys.map(&:to_sym))
32
+ struct_values = value.map { |_k, v| v.is_a?(Hash) ? Line::Bot::V2::Utils.hash_to_struct(v) : v }
33
+ instance_variable_set("@#{key}", struct_klass.new(*struct_values))
34
+ else
35
+ instance_variable_set("@#{key}", value)
36
+ end
37
+ end
38
+ end
39
+
40
+ # Create an instance of the class from a hash
41
+ # @param args [Hash] Hash containing all the required attributes
42
+ # @return [Line::Bot::V2::MessagingApi::ReferralAcquisitionConditionResponse] Instance of the class
43
+ def self.create(args) # steep:ignore
44
+ symbolized_args = Line::Bot::V2::Utils.deep_symbolize(args)
45
+ return new(**symbolized_args) # steep:ignore
46
+ end
47
+
48
+ # @param other [Object] Object to compare
49
+ # @return [Boolean] true if the objects are equal, false otherwise
50
+ def ==(other)
51
+ return false unless self.class == other.class
52
+
53
+ instance_variables.all? do |var|
54
+ instance_variable_get(var) == other.instance_variable_get(var)
55
+ end
56
+ end
57
+
58
+ # @return [Integer] Hash code of the object
59
+ def hash
60
+ [self.class, *instance_variables.map { |var| instance_variable_get(var) }].hash
61
+ end
62
+ end
63
+ end
64
+ end
65
+ end
66
+ end
@@ -2,6 +2,6 @@ module Line
2
2
  module Bot
3
3
  # This version is updated before releasing a new version in the release process.
4
4
  # You don't have to update this version manually.
5
- VERSION = "2.0.0"
5
+ VERSION = "2.1.0"
6
6
  end
7
7
  end
data/line-bot-api.gemspec CHANGED
@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
17
17
  spec.metadata = {
18
18
  "bug_tracker_uri" => "#{spec.homepage}/issues",
19
19
  "changelog_uri" => "#{spec.homepage}/releases",
20
- "documentation_uri" => "https://rubydoc.info/gems/#{spec.name}/#{spec.version}",
20
+ "documentation_uri" => "https://line.github.io/line-bot-sdk-ruby/",
21
21
  "homepage_uri" => spec.homepage,
22
22
  "source_code_uri" => spec.homepage,
23
23
  }
@@ -112,6 +112,82 @@ module Line
112
112
  | String? # otherwise
113
113
  )
114
114
 
115
+ # Close coupon
116
+ # This requests to <code>PUT https://api.line.me/v2/bot/coupon/{couponId}/close</code>
117
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
118
+ #
119
+ # @param coupon_id [String]
120
+ # @see https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon
121
+ # @return [Array((String|nil), Integer, Hash{String => String})] when HTTP status code is 200
122
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
123
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 404
124
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 410
125
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
126
+ def close_coupon_with_http_info: (
127
+ coupon_id: String
128
+ ) -> (
129
+ [String?, 200, Hash[untyped, untyped]] # when HTTP status code is 200
130
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
131
+ | [ErrorResponse, 404, Hash[untyped, untyped]] # when HTTP status code is 404
132
+ | [ErrorResponse, 410, Hash[untyped, untyped]] # when HTTP status code is 410
133
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
134
+ )
135
+
136
+ # Close coupon
137
+ # This requests to <code>PUT https://api.line.me/v2/bot/coupon/{couponId}/close</code>
138
+ # When you want to get HTTP status code or response headers, use {#close_coupon_with_http_info} instead of this.
139
+ #
140
+ # @param coupon_id [String]
141
+ # @see https://developers.line.biz/en/reference/messaging-api/#discontinue-coupon
142
+ # @return [String, nil] when HTTP status code is 200
143
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 400
144
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 404
145
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 410
146
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
147
+ def close_coupon: (
148
+ coupon_id: String
149
+ ) -> (
150
+ String? # when HTTP status code is 200
151
+ | ErrorResponse # when HTTP status code is 400
152
+ | ErrorResponse # when HTTP status code is 404
153
+ | ErrorResponse # when HTTP status code is 410
154
+ | String? # otherwise
155
+ )
156
+
157
+ # Create a new coupon. Define coupon details such as type, title, and validity period.
158
+ # This requests to <code>POST https://api.line.me/v2/bot/coupon</code>
159
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
160
+ #
161
+ # @param coupon_create_request [CouponCreateRequest, nil]
162
+ # @see https://developers.line.biz/en/reference/messaging-api/#create-coupon
163
+ # @return [Array(Line::Bot::V2::MessagingApi::CouponCreateResponse, Integer, Hash{String => String})] when HTTP status code is 200
164
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
165
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
166
+ def create_coupon_with_http_info: (
167
+ ?coupon_create_request: CouponCreateRequest?
168
+ ) -> (
169
+ [CouponCreateResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
170
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
171
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
172
+ )
173
+
174
+ # Create a new coupon. Define coupon details such as type, title, and validity period.
175
+ # This requests to <code>POST https://api.line.me/v2/bot/coupon</code>
176
+ # When you want to get HTTP status code or response headers, use {#create_coupon_with_http_info} instead of this.
177
+ #
178
+ # @param coupon_create_request [CouponCreateRequest, nil]
179
+ # @see https://developers.line.biz/en/reference/messaging-api/#create-coupon
180
+ # @return [Line::Bot::V2::MessagingApi::CouponCreateResponse] when HTTP status code is 200
181
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 400
182
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
183
+ def create_coupon: (
184
+ ?coupon_create_request: CouponCreateRequest?
185
+ ) -> (
186
+ CouponCreateResponse # when HTTP status code is 200
187
+ | ErrorResponse # when HTTP status code is 400
188
+ | String? # otherwise
189
+ )
190
+
115
191
  # Create rich menu
116
192
  # This requests to <code>POST https://api.line.me/v2/bot/richmenu</code>
117
193
  # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -326,6 +402,44 @@ module Line
326
402
  | String? # otherwise
327
403
  )
328
404
 
405
+ # Get coupon detail
406
+ # This requests to <code>GET https://api.line.me/v2/bot/coupon/{couponId}</code>
407
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
408
+ #
409
+ # @param coupon_id [String]
410
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-coupon
411
+ # @return [Array(Line::Bot::V2::MessagingApi::CouponResponse, Integer, Hash{String => String})] when HTTP status code is 200
412
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
413
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 404
414
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
415
+ def get_coupon_detail_with_http_info: (
416
+ coupon_id: String
417
+ ) -> (
418
+ [CouponResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
419
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
420
+ | [ErrorResponse, 404, Hash[untyped, untyped]] # when HTTP status code is 404
421
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
422
+ )
423
+
424
+ # Get coupon detail
425
+ # This requests to <code>GET https://api.line.me/v2/bot/coupon/{couponId}</code>
426
+ # When you want to get HTTP status code or response headers, use {#get_coupon_detail_with_http_info} instead of this.
427
+ #
428
+ # @param coupon_id [String]
429
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-coupon
430
+ # @return [Line::Bot::V2::MessagingApi::CouponResponse] when HTTP status code is 200
431
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 400
432
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 404
433
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
434
+ def get_coupon_detail: (
435
+ coupon_id: String
436
+ ) -> (
437
+ CouponResponse # when HTTP status code is 200
438
+ | ErrorResponse # when HTTP status code is 400
439
+ | ErrorResponse # when HTTP status code is 404
440
+ | String? # otherwise
441
+ )
442
+
329
443
  # Gets the ID of the default rich menu set with the Messaging API.
330
444
  # This requests to <code>GET https://api.line.me/v2/bot/user/all/richmenu</code>
331
445
  # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -1348,6 +1462,48 @@ module Line
1348
1462
  | String? # otherwise
1349
1463
  )
1350
1464
 
1465
+ # Get a paginated list of coupons.
1466
+ # This requests to <code>GET https://api.line.me/v2/bot/coupon</code>
1467
+ # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
1468
+ #
1469
+ # @param status [Array[String], nil] Filter coupons by their status.
1470
+ # @param start [String, nil] Pagination token to retrieve the next page of results.
1471
+ # @param limit [Integer, nil] Maximum number of coupons to return per request.
1472
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-coupons-list
1473
+ # @return [Array(Line::Bot::V2::MessagingApi::MessagingApiPagerCouponListResponse, Integer, Hash{String => String})] when HTTP status code is 200
1474
+ # @return [Array(Line::Bot::V2::MessagingApi::ErrorResponse, Integer, Hash{String => String})] when HTTP status code is 400
1475
+ # @return [Array((String|nil), Integer, Hash{String => String})] when other HTTP status code is returned. String is HTTP response body itself.
1476
+ def list_coupon_with_http_info: (
1477
+ ?status: Array[String]?,
1478
+ ?start: String?,
1479
+ ?limit: Integer?
1480
+ ) -> (
1481
+ [MessagingApiPagerCouponListResponse, 200, Hash[untyped, untyped]] # when HTTP status code is 200
1482
+ | [ErrorResponse, 400, Hash[untyped, untyped]] # when HTTP status code is 400
1483
+ | [String?, Integer, Hash[untyped, untyped]] # otherwise
1484
+ )
1485
+
1486
+ # Get a paginated list of coupons.
1487
+ # This requests to <code>GET https://api.line.me/v2/bot/coupon</code>
1488
+ # When you want to get HTTP status code or response headers, use {#list_coupon_with_http_info} instead of this.
1489
+ #
1490
+ # @param status [Array[String], nil] Filter coupons by their status.
1491
+ # @param start [String, nil] Pagination token to retrieve the next page of results.
1492
+ # @param limit [Integer, nil] Maximum number of coupons to return per request.
1493
+ # @see https://developers.line.biz/en/reference/messaging-api/#get-coupons-list
1494
+ # @return [Line::Bot::V2::MessagingApi::MessagingApiPagerCouponListResponse] when HTTP status code is 200
1495
+ # @return [Line::Bot::V2::MessagingApi::ErrorResponse] when HTTP status code is 400
1496
+ # @return [String, nil] when other HTTP status code is returned. This String is HTTP response body itself.
1497
+ def list_coupon: (
1498
+ ?status: Array[String]?,
1499
+ ?start: String?,
1500
+ ?limit: Integer?
1501
+ ) -> (
1502
+ MessagingApiPagerCouponListResponse # when HTTP status code is 200
1503
+ | ErrorResponse # when HTTP status code is 400
1504
+ | String? # otherwise
1505
+ )
1506
+
1351
1507
  # Mark messages from users as read
1352
1508
  # This requests to <code>POST https://api.line.me/v2/bot/message/markAsRead</code>
1353
1509
  # This returns an array containing response, HTTP status code, and header in order. Please specify all header keys in lowercase.
@@ -0,0 +1,43 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module MessagingApi
14
+ class AcquisitionConditionRequest
15
+ attr_accessor type: String
16
+
17
+
18
+ # @param type [String] Determines how the coupon is distributed or used.
19
+ def initialize: (
20
+ type: String,
21
+ **untyped dynamic_attributes
22
+ ) -> void
23
+
24
+ # Create an instance of the class from a hash
25
+ # @param args [Hash] Hash containing all the required attributes
26
+ # @return [Line::Bot::V2::MessagingApi::AcquisitionConditionRequest] Instance of the class
27
+ def self.create: (Hash[Symbol, untyped]) -> AcquisitionConditionRequest
28
+
29
+ # @param other [Object] Object to compare
30
+ # @return [Boolean] true if the objects are equal, false otherwise
31
+ def ==: (untyped other) -> bool
32
+
33
+ # @return [Integer] Hash code of the object
34
+ def hash: () -> Integer
35
+
36
+ private
37
+
38
+ def self.detect_class: (type: String) -> Class?
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,43 @@
1
+ # LINE Messaging API
2
+ # This document describes LINE Messaging API.
3
+ #
4
+ # The version of the OpenAPI document: 0.0.1
5
+ #
6
+ # NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
7
+ # https://openapi-generator.tech
8
+ # Do not edit the class manually.
9
+
10
+ module Line
11
+ module Bot
12
+ module V2
13
+ module MessagingApi
14
+ class AcquisitionConditionResponse
15
+ attr_accessor type: String
16
+
17
+
18
+ # @param type [String] Determines how the coupon is distributed or used.
19
+ def initialize: (
20
+ type: String,
21
+ **untyped dynamic_attributes
22
+ ) -> void
23
+
24
+ # Create an instance of the class from a hash
25
+ # @param args [Hash] Hash containing all the required attributes
26
+ # @return [Line::Bot::V2::MessagingApi::AcquisitionConditionResponse] Instance of the class
27
+ def self.create: (Hash[Symbol, untyped]) -> AcquisitionConditionResponse
28
+
29
+ # @param other [Object] Object to compare
30
+ # @return [Boolean] true if the objects are equal, false otherwise
31
+ def ==: (untyped other) -> bool
32
+
33
+ # @return [Integer] Hash code of the object
34
+ def hash: () -> Integer
35
+
36
+ private
37
+
38
+ def self.detect_class: (type: String) -> Class?
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end