@polar-sh/sdk 1.0.0-alpha.21 → 1.0.0

package/dist/2027-01/services/subscriptions.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.cjs","names":["HTTPValidationError","ResourceNotFound","AlreadyCanceledSubscription","SubscriptionLocked","SubscriptionsUpdate402Error","SubscriptionsUpdate403Error","SubscriptionsUpdate409Error"],"sources":["../../../src/2027-01/services/subscriptions.ts"],"sourcesContent":["import type { ClientBase, RequestOptions } from \"../../base\";\nimport type {\n  CustomerCancellationReason,\n  ListResourceSubscription,\n  MetadataQuery,\n  Subscription,\n  SubscriptionCreateCustomer,\n  SubscriptionCreateExternalCustomer,\n  SubscriptionExportColumn,\n  SubscriptionSortProperty,\n  SubscriptionStatus,\n  SubscriptionUpdate,\n} from \"../models\";\n\nimport {\n  AlreadyCanceledSubscription,\n  HTTPValidationError,\n  ResourceNotFound,\n  SubscriptionLocked,\n  SubscriptionsUpdate402Error,\n  SubscriptionsUpdate403Error,\n  SubscriptionsUpdate409Error,\n} from \"../errors\";\n\nexport const listSubscriptions = (client: ClientBase) => {\n  /**\n   * List subscriptions.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param query - Query parameters\n   * @param requestOptions - Request options\n   * @returns {ListResourceSubscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      customer_id?: string | string[] | null;\n      external_customer_id?: string | string[] | null;\n      discount_id?: string | string[] | null;\n      active?: boolean | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      customer_cancellation_reason?:\n        | CustomerCancellationReason\n        | CustomerCancellationReason[]\n        | null;\n      canceled_at_after?: string | null;\n      canceled_at_before?: string | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      page?: number;\n      limit?: number;\n      sorting?: SubscriptionSortProperty[] | null;\n      metadata?: MetadataQuery;\n    },\n    requestOptions?: RequestOptions,\n  ): Promise<ListResourceSubscription> => {\n    const pathParams = {};\n    const queryParams = {\n      organization_id: query?.organization_id,\n      product_id: query?.product_id,\n      customer_id: query?.customer_id,\n      external_customer_id: query?.external_customer_id,\n      discount_id: query?.discount_id,\n      active: query?.active,\n      status: query?.status,\n      cancel_at_period_end: query?.cancel_at_period_end,\n      customer_cancellation_reason: query?.customer_cancellation_reason,\n      canceled_at_after: query?.canceled_at_after,\n      canceled_at_before: query?.canceled_at_before,\n      started_after: query?.started_after,\n      started_before: query?.started_before,\n      page: query?.page ?? 1,\n      limit: query?.limit ?? 10,\n      sorting: query?.sorting ?? [\"-started_at\"],\n      metadata: query?.metadata,\n    };\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<ListResourceSubscription>(response, \"json\", {\n      422: HTTPValidationError,\n    });\n  };\n};\n/**\n * List subscriptions.\n *\n * **Scopes**: `subscriptions:read` `subscriptions:write`\n *\n * @param query - Query parameters\n * @param requestOptions - Request options\n * @returns {AsyncGenerator<Subscription>} A generator that yields items of type Subscription.\n * @throws {PolarNetworkError} When a network error occurs\n * @throws {PolarRateLimitError} When the rate limit is exceeded\n * @throws {PolarServerError} When the server returns a 5xx error\n * @throws {HTTPValidationError} Validation Error\n */\nexport const iterListSubscriptions = (client: ClientBase) => {\n  return async function* (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      customer_id?: string | string[] | null;\n      external_customer_id?: string | string[] | null;\n      discount_id?: string | string[] | null;\n      active?: boolean | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      customer_cancellation_reason?:\n        | CustomerCancellationReason\n        | CustomerCancellationReason[]\n        | null;\n      canceled_at_after?: string | null;\n      canceled_at_before?: string | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      page?: number;\n      limit?: number;\n      sorting?: SubscriptionSortProperty[] | null;\n      metadata?: MetadataQuery;\n    },\n    requestOptions?: RequestOptions,\n  ): AsyncGenerator<Subscription> {\n    let page: number;\n    page = query?.page ?? 1;\n    let limit: number | undefined;\n    limit = query?.limit;\n\n    while (true) {\n      const response = await listSubscriptions(client)({ ...query, page, limit }, requestOptions);\n      for (const item of response.items) {\n        yield item;\n      }\n      if (page >= response.pagination.max_page) {\n        break;\n      }\n      page++;\n    }\n  };\n};\nexport const createSubscriptions = (client: ClientBase) => {\n  /**\n   * Create a subscription programmatically.\n   *\n   * This endpoint only allows to create subscription on free products.\n   * For paid products, use the checkout flow.\n   *\n   * No initial order will be created and no confirmation email will be sent.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param body - Request body\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer,\n    requestOptions?: RequestOptions,\n  ): Promise<Subscription> => {\n    const pathParams = {};\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"POST\",\n      \"/v1/subscriptions/\",\n      pathParams,\n      queryParams,\n      body,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const exportSubscriptions = (client: ClientBase) => {\n  /**\n   * Export subscriptions as a CSV file.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param query - Query parameters\n   * @param requestOptions - Request options\n   * @returns {string}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      timezone?: string;\n      columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;\n    },\n    requestOptions?: RequestOptions,\n  ): Promise<string> => {\n    const pathParams = {};\n    const queryParams = {\n      organization_id: query?.organization_id,\n      product_id: query?.product_id,\n      status: query?.status,\n      cancel_at_period_end: query?.cancel_at_period_end,\n      started_after: query?.started_after,\n      started_before: query?.started_before,\n      timezone: query?.timezone ?? \"UTC\",\n      columns: query?.columns,\n    };\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/export\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<string>(response, \"text\", {\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const getSubscriptions = (client: ClientBase) => {\n  /**\n   * Get a subscription by ID.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (id: string, requestOptions?: RequestOptions): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      404: ResourceNotFound,\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const revokeSubscriptions = (client: ClientBase) => {\n  /**\n   * Revoke a subscription, i.e cancel immediately.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {AlreadyCanceledSubscription} This subscription is already revoked.\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {SubscriptionLocked} Subscription is pending an update.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (id: string, requestOptions?: RequestOptions): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"DELETE\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      403: AlreadyCanceledSubscription,\n      404: ResourceNotFound,\n      409: SubscriptionLocked,\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const updateSubscriptions = (client: ClientBase) => {\n  /**\n   * Update a subscription.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param body - Request body\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {SubscriptionsUpdate402Error} The charge failed, or requires customer authentication that can't be completed off-session.\n   * @throws {SubscriptionsUpdate403Error} Subscription is already canceled or will be at the end of the period, is not active, or the organization is not ready to renew subscriptions.\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {SubscriptionsUpdate409Error} Subscription is pending an update, or is not scheduled to be canceled.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    id: string,\n    body: SubscriptionUpdate,\n    requestOptions?: RequestOptions,\n  ): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"PATCH\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      body,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      402: SubscriptionsUpdate402Error,\n      403: SubscriptionsUpdate403Error,\n      404: ResourceNotFound,\n      409: SubscriptionsUpdate409Error,\n      422: HTTPValidationError,\n    });\n  };\n};\n\nexport function createSubscriptionsService(client: ClientBase) {\n  return {\n    list: listSubscriptions(client),\n    create: createSubscriptions(client),\n    export: exportSubscriptions(client),\n    get: getSubscriptions(client),\n    revoke: revokeSubscriptions(client),\n    update: updateSubscriptions(client),\n    iterList: iterListSubscriptions(client),\n  };\n}\n\nexport type Subscriptions = ReturnType<typeof createSubscriptionsService>;\n"],"mappings":";;;AAwBA,MAAa,qBAAqB,WAAuB;;;;;;;;;;;;;;CAcvD,OAAO,OACL,OAsBA,mBACsC;EACtC,MAAM,aAAa,CAAC;EACpB,MAAM,cAAc;GAClB,iBAAiB,OAAO;GACxB,YAAY,OAAO;GACnB,aAAa,OAAO;GACpB,sBAAsB,OAAO;GAC7B,aAAa,OAAO;GACpB,QAAQ,OAAO;GACf,QAAQ,OAAO;GACf,sBAAsB,OAAO;GAC7B,8BAA8B,OAAO;GACrC,mBAAmB,OAAO;GAC1B,oBAAoB,OAAO;GAC3B,eAAe,OAAO;GACtB,gBAAgB,OAAO;GACvB,MAAM,OAAO,QAAQ;GACrB,OAAO,OAAO,SAAS;GACvB,SAAS,OAAO,WAAW,CAAC,aAAa;GACzC,UAAU,OAAO;EACnB;EACA,MAAM,UAAU,OAAO,aACrB,OACA,sBACA,YACA,aACA,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAAwC,UAAU,QAAQ,EACtE,KAAKA,eAAAA,oBACP,CAAC;CACH;AACF;;;;;;;;;;;;;;AAcA,MAAa,yBAAyB,WAAuB;CAC3D,OAAO,iBACL,OAsBA,gBAC8B;EAC9B,IAAI;EACJ,OAAO,OAAO,QAAQ;EACtB,IAAI;EACJ,QAAQ,OAAO;EAEf,OAAO,MAAM;GACX,MAAM,WAAW,MAAM,kBAAkB,MAAM,CAAC,CAAC;IAAE,GAAG;IAAO;IAAM;GAAM,GAAG,cAAc;GAC1F,KAAK,MAAM,QAAQ,SAAS,OAC1B,MAAM;GAER,IAAI,QAAQ,SAAS,WAAW,UAC9B;GAEF;EACF;CACF;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;;;CAmBzD,OAAO,OACL,MACA,mBAC0B;EAG1B,MAAM,UAAU,OAAO,aACrB,QACA,sBACA,CAAS,GACT,CAAU,GACV,IACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ,EAC1D,KAAKA,eAAAA,oBACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;CAczD,OAAO,OACL,OAUA,mBACoB;EACpB,MAAM,aAAa,CAAC;EACpB,MAAM,cAAc;GAClB,iBAAiB,OAAO;GACxB,YAAY,OAAO;GACnB,QAAQ,OAAO;GACf,sBAAsB,OAAO;GAC7B,eAAe,OAAO;GACtB,gBAAgB,OAAO;GACvB,UAAU,OAAO,YAAY;GAC7B,SAAS,OAAO;EAClB;EACA,MAAM,UAAU,OAAO,aACrB,OACA,4BACA,YACA,aACA,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAAsB,UAAU,QAAQ,EACpD,KAAKA,eAAAA,oBACP,CAAC;CACH;AACF;AACA,MAAa,oBAAoB,WAAuB;;;;;;;;;;;;;;;CAetD,OAAO,OAAO,IAAY,mBAA2D;EACnF,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,OACA,0BACA,YACA,CAAU,GACV,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAKC,eAAAA;GACL,KAAKD,eAAAA;EACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;CAiBzD,OAAO,OAAO,IAAY,mBAA2D;EACnF,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,UACA,0BACA,YACA,CAAU,GACV,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAKE,eAAAA;GACL,KAAKD,eAAAA;GACL,KAAKE,eAAAA;GACL,KAAKH,eAAAA;EACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;;;CAmBzD,OAAO,OACL,IACA,MACA,mBAC0B;EAC1B,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,SACA,0BACA,YACA,CAAU,GACV,IACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAKI,eAAAA;GACL,KAAKC,eAAAA;GACL,KAAKJ,eAAAA;GACL,KAAKK,eAAAA;GACL,KAAKN,eAAAA;EACP,CAAC;CACH;AACF;AAEA,SAAgB,2BAA2B,QAAoB;CAC7D,OAAO;EACL,MAAM,kBAAkB,MAAM;EAC9B,QAAQ,oBAAoB,MAAM;EAClC,QAAQ,oBAAoB,MAAM;EAClC,KAAK,iBAAiB,MAAM;EAC5B,QAAQ,oBAAoB,MAAM;EAClC,QAAQ,oBAAoB,MAAM;EAClC,UAAU,sBAAsB,MAAM;CACxC;AACF"}

package/dist/2027-01/services/subscriptions.d.cts

@@ -0,0 +1,126 @@
+import { c as RequestOptions, t as ClientBase } from "../../base-C5EE71lz.cjs";
+import { Ai as SubscriptionSortProperty, Di as SubscriptionExportColumn, Ei as SubscriptionCreateExternalCustomer, J as CustomerCancellationReason, Mi as SubscriptionUpdate, Ti as SubscriptionCreateCustomer, er as ListResourceSubscription, ji as SubscriptionStatus, ur as MetadataQuery, wi as Subscription } from "../../models-COhG3nD4.cjs";
+//#region src/2027-01/services/subscriptions.d.ts
+declare const listSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  customer_id?: string | string[] | null;
+  external_customer_id?: string | string[] | null;
+  discount_id?: string | string[] | null;
+  active?: boolean | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+  canceled_at_after?: string | null;
+  canceled_at_before?: string | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  page?: number;
+  limit?: number;
+  sorting?: SubscriptionSortProperty[] | null;
+  metadata?: MetadataQuery;
+}, requestOptions?: RequestOptions) => Promise<ListResourceSubscription>;
+/**
+ * List subscriptions.
+ *
+ * **Scopes**: `subscriptions:read` `subscriptions:write`
+ *
+ * @param query - Query parameters
+ * @param requestOptions - Request options
+ * @returns {AsyncGenerator<Subscription>} A generator that yields items of type Subscription.
+ * @throws {PolarNetworkError} When a network error occurs
+ * @throws {PolarRateLimitError} When the rate limit is exceeded
+ * @throws {PolarServerError} When the server returns a 5xx error
+ * @throws {HTTPValidationError} Validation Error
+ */
+declare const iterListSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  customer_id?: string | string[] | null;
+  external_customer_id?: string | string[] | null;
+  discount_id?: string | string[] | null;
+  active?: boolean | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+  canceled_at_after?: string | null;
+  canceled_at_before?: string | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  page?: number;
+  limit?: number;
+  sorting?: SubscriptionSortProperty[] | null;
+  metadata?: MetadataQuery;
+}, requestOptions?: RequestOptions) => AsyncGenerator<Subscription>;
+declare const createSubscriptions: (client: ClientBase) => (body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const exportSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  timezone?: string;
+  columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;
+}, requestOptions?: RequestOptions) => Promise<string>;
+declare const getSubscriptions: (client: ClientBase) => (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const revokeSubscriptions: (client: ClientBase) => (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const updateSubscriptions: (client: ClientBase) => (id: string, body: SubscriptionUpdate, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare function createSubscriptionsService(client: ClientBase): {
+  list: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    customer_id?: string | string[] | null;
+    external_customer_id?: string | string[] | null;
+    discount_id?: string | string[] | null;
+    active?: boolean | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+    canceled_at_after?: string | null;
+    canceled_at_before?: string | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    page?: number;
+    limit?: number;
+    sorting?: SubscriptionSortProperty[] | null;
+    metadata?: MetadataQuery;
+  }, requestOptions?: RequestOptions) => Promise<ListResourceSubscription>;
+  create: (body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer, requestOptions?: RequestOptions) => Promise<Subscription>;
+  export: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    timezone?: string;
+    columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;
+  }, requestOptions?: RequestOptions) => Promise<string>;
+  get: (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+  revoke: (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+  update: (id: string, body: SubscriptionUpdate, requestOptions?: RequestOptions) => Promise<Subscription>;
+  iterList: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    customer_id?: string | string[] | null;
+    external_customer_id?: string | string[] | null;
+    discount_id?: string | string[] | null;
+    active?: boolean | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+    canceled_at_after?: string | null;
+    canceled_at_before?: string | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    page?: number;
+    limit?: number;
+    sorting?: SubscriptionSortProperty[] | null;
+    metadata?: MetadataQuery;
+  }, requestOptions?: RequestOptions) => AsyncGenerator<Subscription>;
+};
+type Subscriptions = ReturnType<typeof createSubscriptionsService>;
+//#endregion
+export { Subscriptions, createSubscriptions, createSubscriptionsService, exportSubscriptions, getSubscriptions, iterListSubscriptions, listSubscriptions, revokeSubscriptions, updateSubscriptions };
+//# sourceMappingURL=subscriptions.d.cts.map

package/dist/2027-01/services/subscriptions.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.cts","names":[],"sources":["../../../src/2027-01/services/subscriptions.ts"],"mappings":";;;cAwBa,oBAAqB,QAAQ,gBAetC;EACE;EACA;EACA;EACA;EACA;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA,+BACI,6BACA;EAEJ;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,WAAW;GAEb,iBAAiB,mBAChB,QAAQ;;;;;;;;;;;;;;cA+CA,wBAAyB,QAAQ,gBAE1C;EACE;EACA;EACA;EACA;EACA;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA,+BACI,6BACA;EAEJ;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,WAAW;GAEb,iBAAiB,mBAChB,eAAe;cAkBP,sBAAuB,QAAQ,gBAoBxC,MAAM,6BAA6B,oCACnC,iBAAiB,mBAChB,QAAQ;cAgBA,sBAAuB,QAAQ,gBAexC;EACE;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA;EACA;EACA;EACA,UAAU,2BAA2B;GAEvC,iBAAiB,mBAChB;cAyBQ,mBAAoB,QAAQ,gBAezB,YAAY,iBAAiB,mBAAiB,QAAQ;cAmBzD,sBAAuB,QAAQ,gBAiB5B,YAAY,iBAAiB,mBAAiB,QAAQ;cAqBzD,sBAAuB,QAAQ,gBAoBxC,YACA,MAAM,oBACN,iBAAiB,mBAChB,QAAQ;iBAuBG,2BAA2B,QAAQ;EAhUvC,OAAA;IACN;IACA;IACA;IACA;IACA;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA,+BACI,6BACA;IAEJ;IACA;IACA;IACA;IACA;IACA;IACA,UAAU;IACV,WAAW;KACZ,iBACgB,mBAChB,QAAQ;EA8GH,SAAA,MAAA,6BAA6B,oCAAkC,iBACpD,mBAChB,QAAQ;EA+BD,SAAA;IACN;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA;IACA;IACA;IACA,UAAU,2BAA2B;KACtC,iBACgB,mBAChB;EAwCe,MAAA,YAAM,iBAAmB,mBAAiB,QAAQ;EAoClD,SAAA,YAAM,iBAAmB,mBAAiB,QAAQ;EAyC9D,SAAA,YAAM,MACJ,oBAAkB,iBACP,mBAChB,QAAQ;EAjOD,WAAA;IACN;IACA;IACA;IACA;IACA;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA,+BACI,6BACA;IAEJ;IACA;IACA;IACA;IACA;IACA;IACA,UAAU;IACV,WAAW;KACZ,iBACgB,mBAChB,eAAe;;KA6OR,gBAAgB,kBAAkB"}

package/dist/2027-01/services/subscriptions.d.mts

@@ -0,0 +1,126 @@
+import { c as RequestOptions, t as ClientBase } from "../../base-C5EE71lz.mjs";
+import { Ai as SubscriptionSortProperty, Di as SubscriptionExportColumn, Ei as SubscriptionCreateExternalCustomer, J as CustomerCancellationReason, Mi as SubscriptionUpdate, Ti as SubscriptionCreateCustomer, er as ListResourceSubscription, ji as SubscriptionStatus, ur as MetadataQuery, wi as Subscription } from "../../models-COhG3nD4.mjs";
+//#region src/2027-01/services/subscriptions.d.ts
+declare const listSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  customer_id?: string | string[] | null;
+  external_customer_id?: string | string[] | null;
+  discount_id?: string | string[] | null;
+  active?: boolean | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+  canceled_at_after?: string | null;
+  canceled_at_before?: string | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  page?: number;
+  limit?: number;
+  sorting?: SubscriptionSortProperty[] | null;
+  metadata?: MetadataQuery;
+}, requestOptions?: RequestOptions) => Promise<ListResourceSubscription>;
+/**
+ * List subscriptions.
+ *
+ * **Scopes**: `subscriptions:read` `subscriptions:write`
+ *
+ * @param query - Query parameters
+ * @param requestOptions - Request options
+ * @returns {AsyncGenerator<Subscription>} A generator that yields items of type Subscription.
+ * @throws {PolarNetworkError} When a network error occurs
+ * @throws {PolarRateLimitError} When the rate limit is exceeded
+ * @throws {PolarServerError} When the server returns a 5xx error
+ * @throws {HTTPValidationError} Validation Error
+ */
+declare const iterListSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  customer_id?: string | string[] | null;
+  external_customer_id?: string | string[] | null;
+  discount_id?: string | string[] | null;
+  active?: boolean | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+  canceled_at_after?: string | null;
+  canceled_at_before?: string | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  page?: number;
+  limit?: number;
+  sorting?: SubscriptionSortProperty[] | null;
+  metadata?: MetadataQuery;
+}, requestOptions?: RequestOptions) => AsyncGenerator<Subscription>;
+declare const createSubscriptions: (client: ClientBase) => (body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const exportSubscriptions: (client: ClientBase) => (query?: {
+  organization_id?: string | string[] | null;
+  product_id?: string | string[] | null;
+  status?: SubscriptionStatus | SubscriptionStatus[] | null;
+  cancel_at_period_end?: boolean | null;
+  started_after?: string | null;
+  started_before?: string | null;
+  timezone?: string;
+  columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;
+}, requestOptions?: RequestOptions) => Promise<string>;
+declare const getSubscriptions: (client: ClientBase) => (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const revokeSubscriptions: (client: ClientBase) => (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare const updateSubscriptions: (client: ClientBase) => (id: string, body: SubscriptionUpdate, requestOptions?: RequestOptions) => Promise<Subscription>;
+declare function createSubscriptionsService(client: ClientBase): {
+  list: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    customer_id?: string | string[] | null;
+    external_customer_id?: string | string[] | null;
+    discount_id?: string | string[] | null;
+    active?: boolean | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+    canceled_at_after?: string | null;
+    canceled_at_before?: string | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    page?: number;
+    limit?: number;
+    sorting?: SubscriptionSortProperty[] | null;
+    metadata?: MetadataQuery;
+  }, requestOptions?: RequestOptions) => Promise<ListResourceSubscription>;
+  create: (body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer, requestOptions?: RequestOptions) => Promise<Subscription>;
+  export: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    timezone?: string;
+    columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;
+  }, requestOptions?: RequestOptions) => Promise<string>;
+  get: (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+  revoke: (id: string, requestOptions?: RequestOptions) => Promise<Subscription>;
+  update: (id: string, body: SubscriptionUpdate, requestOptions?: RequestOptions) => Promise<Subscription>;
+  iterList: (query?: {
+    organization_id?: string | string[] | null;
+    product_id?: string | string[] | null;
+    customer_id?: string | string[] | null;
+    external_customer_id?: string | string[] | null;
+    discount_id?: string | string[] | null;
+    active?: boolean | null;
+    status?: SubscriptionStatus | SubscriptionStatus[] | null;
+    cancel_at_period_end?: boolean | null;
+    customer_cancellation_reason?: CustomerCancellationReason | CustomerCancellationReason[] | null;
+    canceled_at_after?: string | null;
+    canceled_at_before?: string | null;
+    started_after?: string | null;
+    started_before?: string | null;
+    page?: number;
+    limit?: number;
+    sorting?: SubscriptionSortProperty[] | null;
+    metadata?: MetadataQuery;
+  }, requestOptions?: RequestOptions) => AsyncGenerator<Subscription>;
+};
+type Subscriptions = ReturnType<typeof createSubscriptionsService>;
+//#endregion
+export { Subscriptions, createSubscriptions, createSubscriptionsService, exportSubscriptions, getSubscriptions, iterListSubscriptions, listSubscriptions, revokeSubscriptions, updateSubscriptions };
+//# sourceMappingURL=subscriptions.d.mts.map

package/dist/2027-01/services/subscriptions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.d.mts","names":[],"sources":["../../../src/2027-01/services/subscriptions.ts"],"mappings":";;;cAwBa,oBAAqB,QAAQ,gBAetC;EACE;EACA;EACA;EACA;EACA;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA,+BACI,6BACA;EAEJ;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,WAAW;GAEb,iBAAiB,mBAChB,QAAQ;;;;;;;;;;;;;;cA+CA,wBAAyB,QAAQ,gBAE1C;EACE;EACA;EACA;EACA;EACA;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA,+BACI,6BACA;EAEJ;EACA;EACA;EACA;EACA;EACA;EACA,UAAU;EACV,WAAW;GAEb,iBAAiB,mBAChB,eAAe;cAkBP,sBAAuB,QAAQ,gBAoBxC,MAAM,6BAA6B,oCACnC,iBAAiB,mBAChB,QAAQ;cAgBA,sBAAuB,QAAQ,gBAexC;EACE;EACA;EACA,SAAS,qBAAqB;EAC9B;EACA;EACA;EACA;EACA,UAAU,2BAA2B;GAEvC,iBAAiB,mBAChB;cAyBQ,mBAAoB,QAAQ,gBAezB,YAAY,iBAAiB,mBAAiB,QAAQ;cAmBzD,sBAAuB,QAAQ,gBAiB5B,YAAY,iBAAiB,mBAAiB,QAAQ;cAqBzD,sBAAuB,QAAQ,gBAoBxC,YACA,MAAM,oBACN,iBAAiB,mBAChB,QAAQ;iBAuBG,2BAA2B,QAAQ;EAhUvC,OAAA;IACN;IACA;IACA;IACA;IACA;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA,+BACI,6BACA;IAEJ;IACA;IACA;IACA;IACA;IACA;IACA,UAAU;IACV,WAAW;KACZ,iBACgB,mBAChB,QAAQ;EA8GH,SAAA,MAAA,6BAA6B,oCAAkC,iBACpD,mBAChB,QAAQ;EA+BD,SAAA;IACN;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA;IACA;IACA;IACA,UAAU,2BAA2B;KACtC,iBACgB,mBAChB;EAwCe,MAAA,YAAM,iBAAmB,mBAAiB,QAAQ;EAoClD,SAAA,YAAM,iBAAmB,mBAAiB,QAAQ;EAyC9D,SAAA,YAAM,MACJ,oBAAkB,iBACP,mBAChB,QAAQ;EAjOD,WAAA;IACN;IACA;IACA;IACA;IACA;IACA;IACA,SAAS,qBAAqB;IAC9B;IACA,+BACI,6BACA;IAEJ;IACA;IACA;IACA;IACA;IACA;IACA,UAAU;IACV,WAAW;KACZ,iBACgB,mBAChB,eAAe;;KA6OR,gBAAgB,kBAAkB"}

package/dist/2027-01/services/subscriptions.mjs

@@ -0,0 +1,230 @@
+import { Mt as SubscriptionsUpdate402Error, Nt as SubscriptionsUpdate403Error, Ot as ResourceNotFound, Pt as SubscriptionsUpdate409Error, dt as HTTPValidationError, jt as SubscriptionLocked, t as AlreadyCanceledSubscription } from "../../errors-B1xadCgl.mjs";
+//#region src/2027-01/services/subscriptions.ts
+const listSubscriptions = (client) => {
+	/**
+	* List subscriptions.
+	*
+	* **Scopes**: `subscriptions:read` `subscriptions:write`
+	*
+	* @param query - Query parameters
+	* @param requestOptions - Request options
+	* @returns {ListResourceSubscription}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (query, requestOptions) => {
+		const pathParams = {};
+		const queryParams = {
+			organization_id: query?.organization_id,
+			product_id: query?.product_id,
+			customer_id: query?.customer_id,
+			external_customer_id: query?.external_customer_id,
+			discount_id: query?.discount_id,
+			active: query?.active,
+			status: query?.status,
+			cancel_at_period_end: query?.cancel_at_period_end,
+			customer_cancellation_reason: query?.customer_cancellation_reason,
+			canceled_at_after: query?.canceled_at_after,
+			canceled_at_before: query?.canceled_at_before,
+			started_after: query?.started_after,
+			started_before: query?.started_before,
+			page: query?.page ?? 1,
+			limit: query?.limit ?? 10,
+			sorting: query?.sorting ?? ["-started_at"],
+			metadata: query?.metadata
+		};
+		const request = client.buildRequest("GET", "/v1/subscriptions/", pathParams, queryParams, void 0);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "json", { 422: HTTPValidationError });
+	};
+};
+/**
+* List subscriptions.
+*
+* **Scopes**: `subscriptions:read` `subscriptions:write`
+*
+* @param query - Query parameters
+* @param requestOptions - Request options
+* @returns {AsyncGenerator<Subscription>} A generator that yields items of type Subscription.
+* @throws {PolarNetworkError} When a network error occurs
+* @throws {PolarRateLimitError} When the rate limit is exceeded
+* @throws {PolarServerError} When the server returns a 5xx error
+* @throws {HTTPValidationError} Validation Error
+*/
+const iterListSubscriptions = (client) => {
+	return async function* (query, requestOptions) {
+		let page;
+		page = query?.page ?? 1;
+		let limit;
+		limit = query?.limit;
+		while (true) {
+			const response = await listSubscriptions(client)({
+				...query,
+				page,
+				limit
+			}, requestOptions);
+			for (const item of response.items) yield item;
+			if (page >= response.pagination.max_page) break;
+			page++;
+		}
+	};
+};
+const createSubscriptions = (client) => {
+	/**
+	* Create a subscription programmatically.
+	*
+	* This endpoint only allows to create subscription on free products.
+	* For paid products, use the checkout flow.
+	*
+	* No initial order will be created and no confirmation email will be sent.
+	*
+	* **Scopes**: `subscriptions:write`
+	*
+	* @param body - Request body
+	* @param requestOptions - Request options
+	* @returns {Subscription}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (body, requestOptions) => {
+		const request = client.buildRequest("POST", "/v1/subscriptions/", {}, {}, body);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "json", { 422: HTTPValidationError });
+	};
+};
+const exportSubscriptions = (client) => {
+	/**
+	* Export subscriptions as a CSV file.
+	*
+	* **Scopes**: `subscriptions:read` `subscriptions:write`
+	*
+	* @param query - Query parameters
+	* @param requestOptions - Request options
+	* @returns {string}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (query, requestOptions) => {
+		const pathParams = {};
+		const queryParams = {
+			organization_id: query?.organization_id,
+			product_id: query?.product_id,
+			status: query?.status,
+			cancel_at_period_end: query?.cancel_at_period_end,
+			started_after: query?.started_after,
+			started_before: query?.started_before,
+			timezone: query?.timezone ?? "UTC",
+			columns: query?.columns
+		};
+		const request = client.buildRequest("GET", "/v1/subscriptions/export", pathParams, queryParams, void 0);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "text", { 422: HTTPValidationError });
+	};
+};
+const getSubscriptions = (client) => {
+	/**
+	* Get a subscription by ID.
+	*
+	* **Scopes**: `subscriptions:read` `subscriptions:write`
+	*
+	* @param id - The subscription ID.
+	* @param requestOptions - Request options
+	* @returns {Subscription}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {ResourceNotFound} Subscription not found.
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (id, requestOptions) => {
+		const pathParams = { id };
+		const request = client.buildRequest("GET", "/v1/subscriptions/{id}", pathParams, {}, void 0);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "json", {
+			404: ResourceNotFound,
+			422: HTTPValidationError
+		});
+	};
+};
+const revokeSubscriptions = (client) => {
+	/**
+	* Revoke a subscription, i.e cancel immediately.
+	*
+	* **Scopes**: `subscriptions:write`
+	*
+	* @param id - The subscription ID.
+	* @param requestOptions - Request options
+	* @returns {Subscription}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {AlreadyCanceledSubscription} This subscription is already revoked.
+	* @throws {ResourceNotFound} Subscription not found.
+	* @throws {SubscriptionLocked} Subscription is pending an update.
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (id, requestOptions) => {
+		const pathParams = { id };
+		const request = client.buildRequest("DELETE", "/v1/subscriptions/{id}", pathParams, {}, void 0);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "json", {
+			403: AlreadyCanceledSubscription,
+			404: ResourceNotFound,
+			409: SubscriptionLocked,
+			422: HTTPValidationError
+		});
+	};
+};
+const updateSubscriptions = (client) => {
+	/**
+	* Update a subscription.
+	*
+	* **Scopes**: `subscriptions:write`
+	*
+	* @param id - The subscription ID.
+	* @param body - Request body
+	* @param requestOptions - Request options
+	* @returns {Subscription}
+	* @throws {PolarNetworkError} When a network error occurs
+	* @throws {PolarRateLimitError} When the rate limit is exceeded
+	* @throws {PolarServerError} When the server returns a 5xx error
+	* @throws {SubscriptionsUpdate402Error} The charge failed, or requires customer authentication that can't be completed off-session.
+	* @throws {SubscriptionsUpdate403Error} Subscription is already canceled or will be at the end of the period, is not active, or the organization is not ready to renew subscriptions.
+	* @throws {ResourceNotFound} Subscription not found.
+	* @throws {SubscriptionsUpdate409Error} Subscription is pending an update, or is not scheduled to be canceled.
+	* @throws {HTTPValidationError} Validation Error
+	*/
+	return async (id, body, requestOptions) => {
+		const pathParams = { id };
+		const request = client.buildRequest("PATCH", "/v1/subscriptions/{id}", pathParams, {}, body);
+		const response = await client.sendRequest(request, requestOptions);
+		return client.parseResponse(response, "json", {
+			402: SubscriptionsUpdate402Error,
+			403: SubscriptionsUpdate403Error,
+			404: ResourceNotFound,
+			409: SubscriptionsUpdate409Error,
+			422: HTTPValidationError
+		});
+	};
+};
+function createSubscriptionsService(client) {
+	return {
+		list: listSubscriptions(client),
+		create: createSubscriptions(client),
+		export: exportSubscriptions(client),
+		get: getSubscriptions(client),
+		revoke: revokeSubscriptions(client),
+		update: updateSubscriptions(client),
+		iterList: iterListSubscriptions(client)
+	};
+}
+//#endregion
+export { createSubscriptions, createSubscriptionsService, exportSubscriptions, getSubscriptions, iterListSubscriptions, listSubscriptions, revokeSubscriptions, updateSubscriptions };
+
+//# sourceMappingURL=subscriptions.mjs.map

package/dist/2027-01/services/subscriptions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"subscriptions.mjs","names":[],"sources":["../../../src/2027-01/services/subscriptions.ts"],"sourcesContent":["import type { ClientBase, RequestOptions } from \"../../base\";\nimport type {\n  CustomerCancellationReason,\n  ListResourceSubscription,\n  MetadataQuery,\n  Subscription,\n  SubscriptionCreateCustomer,\n  SubscriptionCreateExternalCustomer,\n  SubscriptionExportColumn,\n  SubscriptionSortProperty,\n  SubscriptionStatus,\n  SubscriptionUpdate,\n} from \"../models\";\n\nimport {\n  AlreadyCanceledSubscription,\n  HTTPValidationError,\n  ResourceNotFound,\n  SubscriptionLocked,\n  SubscriptionsUpdate402Error,\n  SubscriptionsUpdate403Error,\n  SubscriptionsUpdate409Error,\n} from \"../errors\";\n\nexport const listSubscriptions = (client: ClientBase) => {\n  /**\n   * List subscriptions.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param query - Query parameters\n   * @param requestOptions - Request options\n   * @returns {ListResourceSubscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      customer_id?: string | string[] | null;\n      external_customer_id?: string | string[] | null;\n      discount_id?: string | string[] | null;\n      active?: boolean | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      customer_cancellation_reason?:\n        | CustomerCancellationReason\n        | CustomerCancellationReason[]\n        | null;\n      canceled_at_after?: string | null;\n      canceled_at_before?: string | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      page?: number;\n      limit?: number;\n      sorting?: SubscriptionSortProperty[] | null;\n      metadata?: MetadataQuery;\n    },\n    requestOptions?: RequestOptions,\n  ): Promise<ListResourceSubscription> => {\n    const pathParams = {};\n    const queryParams = {\n      organization_id: query?.organization_id,\n      product_id: query?.product_id,\n      customer_id: query?.customer_id,\n      external_customer_id: query?.external_customer_id,\n      discount_id: query?.discount_id,\n      active: query?.active,\n      status: query?.status,\n      cancel_at_period_end: query?.cancel_at_period_end,\n      customer_cancellation_reason: query?.customer_cancellation_reason,\n      canceled_at_after: query?.canceled_at_after,\n      canceled_at_before: query?.canceled_at_before,\n      started_after: query?.started_after,\n      started_before: query?.started_before,\n      page: query?.page ?? 1,\n      limit: query?.limit ?? 10,\n      sorting: query?.sorting ?? [\"-started_at\"],\n      metadata: query?.metadata,\n    };\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<ListResourceSubscription>(response, \"json\", {\n      422: HTTPValidationError,\n    });\n  };\n};\n/**\n * List subscriptions.\n *\n * **Scopes**: `subscriptions:read` `subscriptions:write`\n *\n * @param query - Query parameters\n * @param requestOptions - Request options\n * @returns {AsyncGenerator<Subscription>} A generator that yields items of type Subscription.\n * @throws {PolarNetworkError} When a network error occurs\n * @throws {PolarRateLimitError} When the rate limit is exceeded\n * @throws {PolarServerError} When the server returns a 5xx error\n * @throws {HTTPValidationError} Validation Error\n */\nexport const iterListSubscriptions = (client: ClientBase) => {\n  return async function* (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      customer_id?: string | string[] | null;\n      external_customer_id?: string | string[] | null;\n      discount_id?: string | string[] | null;\n      active?: boolean | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      customer_cancellation_reason?:\n        | CustomerCancellationReason\n        | CustomerCancellationReason[]\n        | null;\n      canceled_at_after?: string | null;\n      canceled_at_before?: string | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      page?: number;\n      limit?: number;\n      sorting?: SubscriptionSortProperty[] | null;\n      metadata?: MetadataQuery;\n    },\n    requestOptions?: RequestOptions,\n  ): AsyncGenerator<Subscription> {\n    let page: number;\n    page = query?.page ?? 1;\n    let limit: number | undefined;\n    limit = query?.limit;\n\n    while (true) {\n      const response = await listSubscriptions(client)({ ...query, page, limit }, requestOptions);\n      for (const item of response.items) {\n        yield item;\n      }\n      if (page >= response.pagination.max_page) {\n        break;\n      }\n      page++;\n    }\n  };\n};\nexport const createSubscriptions = (client: ClientBase) => {\n  /**\n   * Create a subscription programmatically.\n   *\n   * This endpoint only allows to create subscription on free products.\n   * For paid products, use the checkout flow.\n   *\n   * No initial order will be created and no confirmation email will be sent.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param body - Request body\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    body: SubscriptionCreateCustomer | SubscriptionCreateExternalCustomer,\n    requestOptions?: RequestOptions,\n  ): Promise<Subscription> => {\n    const pathParams = {};\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"POST\",\n      \"/v1/subscriptions/\",\n      pathParams,\n      queryParams,\n      body,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const exportSubscriptions = (client: ClientBase) => {\n  /**\n   * Export subscriptions as a CSV file.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param query - Query parameters\n   * @param requestOptions - Request options\n   * @returns {string}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    query?: {\n      organization_id?: string | string[] | null;\n      product_id?: string | string[] | null;\n      status?: SubscriptionStatus | SubscriptionStatus[] | null;\n      cancel_at_period_end?: boolean | null;\n      started_after?: string | null;\n      started_before?: string | null;\n      timezone?: string;\n      columns?: SubscriptionExportColumn | SubscriptionExportColumn[] | null;\n    },\n    requestOptions?: RequestOptions,\n  ): Promise<string> => {\n    const pathParams = {};\n    const queryParams = {\n      organization_id: query?.organization_id,\n      product_id: query?.product_id,\n      status: query?.status,\n      cancel_at_period_end: query?.cancel_at_period_end,\n      started_after: query?.started_after,\n      started_before: query?.started_before,\n      timezone: query?.timezone ?? \"UTC\",\n      columns: query?.columns,\n    };\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/export\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<string>(response, \"text\", {\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const getSubscriptions = (client: ClientBase) => {\n  /**\n   * Get a subscription by ID.\n   *\n   * **Scopes**: `subscriptions:read` `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (id: string, requestOptions?: RequestOptions): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"GET\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      404: ResourceNotFound,\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const revokeSubscriptions = (client: ClientBase) => {\n  /**\n   * Revoke a subscription, i.e cancel immediately.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {AlreadyCanceledSubscription} This subscription is already revoked.\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {SubscriptionLocked} Subscription is pending an update.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (id: string, requestOptions?: RequestOptions): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"DELETE\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      undefined,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      403: AlreadyCanceledSubscription,\n      404: ResourceNotFound,\n      409: SubscriptionLocked,\n      422: HTTPValidationError,\n    });\n  };\n};\nexport const updateSubscriptions = (client: ClientBase) => {\n  /**\n   * Update a subscription.\n   *\n   * **Scopes**: `subscriptions:write`\n   *\n   * @param id - The subscription ID.\n   * @param body - Request body\n   * @param requestOptions - Request options\n   * @returns {Subscription}\n   * @throws {PolarNetworkError} When a network error occurs\n   * @throws {PolarRateLimitError} When the rate limit is exceeded\n   * @throws {PolarServerError} When the server returns a 5xx error\n   * @throws {SubscriptionsUpdate402Error} The charge failed, or requires customer authentication that can't be completed off-session.\n   * @throws {SubscriptionsUpdate403Error} Subscription is already canceled or will be at the end of the period, is not active, or the organization is not ready to renew subscriptions.\n   * @throws {ResourceNotFound} Subscription not found.\n   * @throws {SubscriptionsUpdate409Error} Subscription is pending an update, or is not scheduled to be canceled.\n   * @throws {HTTPValidationError} Validation Error\n   */\n  return async (\n    id: string,\n    body: SubscriptionUpdate,\n    requestOptions?: RequestOptions,\n  ): Promise<Subscription> => {\n    const pathParams = {\n      id: id,\n    };\n    const queryParams = {};\n    const request = client.buildRequest(\n      \"PATCH\",\n      \"/v1/subscriptions/{id}\",\n      pathParams,\n      queryParams,\n      body,\n    );\n    const response = await client.sendRequest(request, requestOptions);\n    return client.parseResponse<Subscription>(response, \"json\", {\n      402: SubscriptionsUpdate402Error,\n      403: SubscriptionsUpdate403Error,\n      404: ResourceNotFound,\n      409: SubscriptionsUpdate409Error,\n      422: HTTPValidationError,\n    });\n  };\n};\n\nexport function createSubscriptionsService(client: ClientBase) {\n  return {\n    list: listSubscriptions(client),\n    create: createSubscriptions(client),\n    export: exportSubscriptions(client),\n    get: getSubscriptions(client),\n    revoke: revokeSubscriptions(client),\n    update: updateSubscriptions(client),\n    iterList: iterListSubscriptions(client),\n  };\n}\n\nexport type Subscriptions = ReturnType<typeof createSubscriptionsService>;\n"],"mappings":";;AAwBA,MAAa,qBAAqB,WAAuB;;;;;;;;;;;;;;CAcvD,OAAO,OACL,OAsBA,mBACsC;EACtC,MAAM,aAAa,CAAC;EACpB,MAAM,cAAc;GAClB,iBAAiB,OAAO;GACxB,YAAY,OAAO;GACnB,aAAa,OAAO;GACpB,sBAAsB,OAAO;GAC7B,aAAa,OAAO;GACpB,QAAQ,OAAO;GACf,QAAQ,OAAO;GACf,sBAAsB,OAAO;GAC7B,8BAA8B,OAAO;GACrC,mBAAmB,OAAO;GAC1B,oBAAoB,OAAO;GAC3B,eAAe,OAAO;GACtB,gBAAgB,OAAO;GACvB,MAAM,OAAO,QAAQ;GACrB,OAAO,OAAO,SAAS;GACvB,SAAS,OAAO,WAAW,CAAC,aAAa;GACzC,UAAU,OAAO;EACnB;EACA,MAAM,UAAU,OAAO,aACrB,OACA,sBACA,YACA,aACA,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAAwC,UAAU,QAAQ,EACtE,KAAK,oBACP,CAAC;CACH;AACF;;;;;;;;;;;;;;AAcA,MAAa,yBAAyB,WAAuB;CAC3D,OAAO,iBACL,OAsBA,gBAC8B;EAC9B,IAAI;EACJ,OAAO,OAAO,QAAQ;EACtB,IAAI;EACJ,QAAQ,OAAO;EAEf,OAAO,MAAM;GACX,MAAM,WAAW,MAAM,kBAAkB,MAAM,CAAC,CAAC;IAAE,GAAG;IAAO;IAAM;GAAM,GAAG,cAAc;GAC1F,KAAK,MAAM,QAAQ,SAAS,OAC1B,MAAM;GAER,IAAI,QAAQ,SAAS,WAAW,UAC9B;GAEF;EACF;CACF;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;;;CAmBzD,OAAO,OACL,MACA,mBAC0B;EAG1B,MAAM,UAAU,OAAO,aACrB,QACA,sBACA,CAAS,GACT,CAAU,GACV,IACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ,EAC1D,KAAK,oBACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;CAczD,OAAO,OACL,OAUA,mBACoB;EACpB,MAAM,aAAa,CAAC;EACpB,MAAM,cAAc;GAClB,iBAAiB,OAAO;GACxB,YAAY,OAAO;GACnB,QAAQ,OAAO;GACf,sBAAsB,OAAO;GAC7B,eAAe,OAAO;GACtB,gBAAgB,OAAO;GACvB,UAAU,OAAO,YAAY;GAC7B,SAAS,OAAO;EAClB;EACA,MAAM,UAAU,OAAO,aACrB,OACA,4BACA,YACA,aACA,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAAsB,UAAU,QAAQ,EACpD,KAAK,oBACP,CAAC;CACH;AACF;AACA,MAAa,oBAAoB,WAAuB;;;;;;;;;;;;;;;CAetD,OAAO,OAAO,IAAY,mBAA2D;EACnF,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,OACA,0BACA,YACA,CAAU,GACV,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAK;GACL,KAAK;EACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;CAiBzD,OAAO,OAAO,IAAY,mBAA2D;EACnF,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,UACA,0BACA,YACA,CAAU,GACV,KAAA,CACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;EACP,CAAC;CACH;AACF;AACA,MAAa,uBAAuB,WAAuB;;;;;;;;;;;;;;;;;;;CAmBzD,OAAO,OACL,IACA,MACA,mBAC0B;EAC1B,MAAM,aAAa,EACb,GACN;EAEA,MAAM,UAAU,OAAO,aACrB,SACA,0BACA,YACA,CAAU,GACV,IACF;EACA,MAAM,WAAW,MAAM,OAAO,YAAY,SAAS,cAAc;EACjE,OAAO,OAAO,cAA4B,UAAU,QAAQ;GAC1D,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;GACL,KAAK;EACP,CAAC;CACH;AACF;AAEA,SAAgB,2BAA2B,QAAoB;CAC7D,OAAO;EACL,MAAM,kBAAkB,MAAM;EAC9B,QAAQ,oBAAoB,MAAM;EAClC,QAAQ,oBAAoB,MAAM;EAClC,KAAK,iBAAiB,MAAM;EAC5B,QAAQ,oBAAoB,MAAM;EAClC,QAAQ,oBAAoB,MAAM;EAClC,UAAU,sBAAsB,MAAM;CACxC;AACF"}