Codes are generated by openapi (#805)

We're excited to announce that the Membership API is now available in
the Messaging API.
With this update, our SDK also supports the use of this API. For more
details, check out the announcement:
https://developers.line.biz/en/news/2024/03/28/re-release-endpoints-for-membership

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

Author: github-actions[bot]

lib/messaging-api/.openapi-generator/FILES

@@ -65,6 +65,7 @@ model/genderDemographicFilter.ts
 model/getAggregationUnitNameListResponse.ts
 model/getAggregationUnitUsageResponse.ts
 model/getFollowersResponse.ts
+model/getMembershipSubscriptionResponse.ts
 model/getMessageContentTranscodingResponse.ts
 model/getWebhookEndpointResponse.ts
 model/groupMemberCountResponse.ts
@@ -85,6 +86,8 @@ model/locationAction.ts
 model/locationMessage.ts
 model/markMessagesAsReadRequest.ts
 model/membersIdsResponse.ts
+model/membership.ts
+model/membershipListResponse.ts
 model/message.ts
 model/messageAction.ts
 model/messageImagemapAction.ts
@@ -133,6 +136,9 @@ model/sender.ts
 model/sentMessage.ts
 model/setWebhookEndpointRequest.ts
 model/stickerMessage.ts
+model/subscribedMembershipPlan.ts
+model/subscribedMembershipUser.ts
+model/subscription.ts
 model/subscriptionPeriodDemographic.ts
 model/subscriptionPeriodDemographicFilter.ts
 model/template.ts

lib/messaging-api/api/messagingApiClient.ts

@@ -19,13 +19,15 @@ import { ErrorResponse } from "../model/errorResponse.js";
 import { GetAggregationUnitNameListResponse } from "../model/getAggregationUnitNameListResponse.js";
 import { GetAggregationUnitUsageResponse } from "../model/getAggregationUnitUsageResponse.js";
 import { GetFollowersResponse } from "../model/getFollowersResponse.js";
+import { GetMembershipSubscriptionResponse } from "../model/getMembershipSubscriptionResponse.js";
 import { GetWebhookEndpointResponse } from "../model/getWebhookEndpointResponse.js";
 import { GroupMemberCountResponse } from "../model/groupMemberCountResponse.js";
 import { GroupSummaryResponse } from "../model/groupSummaryResponse.js";
 import { GroupUserProfileResponse } from "../model/groupUserProfileResponse.js";
 import { IssueLinkTokenResponse } from "../model/issueLinkTokenResponse.js";
 import { MarkMessagesAsReadRequest } from "../model/markMessagesAsReadRequest.js";
 import { MembersIdsResponse } from "../model/membersIdsResponse.js";
+import { MembershipListResponse } from "../model/membershipListResponse.js";
 import { MessageQuotaResponse } from "../model/messageQuotaResponse.js";
 import { MulticastRequest } from "../model/multicastRequest.js";
 import { NarrowcastProgressResponse } from "../model/narrowcastProgressResponse.js";
@@ -624,6 +626,57 @@ export class MessagingApiClient {
     );
     return { httpResponse: res, body: await res.json() };
   }
+  /**
+   * Get a list of memberships.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans"> Documentation</a>
+   */
+  public async getMembershipList(): Promise<MembershipListResponse> {
+    return (await this.getMembershipListWithHttpInfo()).body;
+  }
+
+  /**
+   * Get a list of memberships..
+   * This method includes HttpInfo object to return additional information.
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-membership-plans"> Documentation</a>
+   */
+  public async getMembershipListWithHttpInfo(): Promise<
+    Types.ApiResponseType<MembershipListResponse>
+  > {
+    const res = await this.httpClient.get("/v2/bot/membership/list");
+    return { httpResponse: res, body: await res.json() };
+  }
+  /**
+   * Get a user\'s membership subscription.
+   * @param userId User ID
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status"> Documentation</a>
+   */
+  public async getMembershipSubscription(
+    userId: string,
+  ): Promise<GetMembershipSubscriptionResponse> {
+    return (await this.getMembershipSubscriptionWithHttpInfo(userId)).body;
+  }
+
+  /**
+   * Get a user\'s membership subscription..
+   * This method includes HttpInfo object to return additional information.
+   * @param userId User ID
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status"> Documentation</a>
+   */
+  public async getMembershipSubscriptionWithHttpInfo(
+    userId: string,
+  ): Promise<Types.ApiResponseType<GetMembershipSubscriptionResponse>> {
+    const res = await this.httpClient.get(
+      "/v2/bot/membership/subscription/{userId}".replace(
+        "{userId}",
+        String(userId),
+      ),
+    );
+    return { httpResponse: res, body: await res.json() };
+  }
   /**
    * Gets the target limit for sending messages in the current month. The total number of the free messages and the additional messages is returned.
    *

lib/messaging-api/model/getMembershipSubscriptionResponse.ts

@@ -0,0 +1,25 @@
+/**
+ * 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.
+ */
+
+import { Subscription } from "./subscription.js";
+
+/**
+ * A user\'s membership subscription status
+ */
+export type GetMembershipSubscriptionResponse = {
+  /**
+   * List of subscription information
+   *
+   * @see <a href="https://developers.line.biz/en/reference/messaging-api/#get-a-users-membership-subscription-status">subscriptions Documentation</a>
+   */
+  subscriptions: Array<Subscription> /**/;
+};

lib/messaging-api/model/membership.ts

@@ -0,0 +1,58 @@
+/**
+ * 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.
+ */
+
+export type Membership = {
+  /**
+   * Membership plan ID.
+   */
+  membershipId: number /**/;
+  /**
+   * Membership plan name.
+   */
+  title: string /**/;
+  /**
+   * Membership plan description.
+   */
+  description: string /**/;
+  /**
+   * List of membership plan perks.
+   */
+  benefits: Array<string> /**/;
+  /**
+   * Monthly fee for membership plan. (e.g. 1500.00)
+   */
+  price: number /**/;
+  /**
+   * The currency of membership.price.
+   */
+  currency: Membership.CurrencyEnum /**/;
+  /**
+   * Number of members subscribed to the membership plan.
+   */
+  memberCount: number /**/;
+  /**
+   * The upper limit of members who can subscribe. If no upper limit is set, it will be null.
+   */
+  memberLimit: number | null /**/;
+  /**
+   * Payment method for users who subscribe to a membership plan.
+   */
+  isInAppPurchase: boolean /**/;
+  /**
+   * Membership plan status.
+   */
+  isPublished: boolean /**/;
+};
+
+export namespace Membership {
+  export type CurrencyEnum = "JPY" | "TWD" | "THB";
+}

lib/messaging-api/model/membershipListResponse.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+
+import { Membership } from "./membership.js";
+
+/**
+ * List of memberships
+ */
+export type MembershipListResponse = {
+  /**
+   * List of membership information
+   */
+  memberships: Array<Membership> /**/;
+};

lib/messaging-api/model/models.ts

@@ -60,6 +60,7 @@ export * from "./genderDemographicFilter.js";
 export * from "./getAggregationUnitNameListResponse.js";
 export * from "./getAggregationUnitUsageResponse.js";
 export * from "./getFollowersResponse.js";
+export * from "./getMembershipSubscriptionResponse.js";
 export * from "./getMessageContentTranscodingResponse.js";
 export * from "./getWebhookEndpointResponse.js";
 export * from "./groupMemberCountResponse.js";
@@ -80,6 +81,8 @@ export * from "./locationAction.js";
 export * from "./locationMessage.js";
 export * from "./markMessagesAsReadRequest.js";
 export * from "./membersIdsResponse.js";
+export * from "./membership.js";
+export * from "./membershipListResponse.js";
 export * from "./message.js";
 export * from "./messageAction.js";
 export * from "./messageImagemapAction.js";
@@ -127,6 +130,9 @@ export * from "./sender.js";
 export * from "./sentMessage.js";
 export * from "./setWebhookEndpointRequest.js";
 export * from "./stickerMessage.js";
+export * from "./subscribedMembershipPlan.js";
+export * from "./subscribedMembershipUser.js";
+export * from "./subscription.js";
 export * from "./subscriptionPeriodDemographic.js";
 export * from "./subscriptionPeriodDemographicFilter.js";
 export * from "./template.js";

lib/messaging-api/model/subscribedMembershipPlan.ts

@@ -0,0 +1,45 @@
+/**
+ * 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.
+ */
+
+/**
+ * Object containing information about the membership plan.
+ */
+export type SubscribedMembershipPlan = {
+  /**
+   * Membership plan ID.
+   */
+  membershipId: number /**/;
+  /**
+   * Membership plan name.
+   */
+  title: string /**/;
+  /**
+   * Membership plan description.
+   */
+  description: string /**/;
+  /**
+   * List of membership plan perks.
+   */
+  benefits: Array<string> /**/;
+  /**
+   * Monthly fee for membership plan. (e.g. 1500.00)
+   */
+  price: number /**/;
+  /**
+   * The currency of membership.price.
+   */
+  currency: SubscribedMembershipPlan.CurrencyEnum /**/;
+};
+
+export namespace SubscribedMembershipPlan {
+  export type CurrencyEnum = "JPY" | "TWD" | "THB";
+}

lib/messaging-api/model/subscribedMembershipUser.ts

@@ -0,0 +1,33 @@
+/**
+ * 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.
+ */
+
+/**
+ * Object containing user membership subscription information.
+ */
+export type SubscribedMembershipUser = {
+  /**
+   * The user\'s member number in the membership plan.
+   */
+  membershipNo: number /**/;
+  /**
+   * UNIX timestamp at which the user subscribed to the membership.
+   */
+  joinedTime: number /**/;
+  /**
+   * Next payment date for membership plan. - Format: yyyy-MM-dd (e.g. 2024-02-08) - Timezone: UTC+9
+   */
+  nextBillingDate: string /**/;
+  /**
+   * The period of time in months that the user has been subscribed to a membership plan. If a user previously canceled and then re-subscribed to the same membership plan, only the period after the re-subscription will be counted.
+   */
+  totalSubscriptionMonths: number /**/;
+};

lib/messaging-api/model/subscription.ts

@@ -0,0 +1,26 @@
+/**
+ * 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.
+ */
+
+import { SubscribedMembershipPlan } from "./subscribedMembershipPlan.js";
+import { SubscribedMembershipUser } from "./subscribedMembershipUser.js";
+
+/**
+ * An array of memberships.
+ */
+export type Subscription = {
+  /**
+   */
+  membership: SubscribedMembershipPlan /**/;
+  /**
+   */
+  user: SubscribedMembershipUser /**/;
+};