affinity-sdk/mkdocs.yml at main · lool-ventures/affinity-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
site_name: Affinity Python SDK
site_description: Strongly-typed Python SDK for the Affinity CRM API
repo_url: https://github.com/yaniv-golan/affinity-sdk
edit_uri: edit/main/docs/public/
docs_dir: docs/public
copyright: 'Disclaimer: Unofficial community project; not affiliated with, endorsed by, or sponsored by Affinity. "Affinity" and related marks are trademarks of their respective owners. Use of the Affinity API is subject to Affinity Terms of Service.'

theme:
  name: material

extra:
  version:
    provider: mike

plugins:
  - search
  - include-markdown
  - mkdocstrings:
      handlers:
        python:
          options:
            docstring_style: google
            show_signature_annotations: true

markdown_extensions:
  - admonition
  - fenced_code
  - pymdownx.details
  - pymdownx.superfences
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Getting started: getting-started.md
  - Examples: examples.md
  - Glossary: glossary.md
  - Changelog: changelog.md
  - CLI:
      - Overview: cli/index.md
      - Commands: cli/commands.md
      - Scripting: cli/scripting.md
      - JSON Output Reference: cli-reference.md
  - AI Integrations:
      - Overview: ai-integrations/index.md
      - MCP Server: mcp/index.md
      - Claude Code Plugins & Skills: guides/claude-code-plugins.md
  - Guides:
      - Authentication: guides/authentication.md
      - Configuration: guides/configuration.md
      - Performance tuning: guides/performance.md
      - API versions & routing: guides/api-versions-and-routing.md
      - Pagination: guides/pagination.md
      - Errors & retries: guides/errors-and-retries.md
      - Rate limits: guides/rate-limits.md
      - Filtering: guides/filtering.md
      - Query command: guides/query-command.md
      - Datetime handling: guides/datetime-handling.md
      - CSV Export (CLI): guides/csv-export.md
      - Field types & values: guides/field-types-and-values.md
      - Field values: guides/field-values.md
      - Models: guides/models.md
      - IDs & types: guides/ids-and-types.md
      - Sync vs async: guides/sync-vs-async.md
      - Debugging hooks: guides/debugging-hooks.md
      - Webhooks: guides/webhooks.md
      - Opportunity associations: guides/opportunity-associations.md
  - Troubleshooting: troubleshooting.md
  - Reference:
      - Client: reference/client.md
      - Exceptions: reference/exceptions.md
      - Types: reference/types.md
      - Filters: reference/filters.md
      - Query Language: reference/query-language.md
      - Models: reference/models.md
      - Services:
          - Companies: reference/services/companies.md
          - Persons: reference/services/persons.md
          - Lists: reference/services/lists.md
          - Opportunities: reference/services/opportunities.md
          - Tasks: reference/services/tasks.md
          - V1 endpoints:
              - Notes: reference/services/v1/notes.md
              - Reminders: reference/services/v1/reminders.md
              - Webhooks: reference/services/v1/webhooks.md
              - Interactions: reference/services/v1/interactions.md
              - Fields: reference/services/v1/fields.md
              - Field values: reference/services/v1/field-values.md
              - Files: reference/services/v1/files.md
              - Relationships: reference/services/v1/relationships.md
              - Auth: reference/services/v1/auth.md