Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
S
Stripe Import
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Extensions
Stripe Import
Commits
f91e1878
Commit
f91e1878
authored
1 year ago
by
mattwire
Browse files
Options
Downloads
Patches
Plain Diff
Add skeleton docs
parent
30fe27e1
No related branches found
Branches containing commit
No related tags found
No related merge requests found
Changes
4
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
docs/index.md
+58
-0
58 additions, 0 deletions
docs/index.md
docs/releasenotes.md
+14
-0
14 additions, 0 deletions
docs/releasenotes.md
info.xml
+3
-3
3 additions, 3 deletions
info.xml
mkdocs.yml
+20
-0
20 additions, 0 deletions
mkdocs.yml
with
95 additions
and
3 deletions
docs/index.md
0 → 100644
+
58
−
0
View file @
f91e1878
# Stripe Import
Provides a set of API functions to import Stripe Customers / Subscriptions / Charges.
These can be used in scripts, manually or as a scheduled job.
The extension is licensed under
[
AGPL-3.0
](
LICENSE.txt
)
.
## Installation
Learn more about installing CiviCRM extensions in the
[
CiviCRM Sysadmin Guide
](
https://docs.civicrm.org/sysadmin/en/latest/customize/extensions/
)
.
### You must use the "import" branch of the Stripe extension:
https://lab.civicrm.org/extensions/stripe/-/tree/import
### You must apply API4 MembershipLog patch:
https://github.com/civicrm/civicrm-core/pull/28220
### To disable membership updates make sure you have applied:
https://github.com/civicrm/civicrm-core/pull/28607
## Getting Started
## Known Issues
### Subscription import for memberships renews the membership.
This is because Payment.create triggers a "Contribution Completion"
which in turn triggers a membership renewal.
Workaround: https://github.com/civicrm/civicrm-core/pull/28607
But we'll need a way to conditionally enable/disable this as in "normal" operation
we
*should*
renew the membership. But for initial import we don't want to.
## Customisation
You can listen to the following events to customise the import process:
### civi.stripeimport.startimport
*Currently only implemented for subscription import*
This event is dispatched at the start of each import.
It can be used to setup or change things before processing import.
For example, you could remove the default listener for
`civi.stripeimport.membershipauto`
in order to modify the default processing.
### civi.stripeimport.membershipauto
*Currently only implemented for subscription import*
This event is dispatched if membershipauto is selected as an input parameter and no membership ID is specified.
A default listener is implemented in
`\Civi\StripeImport\MembershipSubscriber`
which will
select the membership linked to the recur if available or the latest current membership by ID.
This diff is collapsed.
Click to expand it.
docs/releasenotes.md
0 → 100644
+
14
−
0
View file @
f91e1878
## Information
Releases use the following numbering system:
**{major}.{minor}.{incremental}**
*
major: Major refactoring or rewrite - make sure you read and test very carefully!
*
minor: Breaking change in some circumstances, or a new feature. Read carefully and make sure you understand the impact of the change.
*
incremental: A "safe" change / improvement. Should
*always*
be safe to upgrade.
*
**[BC]**
: Items marked with [BC] indicate a breaking change that will require updates to your code if you are using that code in your extension.
## Release 1.0 (not yet released)
Initial release.
This diff is collapsed.
Click to expand it.
info.xml
+
3
−
3
View file @
f91e1878
...
...
@@ -13,11 +13,11 @@
<url
desc=
"Support"
>
https://mjw.pt/stripeimport
</url>
<url
desc=
"Licensing"
>
http://www.gnu.org/licenses/agpl-3.0.html
</url>
</urls>
<releaseDate>
202
3-12
-1
1
</releaseDate>
<version>
0.
2
</version>
<releaseDate>
202
4-01
-1
8
</releaseDate>
<version>
0.
3
</version>
<develStage>
beta
</develStage>
<compatibility>
<ver>
5.6
5
</ver>
<ver>
5.6
8
</ver>
</compatibility>
<classloader>
<psr0
prefix=
"CRM_"
path=
"."
/>
...
...
This diff is collapsed.
Click to expand it.
mkdocs.yml
0 → 100644
+
20
−
0
View file @
f91e1878
site_name
:
Importers for Stripe Payment Processor
repo_url
:
https://lab.civicrm.org/extensions/stripeimport
theme
:
name
:
material
markdown_extensions
:
-
attr_list
-
admonition
-
def_list
-
codehilite
-
toc
:
permalink
:
true
-
pymdownx.superfences
-
pymdownx.inlinehilite
-
pymdownx.tilde
-
pymdownx.betterem
-
pymdownx.mark
nav
:
-
About
:
index.md
-
Release Notes
:
releasenotes.md
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment