@getyetty-sdk/sellsy 2026.1.28 → 2026.1.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +8 -3
- package/dist/index.d.mts +35 -35
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +22 -12
package/README.md
CHANGED
|
@@ -77,7 +77,12 @@ const newContact = await createContact({
|
|
|
77
77
|
### Creating a Custom Client Instance
|
|
78
78
|
|
|
79
79
|
```typescript
|
|
80
|
-
import {
|
|
80
|
+
import {
|
|
81
|
+
createClient,
|
|
82
|
+
createClientWithApiKey,
|
|
83
|
+
createConfig,
|
|
84
|
+
getContacts,
|
|
85
|
+
} from '@getyetty-sdk/sellsy';
|
|
81
86
|
|
|
82
87
|
const sellsy = createClient(
|
|
83
88
|
createConfig({
|
|
@@ -85,11 +90,11 @@ const sellsy = createClient(
|
|
|
85
90
|
headers: {
|
|
86
91
|
Authorization: `Bearer ${process.env.SELLSY_API_KEY}`,
|
|
87
92
|
},
|
|
88
|
-
})
|
|
93
|
+
}),
|
|
89
94
|
);
|
|
90
95
|
|
|
91
96
|
// Or alternatively if you just have to provide an API key
|
|
92
|
-
const sellsy = createClientWithApiKey(process.env.SELLSY_API_KEY)
|
|
97
|
+
const sellsy = createClientWithApiKey(process.env.SELLSY_API_KEY);
|
|
93
98
|
|
|
94
99
|
// Use the custom client
|
|
95
100
|
const contacts = await getContacts({
|
package/dist/index.d.mts
CHANGED
|
@@ -30188,7 +30188,7 @@ declare const ModelOrder: {
|
|
|
30188
30188
|
/**
|
|
30189
30189
|
* Order field
|
|
30190
30190
|
*/
|
|
30191
|
-
type ModelOrder = typeof ModelOrder[keyof typeof ModelOrder];
|
|
30191
|
+
type ModelOrder = (typeof ModelOrder)[keyof typeof ModelOrder];
|
|
30192
30192
|
/**
|
|
30193
30193
|
* The order field
|
|
30194
30194
|
*/
|
|
@@ -30200,7 +30200,7 @@ declare const CommentOrder: {
|
|
|
30200
30200
|
/**
|
|
30201
30201
|
* The order field
|
|
30202
30202
|
*/
|
|
30203
|
-
type CommentOrder = typeof CommentOrder[keyof typeof CommentOrder];
|
|
30203
|
+
type CommentOrder = (typeof CommentOrder)[keyof typeof CommentOrder];
|
|
30204
30204
|
/**
|
|
30205
30205
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - owner: `staffs.read`<br /> - contact: `contacts.read`<br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned
|
|
30206
30206
|
*
|
|
@@ -30224,7 +30224,7 @@ declare const CrmActivityOrder: {
|
|
|
30224
30224
|
/**
|
|
30225
30225
|
* The order field
|
|
30226
30226
|
*/
|
|
30227
|
-
type CrmActivityOrder = typeof CrmActivityOrder[keyof typeof CrmActivityOrder];
|
|
30227
|
+
type CrmActivityOrder = (typeof CrmActivityOrder)[keyof typeof CrmActivityOrder];
|
|
30228
30228
|
/**
|
|
30229
30229
|
* The order field
|
|
30230
30230
|
*/
|
|
@@ -30237,7 +30237,7 @@ declare const DealsActivityOrder: {
|
|
|
30237
30237
|
/**
|
|
30238
30238
|
* The order field
|
|
30239
30239
|
*/
|
|
30240
|
-
type DealsActivityOrder = typeof DealsActivityOrder[keyof typeof DealsActivityOrder];
|
|
30240
|
+
type DealsActivityOrder = (typeof DealsActivityOrder)[keyof typeof DealsActivityOrder];
|
|
30241
30241
|
/**
|
|
30242
30242
|
* The order field
|
|
30243
30243
|
*/
|
|
@@ -30247,7 +30247,7 @@ declare const AccountDocumentOrder: {
|
|
|
30247
30247
|
/**
|
|
30248
30248
|
* The order field
|
|
30249
30249
|
*/
|
|
30250
|
-
type AccountDocumentOrder = typeof AccountDocumentOrder[keyof typeof AccountDocumentOrder];
|
|
30250
|
+
type AccountDocumentOrder = (typeof AccountDocumentOrder)[keyof typeof AccountDocumentOrder];
|
|
30251
30251
|
/**
|
|
30252
30252
|
* Additional object included in the result. <br/> <strong>Aggregations by date only works with due_date filter : </strong> <br/> - For aggregations.by_day_and_event, maximum interval of due_date is 90 days <br/> - For aggregations.by_month_and_event, maximum interval of due_date is 365 days
|
|
30253
30253
|
*/
|
|
@@ -30274,7 +30274,7 @@ declare const OpportunityOrder: {
|
|
|
30274
30274
|
/**
|
|
30275
30275
|
* The order field
|
|
30276
30276
|
*/
|
|
30277
|
-
type OpportunityOrder = typeof OpportunityOrder[keyof typeof OpportunityOrder];
|
|
30277
|
+
type OpportunityOrder = (typeof OpportunityOrder)[keyof typeof OpportunityOrder];
|
|
30278
30278
|
/**
|
|
30279
30279
|
* Additional object included in the result.<br /><br /> If current user visibility on staffs is restricted, embed will not be available.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - licenses: `accounts.read`
|
|
30280
30280
|
*
|
|
@@ -30295,7 +30295,7 @@ declare const OpportunitySourceOrder: {
|
|
|
30295
30295
|
/**
|
|
30296
30296
|
* The order field
|
|
30297
30297
|
*/
|
|
30298
|
-
type OpportunitySourceOrder = typeof OpportunitySourceOrder[keyof typeof OpportunitySourceOrder];
|
|
30298
|
+
type OpportunitySourceOrder = (typeof OpportunitySourceOrder)[keyof typeof OpportunitySourceOrder];
|
|
30299
30299
|
/**
|
|
30300
30300
|
* The order field
|
|
30301
30301
|
*/
|
|
@@ -30306,7 +30306,7 @@ declare const OpportunityPipelineOrder: {
|
|
|
30306
30306
|
/**
|
|
30307
30307
|
* The order field
|
|
30308
30308
|
*/
|
|
30309
|
-
type OpportunityPipelineOrder = typeof OpportunityPipelineOrder[keyof typeof OpportunityPipelineOrder];
|
|
30309
|
+
type OpportunityPipelineOrder = (typeof OpportunityPipelineOrder)[keyof typeof OpportunityPipelineOrder];
|
|
30310
30310
|
/**
|
|
30311
30311
|
* The order field
|
|
30312
30312
|
*/
|
|
@@ -30318,7 +30318,7 @@ declare const PipelineStepOrder: {
|
|
|
30318
30318
|
/**
|
|
30319
30319
|
* The order field
|
|
30320
30320
|
*/
|
|
30321
|
-
type PipelineStepOrder = typeof PipelineStepOrder[keyof typeof PipelineStepOrder];
|
|
30321
|
+
type PipelineStepOrder = (typeof PipelineStepOrder)[keyof typeof PipelineStepOrder];
|
|
30322
30322
|
/**
|
|
30323
30323
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - opportunities_number: `opportunities.read`
|
|
30324
30324
|
*
|
|
@@ -30339,7 +30339,7 @@ declare const FavouriteFiltersOrder: {
|
|
|
30339
30339
|
/**
|
|
30340
30340
|
* The order field
|
|
30341
30341
|
*/
|
|
30342
|
-
type FavouriteFiltersOrder = typeof FavouriteFiltersOrder[keyof typeof FavouriteFiltersOrder];
|
|
30342
|
+
type FavouriteFiltersOrder = (typeof FavouriteFiltersOrder)[keyof typeof FavouriteFiltersOrder];
|
|
30343
30343
|
/**
|
|
30344
30344
|
* Example : `embed[]=payment_method_ids&embed[]=cf.1542&embed[]=acl` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - payment_method_ids: `payments.read`<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - contact: `contacts.read`<br /> - cf.{custom_field_id} : `custom-fields.read` <br /> - smart_tags: `smart-tags.read`<br /> Additionally, the smart_tags embed is limited to the 20 first results sorted in alphabetical order. <br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned <br/><br /> <strong>Aggregations on amounts only works in addition with the currency filter</strong>
|
|
30345
30345
|
*
|
|
@@ -30367,7 +30367,7 @@ declare const SaleOrder: {
|
|
|
30367
30367
|
* The order field
|
|
30368
30368
|
* > Value `numero` is deprecated and will be deleted on the July 1st 2022. Use `number` instead.
|
|
30369
30369
|
*/
|
|
30370
|
-
type SaleOrder = typeof SaleOrder[keyof typeof SaleOrder];
|
|
30370
|
+
type SaleOrder = (typeof SaleOrder)[keyof typeof SaleOrder];
|
|
30371
30371
|
/**
|
|
30372
30372
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - owner, assigned_staffs: `staffs.read`<br /> - contact: `contacts.read`<br /> - related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned
|
|
30373
30373
|
*
|
|
@@ -30383,7 +30383,7 @@ declare const TaskOrder: {
|
|
|
30383
30383
|
/**
|
|
30384
30384
|
* The order field
|
|
30385
30385
|
*/
|
|
30386
|
-
type TaskOrder = typeof TaskOrder[keyof typeof TaskOrder];
|
|
30386
|
+
type TaskOrder = (typeof TaskOrder)[keyof typeof TaskOrder];
|
|
30387
30387
|
/**
|
|
30388
30388
|
* The order field
|
|
30389
30389
|
*/
|
|
@@ -30394,7 +30394,7 @@ declare const LabelOrder: {
|
|
|
30394
30394
|
/**
|
|
30395
30395
|
* The order field
|
|
30396
30396
|
*/
|
|
30397
|
-
type LabelOrder = typeof LabelOrder[keyof typeof LabelOrder];
|
|
30397
|
+
type LabelOrder = (typeof LabelOrder)[keyof typeof LabelOrder];
|
|
30398
30398
|
/**
|
|
30399
30399
|
* The search field
|
|
30400
30400
|
*/
|
|
@@ -30416,7 +30416,7 @@ declare const ActivityOrder: {
|
|
|
30416
30416
|
/**
|
|
30417
30417
|
* The order field
|
|
30418
30418
|
*/
|
|
30419
|
-
type ActivityOrder = typeof ActivityOrder[keyof typeof ActivityOrder];
|
|
30419
|
+
type ActivityOrder = (typeof ActivityOrder)[keyof typeof ActivityOrder];
|
|
30420
30420
|
/**
|
|
30421
30421
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - author: `staffs.read`<br /> - object_related: by object type. Check the entire documentation to verify the usual scopes requested for the types returned
|
|
30422
30422
|
*
|
|
@@ -30436,7 +30436,7 @@ declare const PhoneCallOrder: {
|
|
|
30436
30436
|
/**
|
|
30437
30437
|
* The order field
|
|
30438
30438
|
*/
|
|
30439
|
-
type PhoneCallOrder = typeof PhoneCallOrder[keyof typeof PhoneCallOrder];
|
|
30439
|
+
type PhoneCallOrder = (typeof PhoneCallOrder)[keyof typeof PhoneCallOrder];
|
|
30440
30440
|
/**
|
|
30441
30441
|
* Additional object included in the result.
|
|
30442
30442
|
*/
|
|
@@ -30452,7 +30452,7 @@ declare const ContactOrders: {
|
|
|
30452
30452
|
/**
|
|
30453
30453
|
* The order field
|
|
30454
30454
|
*/
|
|
30455
|
-
type ContactOrders = typeof ContactOrders[keyof typeof ContactOrders];
|
|
30455
|
+
type ContactOrders = (typeof ContactOrders)[keyof typeof ContactOrders];
|
|
30456
30456
|
/**
|
|
30457
30457
|
* The order field
|
|
30458
30458
|
*/
|
|
@@ -30463,7 +30463,7 @@ declare const CheckLabelOrders: {
|
|
|
30463
30463
|
/**
|
|
30464
30464
|
* The order field
|
|
30465
30465
|
*/
|
|
30466
|
-
type CheckLabelOrders = typeof CheckLabelOrders[keyof typeof CheckLabelOrders];
|
|
30466
|
+
type CheckLabelOrders = (typeof CheckLabelOrders)[keyof typeof CheckLabelOrders];
|
|
30467
30467
|
/**
|
|
30468
30468
|
* Additional object included in the result
|
|
30469
30469
|
*/
|
|
@@ -30490,7 +30490,7 @@ declare const UnitOrder: {
|
|
|
30490
30490
|
/**
|
|
30491
30491
|
* The order field
|
|
30492
30492
|
*/
|
|
30493
|
-
type UnitOrder = typeof UnitOrder[keyof typeof UnitOrder];
|
|
30493
|
+
type UnitOrder = (typeof UnitOrder)[keyof typeof UnitOrder];
|
|
30494
30494
|
/**
|
|
30495
30495
|
* The order direction
|
|
30496
30496
|
*/
|
|
@@ -30501,7 +30501,7 @@ declare const Direction: {
|
|
|
30501
30501
|
/**
|
|
30502
30502
|
* The order direction
|
|
30503
30503
|
*/
|
|
30504
|
-
type Direction = typeof Direction[keyof typeof Direction];
|
|
30504
|
+
type Direction = (typeof Direction)[keyof typeof Direction];
|
|
30505
30505
|
/**
|
|
30506
30506
|
* The order field
|
|
30507
30507
|
*/
|
|
@@ -30524,7 +30524,7 @@ declare const Language: {
|
|
|
30524
30524
|
/**
|
|
30525
30525
|
* language code
|
|
30526
30526
|
*/
|
|
30527
|
-
type Language = typeof Language[keyof typeof Language];
|
|
30527
|
+
type Language = (typeof Language)[keyof typeof Language];
|
|
30528
30528
|
/**
|
|
30529
30529
|
* The order field
|
|
30530
30530
|
*/
|
|
@@ -30534,7 +30534,7 @@ declare const CustomActivityOrder: {
|
|
|
30534
30534
|
/**
|
|
30535
30535
|
* The order field
|
|
30536
30536
|
*/
|
|
30537
|
-
type CustomActivityOrder = typeof CustomActivityOrder[keyof typeof CustomActivityOrder];
|
|
30537
|
+
type CustomActivityOrder = (typeof CustomActivityOrder)[keyof typeof CustomActivityOrder];
|
|
30538
30538
|
/**
|
|
30539
30539
|
* The order field
|
|
30540
30540
|
*/
|
|
@@ -30545,7 +30545,7 @@ declare const OcrOrder: {
|
|
|
30545
30545
|
/**
|
|
30546
30546
|
* The order field
|
|
30547
30547
|
*/
|
|
30548
|
-
type OcrOrder = typeof OcrOrder[keyof typeof OcrOrder];
|
|
30548
|
+
type OcrOrder = (typeof OcrOrder)[keyof typeof OcrOrder];
|
|
30549
30549
|
/**
|
|
30550
30550
|
* The order field
|
|
30551
30551
|
*/
|
|
@@ -30556,7 +30556,7 @@ declare const PaymentMethodOrder: {
|
|
|
30556
30556
|
/**
|
|
30557
30557
|
* The order field
|
|
30558
30558
|
*/
|
|
30559
|
-
type PaymentMethodOrder = typeof PaymentMethodOrder[keyof typeof PaymentMethodOrder];
|
|
30559
|
+
type PaymentMethodOrder = (typeof PaymentMethodOrder)[keyof typeof PaymentMethodOrder];
|
|
30560
30560
|
/**
|
|
30561
30561
|
* Additional object included in the result
|
|
30562
30562
|
*/
|
|
@@ -30570,7 +30570,7 @@ declare const AccountingOrder: {
|
|
|
30570
30570
|
/**
|
|
30571
30571
|
* The order field
|
|
30572
30572
|
*/
|
|
30573
|
-
type AccountingOrder = typeof AccountingOrder[keyof typeof AccountingOrder];
|
|
30573
|
+
type AccountingOrder = (typeof AccountingOrder)[keyof typeof AccountingOrder];
|
|
30574
30574
|
/**
|
|
30575
30575
|
* Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - company: `companies.read`<br /> - individual: `individuals.read`<br /> - owner: `staffs.read`<br /> - contact: `contacts.read`<br /> - related, participants: by object type. Check the entire documentation to verify the usual scopes requested for the types returned
|
|
30576
30576
|
*
|
|
@@ -30586,7 +30586,7 @@ declare const CalendarEventOrder: {
|
|
|
30586
30586
|
/**
|
|
30587
30587
|
* The order field
|
|
30588
30588
|
*/
|
|
30589
|
-
type CalendarEventOrder = typeof CalendarEventOrder[keyof typeof CalendarEventOrder];
|
|
30589
|
+
type CalendarEventOrder = (typeof CalendarEventOrder)[keyof typeof CalendarEventOrder];
|
|
30590
30590
|
/**
|
|
30591
30591
|
* The order field
|
|
30592
30592
|
*/
|
|
@@ -30597,7 +30597,7 @@ declare const ProfileOrder: {
|
|
|
30597
30597
|
/**
|
|
30598
30598
|
* The order field
|
|
30599
30599
|
*/
|
|
30600
|
-
type ProfileOrder = typeof ProfileOrder[keyof typeof ProfileOrder];
|
|
30600
|
+
type ProfileOrder = (typeof ProfileOrder)[keyof typeof ProfileOrder];
|
|
30601
30601
|
/**
|
|
30602
30602
|
* Field on which to sort the data
|
|
30603
30603
|
*/
|
|
@@ -30608,7 +30608,7 @@ declare const StaffOrder: {
|
|
|
30608
30608
|
/**
|
|
30609
30609
|
* Field on which to sort the data
|
|
30610
30610
|
*/
|
|
30611
|
-
type StaffOrder = typeof StaffOrder[keyof typeof StaffOrder];
|
|
30611
|
+
type StaffOrder = (typeof StaffOrder)[keyof typeof StaffOrder];
|
|
30612
30612
|
/**
|
|
30613
30613
|
* Flag to trigger validation only (set to true to validate payload without persisting data)
|
|
30614
30614
|
*/
|
|
@@ -30647,7 +30647,7 @@ declare const InvoiceOrder: {
|
|
|
30647
30647
|
/**
|
|
30648
30648
|
* Order field
|
|
30649
30649
|
*/
|
|
30650
|
-
type InvoiceOrder = typeof InvoiceOrder[keyof typeof InvoiceOrder];
|
|
30650
|
+
type InvoiceOrder = (typeof InvoiceOrder)[keyof typeof InvoiceOrder];
|
|
30651
30651
|
/**
|
|
30652
30652
|
* Additional object included in the result
|
|
30653
30653
|
*/
|
|
@@ -30669,7 +30669,7 @@ declare const CreditNoteOrder: {
|
|
|
30669
30669
|
/**
|
|
30670
30670
|
* Order field
|
|
30671
30671
|
*/
|
|
30672
|
-
type CreditNoteOrder = typeof CreditNoteOrder[keyof typeof CreditNoteOrder];
|
|
30672
|
+
type CreditNoteOrder = (typeof CreditNoteOrder)[keyof typeof CreditNoteOrder];
|
|
30673
30673
|
/**
|
|
30674
30674
|
* Order field
|
|
30675
30675
|
*/
|
|
@@ -30680,7 +30680,7 @@ declare const ItemOrder: {
|
|
|
30680
30680
|
/**
|
|
30681
30681
|
* Order field
|
|
30682
30682
|
*/
|
|
30683
|
-
type ItemOrder = typeof ItemOrder[keyof typeof ItemOrder];
|
|
30683
|
+
type ItemOrder = (typeof ItemOrder)[keyof typeof ItemOrder];
|
|
30684
30684
|
/**
|
|
30685
30685
|
* Type of import
|
|
30686
30686
|
*/
|
|
@@ -30697,7 +30697,7 @@ declare const ImportType: {
|
|
|
30697
30697
|
/**
|
|
30698
30698
|
* Type of import
|
|
30699
30699
|
*/
|
|
30700
|
-
type ImportType = typeof ImportType[keyof typeof ImportType];
|
|
30700
|
+
type ImportType = (typeof ImportType)[keyof typeof ImportType];
|
|
30701
30701
|
/**
|
|
30702
30702
|
* Additional object included in the result
|
|
30703
30703
|
*/
|
|
@@ -30721,7 +30721,7 @@ declare const OrderOrder: {
|
|
|
30721
30721
|
/**
|
|
30722
30722
|
* Order field
|
|
30723
30723
|
*/
|
|
30724
|
-
type OrderOrder = typeof OrderOrder[keyof typeof OrderOrder];
|
|
30724
|
+
type OrderOrder = (typeof OrderOrder)[keyof typeof OrderOrder];
|
|
30725
30725
|
/**
|
|
30726
30726
|
* The order field
|
|
30727
30727
|
*/
|
|
@@ -30743,7 +30743,7 @@ declare const ObjectiveOrder: {
|
|
|
30743
30743
|
/**
|
|
30744
30744
|
* The order field
|
|
30745
30745
|
*/
|
|
30746
|
-
type ObjectiveOrder = typeof ObjectiveOrder[keyof typeof ObjectiveOrder];
|
|
30746
|
+
type ObjectiveOrder = (typeof ObjectiveOrder)[keyof typeof ObjectiveOrder];
|
|
30747
30747
|
/**
|
|
30748
30748
|
* Example : `embed[]=created_by&embed[]=modified_by` <br /> Additional object included in the result.<br /><br /> Each embed object may require different oauth2 scopes than the main endpoint:<br /> - created_by: `staffs.read`<br /> - modified_by: `staffs.read`<br />
|
|
30749
30749
|
*
|
|
@@ -30764,7 +30764,7 @@ declare const ProgressInvoiceDocType: {
|
|
|
30764
30764
|
/**
|
|
30765
30765
|
* The type of the invoice or it's parent
|
|
30766
30766
|
*/
|
|
30767
|
-
type ProgressInvoiceDocType = typeof ProgressInvoiceDocType[keyof typeof ProgressInvoiceDocType];
|
|
30767
|
+
type ProgressInvoiceDocType = (typeof ProgressInvoiceDocType)[keyof typeof ProgressInvoiceDocType];
|
|
30768
30768
|
/**
|
|
30769
30769
|
* The ID of the invoice or it's parent
|
|
30770
30770
|
*/
|
|
@@ -30780,7 +30780,7 @@ declare const EmailsListOrder: {
|
|
|
30780
30780
|
/**
|
|
30781
30781
|
* Order fields
|
|
30782
30782
|
*/
|
|
30783
|
-
type EmailsListOrder = typeof EmailsListOrder[keyof typeof EmailsListOrder];
|
|
30783
|
+
type EmailsListOrder = (typeof EmailsListOrder)[keyof typeof EmailsListOrder];
|
|
30784
30784
|
type GetCommentsData = {
|
|
30785
30785
|
body?: never;
|
|
30786
30786
|
path?: never;
|