WIP #472 - Add support for Subscriptions

elasticpath · Aug 26, 2024 · 7e7256d · 7e7256d
1 parent 923ace5
commit 7e7256d
Showing 1 changed file with 134 additions and 0 deletions.
diff --git a/external/resources/yaml/resources.yaml b/external/resources/yaml/resources.yaml
@@ -2372,3 +2372,137 @@ stores:
   get-entity:
     docs: "https://elasticpath.dev/docs/getting-started/api-reference"
     url: "/v2/stores/{settings}"
+subscription-products:
+  docs: "https://elasticpath.dev/docs/api/subscriptions/products"
+  json-api-type: subscription_product
+  json-api-format: compliant
+  singular-name: subscription-product
+  get-collection:
+    docs: https://elasticpath.dev/docs/api/subscriptions/list-products
+    url: /v2/subscriptions/products
+  get-entity:
+    docs: https://elasticpath.dev/docs/api/subscriptions/get-product
+    url: /v2/subscriptions/products/{subscription_products}
+  create-entity:
+    docs: https://elasticpath.dev/docs/api/subscriptions/create-product
+    url: /v2/subscriptions/products
+  update-entity:
+    docs: https://elasticpath.dev/docs/api/subscriptions/update-product
+    url: /v2/subscriptions/products/{subscription_products}
+  delete-entity:
+    docs: https://elasticpath.dev/docs/api/subscriptions/delete-product
+    url: /v2/subscriptions/products/{subscription_products}
+  attributes:
+    ^price\.([a-zA-Z0-9-_]+)\.amount$:
+      type: INT
+    ^price\.([a-zA-Z0-9-_]+)\.includes_tax$:
+      type: BOOL
+    description:
+      type: STRING
+      autofill: VALUE:Auto Generated
+    external_ref:
+      type: STRING
+    main_image:
+      type: STRING
+    name:
+      type: STRING
+      autofill: FUNC:Name
+    price_units.amount:
+      type: INT
+    price_units.unit:
+      type: ENUM:day,month
+    sku:
+      type: STRING
+subscription-plans:
+  docs: "https://elasticpath.dev/docs/api/subscriptions/plans"
+  json-api-type: subscription_plan
+  json-api-format: compliant
+  singular-name: subscription-plan
+  get-collection:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/list-plans"
+    url: /v2/subscriptions/plans
+  get-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/get-plan"
+    url: /v2/subscriptions/plans/{subscription_plans}
+  create-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/create-plan"
+    url: /v2/subscriptions/plans
+  update-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/update-plan"
+    url: /v2/subscriptions/plans/{subscription_plans}
+  delete-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/delete-plan"
+    url: /v2/subscriptions/plans/{subscription_plans}
+  attributes:
+    ^fixed_price\.(USD|[a-zA-Z0-9-_]+)\.amount$:
+      type: INT
+    ^fixed_price\.(USD|[a-zA-Z0-9-_]+)\.includes_tax$:
+      type: BOOL
+    billing_day:
+      type: INT
+    billing_frequency:
+      type: INT
+      autofill: VALUE:1
+    billing_interval_type:
+      type: ENUM:day,week,month,year
+      autofill: VALUE:day
+    billing_month_day:
+      type: INT
+    can_cancel:
+      type: BOOL
+      autofill: VALUE:true
+    can_pause:
+      type: BOOL
+      autofill: VALUE:true
+    can_resume:
+      type: BOOL
+      autofill: VALUE:true
+    description:
+      type: STRING
+      autofill: VALUE:Auto Generated
+    end_behavior:
+      type: ENUM:close,roll
+      autofill: VALUE:close
+    external_ref:
+      type: STRING
+    name:
+      type: STRING
+      autofill: FUNC:Name
+    plan_length:
+      type: INT
+      autofill: VALUE:1
+    status:
+      type: ENUM:active,draft,archive
+    trial_period:
+      type: INT
+subscription-offerings:
+  docs: "https://elasticpath.dev/docs/api/subscriptions/offerings"
+  json-api-type: subscription_offering
+  json-api-format: compliant
+  get-collection:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/create-offering"
+    url: /v2/subscriptions/offerings
+  get-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/get-offering"
+    url: /v2/subscriptions/offerings/{subscription_offerings}
+  create-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/create-offering"
+    url: /v2/subscriptions/offerings
+  update-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/update-offering"
+    url: /v2/subscriptions/offerings/{subscription_offerings}
+  delete-entity:
+    docs: "https://elasticpath.dev/docs/api/subscriptions/delete-offering"
+    url: /v2/subscriptions/offerings/{subscription_offerings}
+  attributes:
+    description:
+      type: STRING
+      autofill: VALUE:Auto Generated
+    external_ref:
+      type: STRING
+    id:
+      type: RESOURCE_ID:subscription-offerings
+    name:
+      type: STRING
+      autofill: FUNC:Name
+  singular-name: subscription-offering